Contents

CampaignResponse

The response object for a Campaign operation.

Declaration

object CampaignResponse

Properties

NameTypeDescription
resultCampaign

The affected Campaign in its post-operation state. Absent on failure. See Campaign. Read-only.

errorError

Error details when the request fails. Absent on success. See Error. Read-only.

Discussion

Create, get, and update campaign operations return CampaignResponse as the single-item response envelope. On success, result contains the Campaign object reflecting its current or post-operation state. On failure, result is absent and error contains structured details about what went wrong.

Delete operations (DELETE /v1/campaigns/{id} (Delete a Campaign)) don’t return a CampaignResponse. They return a generic Response object with a null result on success.

To handle failures gracefully, check the error field before accessing result.

Example

The following example shows the response for a Get a Campaign request.

{
  "result": {
    "id": 123456789,
    "adAccountId": 555666777,
    "name": "AwayFinder Fall Launch",
    "billingEvent": "TAPS",
    "paymentModel": "LOC",
    "startTime": "2025-01-10T08:00:00.000",
    "endTime": "2025-12-31T00:00:00.000",
    "promotedObjectType": "APPSTORE_APP",
    "promotedObjectId": "987654321",
    "status": "ENABLED",
    "systemStatus": "RUNNING",
    "systemStatusReasons": [],
    "systemStatusLimitingReasons": [],
    "displayStatus": "RUNNING",
    "dailyBudget": {
      "value": {
        "amount": "100.00",
        "currency": "USD"
      }
    },
    "sharedBudgets": [
      {
        "budgetId": 246813579
      }
    ],
    "targeting": {
      "supplySource": {
        "include": [
          "APPSTORE"
        ]
      },
      "supplyPlacement": {
        "include": [
          "APPSTORE_SEARCH_RESULTS"
        ]
      },
      "countryOrRegion": {
        "include": [
          "US",
          "CA"
        ]
      }
    },
    "bidStrategy": {
      "bidStrategyType": "MANUAL_CPT",
      "bidStrategyGoal": "TAP",
      "bid": {
        "amount": "2.50",
        "currency": "USD"
      }
    },
    "invoiceDetail": {
      "name": "AwayFinder Q3 Invoice",
      "orderNumber": "PO-2025-0456",
      "clientName": "AwayFinder Inc.",
      "primaryBuyerName": "Jordan Lee",
      "primaryBuyerEmail": "jordan.lee@awayfinder.com",
      "billingEmail": "billing@awayfinder.com"
    },
    "regulationResponses": [
      {
        "regulationType": "CAMPAIGN_SAPIN_LAW",
        "responseValue": "NOT_ANSWERED"
      }
    ],
    "creationTime": "2025-01-10T08:00:00.000",
    "modificationTime": "2025-01-10T08:00:00.000",
    "deleted": false
  }
}

See Also