\Google\AdsApi\AdWords\Reporting\v201809RequestOptionsFactory

Creates request options for downloading reports.

Summary

Methods
Properties
Constants
__construct()
createRequestOptionsWithReportDefinition()
createRequestOptionsWithAwqlQuery()
No public properties found
DEFAULT_TIMEOUT_IN_SECONDS
No protected methods found
No protected properties found
N/A
createHeaders()
$session
$reportDefinitionSerializer
$oAuth2TokenRefresher
$options
$httpHandler
N/A

Constants

DEFAULT_TIMEOUT_IN_SECONDS

DEFAULT_TIMEOUT_IN_SECONDS

A default timeout for opening streams to download AdWords API reports.

You can override this using the constructor. See README.md for details.

Properties

$session

$session :

Type

$reportDefinitionSerializer

$reportDefinitionSerializer :

Type

$oAuth2TokenRefresher

$oAuth2TokenRefresher :

Type

$options

$options :

Type

$httpHandler

$httpHandler :

Type

Methods

__construct()

__construct(\Google\AdsApi\AdWords\AdWordsSession  $session,array<mixed,string>  $options = null,\Symfony\Component\Serializer\Serializer|null  $reportDefinitionSerializer = null)

Creates a factory for request options with the specified AdWords session.

Parameters

\Google\AdsApi\AdWords\AdWordsSession $session

the session for using the AdWords API

array<mixed,string> $options

the additional request options for making requests in the form of associative array

\Symfony\Component\Serializer\Serializer|null $reportDefinitionSerializer

the Symfony serializer for serializing report definitions

createRequestOptionsWithReportDefinition()

createRequestOptionsWithReportDefinition(\Google\AdsApi\AdWords\Reporting\v201809\ReportDefinition  $reportDefinition,null|\Google\AdsApi\AdWords\ReportSettings  $reportSettingsOverride = null): array

Creates request options for downloading a report using an XML-based report definition.

Parameters

\Google\AdsApi\AdWords\Reporting\v201809\ReportDefinition $reportDefinition

the report definition

null|\Google\AdsApi\AdWords\ReportSettings $reportSettingsOverride

the report settings used to override the report settings of the AdWords session for this request

Returns

array —

the request options

createRequestOptionsWithAwqlQuery()

createRequestOptionsWithAwqlQuery(string  $reportDefinition,string  $reportFormat,null|\Google\AdsApi\AdWords\ReportSettings  $reportSettingsOverride = null): array

Creates request options for downloading a report using an AWQL-based report definition.

Parameters

string $reportDefinition

the report definition in AWQL format

string $reportFormat

the format to download report as

null|\Google\AdsApi\AdWords\ReportSettings $reportSettingsOverride

the report settings used to override the report settings of the AdWords session for this request

Returns

array —

the request options