Skip to content
Book a demo

Connect documentation

All documentation
Documentation

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.

FieldAdverity UI nameType
BudgetMetric

Represents the financial limit set for advertising campaigns. This can be either a daily spending limit or a total budget for the campaign.

adChannelTypeMetric

The type of ad channel used for the ad. For example, 'SEARCH'.

adGroupDeletedMetric

Indicates whether the ad group has been marked as deleted.

adGroupDisplayStatusMetric

The current display status of the ad group, indicating its visibility and serving state.

adGroupIdMetric

A unique identifier for the ad group.

adGroupNameMetric

The name assigned to the ad group.

adGroupServingStateReasons.0Metric

The primary reason an ad group is not currently running. This is the first item in a list of potential reasons.

adGroupServingStatusMetric

The current serving status of the ad group, such as 'RUNNING', 'PAUSED', or 'NOT_SERVING'.

adGroupStatusMetric

The overall status of the ad group, such as 'ENABLED' or 'PAUSED'.

adIdMetric

A unique identifier for the ad creative.

adServingStateReasonsMetric

A list of reasons provided by the system explaining why an ad is not currently running.

adamIdMetric

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.automatedKeywordsOptInMetric

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.amountMetric

The target cost-per-acquisition (CPA) amount set for the ad group.

adgroup.cpaGoal.currencyMetric

The currency of the cost-per-acquisition (CPA) goal for the ad group.

adgroup.defaultBidAmount.amountMetric

The default bid amount for keywords within the ad group.

adgroup.defaultBidAmount.currencyMetric

The currency of the default bid amount for keywords within the ad group.

adgroup.deletedMetric

Indicates if the ad group has been deleted.

adgroup.displayStatusMetric

The current display status of the ad group.

adgroup.endTimeMetric

The date and time when the ad group is scheduled to end.

adgroup.modificationTimeMetric

The date and time when the ad group was last modified.

adgroup.pricingModelMetric

The pricing model configured for the ad group's bids, such as Cost-Per-Tap (CPC) or Cost-Per-Mille (CPM).

adgroup.servingStateReasonsMetric

A list of reasons indicating why the ad group is in its current serving state.

adgroup.servingStatusMetric

The current serving status of the ad group, reflecting its eligibility to deliver ads.

adgroup.startTimeMetric

The date and time when the ad group is scheduled to start.

adgroup.statusMetric

The status of the ad group, such as 'ENABLED' or 'PAUSED'.

adgroup.targetingDimensions.adminAreaMetric

The administrative area (e.g., state or province) used for targeting within the ad group.

adgroup.targetingDimensions.ageMetric

The age range demographic used for targeting within the ad group.

adgroup.targetingDimensions.countryMetric

The country or region used for targeting within the ad group, represented by a country code.

adgroup.targetingDimensions.deviceClassMetric

The device class (e.g., 'IPAD', 'IPHONE') used for targeting within the ad group.

adgroup.targetingDimensions.genderMetric

The gender demographic used for targeting within the ad group.

adgroup.targetingDimensions.localityMetric

The locality (e.g., city or group of cities) used for targeting within the ad group.

app.adamIdMetric

The Apple ID (Adam ID) of the app being promoted.

app.appNameMetric

The name of the app being promoted.

appNameDimension

The name of the application associated with the 'adamId'.

automatedKeywordsOptInMetric

Indicates whether Search Match is enabled. If true, the system automatically adds optimized keywords to the ad group.

avgCPA.amountMetric

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.currencyDimension

The currency in which the average Cost Per Acquisition (CPA) amount is reported.

avgCPM.amountMetric

The average cost-per-mille (CPM) amount, representing the average cost for one thousand impressions.

avgCPM.currencyMetric

The currency of the average cost-per-mille (CPM) amount.

avgCPT.amountMetric

The average cost-per-tap (CPT) amount, representing the average cost for each tap on an ad.

avgCPT.currencyMetric

The currency of the average cost-per-tap (CPT) amount.

bidAmount.amountMetric

The bid amount for a keyword.

bidAmount.currencyMetric

The currency of the bid amount for a keyword.

bidRecommendation.suggestedBidAmount.amountMetric

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.currencyMetric

The currency of the suggested bid amount for a keyword.

campaign.adChannelTypeMetric

The type of ad channel associated with the campaign.

campaign.adamIdMetric

The Apple ID (Adam ID) of the app promoted by the campaign.

campaign.billingEventMetric

The type of billing event for a campaign, such as 'TAPS'.

campaign.budgetAmount.amountMetric

The total budget amount allocated for the campaign.

campaign.budgetAmount.currencyMetric

The currency of the total budget amount for the campaign.

campaign.budgetOrdersMetric

Information related to budget orders associated with the campaign.

campaign.countriesOrRegionsMetric

A list of country or region codes where the campaign's ads will be served.

campaign.countryOrRegionServingStateReasonsMetric

A map of reasons indicating why a campaign cannot run for specific countries or regions.

campaign.dailyBudgetAmount.amountMetric

The daily budget amount allocated for the campaign.

campaign.dailyBudgetAmount.currencyMetric

The currency of the daily budget amount for the campaign.

campaign.deletedMetric

Indicates if the campaign has been deleted.

campaign.displayStatusMetric

The current display status of the campaign, indicating its visibility and serving state.

campaign.endTimeMetric

The date and time when the campaign is scheduled to end.

campaign.modificationTimeMetric

The date and time when the campaign was last modified.

campaign.paymentModelMetric

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.servingStateReasonsMetric

A list of reasons indicating why the campaign is in its current serving state.

