\Google\AdsApi\AdWords\Reporting\v201809ReportDownloader

Provides functionality to help with retrieving a report.

Summary

Methods
Properties
Constants
__construct()
downloadReport()
downloadReportWithAwql()
downloadReportWithReportQuery()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
makeReportRequest()
$REPORT_DOWNLOAD_URL_PATH
$REDACTED_DATA_MESSAGE
$session
$httpClient
$requestOptionsFactory
$apiErrorSerializer
N/A

Properties

$REPORT_DOWNLOAD_URL_PATH

$REPORT_DOWNLOAD_URL_PATH :

Type

$REDACTED_DATA_MESSAGE

$REDACTED_DATA_MESSAGE :

Type

$session

$session :

Type

$httpClient

$httpClient :

Type

$requestOptionsFactory

$requestOptionsFactory :

Type

$apiErrorSerializer

$apiErrorSerializer :

Type

Methods

__construct()

__construct(\Google\AdsApi\AdWords\AdWordsSession  $session,\Google\AdsApi\AdWords\Reporting\v201809\RequestOptionsFactory|null  $requestOptionsFactory = null,\GuzzleHttp\Client|null  $httpClient = null,\Google\AdsApi\Common\GuzzleHttpClientFactory|null  $httpClientFactory = null)

Creates a report downloader with the specified parameters.

Parameters

\Google\AdsApi\AdWords\AdWordsSession $session

the session used to connect to AdWords API

\Google\AdsApi\AdWords\Reporting\v201809\RequestOptionsFactory|null $requestOptionsFactory

optional, the factory to create report requests

\GuzzleHttp\Client|null $httpClient

optional, the Guzzle HTTP client whose handler stacks this library's logging middleware will be pushed to

\Google\AdsApi\Common\GuzzleHttpClientFactory|null $httpClientFactory

optional, the Guzzle HTTP client factory that will generate a client handling HTTP calls

downloadReport()

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

Downloads a report using report definition.

Parameters

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

the report definition to download

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

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

Throws

\Google\AdsApi\AdWords\v201809\cm\ApiException

if there are errors during downloading reports

Returns

\Google\AdsApi\AdWords\Reporting\ReportDownloadResult

the report download result

downloadReportWithAwql()

downloadReportWithAwql(string  $reportQuery,string  $reportFormat,null|\Google\AdsApi\AdWords\ReportSettings  $reportSettingsOverride = null): \Google\AdsApi\AdWords\Reporting\ReportDownloadResult

Downloads a report using AWQL.

Parameters

string $reportQuery

the query to use for the report

string $reportFormat

the report format to request

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

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

Throws

\Google\AdsApi\AdWords\v201809\cm\ApiException

if there are errors during downloading reports

Returns

\Google\AdsApi\AdWords\Reporting\ReportDownloadResult

the report download result

downloadReportWithReportQuery()

downloadReportWithReportQuery(\Google\AdsApi\AdWords\Query\v201809\ReportQuery  $reportQuery,string  $reportFormat,null|\Google\AdsApi\AdWords\ReportSettings  $reportSettingsOverride = null): \Google\AdsApi\AdWords\Reporting\ReportDownloadResult

Downloads a report using a report query object.

Parameters

\Google\AdsApi\AdWords\Query\v201809\ReportQuery $reportQuery

the report query object that can generate an AWQL string

string $reportFormat

the report format to request

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

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

Throws

\Google\AdsApi\AdWords\v201809\cm\ApiException

if there are errors during downloading reports

Returns

\Google\AdsApi\AdWords\Reporting\ReportDownloadResult

the report download result

makeReportRequest()

makeReportRequest(array  $requestOptions): \Google\AdsApi\AdWords\Reporting\ReportDownloadResult

Make an HTTP request to download a report with the specified request options.

Parameters

array $requestOptions

the options for making HTTP request via Guzzle

Throws

\Google\AdsApi\AdWords\v201809\cm\ApiException

if there are errors during downloading reports

Returns

\Google\AdsApi\AdWords\Reporting\ReportDownloadResult

the report download result