Campaigns Metadata

The type of billing event for a campaign. See BillingEventType for value descriptions. Possible Values: IMPRESSIONS, TAPS.

The campaign’s status. You can use EQUALS and IN with Find Campaigns. Possible Values: RUNNING, NOT_RUNNING.

The ad placements for a campaign. You can use EQUALS, CONTAINS_ANY, and CONTAINS_ALL with Find Campaigns. Possible Values: APPSTORE_PRODUCT_PAGES_BROWSE, APPSTORE_SEARCH_RESULTS, APPSTORE_SEARCH_TAB, APPSTORE_TODAY_TAB.

The user-controlled status to enable or pause the campaign. You can use EQUALS and IN with Find Campaigns. Default: ENABLED. Possible Values: ENABLED, PAUSED. This field is updatable.

The channel type of an ad in a campaign. You can use the EQUALS Selector Condition operator with Find Campaigns and Get Campaign-Level Reports. Possible Values: SEARCH, DISPLAY.

The status of the campaign, resolved by servingStatus and additional criteria. Possible Values: DELETED, ON_HOLD, PAUSED, RUNNING.

The scheduled start date and time (UTC). Must be greater than current time and before endTime if set. Defaults to the request timestamp if not set. Updatable until the designated time is reached. You can use EQUALS, LESS_THAN, and GREATER_THAN with Find Campaigns. This field is updatable.

A list of reasons why a campaign can’t run. See CampaignServingStateReasons for value descriptions.

The payment model set through the Search Ads UI. If not set, campaigns can’t run. See PaymentModel for value descriptions. Possible Values: LOC, PAYG. You can use EQUALS and IN with Find Campaigns.

The identifier of the organization that owns the campaign (the same as your account in the Search Ads UI).

The campaign name (unique within an organization). Maximum length: 200. You can use EQUALS, IN, and STARTSWITH with Find Campaigns. This field is updatable.

The date and time of the most recent modification. You can use EQUALS, LESS_THAN, and GREATER_THAN with Find Campaigns.

The standard invoice details you set and edit with the LOCInvoiceDetails object. This field is updatable.

A unique campaign identifier. You can use EQUALS and IN with Find Campaigns.

The scheduled end date and time for the campaign, in UTC. Must be after startTime. Updatable until the designated time is reached. You can use EQUALS, LESS_THAN, and GREATER_THAN with Find Campaigns.

Indicates if the campaign is soft-deleted. Default is false. You can use EQUALS and IN with Find Campaigns.

Your daily budget. Must be less than budgetAmount, and greater than or equal to AdGroup’s defaultBidAmount. You can use EQUALS, LESS_THAN, and GREATER_THAN with Find Campaigns. This field is updatable.

Your daily budget's currency.

The date and time when you created the campaign.

The map of reasons returned when a campaign isn’t running. See CampaignCountryOrRegionsServingStateReasons for descriptions.

The App Store geoterritories (ISO 3166-1 alpha-2 country codes) where you’re promoting your app. Default is US. You can use EQUALS, CONTAINS_ANY, and CONTAINS_ALL Selector Condition operators with Find Campaigns. This field is updatable.

The lifetime budget amount available to a campaign. Must exceed the lifetime spend of the campaign. You can use EQUALS, LESS_THAN, and GREATER_THAN Selector Condition operators with Find Campaigns. This field is updatable.

The budget orders you assign to a campaign (line-of-credit payment model only). This field is updatable.

Your unique App Store app identifier. Obtain it 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.