campaign.servingStatusMetric

The current serving status of the campaign, reflecting its eligibility to deliver ads.

campaign.startTimeMetric

The date and time when the campaign is scheduled to start.

campaign.statusMetric

The overall status of the campaign, such as 'ENABLED' or 'PAUSED'.

campaign.supplySourcesMetric

A list of ad placements where the campaign's ads can appear, such as App Store Search Results or App Store Search Tab.

campaignIdMetric

A unique identifier for the campaign.

campaignNameMetric

The name assigned to the campaign.

campaignStatusMetric

The overall status of the campaign, such as 'ENABLED' or 'PAUSED'.

conversionRateMetric

The percentage of user engagements (e.g., taps or impressions) that resulted in a conversion, such as an app install.

countriesOrRegionsMetric

A list of country or region codes relevant to the campaign or ad group.

countryCodeDimension

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.

countryOrRegionDimension

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.amountMetric

The target cost-per-acquisition (CPA) amount.

cpaGoal.currencyMetric

The currency of the target cost-per-acquisition (CPA) amount.

creationTimeMetric

The date and time when the entity (e.g., campaign, ad group) was created.

creativeIdMetric

A unique identifier for the ad creative.

creativeTypeMetric

The creativeType specifies the type of creative asset used in an ad, such as app previews or screenshots.

dailyBudget.amountMetric

The daily budget amount.

dailyBudget.currencyMetric

The currency of the daily budget amount.

dateMetric

The date for which the report data is aggregated. Format is YYYY-MM-DD.

defaultCpcBid.amountMetric

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.currencyMetric

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.

deleteDimension

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.

deletedMetric

Indicates if the entity has been deleted.

deviceClassDimension

The type of device (e.g., iPhone, iPad) on which the ad impressions or app downloads occurred.

displayStatusMetric

The current display status of the entity.

endTimeMetric

The date and time when the entity is scheduled to end.

highImpressionShareMetric

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.

hourDimension

The hour of the day when performance data was recorded, used when reporting data with hourly granularity.

impressionsMetric

The number of times an ad appeared in App Store search results within the reporting time period.

installsMetric

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.

keywordMetric

The text of the keyword used for targeting.

keywordDisplayStatusMetric

The current display status of the keyword.

keywordIdMetric

A unique identifier for the keyword.

keywordStatusMetric

The overall status of the keyword, such as 'ENABLED' or 'PAUSED'.

languageMetric

The language associated with ad creatives or the default language for countries/regions in a campaign.

latOffInstallsMetric

The total number of installs from users who have not enabled Limit Ad Tracking (LAT) on their device.

latOnInstallsMetric

The total number of installs from users who have enabled Limit Ad Tracking (LAT) on their device.

localSpend.amountMetric

The total amount of money spent in the local currency.

localSpend.currencyMetric

The currency of the total local spend amount.

lowImpressionShareMetric

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.

matchTypeMetric

The keyword match type (e.g., 'BROAD', 'EXACT', 'SEARCH_MATCH').

modificationTimeMetric

The date and time when the entity was last modified.

newDownloadsMetric

The number of first-time downloads of an app resulting from an ad within the reporting period.

orgIdMetric

A unique identifier for the organization or campaign group. Equivalent to a campaign group in the Apple Search Ads UI.

organizationIdMetric

A unique identifier for the organization.

organizationNameMetric

The name of the organization.

rankDimension

The ranking of a keyword or app in search results, often used in keyword performance reports.

redownloadsMetric

The number of times users downloaded an app again after previously deleting it, attributed to an ad within the reporting period.

searchPopularityMetric

An official score representing the popularity of a specific search term, exposed by the Apple Ads Platform API as 'asa_search_term_popularity'.

searchTermDimension

The actual user query that triggered an ad, available through search term performance reports.

searchTermSourceMetric

Indicates the source of a search term. 'AUTO' signifies automatic matching, while 'TARGETED' indicates a specifically chosen keyword match type (Broad or Exact).

searchTermTextMetric

The actual text of the search query entered by a user.

servingStateReasonsMetric

A list of reasons indicating why the entity is in its current serving state.

servingStatusMetric

The current serving status of the entity, reflecting its eligibility to deliver ads.

startTimeMetric

The date and time when the entity is scheduled to start.

statusMetric

The overall status of the entity (e.g., 'ENABLED', 'PAUSED').

tapInstallCPI.amountMetric

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.currencyMetric

The currency of the tap-through cost-per-install (CPI) amount.

tapInstallsMetric

The total number of app installs that occurred after a user tapped on an ad.

tapNewDownloadsMetric

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.

tapRedownloadsMetric

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.

tapThroughRateMetric

The rate at which users tap on an ad after viewing it (Taps / Impressions).

tapsMetric

The total number of times users tapped on an ad.

targetingDimensionsMetric

A collection of audience refinement criteria used for targeting, such as age, gender, device, and location.

totalBudget.amountMetric

The total budget amount allocated.

totalBudget.currencyMetric

The currency of the total budget amount.

totalInstallRateMetric

The rate of total installs, calculated as the total number of installs divided by the total number of taps within the reporting period.

totalInstallsMetric

The total number of new downloads or redownloads resulting from an ad.

totalNewDownloadsMetric

The total number of app downloads from new users who have never before installed the app.

totalRedownloadsMetric

The total number of times users re-downloaded the app after previously deleting it.

viewInstallsMetric

The total number of installs attributed to users who viewed an ad but did not tap it (view-through installs).

viewNewDownloadsMetric

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.

viewRedownloadsMetric

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.