Fields listing for Apple Search Ads

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

The unique identifier for a creative.

The type of creative. You can create one creative per custom product page per organization.

Indicates whether an ad is deleted.

The parameter for enabling and disabling Search Match. If true, the system automatically adds optimized keywords in addition to those you explicitly add to the ad group.

The cost-per-acquisition goal. The maximum amount you are willing to pay for a conversion.

The cost-per-acquisition goal. the currency of the maximum amount you are willing to pay for a conversion.

The default maximum cost-per-tap or cost-per-impression bid for the ad group.

The default maximum cost-per-tap or cost-per-impression bid currency for the ad group.

The indicator of whether the ad group is soft-deleted. This includes keywords that belong to an ad group.

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

The scheduled end time and date for the ad group, which the system determines from the ad group with the latest end time. The endTime must be after the startTime. The endTime is updatable until you reach the designated time. The endTime must be in UTC.

The unique identifier for the ad group that you can use as adGroupId in endpoint resources.

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

The unique name of the ad group. Responses don’t include deleted ad groups.

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

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

The type of pricing model for a bid. See PricingModel for value descriptions. Possible Values: CPC, CPM

A list of reasons that displays when an ad group isn’t running. Possible Values: ADGROUP_END_DATE_REACHED, AD_GROUP_PAUSED_BY_USER, APP_NOT_SUPPORT, AUDIENCE_BELOW_THRESHOLD, CAMPAIGN_END_DATE_REACHED, CAMPAIGN_NOT_RUNNING, CAMPAIGN_START_DATE_IN_FUTURE, DELETED_BY_USER, NO_AVAILABLE_ADS, PENDING_AUDIENCE_VERIFICATION, START_DATE_IN_THE_FUTURE, TARGETED_DEVICE_CLASS_NOT_SUPPORTED_SUPPLY_SOURCE

The status of whether the ad group is serving. Default: RUNNING Possible Values: NOT_RUNNING, RUNNING

The scheduled start date and time for the ad group with the earliest start time in 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.

The user-controlled status to enable or pause the ad group. This field is updatable. Default: ENABLED Possible Values: ENABLED, PAUSED

An adId is a unique identifier that represents the assignment relationship between an adgroup and an ad.

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

The unique name of the ad assigned to an adgroup.

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

A list of reasons that displays when an ad isn’t running. For example, if the DeviceClass changes, the servingStateReasons may change.

The indicator of the status of an ad assignment with an ad group.

The status of the ad.

The adminArea dimension is a group of states or the equivalent according to its associated country.

The ageRange dimension is a group of the user demographic age ranges.

The average cost-per-acquisition (CPA) is the total spend divided by the number of installs within the same time period.

The average cost-per-acquisition (CPA) is the total spend divided by the number of installs within the same time period.

The total campaign spend divided by the total number of installs within the reporting period.

The total campaign spend divided by the total number of installs within the reporting period.

The average cost-per-tap (CPT) is the ratio of spend over taps.

The average cost-per-tap (CPT) is the ratio of spend over taps.

The average CPM is the average amount you pay per one thousand ad impressions.

The average CPM is the average amount you pay per one thousand ad impressions.

The channel type of an ad in a 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.

The type of billing event for a campaign.

The lifetime budget amount available to a campaign.

The lifetime budget currency available to a campaign.

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

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 map of reasons that returns when a campaign isn’t running.

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

Your daily budget amount.

Your daily budget currency.

The indicator of whether the campaign is soft-deleted.

The status of the campaign. The status resolves according to servingStatus and additional criteria. Possible Values: DELETED, ON_HOLD, PAUSED, RUNNING

The scheduled end time and date for the campaign.

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

A valid email address for the LOC billing contact.

A valid email address for the LOC buyer.

A valid LOC buyer name.

An advertiser or product. Required for agency-type accounts.

A purchase order number. Required for agency-type accounts.

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

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

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

The payment model that you set through the Search Ads UI.

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

The status of the campaign.

The scheduled start time and date for the campaign.

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

The ad placements for a campaign.

