CampaignUpdate

The request body for updating an existing Campaign object.

Declaration

object CampaignUpdate

Properties

Name	Type	Description
`name`	string	The advertiser-given name of this campaign. Maximum 200 characters. Must be non-empty. Mutable.
`startTime`	date-time	The scheduled start date and time of the campaign. Format: `yyyy-MM-dd'T'HH:mm:ss.SSS` in UTC (for example, `2026-06-07T00:00:00.000`). Mutable.
`endTime`	date-time	The scheduled end date and time. Format: `yyyy-MM-dd'T'HH:mm:ss.SSS` in UTC (for example, `2026-12-31T00:00:00.000`). Omit to keep the campaign running indefinitely. Mutable.
`status`	`CampaignUpdate.Status`	Advertiser-configurable serving status. Use to pause or resume the campaign. See CampaignStatus. Mutable.
`dailyBudget`	`CampaignUpdate.DailyBudget`	The daily spend cap for this campaign. See DailyBudgetUpdate. Mutable.
`sharedBudgets`	[`SharedBudgetAssignmentUpdate`]	One or more budget order assignments for this campaign. See SharedBudgetAssignmentUpdate. Mutable.
`targeting`	`CampaignUpdate.Targeting`	Country or region, supply source, and placement targeting for this campaign. Mutable.
`bidStrategy`	`CampaignUpdate.BidStrategy`	The bid strategy governing how this campaign competes in auctions. `bidStrategyType` and `bidStrategyGoal` must be sent together and matched per the pairings in BidStrategy. See BidStrategyUpdate. Mutable.
`invoiceDetail`	`CampaignUpdate.InvoiceDetail`	Invoice and billing contact details for Line of Credit accounts. Mutable.
`regulationResponses`	[`RegulationResponseUpdate`]	Regulatory consent acknowledgments required in certain markets. See RegulationResponseUpdate. Mutable.

Discussion

The CampaignUpdate object is the request payload for modifying an existing campaign. Only the fields listed here can be changed after creation. Immutable fields such as billingEvent, promotedObjectType, and promotedObjectId aren’t present. Include only the fields you want to modify.

Both dailyBudget and sharedBudgets can be present on a campaign and function independently: dailyBudget caps daily spending. Each shared budget enforces a flight-period cap defined by its startTime and endTime.

To pause (PAUSED) or resume (ENABLED) delivery without deleting the campaign, use status.

Example

{
  "name": "AwayFinder Apple Maps Campaign",
  "startTime": "2025-09-01T00:00:00.000",
  "endTime": "2025-12-31T23:59:59.000",
  "status": "ENABLED",
  "dailyBudget": {
    "value": {
      "amount": "1200.00",
      "currency": "USD"
    }
  },
  "sharedBudgets": [
    {
      "budgetId": 555666777
    }
  ],
  "targeting": {
    "supplySource": {
      "include": [
        "MAPS"
      ]
    },
    "supplyPlacement": {
      "include": [
        "MAPS_SEARCH_RESULTS"
      ]
    },
    "countryOrRegion": {
      "include": [
        "US"
      ]
    }
  },
  "bidStrategy": {
    "bidStrategyType": "MANUAL_CPT",
    "bidStrategyGoal": "TAP",
    "bid": {
      "amount": "2.50",
      "currency": "USD"
    }
  },
  "invoiceDetail": {
    "name": "AwayFinder Q3 Invoice",
    "orderNumber": "PO-555666777",
    "clientName": "AwayFinder",
    "primaryBuyerName": "Jordan Lee",
    "primaryBuyerEmail": "jordan.lee@awayfinder.com",
    "billingEmail": "billing@awayfinder.com"
  },
  "regulationResponses": [
    {
      "regulationType": "CAMPAIGN_SAPIN_LAW",
      "responseValue": "NOT_ANSWERED"
    }
  ]
}

Topics

Dictionaries

Type Aliases

CampaignUpdate.Status