Method: exchanges.generateReport

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

Report type.

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

Report DimensionId enum.

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.