The total number of conversions divided by the total number of taps within the same time period.

The countryCode dimension is a group of country codes that indicate the country or region to serve ads in.

The countryOrRegion dimension is a group of countries and regions.

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

The creativeId is a unique identifier for a creative.

The ISO 639-1 language code appended to the ISO alpha-2 country code, such as en-US.

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

The name of a creative.

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

The system state of the custom product page that indicates whether the page is visible.

The detailed explanation of the system state.

The type of creative.

Year, month, and day.

Day of the year

Week of the year

The deviceClass dimension is a group of device classes that the promoted app supports.

The gender dimension is a group of user-demographic genders.

If impression share is 91–100%, lowImpressionShare is 0.91 and highImpressionShare is 1.

Hour of the day

The number of times your ad appears in App Store search results within the reporting period.

The total number of newDownloads or redownloads resulting from an ad within the reporting period. The API attributes Apple Search Ads installs within a 30‑day tap-through window.

The maximum cost-per-tap/impression bid amount. This is the offer price for a keyword in a bidding auction. If the bidAmount field is null, the bidAmount uses the defaultBidAmount of the corresponding ad group.

The maximum cost-per-tap/impression bid currency. This is the offer price for a keyword in a bidding auction. If the bidAmount field is null, the bidAmount uses the defaultBidAmount of the corresponding ad group.

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

An indicator of whether the keyword is soft-deleted.

A unique identifier for the targeting keyword in the payload to update keyword bids or statuses. This keywordId is specific to a particular ad group and match type that you use to update bid amounts.

An automated keyword and bidding strategy. Match type can be either Broad or Exact.

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

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

The word or phrase to match in App Store user searches to show your ad.

The installs from users who don’t have Limit Ad Tracking (LAT) in an enabled state on their devices. latOnInstalls int64

The installs from users who have Limit Ad Tracking (LAT) in an enabled state on their devices.

The total spend amount of a campaign in the currency the organization uses.

The total spend currency of a campaign in the currency the organization uses.

The locality dimension is the city or group of cities equivalent according to its associated adminArea.

If impression share is 11–20%, lowImpressionShare is 0.11 and highImpressionShare is 0.2.

Month and day

Month of the year

An indicator of whether the keyword is soft-deleted.

A unique identifier for the negative keyword.

An automated keyword and bidding strategy. Match type can be either Broad or Exact.

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

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

The word or phrase to match in App Store user searches to show your ad.

The enumerated app downloads from new users without previous installs of your app.

Quarter of the year

The ranking of your app in terms of impression share compared to other apps in the same countries or regions. The rank displays from ONE to FIVE or GREATER_THAN_FIVE, with ONE being the highest rank.

The enumerated reinstalls of your app from users with previous installs.

The total search volume of keyword popularity. The popularity of search terms is based on country or region. The ranking is 1–5, with 5 as the most search volume.

The search terms id, composed by campaignId-adGroupId-keywordId-searchTermText.

An automated keyword and bidding strategy. Match type can be either Broad or Exact.

The search terms to use for app searches.

The tap-through rate (TTR) is the number of times users tap your ad divided by the total impressions your ad receives.

The number of times users tap your ad within the reporting period.

The total number of tap-through and view-through new downloads and redownloads within the reporting period.

The total number of installs divided by the total number of taps within the reporting period.

The total number of tap-through and view-through new downloads within the reporting period.

The total number of tap-through and view-through redownloads within the reporting period.

The total number of new downloads and redownloads from people who viewed your ad, but didn’t tap it, within a 1-day attribution window.

New downloads from people who viewed your ad, but didn’t tap it, within a 1-day attribution window. The API counts new downloads when someone downloads your app to a device where your app hasn’t previously been installed.

Redownloads from people who viewed your ad, but didn’t tap it, within a 1-day attribution window. The API counts redownloads when someone downloads your app, deletes it, and downloads it again on the same device, or a different one, following an ad view.

Week of the year

Week of the year

Year such as 2017.

Year and month.

Year, month, day, and hour.

Year and quarter.

Year and week.