class Reports extends Resource (View source)

The "reports" collection of methods.

Typical usage is:

 $doubleclicksearchService = new Google\Service\Doubleclicksearch(...);
 $reports = $doubleclicksearchService->reports;

Methods

generate(ReportRequest $postBody, array $optParams = [])

Generates and returns a report immediately. (reports.generate)

get(string $reportId, array $optParams = [])

Polls for the status of a report request. (reports.get)

getFile(string $reportId, int $reportFragment, array $optParams = [])

Downloads a report file encoded in UTF-8. (reports.getFile)

getIdMappingFile(string $agencyId, string $advertiserId, array $optParams = [])

Downloads a csv file(encoded in UTF-8) that contains ID mappings between legacy SA360 and new SA360. The file includes all children entities of the given advertiser(e.g. engine accounts, campaigns, ad groups, etc.) that exist in both legacy SA360 and new SA360. (reports.getIdMappingFile)

request(ReportRequest $postBody, array $optParams = [])

Inserts a report request into the reporting system. (reports.request)

Details

Report generate(ReportRequest $postBody, array $optParams = [])

Generates and returns a report immediately. (reports.generate)

Parameters

ReportRequest $postBody
array $optParams

Optional parameters.

Return Value

Report

Exceptions

Exception

Report get(string $reportId, array $optParams = [])

Polls for the status of a report request. (reports.get)

Parameters

string $reportId

ID of the report request being polled.

array $optParams

Optional parameters.

Return Value

Report

Exceptions

Exception

getFile(string $reportId, int $reportFragment, array $optParams = [])

Downloads a report file encoded in UTF-8. (reports.getFile)

Parameters

string $reportId

ID of the report.

int $reportFragment

The index of the report fragment to download.

array $optParams

Optional parameters.

Exceptions

Exception

IdMappingFile getIdMappingFile(string $agencyId, string $advertiserId, array $optParams = [])

Downloads a csv file(encoded in UTF-8) that contains ID mappings between legacy SA360 and new SA360. The file includes all children entities of the given advertiser(e.g. engine accounts, campaigns, ad groups, etc.) that exist in both legacy SA360 and new SA360. (reports.getIdMappingFile)

Parameters

string $agencyId

Legacy SA360 agency ID.

string $advertiserId

Legacy SA360 advertiser ID.

array $optParams

Optional parameters.

Return Value

IdMappingFile

Exceptions

Exception

Report request(ReportRequest $postBody, array $optParams = [])

Inserts a report request into the reporting system. (reports.request)

Parameters

ReportRequest $postBody
array $optParams

Optional parameters.

Return Value

Report

Exceptions

Exception