Contents

CampaignCreate

The request body for creating a new campaign.

Declaration

object CampaignCreate

Properties

NameTypeDescription
name Requiredstring

The advertiser-given name of this campaign. Maximum 200 characters. Must be non-empty. Mutable.

startTimedate-time

The scheduled start date and time of this campaign. Format: yyyy-MM-dd'T'HH:mm:ss.SSS in UTC (for example, 2025-09-01T00:00:00.000). If omitted, the campaign starts immediately upon activation. Mutable.

endTimedate-time

The scheduled end date and time. Format: yyyy-MM-dd'T'HH:mm:ss.SSS in UTC (for example, 2025-12-31T23:59:59.000). Omit to keep the campaign running indefinitely. Mutable.

dailyBudget RequiredCampaignCreate.DailyBudget

The daily spend cap for this campaign. See DailyBudgetCreate. Mutable.

sharedBudgets[SharedBudgetAssignmentCreate]

One or more budget order assignments for this campaign. Can be provided alongside dailyBudget. See SharedBudgetAssignmentCreate.

targeting RequiredCampaignCreate.Targeting

Country or region, supply source, and placement targeting for this campaign. See CampaignTargetingCreate. Mutable.

bidStrategyCampaignCreate.BidStrategy

Bid strategy governing how this campaign competes in auctions. bidStrategyType and bidStrategyGoal must both be supplied and must match one of the pairings in BidStrategy. Omitting either field, or pairing a mismatched goal, returns an error. See BidStrategyCreate. Mutable.

invoiceDetailCampaignCreate.InvoiceDetail

Invoice and billing contact details. Required for Line of Credit accounts. See InvoiceDetailCreate.

regulationResponses[RegulationResponseCreate]

Regulatory consent acknowledgments required in certain markets. See RegulationResponseCreate.

adAccountId Requiredint64

The ad account this campaign belongs to. Immutable after creation.

billingEvent RequiredCampaignCreate.BillingEvent

The billing event for this campaign. See BillingEvent. Immutable after creation.

promotedObjectId Requiredstring

The identifier for the promoted object (for example, an app Adam ID). Immutable after creation.

promotedObjectType RequiredCampaignCreate.PromotedObjectType

The type of the promoted object. See PromotedObjectType. Immutable after creation.

statusCampaignCreate.Status

Advertiser-configurable serving status, ENABLED or PAUSED. Specify it explicitly if a specific initial status is required. See CampaignStatus.

Discussion

Creating a campaign ties together what’s being promoted, a budget, targeting, and a bid strategy in a single request.

Example

{
  "name": "AwayFinder App Campaign",
  "startTime": "2025-09-01T00:00:00.000",
  "endTime": "2025-12-31T23:59:59.000",
  "dailyBudget": {
    "value": {
      "amount": "100.00",
      "currency": "USD"
    }
  },
  "sharedBudgets": [
    {
      "budgetId": 555666777
    }
  ],
  "targeting": {
    "countryOrRegion": {
      "include": [
        "US"
      ]
    },
    "supplyPlacement": {
      "include": [
        "APPSTORE_SEARCH_RESULTS"
      ]
    }
  },
  "bidStrategy": {
    "bidStrategyType": "MANUAL_CPT",
    "bidStrategyGoal": "TAP"
  },
  "invoiceDetail": {
    "name": "AwayFinder Inc.",
    "orderNumber": "PO-100234",
    "clientName": "AwayFinder Inc.",
    "primaryBuyerName": "Jordan Lee",
    "primaryBuyerEmail": "jordan.lee@awayfinder.com",
    "billingEmail": "billing@awayfinder.com"
  },
  "regulationResponses": [
    {
      "regulationType": "CAMPAIGN_SAPIN_LAW",
      "responseValue": "NOT_AGENT"
    }
  ],
  "adAccountId": 123456789,
  "billingEvent": "TAPS",
  "promotedObjectId": "987654321",
  "promotedObjectType": "APPSTORE_APP",
  "status": "ENABLED"
}

Topics

Dictionaries

Type Aliases

See Also