Contents

AdQueryResponse

The response object for an Ad query, containing matched results and pagination metadata.

Declaration

object AdQueryResponse

Properties

NameTypeDescription
result[Ad]

Array of Ad. Read-only.

paginationQueryPaginationResult

Pagination metadata for the response, including offset, pageSize, and totalCount. See QueryPaginationResult. Read-only.

errorError

Error information if the request encountered an error. See Error. Read-only.

Discussion

The ads query endpoint returns AdQueryResponse, which contains the filtered, sorted, and paginated set of Ad objects matching the request.

To scope results by adGroupId, campaignId, status, or other filterable fields, use the QueryRequest body with filters.

Example

{
  "result": [
    {
      "id": 777888999,
      "adAccountId": 123456789,
      "campaignId": 444555666,
      "adGroupId": 555666777,
      "creativeId": 666777888,
      "name": "AwayFinder - Default Product Page",
      "status": "ENABLED",
      "systemStatus": "RUNNING",
      "systemStatusReasons": [],
      "systemStatusLimitingReasons": [],
      "deleted": false,
      "creationTime": "2025-09-01T08:00:00.000",
      "modificationTime": "2025-09-01T08:00:00.000"
    }
  ],
  "pagination": {
    "offset": 0,
    "pageSize": 20,
    "totalCount": 1
  }
}

See Also