|
|
BasicReportService
BasicReportService provides operations for requesting and managing reports that contain performance information about your accounts, campaigns, ad groups, and keywords.
You can store up to 50 reports on the system per master account, per user.
Reports are saved for 2 days. For security reasons, the URLs that you use to
retrieve reports are valid for 5 minutes.
Operations
- addReportRequest (added in Version 6.0)
- deleteReport
- deleteReports
- getBooksClosedTime (added in Version 6.0)
- getOptInReportingForAdGroups
- getOptInReportingForCampaigns
- getReportDownloadUrl (added in Version 6.0)
- getReportDownloadUrls (added in Version 6.0)
- getReportList
- isBooksClosed
- setOptInReportingForAdGroups
- setOptInReportingForCampaigns
addReportRequest
Add a report request for asynchronous processing. The report is generated in the specified format. The time taken for processing the report depends on the date range specified in the report request.
If the spend account ID is specified as null, the report aggregates metrics for all of the accounts that you have access to in the master account; otherwise, the report aggregates metrics for the specified spend account.
If you are requesting a large report in CSV Excel file type and unzipped format, please note that the report download will not work if the report has more than 64,000 rows. Please ensure you use zipped format for this use case.
The report request will be rejected if there is a similar report request in pending status. Please note that certain attributes of a report request (such as report name and zip format) are not considered when identifying duplicate report requests. See BasicReportService Overview for more details.
Added in: Version 6.0
Capability required: Reporting
License command group: BasicReports
Supported accounts: Web, Mobile
Parameters
| Parameter | Data Type | Description |
|---|---|---|
| accountID | string | The spend account ID (optional). |
| reportRequest | BasicReportRequest | The report request. |
| fileOutputFormat | FileOutputFormat | The report file output format. |
Response
long - The report ID.
deleteReport
Delete the report (specified by reportID) that you have requested. If necessary, use getReportList to obtain the report ID.
Capability required: Reporting
License command group: BasicReports
Supported accounts: Web, Mobile
Parameters
| Parameter | Data Type | Description |
|---|---|---|
| reportID | long | The report ID. |
Response
none
deleteReports
Delete one or more reports (specified by the list of reportIDs) that you have requested. If necessary, use getReportList to obtain the report IDs.
Capability required: Reporting
License command group: BasicReports
Supported accounts: Web, Mobile
Parameters
| Parameter | Data Type | Description |
|---|---|---|
| reportIDs | long[] | A list of report IDs. |
Response
none
getBooksClosedTime
Returns the books closed time (in UTC) for the given report (see Books Closed and Report Headers).
Note: This operation is not supported for the Billing Transaction Detail report.
Added in: Version 6.0
Capability required: Reporting
License command group: BasicReports
Supported accounts: Web, Mobile
Parameters
| Parameter | Data Type | Description |
|---|---|---|
| reportType | BasicReportType | The report type. |
Response
dateTime - The books closed time (in UTC).
getOptInReportingForAdGroups
Return the OptInReporting status for one or more ad groups (specified by the list of adGroupIDs).
Capability required: Reporting
License command group: BasicReports
Supported accounts: Web
Parameters
| Parameter | Data Type | Description |
|---|---|---|
| accountID | string | The account ID. |
| adGroupIDs | long[] | A list of ad group IDs. |
Response
OptInAdGroupResponse[] - The list of responses, which indicate if the operations succeeded or failed, and the OptInReporting status for the specified list of ad groups.
getOptInReportingForCampaigns
Return the OptInReporting status for one or more campaigns (specified by the list of campaignIDs).
Capability required: Reporting
License command group: BasicReports
Supported accounts: Web
Parameters
| Parameter | Data Type | Description |
|---|---|---|
| accountID | string | The account ID. |
| campaignIDs | long[] | A list of campaign IDs. |
Response
OptInCampaignResponse[] - The list of responses, which indicate if the operations succeeded or failed, and the OptInReporting status for the specified list of campaigns.
getReportDownloadUrl
Returns a response object containing download information for the given report ID. This includes the report status, download URL and file output format of the report.
The download URL and file output format is available only if the report has been processed and is in completed status. For security reasons, the URL is available for 5 minutes only.
Added in: Version 6.0
Capability required: Reporting
License command group: BasicReports
Supported accounts: Web, Mobile
Parameters
| Parameter | Data Type | Description |
|---|---|---|
| reportID | long | The report ID. |
Response
ReportDownloadInfo - The response object containing the status and download URL for the given report ID.
getReportDownloadUrls
Returns a response object containing download information for the given report ID. This includes the report status, download URL and file output format of the report.
The download URL and file output format is available only if the report has been processed and is in completed status. For security reasons, the URL is available for 5 minutes only.
You can specify a maximum of 50 report IDs for this operation.
Added in: Version 6.0
Capability required: Reporting
License command group: BasicReports
Supported accounts: Web, Mobile
Parameters
| Parameter | Data Type | Description |
|---|---|---|
| reportIDs | long[] | A list of report IDs. |
Response
ReportDownloadInfo[] - A list of response objects containing the status and download URL for the given list of report IDs.
getReportList
Return a list of all requested reports that you have access to in the master account.
Capability required: Reporting
License command group: BasicReports
Supported accounts: Web, Mobile
Parameters
| Parameter | Data Type | Description |
|---|---|---|
| onlyCompleted | boolean | If true, returns only those reports in completed status. |
Response
ReportInfo[] - A list of all requested reports that you have access to in the master account.
isBooksClosed
Return the status of books closed (see Books Closed and Report Headers).
Note: This operation is not supported for the Billing Transaction Detail report.
Note: reportName element in BasicReportRequest object are ignored for this operation.
Capability required: Reporting
License command group: BasicReports
Supported accounts: Web, Mobile
Parameters
| Parameter | Data Type | Description |
|---|---|---|
| reportRequest | BasicReportRequest | The report request object. |
Response
boolean - If true, the books are closed for the date range specified in the request. If false, the books are not closed.
setOptInReportingForAdGroups
Enable OptInReporting for one or more ad groups (specified by the list of adGroupIDs).
Capability required: Reporting
License command group: BasicReports
Supported accounts: Web
Parameters
| Parameter | Data Type | Description |
|---|---|---|
| optInReporting | OptInReporting | The category of reports to opt-in. |
| accountID | string | The account ID. |
| adGroupIDs | long[] | A list of ad group IDs. |
Response
OptInAdGroupResponse[] - The list of responses, which indicate if the operations succeeded or failed, and the OptInReporting status for the specified list of ad groups.
setOptInReportingForCampaigns
Enable OptInReporting for one or more campaigns (specified by the list of campaignIDs).
Capability required: Reporting
License command group: BasicReports
Supported accounts: Web
Parameters
| Parameter | Data Type | Description |
|---|---|---|
| optInReporting | OptInReporting | The category of reports to opt-in. |
| accountID | string | The account ID. |
| campaignIDs | long[] | A list of campaign IDs. |
Response
OptInCampaignResponse[] - The list of responses, which indicate if the operations succeeded or failed, and the OptInReporting status for the specified list of campaigns.