ReportResult
Stay organized with collections
Save and categorize content based on your preferences.
Result of a generated report.
| JSON representation |
{
"totalMatchedRows": string,
"headers": [
{
object (Header)
}
],
"rows": [
{
object (Row)
}
],
"totals": {
object (Row)
},
"averages": {
object (Row)
},
"warnings": [
string
],
"startDate": {
object (Date)
},
"endDate": {
object (Date)
}
} |
| Fields |
totalMatchedRows |
string (int64 format)
The total number of rows matched by the report request.
|
rows[] |
object (Row)
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.
|
totals |
object (Row)
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 |
object (Row)
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[] |
string
Any warnings associated with generation of the report. These warnings are always returned in English.
|
startDate |
object (Date)
Required. Start date of the range (inclusive).
|
endDate |
object (Date)
Required. End date of the range (inclusive).
|
Row
| JSON representation |
{
"cells": [
{
object (Cell)
}
]
} |
| Fields |
cells[] |
object (Cell)
Cells in the row.
|
Cell
| JSON representation |
{
"value": string
} |
| Fields |
value |
string
Value in the cell. The dimension cells contain strings, and the metric cells contain numbers.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-02-28 UTC.
[null,null,["Last updated 2025-02-28 UTC."],[[["\u003cp\u003eReportResult objects contain the results of a generated report, including total rows, headers, rows, totals, averages, warnings, and start and end dates.\u003c/p\u003e\n"],["\u003cp\u003eHeaders define the columns of the report, specifying the name, type (dimension, metric), and currency if applicable.\u003c/p\u003e\n"],["\u003cp\u003eRows contain cells with values for each dimension and metric in the report.\u003c/p\u003e\n"],["\u003cp\u003eCells hold the actual data, with strings for dimensions and numbers for metrics.\u003c/p\u003e\n"],["\u003cp\u003eReports use HeaderType to distinguish dimensions, tallies, ratios, currency, milliseconds, and decimals for metrics.\u003c/p\u003e\n"]]],[],null,["# ReportResult\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n- [Header](#Header)\n - [JSON representation](#Header.SCHEMA_REPRESENTATION)\n- [HeaderType](#HeaderType)\n- [Row](#Row)\n - [JSON representation](#Row.SCHEMA_REPRESENTATION)\n- [Cell](#Cell)\n - [JSON representation](#Cell.SCHEMA_REPRESENTATION)\n\nResult of a generated report.\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"totalMatchedRows\": string, \"headers\": [ { object (/adsense/management/reference/rest/v2/ReportResult#Header) } ], \"rows\": [ { object (/adsense/management/reference/rest/v2/ReportResult#Row) } ], \"totals\": { object (/adsense/management/reference/rest/v2/ReportResult#Row) }, \"averages\": { object (/adsense/management/reference/rest/v2/ReportResult#Row) }, \"warnings\": [ string ], \"startDate\": { object (/adsense/management/reference/rest/v2/Date) }, \"endDate\": { object (/adsense/management/reference/rest/v2/Date) } } ``` |\n\n| Fields ||\n|--------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `totalMatchedRows` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` The total number of rows matched by the report request. |\n| `headers[]` | `object (`[Header](/adsense/management/reference/rest/v2/ReportResult#Header)`)` The header information; one for each dimension in the request, followed by one for each metric in the request. |\n| `rows[]` | `object (`[Row](/adsense/management/reference/rest/v2/ReportResult#Row)`)` 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. |\n| `totals` | `object (`[Row](/adsense/management/reference/rest/v2/ReportResult#Row)`)` The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty. |\n| `averages` | `object (`[Row](/adsense/management/reference/rest/v2/ReportResult#Row)`)` The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty. |\n| `warnings[]` | `string` Any warnings associated with generation of the report. These warnings are always returned in English. |\n| `startDate` | `object (`[Date](/adsense/management/reference/rest/v2/Date)`)` Required. Start date of the range (inclusive). |\n| `endDate` | `object (`[Date](/adsense/management/reference/rest/v2/Date)`)` Required. End date of the range (inclusive). |\n\nHeader\n------\n\nThe header information of the columns requested in the report.\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"type\": enum (/adsense/management/reference/rest/v2/ReportResult#HeaderType), \"currencyCode\": string } ``` |\n\n| Fields ||\n|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Required. Name of the header. |\n| `type` | `enum (`[HeaderType](/adsense/management/reference/rest/v2/ReportResult#HeaderType)`)` Required. Type of the header. |\n| `currencyCode` | `string` The [ISO-4217 currency code](https://en.wikipedia.org/wiki/ISO_4217) of this column. Only present if the header type is METRIC_CURRENCY. |\n\nHeaderType\n----------\n\nType of the header.\n\n| Enums ||\n|---------------------------|---------------------------|\n| `HEADER_TYPE_UNSPECIFIED` | Unspecified header. |\n| `DIMENSION` | Dimension header type. |\n| `METRIC_TALLY` | Tally header type. |\n| `METRIC_RATIO` | Ratio header type. |\n| `METRIC_CURRENCY` | Currency header type. |\n| `METRIC_MILLISECONDS` | Milliseconds header type. |\n| `METRIC_DECIMAL` | Decimal header type. |\n\nRow\n---\n\nRow representation.\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------|\n| ``` { \"cells\": [ { object (/adsense/management/reference/rest/v2/ReportResult#Cell) } ] } ``` |\n\n| Fields ||\n|-----------|------------------------------------------------------------------------------------------------|\n| `cells[]` | `object (`[Cell](/adsense/management/reference/rest/v2/ReportResult#Cell)`)` Cells in the row. |\n\nCell\n----\n\nCell representation.\n\n| JSON representation |\n|-----------------------------|\n| ``` { \"value\": string } ``` |\n\n| Fields ||\n|---------|--------------------------------------------------------------------------------------------------------|\n| `value` | `string` Value in the cell. The dimension cells contain strings, and the metric cells contain numbers. |"]]
