Contents

CampaignQueryResponse

The response object for a Campaign query, containing matched results and pagination metadata.

Declaration

object CampaignQueryResponse

Properties

NameTypeDescription
result[Campaign]

The list of campaigns matching the query filters. See Campaign. 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 campaign query endpoint returns CampaignQueryResponse, which contains the filtered, sorted, and paginated set of Campaign objects matching the request. Pagination metadata in the envelope supports offset-based navigation through large result sets.

Example

{
  "result": [
    {
      "id": 111222333,
      "name": "AwayFinder Apple Maps Campaign",
      "adAccountId": 123456789,
      "promotedObjectType": "BUSINESS_BRAND",
      "promotedObjectId": "987654321",
      "status": "ENABLED",
      "billingEvent": "TAPS",
      "startTime": "2025-09-01T00:00:00.000",
      "endTime": "2025-12-31T23:59:59.000",
      "dailyBudget": {
        "value": {
          "amount": "900.00",
          "currency": "USD"
        }
      },
      "targeting": {
        "supplySource": {
          "include": [
            "MAPS"
          ]
        },
        "supplyPlacement": {
          "include": [
            "MAPS_SEARCH_RESULTS"
          ]
        }
      },
      "bidStrategy": {
        "bidStrategyType": "MAX_ENGAGEMENTS",
        "bidStrategyGoal": "TAP"
      },
      "creationTime": "2025-01-15T10:30:00.000",
      "modificationTime": "2025-01-20T14:45:00.000",
      "paymentModel": "PAYG",
      "systemStatus": "RUNNING",
      "systemStatusReasons": [],
      "systemStatusLimitingReasons": [],
      "displayStatus": "RUNNING",
      "deleted": false
    }
  ],
  "pagination": {
    "offset": 0,
    "pageSize": 20,
    "totalCount": 1
  }
}

See Also