Contents

AppsReportingRequest

Request body for apps reporting queries.

Declaration

object AppsReportingRequest

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. campaignId is a required filter for every apps report request. See Filter for details.

fields[string]

A list of field names to return in the response. If you omit this field, the response includes all fields.

groupBy[string]

Groups responses by selected dimensions. Supported values for apps: deviceClass, ageRange, gender, countryCode, adminArea, locality, storefront, countryOrRegion. Note: KEYWORD and SEARCHTERM entities exclude ageRange, gender, countryCode, adminArea, locality. The AD entity also excludes deviceClass, ageRange, gender, countryCode, adminArea, locality, supporting only storefront and countryOrRegion.

timeRangeTimeRange

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

optionsAppsOptions

Options to include additional rows in the report (for example, GRAND_TOTAL, EMPTY_METRICS). You can’t combine EMPTY_METRICS with groupBy. See AppsOptions for details.

Discussion

The AppsReportingRequest object is the request body for all apps entity-level report endpoints (campaign, ad group, ad, keyword, search term).

Example

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

See Also