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.

API name	Adverity UI name	Description	Use in Adverity
adChannelType	adChannelType	The type of ad channel used for the ad. For example, ‘SEARCH’.	metric
adGroupDeleted	adGroupDeleted	Indicates whether the ad group has been marked as deleted.	metric
adGroupDisplayStatus	adGroupDisplayStatus	The current display status of the ad group, indicating its visibility and serving state.	metric
adGroupId		A unique identifier for the ad group.	metric
adGroupName	adGroupName	The name assigned to the ad group.	metric
adGroupServingStateReasons.0	adGroupServingStateReasons.0	The first reason why the ad group may not be serving ads, or is in a specific serving state.	metric
adGroupServingStatus	adGroupServingStatus	The current serving status of the ad group, such as ‘RUNNING’, ‘PAUSED’, or ‘NOT_SERVING’.	metric
adGroupStatus	adGroupStatus	The overall status of the ad group, such as ‘ENABLED’ or ‘PAUSED’.	metric
adId		A unique identifier for the ad creative.	metric
adServingStateReasons	adServingStateReasons	A list of reasons why the ad creative may not be serving or is in a specific serving state.	metric
adgroup.automatedKeywordsOptIn	adgroup.automatedKeywordsOptIn	Indicates whether the ad group is opted into automated keyword matching.	metric
adgroup.cpaGoal.amount	adgroup.cpaGoal.amount	The target cost-per-acquisition (CPA) amount set for the ad group.	metric
adgroup.cpaGoal.currency	adgroup.cpaGoal.currency	The currency of the cost-per-acquisition (CPA) goal for the ad group.	metric
adgroup.defaultBidAmount.amount	adgroup.defaultBidAmount.amount	The default bid amount for keywords within the ad group.	metric
adgroup.defaultBidAmount.currency	adgroup.defaultBidAmount.currency	The currency of the default bid amount for keywords within the ad group.	metric
adgroup.deleted	adgroup.deleted	Indicates if the ad group has been deleted.	metric
adgroup.displayStatus	adgroup.displayStatus	The current display status of the ad group.	metric
adgroup.endTime	adgroup.endTime	The date and time when the ad group is scheduled to end.	metric
adgroup.modificationTime		The date and time when the ad group was last modified.	metric
adgroup.pricingModel	adgroup.pricingModel	The pricing model associated with the ad group (e.g., ‘CPT’, ‘CPA’).	metric
adgroup.servingStateReasons	adgroup.servingStateReasons	A list of reasons indicating why the ad group is in its current serving state.	metric
adgroup.servingStatus	adgroup.servingStatus	The current serving status of the ad group, reflecting its eligibility to deliver ads.	metric
adgroup.startTime	adgroup.startTime	The date and time when the ad group is scheduled to start.	metric
adgroup.status	adgroup.status	The status of the ad group, such as ‘ENABLED’ or ‘PAUSED’.	metric
adgroup.targetingDimensions.adminArea	adgroup.targetingDimensions.adminArea	The administrative area (e.g., state or province) used for targeting within the ad group.	metric
adgroup.targetingDimensions.age	adgroup.targetingDimensions.age	The age range demographic used for targeting within the ad group.	metric
adgroup.targetingDimensions.country	adgroup.targetingDimensions.country	The country or region used for targeting within the ad group, represented by a country code.	metric
adgroup.targetingDimensions.deviceClass	adgroup.targetingDimensions.deviceClass	The device class (e.g., ‘IPAD’, ‘IPHONE’) used for targeting within the ad group.	metric
adgroup.targetingDimensions.gender	adgroup.targetingDimensions.gender	The gender demographic used for targeting within the ad group.	metric
adgroup.targetingDimensions.locality	adgroup.targetingDimensions.locality	The locality (e.g., city or group of cities) used for targeting within the ad group.	metric
app.adamId	app.adamId	The Apple ID (Adam ID) of the app being promoted.	metric
app.appName	app.appName	The name of the app being promoted.	metric
automatedKeywordsOptIn	automatedKeywordsOptIn	Indicates whether automated keyword matching is enabled.	metric
avgCPM.amount	avgCPM.amount	The average cost-per-mille (CPM) amount, representing the average cost for one thousand impressions.	metric
avgCPM.currency	avgCPM.currency	The currency of the average cost-per-mille (CPM) amount.	metric
avgCPT.amount	avgCPT.amount	The average cost-per-tap (CPT) amount, representing the average cost for each tap on an ad.	metric
avgCPT.currency	avgCPT.currency	The currency of the average cost-per-tap (CPT) amount.	metric
bidAmount.amount	bidAmount.amount	The bid amount for a keyword.	metric
bidAmount.currency	bidAmount.currency	The currency of the bid amount for a keyword.	metric
bidRecommendation.suggestedBidAmount.amount	bidRecommendation.suggestedBidAmount.amount	The suggested bid amount for a keyword, provided as a recommendation.	metric
bidRecommendation.suggestedBidAmount.currency	bidRecommendation.suggestedBidAmount.currency	The currency of the suggested bid amount for a keyword.	metric
campaign.adChannelType	campaign.adChannelType	The type of ad channel associated with the campaign.	metric
campaign.adamId	campaign.adamId	The Apple ID (Adam ID) of the app promoted by the campaign.	metric
campaign.billingEvent	campaign.billingEvent	The billing event type for the campaign.	metric
campaign.budgetAmount.amount	campaign.budgetAmount.amount	The total budget amount allocated for the campaign.	metric
campaign.budgetAmount.currency	campaign.budgetAmount.currency	The currency of the total budget amount for the campaign.	metric
campaign.budgetOrders		Information related to budget orders associated with the campaign.	metric
campaign.countriesOrRegions	campaign.countriesOrRegions	A list of country or region codes where the campaign’s ads will be served.	metric
campaign.countryOrRegionServingStateReasons		Reasons why a campaign may not be serving ads in a specific country or region.	metric
campaign.dailyBudgetAmount.amount	campaign.dailyBudgetAmount.amount	The daily budget amount allocated for the campaign.	metric
campaign.dailyBudgetAmount.currency	campaign.dailyBudgetAmount.currency	The currency of the daily budget amount for the campaign.	metric
campaign.deleted		Indicates if the campaign has been deleted.	metric
campaign.displayStatus	campaign.displayStatus	The current display status of the campaign, indicating its visibility and serving state.	metric
campaign.endTime	campaign.endTime	The date and time when the campaign is scheduled to end.	metric
campaign.modificationTime		The date and time when the campaign was last modified.	metric
campaign.paymentModel	campaign.paymentModel	The payment model used for the campaign (e.g., ‘COST_PER_TAP’).	metric
campaign.servingStateReasons	campaign.servingStateReasons	A list of reasons indicating why the campaign is in its current serving state.	metric
campaign.servingStatus	campaign.servingStatus	The current serving status of the campaign, reflecting its eligibility to deliver ads.	metric
campaign.startTime	campaign.startTime	The date and time when the campaign is scheduled to start.	metric
campaign.status	campaign.status	The overall status of the campaign, such as ‘ENABLED’ or ‘PAUSED’.	metric
campaign.supplySources	campaign.supplySources	A list of supply sources where the campaign’s ads are displayed.	metric
campaignId		A unique identifier for the campaign.	metric
campaignName	campaignName	The name assigned to the campaign.	metric
campaignStatus	campaignStatus	The overall status of the campaign, such as ‘ENABLED’ or ‘PAUSED’.	metric
countriesOrRegions	countriesOrRegions	A list of country or region codes relevant to the campaign or ad group.	metric
cpaGoal	cpaGoal	The target cost-per-acquisition (CPA) goal.	dimension
cpaGoal.amount	cpaGoal.amount	The target cost-per-acquisition (CPA) amount.	metric
cpaGoal.currency	cpaGoal.currency	The currency of the target cost-per-acquisition (CPA) amount.	metric
creationTime	creationTime	The date and time when the entity (e.g., campaign, ad group) was created.	metric
creativeId	creativeId	A unique identifier for the ad creative.	metric
creativeSetName	creativeSetName	The name of the creative set. Note: Creative Sets is deprecated in Apple Ads Campaign Management API 5.	dimension
creativeType	creativeType	The type of the ad creative (e.g., ‘IMAGE’, ‘TEXT’).	metric
dailyBudget	dailyBudget	The daily budget allocated for an entity.	dimension
dailyBudget.amount	dailyBudget.amount	The daily budget amount.	metric
dailyBudget.currency	dailyBudget.currency	The currency of the daily budget amount.	metric
date	date	The date for which the report data is aggregated. Format is YYYY-MM-DD.	metric
defaultCpcBid.amount	defaultCpcBid.amount	The default cost-per-click (CPC) bid amount.	metric
defaultCpcBid.currency	defaultCpcBid.currency	The currency of the default cost-per-click (CPC) bid amount.	metric
deleted	deleted	Indicates if the entity has been deleted.	metric
displayStatus	displayStatus	The current display status of the entity.	metric
endTime	endTime	The date and time when the entity is scheduled to end.	metric
hour	hour	The hour of the day for which the report data is aggregated, typically used with ‘HOURLY’ granularity.	metric
impressions	impressions	The number of times an ad appeared in App Store search results within the reporting time period.	metric
installs	installs	The total number of new downloads or redownloads resulting from an ad.	metric
keyword	keyword	The text of the keyword used for targeting.	metric
keywordDisplayStatus	keywordDisplayStatus	The current display status of the keyword.	metric
keywordId		A unique identifier for the keyword.	metric
keywordStatus	keywordStatus	The overall status of the keyword, such as ‘ENABLED’ or ‘PAUSED’.	metric
language	language	The language of the users targeted by the ad.	metric
latOffInstalls	latOffInstalls	The total number of installs from users who have not enabled Limit Ad Tracking (LAT) on their device.	metric
latOnInstalls	latOnInstalls	The total number of installs from users who have enabled Limit Ad Tracking (LAT) on their device.	metric
localSpend.amount	localSpend.amount	The total amount of money spent in the local currency.	metric
localSpend.currency	localSpend.currency	The currency of the total local spend amount.	metric
matchType	matchType	The keyword match type (e.g., ‘BROAD’, ‘EXACT’, ‘SEARCH_MATCH’).	metric
modificationTime	modificationTime	The date and time when the entity was last modified.	metric
newDownloads	newDownloads	App downloads from new users who have never before installed your app.	metric
orgId	orgId	A unique identifier for the organization or campaign group. Equivalent to a campaign group in the Apple Search Ads UI.	metric
organizationId	organizationId	A unique identifier for the organization.	metric
organizationName	organizationName	The name of the organization.	metric
redownloads	redownloads	Occurs when a user downloads your app, deletes it, and downloads it again.	metric
searchTermSource	searchTermSource	The source of the search term (e.g., ‘AUTOMATED_MATCH’, ‘KEYWORD’).	metric
searchTermText		The actual text of the search query entered by a user.	metric
servingStateReasons	servingStateReasons	A list of reasons indicating why the entity is in its current serving state.	metric
servingStatus	servingStatus	The current serving status of the entity, reflecting its eligibility to deliver ads.	metric
startTime	startTime	The date and time when the entity is scheduled to start.	metric
status	status	The overall status of the entity (e.g., ‘ENABLED’, ‘PAUSED’).	metric
tapInstalls	tapInstalls	The total number of app installs that occurred after a user tapped on an ad.	metric
tapThroughRate	tapThroughRate	The rate at which users tap on an ad after viewing it (Taps / Impressions).	metric
taps	taps	The total number of times users tapped on an ad.	metric
targetingDimensions	targetingDimensions	A collection of audience refinement criteria used for targeting, such as age, gender, device, and location.	metric
totalBudget.amount	totalBudget.amount	The total budget amount allocated.	metric
totalBudget.currency	totalBudget.currency	The currency of the total budget amount.	metric
totalInstallRate		The percentage of total installs relative to total impressions, calculated as (total installs / impressions) * 100	metric
totalInstalls	totalInstalls	The total number of new downloads or redownloads resulting from an ad.	metric
totalNewDownloads	totalNewDownloads	The total number of app downloads from new users who have never before installed the app.	metric
totalRedownloads		The total number of times users re-downloaded the app after previously deleting it.	metric
viewInstalls	viewInstalls	The number of app installations attributed to ad impressions without taps (view-through installs)	metric
viewNewDownloads		The number of new app downloads attributed to ad impressions without taps	metric
viewRedownloads			metric