Apple Search Ads: Most-used fields#
The table below gives information about most-used fields that you can import from Apple Search Ads. Other fields might also be available in Adverity.
The fields that you can fetch in Adverity are updated regularly to reflect updates to data source APIs.
Budget Metric
Represents the financial limit set for advertising campaigns. This can be either a daily spending limit or a total budget for the campaign.
adChannelType Metric
The type of ad channel used for the ad. For example, 'SEARCH'.
adGroupDeleted Metric
Indicates whether the ad group has been marked as deleted.
adGroupDisplayStatus Metric
The current display status of the ad group, indicating its visibility and serving state.
adGroupId Metric
A unique identifier for the ad group.
adGroupName Metric
The name assigned to the ad group.
adGroupServingStateReasons.0 Metric
The primary reason an ad group is not currently running. This is the first item in a list of potential reasons.
adGroupServingStatus Metric
The current serving status of the ad group, such as 'RUNNING', 'PAUSED', or 'NOT_SERVING'.
adGroupStatus Metric
The overall status of the ad group, such as 'ENABLED' or 'PAUSED'.
adId Metric
A unique identifier for the ad creative.
adServingStateReasons Metric
A list of reasons provided by the system explaining why an ad is not currently running.
adamId Metric
A unique identifier for an application within the Apple ecosystem, used to filter data or retrieve app-specific information from the Apple Search Ads API.
adgroup.automatedKeywordsOptIn Metric
Indicates whether Search Match is enabled for the ad group. If true, the system automatically adds optimized keywords in addition to manually added keywords.
adgroup.cpaGoal.amount Metric
The target cost-per-acquisition (CPA) amount set for the ad group.
adgroup.cpaGoal.currency Metric
The currency of the cost-per-acquisition (CPA) goal for the ad group.
adgroup.defaultBidAmount.amount Metric
The default bid amount for keywords within the ad group.
adgroup.defaultBidAmount.currency Metric
The currency of the default bid amount for keywords within the ad group.
adgroup.deleted Metric
Indicates if the ad group has been deleted.
adgroup.displayStatus Metric
The current display status of the ad group.
adgroup.endTime Metric
The date and time when the ad group is scheduled to end.
adgroup.modificationTime Metric
The date and time when the ad group was last modified.
adgroup.pricingModel Metric
The pricing model configured for the ad group's bids, such as Cost-Per-Tap (CPC) or Cost-Per-Mille (CPM).
adgroup.servingStateReasons Metric
A list of reasons indicating why the ad group is in its current serving state.
adgroup.servingStatus Metric
The current serving status of the ad group, reflecting its eligibility to deliver ads.
adgroup.startTime Metric
The date and time when the ad group is scheduled to start.
adgroup.status Metric
The status of the ad group, such as 'ENABLED' or 'PAUSED'.
adgroup.targetingDimensions.adminArea Metric
The administrative area (e.g., state or province) used for targeting within the ad group.
adgroup.targetingDimensions.age Metric
The age range demographic used for targeting within the ad group.
adgroup.targetingDimensions.country Metric
The country or region used for targeting within the ad group, represented by a country code.
adgroup.targetingDimensions.deviceClass Metric
The device class (e.g., 'IPAD', 'IPHONE') used for targeting within the ad group.
adgroup.targetingDimensions.gender Metric
The gender demographic used for targeting within the ad group.
adgroup.targetingDimensions.locality Metric
The locality (e.g., city or group of cities) used for targeting within the ad group.
ageRange Dimension
The age range demographic used for targeting within an ad group in Apple Search Ads, allowing advertisers to define the minimum and maximum ages of their target audience.
app.adamId Metric
The Apple ID (Adam ID) of the app being promoted.
app.appName Metric
The name of the app being promoted.
appName Dimension
The name of the application associated with the 'adamId'.
automatedKeywordsOptIn Metric
Indicates whether Search Match is enabled. If true, the system automatically adds optimized keywords to the ad group.
avgCPA.amount Metric
The average cost-per-acquisition (CPA) amount, representing the average cost incurred to acquire a conversion (e.g., an install) through Apple Search Ads. This metric is used to optimize for the highest conversion volume.
avgCPA.currency Dimension
The currency in which the average Cost Per Acquisition (CPA) amount is reported.
avgCPM.amount Metric
The average cost-per-mille (CPM) amount, representing the average cost for one thousand impressions.
avgCPM.currency Metric
The currency of the average cost-per-mille (CPM) amount.
avgCPT.amount Metric
The average cost-per-tap (CPT) amount, representing the average cost for each tap on an ad.
avgCPT.currency Metric
The currency of the average cost-per-tap (CPT) amount.
bidAmount.amount Metric
The bid amount for a keyword.
bidAmount.currency Metric
The currency of the bid amount for a keyword.
bidRecommendation.suggestedBidAmount.amount Metric
The suggested bid amount for a keyword, which is an indicator to help increase the likelihood of an ad showing in App Store searches.
bidRecommendation.suggestedBidAmount.currency Metric
The currency of the suggested bid amount for a keyword.
campaign.adChannelType Metric
The type of ad channel associated with the campaign.
campaign.adamId Metric
The Apple ID (Adam ID) of the app promoted by the campaign.
campaign.billingEvent Metric
The type of billing event for a campaign, such as 'TAPS'.
campaign.budgetAmount.amount Metric
The total budget amount allocated for the campaign.
campaign.budgetAmount.currency Metric
The currency of the total budget amount for the campaign.
campaign.budgetOrders Metric
Information related to budget orders associated with the campaign.
campaign.countriesOrRegions Metric
A list of country or region codes where the campaign's ads will be served.
campaign.countryOrRegionServingStateReasons Metric
A map of reasons indicating why a campaign cannot run for specific countries or regions.
campaign.dailyBudgetAmount.amount Metric
The daily budget amount allocated for the campaign.
campaign.dailyBudgetAmount.currency Metric
The currency of the daily budget amount for the campaign.
campaign.deleted Metric
Indicates if the campaign has been deleted.
campaign.displayStatus Metric
The current display status of the campaign, indicating its visibility and serving state.
campaign.endTime Metric
The date and time when the campaign is scheduled to end.
campaign.modificationTime Metric
The date and time when the campaign was last modified.
campaign.paymentModel Metric
The payment model set up for the campaign, which influences whether campaigns can run. Possible values include PAYG (Pay-As-You-Go) or LOC (Line of Credit).
campaign.servingStateReasons Metric
A list of reasons indicating why the campaign is in its current serving state.
campaign.servingStatus Metric
The current serving status of the campaign, reflecting its eligibility to deliver ads.
campaign.startTime Metric
The date and time when the campaign is scheduled to start.
campaign.status Metric
The overall status of the campaign, such as 'ENABLED' or 'PAUSED'.
campaign.supplySources Metric
A list of ad placements where the campaign's ads can appear, such as App Store Search Results or App Store Search Tab.
campaignId Metric
A unique identifier for the campaign.
campaignName Metric
The name assigned to the campaign.
campaignStatus Metric
The overall status of the campaign, such as 'ENABLED' or 'PAUSED'.
conversionRate Metric
The percentage of user engagements (e.g., taps or impressions) that resulted in a conversion, such as an app install.
countriesOrRegions Metric
A list of country or region codes relevant to the campaign or ad group.
countryCode Dimension
An ISO 3166-1 alpha-2 country code that represents the country or region where advertising campaigns are targeted or where performance data is reported.
countryOrRegion Dimension
The display name for the country or region where ad campaigns are run or data is reported. This corresponds to the countryCode API field.
cpaGoal.amount Metric
The target cost-per-acquisition (CPA) amount.
cpaGoal.currency Metric
The currency of the target cost-per-acquisition (CPA) amount.
creationTime Metric
The date and time when the entity (e.g., campaign, ad group) was created.
creativeId Metric
A unique identifier for the ad creative.
creativeType Metric
The creativeType specifies the type of creative asset used in an ad, such as app previews or screenshots.
dailyBudget.amount Metric
The daily budget amount.
dailyBudget.currency Metric
The currency of the daily budget amount.
date Metric
The date for which the report data is aggregated. Format is YYYY-MM-DD.
defaultCpcBid.amount Metric
The default maximum cost-per-tap (CPC) or cost-per-impression bid amount for an ad group. This field was renamed to 'defaultBidAmount' in API v4.
defaultCpcBid.currency Metric
The currency of the default maximum cost-per-tap (CPC) or cost-per-impression bid for an ad group. This field was renamed to 'defaultBidAmount' in API v4.
delete Dimension
Indicates if the entity (e.g., campaign, ad group, or keyword) has been deleted or soft-deleted. This field reflects the removal status of an advertising component within the Apple Search Ads platform.
deleted Metric
Indicates if the entity has been deleted.
deviceClass Dimension
The type of device (e.g., iPhone, iPad) on which the ad impressions or app downloads occurred.
displayStatus Metric
The current display status of the entity.
endTime Metric
The date and time when the entity is scheduled to end.
highImpressionShare Metric
A metric representing the higher end of the impression share percentage your app captured for a specific search term or keyword. Impression share data is available through the Apple Ads Platform API.
hour Dimension
The hour of the day when performance data was recorded, used when reporting data with hourly granularity.
impressions Metric
The number of times an ad appeared in App Store search results within the reporting time period.
installs Metric
The total number of new downloads and redownloads of an app attributed to an ad within the reporting period, including both tap-through and view-through conversions.
keyword Metric
The text of the keyword used for targeting.
keywordDisplayStatus Metric
The current display status of the keyword.
keywordId Metric
A unique identifier for the keyword.
keywordStatus Metric
The overall status of the keyword, such as 'ENABLED' or 'PAUSED'.
language Metric
The language associated with ad creatives or the default language for countries/regions in a campaign.
latOffInstalls Metric
The total number of installs from users who have not enabled Limit Ad Tracking (LAT) on their device.
latOnInstalls Metric
The total number of installs from users who have enabled Limit Ad Tracking (LAT) on their device.
localSpend.amount Metric
The total amount of money spent in the local currency.
localSpend.currency Metric
The currency of the total local spend amount.
lowImpressionShare Metric
A metric representing the lower end of the impression share percentage your app captured for a specific search term or keyword. Impression share data is available through the Apple Ads Platform API.
matchType Metric
The keyword match type (e.g., 'BROAD', 'EXACT', 'SEARCH_MATCH').
modificationTime Metric
The date and time when the entity was last modified.
newDownloads Metric
The number of first-time downloads of an app resulting from an ad within the reporting period.
orgId Metric
A unique identifier for the organization or campaign group. Equivalent to a campaign group in the Apple Search Ads UI.
organizationId Metric
A unique identifier for the organization.
organizationName Metric
The name of the organization.
rank Dimension
The ranking of a keyword or app in search results, often used in keyword performance reports.
redownloads Metric
The number of times users downloaded an app again after previously deleting it, attributed to an ad within the reporting period.
searchPopularity Metric
An official score representing the popularity of a specific search term, exposed by the Apple Ads Platform API as 'asa_search_term_popularity'.
searchTerm Dimension
The actual user query that triggered an ad, available through search term performance reports.
searchTermSource Metric
Indicates the source of a search term. 'AUTO' signifies automatic matching, while 'TARGETED' indicates a specifically chosen keyword match type (Broad or Exact).
searchTermText Metric
The actual text of the search query entered by a user.
servingStateReasons Metric
A list of reasons indicating why the entity is in its current serving state.
servingStatus Metric
The current serving status of the entity, reflecting its eligibility to deliver ads.
startTime Metric
The date and time when the entity is scheduled to start.
status Metric
The overall status of the entity (e.g., 'ENABLED', 'PAUSED').
tapInstallCPI.amount Metric
The cost-per-install (CPI) amount, calculated as the total campaign spend divided by the number of tap-through installs within the reporting period.
tapInstallCPI.currency Metric
The currency of the tap-through cost-per-install (CPI) amount.
tapInstalls Metric
The total number of app installs that occurred after a user tapped on an ad.
tapNewDownloads Metric
The total number of new downloads attributed to users who tapped an ad within a 30-day attribution window. This counts when an app is downloaded to a device where it hasn't been previously installed.
tapRedownloads Metric
The total number of redownloads attributed to users who tapped an ad within a 30-day attribution window. This counts when an app is downloaded again on the same or a different device after being previously deleted.
tapThroughRate Metric
The rate at which users tap on an ad after viewing it (Taps / Impressions).
taps Metric
The total number of times users tapped on an ad.
targetingDimensions Metric
A collection of audience refinement criteria used for targeting, such as age, gender, device, and location.
totalBudget.amount Metric
The total budget amount allocated.
totalBudget.currency Metric
The currency of the total budget amount.
totalInstallRate Metric
The rate of total installs, calculated as the total number of installs divided by the total number of taps within the reporting period.
totalInstalls Metric
The total number of new downloads or redownloads resulting from an ad.
totalNewDownloads Metric
The total number of app downloads from new users who have never before installed the app.
totalRedownloads Metric
The total number of times users re-downloaded the app after previously deleting it.
viewInstalls Metric
The total number of installs attributed to users who viewed an ad but did not tap it (view-through installs).
viewNewDownloads Metric
New downloads from users who viewed an ad but did not tap it, within a 1-day attribution window. This counts when an app is downloaded to a device where it hasn't been previously installed.
viewRedownloads Metric
Redownloads from users who viewed an ad but did not tap it, within a 1-day attribution window. This counts when an app is downloaded again on the same or a different device after being previously deleted.