|
|
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
- addReportRequestForAccountID (changed in Version 5.2.0)
- addReportRequestWithAccountAggregation (changed in Version 5.2.0)
- deleteReport
- deleteReports
- getOptInReportingForAdGroups
- getOptInReportingForCampaigns
- getReportList
- getReportOutputUrl
- getReportOutputUrls
- isBooksClosed
- setOptInReportingForAdGroups
- setOptInReportingForCampaigns
addReportRequestForAccountID
Request a report that aggregates metrics for a specific account (specified by accountID).
Changed in: Version 5.2.0
Capability required: Reporting
License command group: BasicReports
Supported accounts: Web, Mobile
Parameters
| Parameter | Data Type | Description |
|---|---|---|
| accountID | string | The account ID. |
| reportRequest | BasicReportRequest | The report request object. |
Response
long - The report ID.
addReportRequestWithAccountAggregation
Request a report that aggregates metrics for all of the accounts that you have access to in the master account.
Changed in: Version 5.2.0
Capability required: Reporting
License command group: BasicReports
Supported accounts: Web, Mobile
Parameters
| Parameter | Data Type | Description |
|---|---|---|
| reportRequest | BasicReportRequest | The report request object. |
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
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.
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, return only those reports with a status of COMPLETE. |
Response
ReportInfo[] - A list of all requested reports that you have access to in the master account.
getReportOutputUrl
Return a URL that you can use to retrieve the report (specified by reportID) using the HTTP GET method. For security reasons, the URL is available for 5 minutes only.
If the report is not ready, the return string will contain the status of the report rather than the URL.
Capability required: Reporting
License command group: BasicReports
Supported accounts: Web, Mobile
Parameters
| Parameter | Data Type | Description |
|---|---|---|
| reportID | long | The report ID. |
| fileFormat | FileOutputFormat | The output file format for the report. |
Response
string - A URL you can use to retrieve the report using the HTTP GET method.
getReportOutputUrls
Return a list of URLs that you can use to retrieve the reports (specified by the list of reportsIDs) using the HTTP GET method. For security reasons, the URLs are available for 5 minutes.
If a report is not ready, the return string will contain the status of the report rather than the URL.
Capability required: Reporting
License command group: BasicReports
Supported accounts: Web, Mobile
Parameters
| Parameter | Data Type | Description |
|---|---|---|
| reportIDs | long[] | A list of report IDs. |
| fileFormat | FileOutputFormat | The output file format for the reports. |
Response
string[] - A list of URLs you can use to retrieve the reports using the HTTP GET method.
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 and includeConversions elements 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 for the date range specified in the request.
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.