Method: exchanges.generateReport
Stay organized with collections
Save and categorize content based on your preferences.
Generates and returns the report Id. The report is not persisted. Invocations with the same request will regenerate the report.
HTTP request
POST https://dv360exchangereporting.googleapis.com/v1alpha1/{exchange=exchanges/*}:generateReport
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
exchange |
string
Required. Name of the exchange that reports that belongs to. Example: "exchanges/123" Required.
|
Request body
The request body contains data with the following structure:
| JSON representation |
{
"startDate": string,
"endDate": string,
"reportType": enum (ReportType),
"dimensionIds": [
enum (DimensionId)
]
} |
| Fields |
startDate |
string
Required. Start date of the reports in ISO_8601 format YYYY-MM-DD, inclusive. Required as input.
|
endDate |
string
Required. End date of the reports in ISO_8601 format YYYY-MM-DD, inclusive. Required as input.
|
reportType |
enum (ReportType)
Required. Report type, if not specified, will return errors.
|
dimensionIds[] |
enum (DimensionId)
Optional. List of Dimensions based on which the report will be generated. If null then only include publisher ID. If the dimensions are not supported in a specific type of report, they will be ignored.
|
Response body
If successful, the response body contains an instance of Report.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/doubleclickbidmanager
For more information, see the OAuth 2.0 Overview.
ReportType
| Enums |
REPORT_TYPE_UNSPECIFIED |
Report type unspecified, invalid input value |
HOURLY |
Report type hourly. |
DAILY |
Report type daily. |
WEEKLY |
Report type weekly. |
MONTHLY |
Report type monthly. |
DimensionId
| Enums |
DIMENSION_ID_UNSPECIFIED |
Report Dimension unspecified, invalid input value. |
PARTNER_ID |
Partner ID, only supported in Daily report. |
DEVICE_TYPE |
Device type, only supported in Daily report. |
CREATIVE_ID |
Creative ID, only supported in Daily report. Please notice that this dimension could significantly contribute to the file size of the reports. And the reports include this dimension could take hours to run. In the future we will limit the rating on these heavy loading fields. |
CREATIVE_TYPE |
Creative type, only supported in Daily report. Please notice that this dimension could significantly contribute to the file size of the reports. And the reports include this dimension could take hours to run. In the future we will limit the rating on these heavy loading fields. |
REGION_CODE |
Country/Region code, only supported in Daily report. |
DEAL_ID |
Deal ID, mapping to inventory source, only supported in Daily report. |
PUBLISHER_ID |
Publisher ID, if input dimension Id list is null, this is the default dimension. |
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 2024-09-18 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-09-18 UTC."],[[["\u003cp\u003eGenerates a non-persistent report based on specified criteria like date range, report type, and dimensions.\u003c/p\u003e\n"],["\u003cp\u003eAccepts start and end dates, report type, and optional dimension IDs in the request body.\u003c/p\u003e\n"],["\u003cp\u003eAllows filtering by dimensions such as Partner ID, Device Type, Creative ID, and more, with Publisher ID as the default if no dimensions are specified.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/doubleclickbidmanager\u003c/code\u003e scope.\u003c/p\u003e\n"],["\u003cp\u003eOffers various report types including hourly, daily, weekly, and monthly.\u003c/p\u003e\n"]]],["This service generates reports via a `POST` request to a specific URL, requiring an `exchange` path parameter. The request body must include `startDate`, `endDate`, `reportType` (e.g., hourly, daily), and optionally `dimensionIds` (e.g., partner ID, device type). The response, if successful, contains a `Report` instance. The request must use the OAuth scope `https://www.googleapis.com/auth/doubleclickbidmanager`. Reports are not persisted and regenerate upon each invocation.\n"],null,["# Method: exchanges.generateReport\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [ReportType](#ReportType)\n- [DimensionId](#DimensionId)\n\nGenerates and returns the report Id. The report is not persisted. Invocations with the same request will regenerate the report.\n\n### HTTP request\n\n`POST https://dv360exchangereporting.googleapis.com/v1alpha1/{exchange=exchanges/*}:generateReport`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|------------|----------------------------------------------------------------------------------------------------------|\n| `exchange` | `string` Required. Name of the exchange that reports that belongs to. Example: \"exchanges/123\" Required. |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"startDate\": string, \"endDate\": string, \"reportType\": enum (/display-video/exchange-reporting/reference/rest/v1alpha1/exchanges/generateReport#ReportType), \"dimensionIds\": [ enum (/display-video/exchange-reporting/reference/rest/v1alpha1/exchanges/generateReport#DimensionId) ] } ``` |\n\n| Fields ||\n|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `startDate` | `string` Required. Start date of the reports in ISO_8601 format YYYY-MM-DD, inclusive. Required as input. |\n| `endDate` | `string` Required. End date of the reports in ISO_8601 format YYYY-MM-DD, inclusive. Required as input. |\n| `reportType` | `enum (`[ReportType](/display-video/exchange-reporting/reference/rest/v1alpha1/exchanges/generateReport#ReportType)`)` Required. Report type, if not specified, will return errors. |\n| `dimensionIds[]` | `enum (`[DimensionId](/display-video/exchange-reporting/reference/rest/v1alpha1/exchanges/generateReport#DimensionId)`)` Optional. List of Dimensions based on which the report will be generated. If null then only include publisher ID. If the dimensions are not supported in a specific type of report, they will be ignored. |\n\n### Response body\n\nIf successful, the response body contains an instance of [Report](/display-video/exchange-reporting/reference/rest/v1alpha1/exchanges.reports#Report).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/doubleclickbidmanager`\n\nFor more information, see the [OAuth 2.0 Overview](https://developers.google.com/identity/protocols/OAuth2).\n\nReportType\n----------\n\nReport type.\n\n| Enums ||\n|---------------------------|----------------------------------------------|\n| `REPORT_TYPE_UNSPECIFIED` | Report type unspecified, invalid input value |\n| `HOURLY` | Report type hourly. |\n| `DAILY` | Report type daily. |\n| `WEEKLY` | Report type weekly. |\n| `MONTHLY` | Report type monthly. |\n\nDimensionId\n-----------\n\nReport DimensionId enum.\n\n| Enums ||\n|----------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `DIMENSION_ID_UNSPECIFIED` | Report Dimension unspecified, invalid input value. |\n| `PARTNER_ID` | Partner ID, only supported in Daily report. |\n| `DEVICE_TYPE` | Device type, only supported in Daily report. |\n| `CREATIVE_ID` | Creative ID, only supported in Daily report. Please notice that this dimension could significantly contribute to the file size of the reports. And the reports include this dimension could take hours to run. In the future we will limit the rating on these heavy loading fields. |\n| `CREATIVE_TYPE` | Creative type, only supported in Daily report. Please notice that this dimension could significantly contribute to the file size of the reports. And the reports include this dimension could take hours to run. In the future we will limit the rating on these heavy loading fields. |\n| `REGION_CODE` | Country/Region code, only supported in Daily report. |\n| `DEAL_ID` | Deal ID, mapping to inventory source, only supported in Daily report. |\n| `PUBLISHER_ID` | Publisher ID, if input dimension Id list is null, this is the default dimension. |"]]
