Generate an AdSense report based on the saved report ID sent in the query parameters. Try it now.
Request
HTTP request
GET https://www.googleapis.com/adsense/v1.4/accounts/accountId/reports/savedReportId
Parameters
Parameter name | Value | Description |
---|---|---|
Path parameters | ||
accountId |
string |
Account to which the saved reports belong. |
savedReportId |
string |
The saved report to retrieve. |
Optional query parameters | ||
locale |
string |
Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified. |
maxResults |
integer |
The maximum number of rows of report data to return. If startIndex is either unset or zero, the API will return as many rows as specified by the value of maxResults. If maxResults is not set the API will return as many rows as possible, up to 50,000. If startIndex is set to a non-zero value, the sum of startIndex and maxResults cannot be greater than 5000, or an error will be returned: paging past row 5000 is unsupported.
Acceptable values are 0 to 50000 , inclusive.
|
startIndex |
integer |
Index of the first row of report data to return. If startIndex is either unset or zero, the API will return as many rows as specified by the value of maxResults. If maxResults is not set the API will return as many rows as possible, up to 50,000. If startIndex is set to a non-zero value, the sum of startIndex and maxResults cannot be greater than 5000, or an error will be returned: paging past row 5000 is unsupported.
Acceptable values are 0 to 5000 , inclusive.
|
Authorization
This request requires authorization with at least one of the following scopes:
Scope |
---|
https://www.googleapis.com/auth/adsense |
https://www.googleapis.com/auth/adsense.readonly |
For more information, see the authentication and authorization page.
Request body
Do not supply a request body with this method.
Response
If successful, this method returns a response body with the following structure:
JSON
{ "kind": "adsense#report", "totalMatchedRows": long, "headers": [ { "name": string, "type": string, "currency": string } ], "rows": [ [ string ] ], "totals": [ string ], "averages": [ string ], "warnings": [ string ], "startDate": string, "endDate": string }
Property name | Value | Description | Notes |
---|---|---|---|
kind |
string |
Kind this is, in this case adsense#report. | |
totalMatchedRows |
long |
The total number of rows matched by the report request. Fewer rows may be returned in the response due to being limited by the row count requested or the report row limit. | |
headers[] |
list |
The header information of the columns requested in the report. This is a list of headers; one for each dimension in the request, followed by one for each metric in the request. | |
headers[].name |
string |
The name of the header. | |
headers[].type |
string |
The type of the header; one of DIMENSION, METRIC_TALLY, METRIC_RATIO, or METRIC_CURRENCY.
Acceptable values are:
|
|
headers[].currency |
string |
The currency of this column. Only present if the header type is METRIC_CURRENCY. | |
rows[] |
list |
The output rows of the report. Each row is a list of cells; one for each dimension in the request, followed by one for each metric in the request. The dimension cells contain strings, and the metric cells contain numbers. | |
totals[] |
list |
The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty. | |
averages[] |
list |
The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty. | |
warnings[] |
list |
Any warnings associated with generation of the report. | |
startDate |
string |
The requested start date in yyyy-mm-dd format. | |
endDate |
string |
The requested end date in yyyy-mm-dd format. |
CSV
"(dynamic)" (foreach) string (/foreach)
Property name | Value | Description | Notes |
---|---|---|---|
(dynamic) |
string |
Try it!
Use the APIs Explorer below to call this method on live data and see the response.