| Method | Description | |
|---|---|---|
| DownloadReport ( mixed $reportDefinition, string $path = null, AdWordsUser $user, array $options = null ) : mixed | Downloads a new instance of an existing report definition. If the path parameter is specified it will be downloaded to the file at that path, otherwise it will be downloaded to memory and be returned as a string. | |
| DownloadReport ( mixed $reportDefinition, string $path = null, AdWordsUser $user, array $options = null, array $customCurlOptions = null ) : mixed | Downloads a new instance of an existing report definition. If the path parameter is specified it will be downloaded to the file at that path, otherwise it will be downloaded to memory and be returned as a string. | |
| DownloadReportWithAwql ( string $reportQuery, string $path = null, AdWordsUser $user, $reportFormat, array $options = null ) : mixed | Downloads a report with AWQL. If the path parameter is specified it will be downloaded to the file at that path, otherwise it will be downloaded to memory and be returned as a string. | |
| DownloadReportWithAwql ( string $reportQuery, string $path = null, AdWordsUser $user, $reportFormat, array $options = null, array $customCurlOptions = null ) : mixed | Downloads a report with AWQL. If the path parameter is specified it will be downloaded to the file at that path, otherwise it will be downloaded to memory and be returned as a string. | |
| __construct ( AdsUtilityRegistry $adsUtilityRegistry = null ) | Create an instance of ReportUtils with the specified ads utility registry. |
| public DownloadReport ( mixed $reportDefinition, string $path = null, AdWordsUser $user, array $options = null ) : mixed | ||
| $reportDefinition | mixed | the ReportDefinition to download or the id of a stored report definition |
| $path | string | an optional path of the file to download the report to |
| $user | AdWordsUser | the user that created the ReportDefinition |
| $options | array | the option to use when downloading the report: {boolean} skipReportHeader: if report responses should skip the header row containing the report name and date range {boolean} skipColumnHeader: if report responses should skip the header row containing column names {boolean} skipReportSummary: if report responses should skip the summary row containing totals {boolean} includeZeroImpressions: if report responses should include zero impression rows {boolean} useRawEnumValues: if report responses should return enum values instead of enum display values {string} server: the server to make the request to. If null, then the default server will be used {string} version: the version to make the request against. If null, then the default version will be used |
| return | mixed | if path isn't specified the contents of the report, otherwise the size in bytes of the downloaded report |
| public DownloadReport ( mixed $reportDefinition, string $path = null, AdWordsUser $user, array $options = null, array $customCurlOptions = null ) : mixed | ||
| $reportDefinition | mixed | the ReportDefinition to download or the id of a stored report definition |
| $path | string | an optional path of the file to download the report to |
| $user | AdWordsUser | the user that created the ReportDefinition |
| $options | array | the option to use when downloading the report: {boolean} skipReportHeader: if report responses should skip the header row containing the report name and date range {boolean} skipColumnHeader: if report responses should skip the header row containing column names {boolean} skipReportSummary: if report responses should skip the summary row containing totals {boolean} includeZeroImpressions: if report responses should include zero impression rows {boolean} useRawEnumValues: if report responses should return enum values instead of enum display values {string} server: the server to make the request to. If null, then the default server will be used {string} version: the version to make the request against. If null, then the default version will be used |
| $customCurlOptions | array | the custom curl options for downloading reports |
| return | mixed | if path isn't specified the contents of the report, otherwise the size in bytes of the downloaded report |
| public DownloadReportWithAwql ( string $reportQuery, string $path = null, AdWordsUser $user, $reportFormat, array $options = null ) : mixed | ||
| $reportQuery | string | the query to use for the report |
| $path | string | an optional path of the file to download the report to |
| $user | AdWordsUser | the user to retrieve report with |
| $options | array | the option to use when downloading the report: {string} server: the server to make the request to. If null, then the default server will be used {string} version: the version to make the request against. If null, then the default version will be used |
| return | mixed | if path isn't specified the contents of the report, otherwise the size in bytes of the downloaded report |
| public DownloadReportWithAwql ( string $reportQuery, string $path = null, AdWordsUser $user, $reportFormat, array $options = null, array $customCurlOptions = null ) : mixed | ||
| $reportQuery | string | the query to use for the report |
| $path | string | an optional path of the file to download the report to |
| $user | AdWordsUser | the user to retrieve report with |
| $options | array | the option to use when downloading the report: {string} server: the server to make the request to. If null, then the default server will be used {string} version: the version to make the request against. If null, then the default version will be used |
| $customCurlOptions | array | the custom curl options for downloading reports |
| return | mixed | if path isn't specified the contents of the report, otherwise the size in bytes of the downloaded report |
| public __construct ( AdsUtilityRegistry $adsUtilityRegistry = null ) | ||
| $adsUtilityRegistry | AdsUtilityRegistry | the ads utility registry |
