Contents

QueryRequest

The standard request body used across all query endpoints, supporting filters, sorting, pagination, and field selection.

Declaration

object QueryRequest

Properties

NameTypeDescription
filters[QueryFilter]

Filter field conditions. If no filters are in the request, all non-deleted entities within the current ad account scope are returned. Deleted entities aren’t returned unless specified to be included. See QueryFilter.

sorting[QuerySort]

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

paginationQueryPagination

Controls pagination settings for results using offset and size. See QueryPagination.

Discussion

The QueryRequest object is the standard request body used across all query endpoints in the Apple Ads Platform API.

To filter on fields marked Filterable in each entity’s dictionary keys, use QueryFilter entries. The query combines multiple filters with logical AND.

Example

{
  "filters": [
    {
      "field": "name",
      "operator": "CONTAINS_ANY",
      "value": ["AwayFinder", "AwayFinder Promo"],
      "ignoreCase": true
    }
  ],
  "sorting": [
    {
      "field": "id",
      "order": "DESC"
    }
  ],
  "pagination": {
    "pageSize": 25,
    "offset": 0,
    "fetchTotalCount": true
  }
}

See Also

Query Objects