Campaign

Your unique App Store app identifier. You can obtain your app adamId through Search for iOS apps, Get a Campaign, or Get all Campaigns.

You can use the EQUALS and IN selector Condition operators with Find Campaigns.

The channel type of an ad in a campaign.

See AdChannelType for value descriptions.

You can use the EQUALS selector Condition operator with Find Campaigns and Get Campaign-Level Reports.

The type of billing event for a campaign.

See BillingEventType for value descriptions.

The bidding strategy for the campaign. Possible values include:

MANUAL_CPT (default): The manual cost-per-tap bidding. This is existing behavior in the API.

MAX_CONVERSIONS: Maximize Conversions bidding strategy with automated bid optimization.

Mutable after campaign creation. This field is updatable. To switch bidding stategies, see Update a Campaign.

The budget orders that you assign to the campaign. This applies only to campaigns with a line-of-credit payment model.

This field is updatable.

The App Store geoterritories where you’re promoting your app. The default value is US.

Use an alpha-2 country code value , such as US, for the locations where you’re promoting.

The EQUALS, CONTAINS_ANY, and CONTAINS_ALL selector Condition operators are available to use with Find Campaigns.

This field is updatable.

The map of reasons that returns when a campaign isn’t running.

See CampaignCountryOrRegionsServingStateReasons for value descriptions.

The date and time of the creation of the campaign object.

Your daily budget.

A dailyBudgetAmount is a required field for all new campaigns.

• A dailyBudgetAmount can be changed but not removed from the payload when updating an existing campaign.

• Your dailyBudgetAmount must be greater than or equal to the defaultBidAmount in your AdGroup.

You can use the EQUALS, LESS_THAN, and GREATER_THAN selector Condition operators with Find Campaigns.

This field is updatable.

The indicator of whether the campaign is soft-deleted.

You can use the EQUALS and IN selector Condition operators with Find Campaigns.

The status of the campaign. The status resolves according to servingStatus and additional criteria.

The scheduled end time and date for the campaign.

• The endTime must be after the startTime.

• The endTime is updatable until you reach the designated time.

• The endTime must be in UTC.

You can use the EQUALS, LESS_THAN, and GREATER_THAN selector Condition operators with Find Campaigns.

A unique identifier for the campaign that you can use as a campaignid in endpoint resources.

You can use the EQUALS and IN selector Condition operators with Find Campaigns.

The standard invoice details that you can set and edit using the LOCInvoiceDetails object.

This field is updatable.

The date and time of the most recent modification of the object.

You can use the EQUALS, LESS_THAN, and GREATER_THAN selector Condition operators with Find Campaigns.

The name of the campaign, which is unique within an organization.

You can use the EQUALS, IN, and STARTSWITH selector Condition operators with Find Campaigns.

This field is updatable.

The identifier of the organization that owns the campaign. Your orgId is the same as your account in Apple Ads.

The payment model that you set through Apple Ads. If you don’t set a payment model, campaigns can’t run.

See PaymentModel for value descriptions.

If you don’t select a payment model, you can still create campaigns. You must select a payment model before a campaign is eligible to run.

See BudgetOrder for details about setting a payment model.

You can use the EQUALS and IN selector Condition operators with Find Campaigns.

A list of reasons that displays when a campaign can’t run.

See CampaignServingStateReasons for value descriptions.

The status of the campaign.

You can use the EQUALS and IN selector Condition operators with Find Campaigns.

The scheduled start time and date for the campaign.

• The startTime must be greater than the current time, and before the campaign endTime, if you set it.

• If you don’t set a startTime, the campaign defaults to the campaign request timestamp and the startTime is updatable until you reach the designated time.

• The startTime must be in UTC.

You can use the EQUALS, LESS_THAN, and GREATER_THAN selector Condition operators with Find Campaigns.

This field is updatable.

The user-controlled status to enable or pause the campaign.

You can use the EQUALS and IN selector Condition operators with Find Campaigns.

This field is updatable.

The ad placements for a campaign.

See SupplySource for full descriptions of values.

You can use the EQUALS , CONTAINS_ANY, CONTAINS_ALL selector Condition operators with Find Campaigns.

The target cost-per-acquisition for MAX_CONVERSIONS campaigns. This field is required if the biddingStrategy is MAX_CONVERSIONS. The Target CPA is the average amount you want to spend per tap-through install. This amount is used to calculate optimal bids for each search query, with the goal of maximizing the number of installs near your target CPA.

Returned as null for MANUAL_CPT campaigns.

Mutable after campaign creation.