Contents

BrandsReportingRequest

Request body for brands reporting queries.

Declaration

object BrandsReportingRequest

Properties

NameTypeDescription
paginationRequestPagination

Pagination settings for the report results. See RequestPagination for details.

sorting[Sorting]

Sort entities in ascending or descending order. The default behavior is to sort by ID, ascending. See Sorting for details.

filters[Filter]

Filter field conditions for the report. See Filter for details.

fields[string]

A list of field names to return in the response. If omitted, all fields are returned.

groupBy[string]

Groups responses by selected dimensions. Supported values for brands campaign, ad group, and ad entities: deviceClass, locationId, supplyPlacement. Note: KEYWORD and SEARCHTERM entities exclude both supplyPlacement and locationId.

timeRangeTimeRange

The date range, timezone, and granularity for report data. Defines the start and end dates for the reporting period. See TimeRange for details.

optionsBrandsOptions

Options to include additional rows in the report. Note: EMPTY_METRICS is not supported for any brands entity. See BrandsOptions for details.

Discussion

The BrandsReportingRequest object is the request body for all brands entity-level report endpoints.

Example

{
  "pagination": {
    "offset": 0,
    "pageSize": 100
  },
  "sorting": [
    {
      "field": "impressions",
      "order": "DESC"
    }
  ],
  "filters": [
    {
      "field": "campaignId",
      "operator": "EQUALS",
      "value": "555666777"
    }
  ],
  "fields": [
    "campaignId",
    "impressions",
    "taps",
    "installs",
    "localSpend"
  ],
  "groupBy": [
    "deviceClass"
  ],
  "timeRange": {
    "start": "2025-01-01",
    "end": "2025-01-10",
    "timeZone": "ORTZ",
    "granularity": "DAILY"
  },
  "options": {
    "includeRows": [
      "GRAND_TOTAL"
    ]
  }
}

See Also