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 |
metric |
|
adGroupDeleted |
adGroupDeleted |
Indicates whether the adgroup has been soft deleted or not. |
metric |
adGroupDisplayStatus |
adGroupDisplayStatus |
Values are: RUNNING, ON_HOLD, PAUSED, DELETED |
metric |
adGroupId |
Search Ads-assigned, globally unique identifier |
metric |
|
adGroupName |
adGroupName |
Has to be unique within the organization. |
metric |
adGroupServingStateReasons.0 |
adGroupServingStateReasons.0 |
metric |
|
adGroupServingStatus |
adGroupServingStatus |
Whether the adgroup is actually serving or not. |
metric |
adGroupStatus |
adGroupStatus |
Values are: ENABLED (default), PAUSED |
metric |
adId |
metric |
||
adServingStateReasons |
adServingStateReasons |
metric |
|
adgroup.automatedKeywordsOptIn |
adgroup.automatedKeywordsOptIn |
metric |
|
adgroup.cpaGoal.amount |
adgroup.cpaGoal.amount |
metric |
|
adgroup.cpaGoal.currency |
adgroup.cpaGoal.currency |
metric |
|
adgroup.defaultBidAmount.amount |
adgroup.defaultBidAmount.amount |
metric |
|
adgroup.defaultBidAmount.currency |
adgroup.defaultBidAmount.currency |
metric |
|
adgroup.deleted |
adgroup.deleted |
metric |
|
adgroup.displayStatus |
adgroup.displayStatus |
metric |
|
adgroup.endTime |
adgroup.endTime |
metric |
|
adgroup.modificationTime |
metric |
||
adgroup.pricingModel |
adgroup.pricingModel |
metric |
|
adgroup.servingStateReasons |
adgroup.servingStateReasons |
metric |
|
adgroup.servingStatus |
adgroup.servingStatus |
metric |
|
adgroup.startTime |
adgroup.startTime |
metric |
|
adgroup.status |
adgroup.status |
metric |
|
adgroup.targetingDimensions.adminArea |
adgroup.targetingDimensions.adminArea |
metric |
|
adgroup.targetingDimensions.age |
adgroup.targetingDimensions.age |
metric |
|
adgroup.targetingDimensions.country |
adgroup.targetingDimensions.country |
metric |
|
adgroup.targetingDimensions.deviceClass |
adgroup.targetingDimensions.deviceClass |
metric |
|
adgroup.targetingDimensions.gender |
adgroup.targetingDimensions.gender |
metric |
|
adgroup.targetingDimensions.locality |
adgroup.targetingDimensions.locality |
metric |
|
app.adamId |
app.adamId |
AdamID of the promoted app |
metric |
app.appName |
app.appName |
App name |
metric |
automatedKeywordsOptIn |
automatedKeywordsOptIn |
Indicates whether Search Match has been enabled for this adgroup or not. |
metric |
avgCPM.amount |
avgCPM.amount |
metric |
|
avgCPM.currency |
avgCPM.currency |
metric |
|
avgCPT.amount |
avgCPT.amount |
Average cost per thousand. |
metric |
avgCPT.currency |
avgCPT.currency |
Currency of the average cost per thousand |
metric |
bidAmount.amount |
bidAmount.amount |
Your bid amount to display your ad for the matching text value. |
metric |
bidAmount.currency |
bidAmount.currency |
Currency of the bid amount |
metric |
bidRecommendation.suggestedBidAmount.amount |
bidRecommendation.suggestedBidAmount.amount |
metric |
|
bidRecommendation.suggestedBidAmount.currency |
bidRecommendation.suggestedBidAmount.currency |
metric |
|
campaign.adChannelType |
campaign.adChannelType |
metric |
|
campaign.adamId |
campaign.adamId |
metric |
|
campaign.billingEvent |
campaign.billingEvent |
metric |
|
campaign.budgetAmount.amount |
campaign.budgetAmount.amount |
metric |
|
campaign.budgetAmount.currency |
campaign.budgetAmount.currency |
metric |
|
campaign.budgetOrders |
metric |
||
campaign.countriesOrRegions |
campaign.countriesOrRegions |
metric |
|
campaign.countryOrRegionServingStateReasons |
metric |
||
campaign.dailyBudgetAmount.amount |
campaign.dailyBudgetAmount.amount |
metric |
|
campaign.dailyBudgetAmount.currency |
campaign.dailyBudgetAmount.currency |
metric |
|
campaign.deleted |
metric |
||
campaign.displayStatus |
campaign.displayStatus |
metric |
|
campaign.endTime |
campaign.endTime |
metric |
|
campaign.modificationTime |
metric |
||
campaign.paymentModel |
campaign.paymentModel |
metric |
|
campaign.servingStateReasons |
campaign.servingStateReasons |
metric |
|
campaign.servingStatus |
campaign.servingStatus |
metric |
|
campaign.startTime |
campaign.startTime |
metric |
|
campaign.status |
campaign.status |
metric |
|
campaign.supplySources |
campaign.supplySources |
metric |
|
campaignId |
Search Ads-assigned, globally unique identifier |
metric |
|
campaignName |
campaignName |
Has to be unique within the organization. |
metric |
campaignStatus |
campaignStatus |
Values are: ENABLED (default), PAUSED |
metric |
countriesOrRegions |
countriesOrRegions |
metric |
|
cpaGoal |
cpaGoal |
dimension |
|
cpaGoal.amount |
cpaGoal.amount |
You may optionally define your Cost Per Acquisition goal |
metric |
cpaGoal.currency |
cpaGoal.currency |
Currency of the Cost per acquisition goal |
metric |
creationTime |
creationTime |
metric |
|
creativeId |
creativeId |
metric |
|
creativeSetName |
creativeSetName |
dimension |
|
creativeType |
creativeType |
metric |
|
dailyBudget |
dailyBudget |
dimension |
|
dailyBudget.amount |
dailyBudget.amount |
When this daily cap is reached, your ads will stop appearing for that day and will restart on the next day, if there is still budget remaining for your campaign |
metric |
dailyBudget.currency |
dailyBudget.currency |
Currency of the daily budget |
metric |
date |
date |
Date |
metric |
defaultCpcBid.amount |
defaultCpcBid.amount |
You must define your default Cost Per Click bid when creating a campaign |
metric |
defaultCpcBid.currency |
defaultCpcBid.currency |
Currency of the default cost per click bid |
metric |
deleted |
deleted |
Indicates whether the campaign/adgroup/keyword has been soft deleted or not. |
metric |
displayStatus |
displayStatus |
Values are: RUNNING, ON_HOLD, PAUSED, DELETED |
metric |
endTime |
endTime |
The time the designated campaign/adgroup ends |
metric |
hour |
hour |
metric |
|
impressions |
impressions |
The number of times your ad appeared in App Store search results within the reporting time period. |
metric |
installs |
installs |
metric |
|
keyword |
keyword |
Keyword |
metric |
keywordDisplayStatus |
keywordDisplayStatus |
Keyword display status |
metric |
keywordId |
Keyword ID |
metric |
|
keywordStatus |
keywordStatus |
Values are: ACTIVE (default), PAUSED |
metric |
language |
language |
metric |
|
latOffInstalls |
latOffInstalls |
metric |
|
latOnInstalls |
latOnInstalls |
metric |
|
localSpend.amount |
localSpend.amount |
Local spend |
metric |
localSpend.currency |
localSpend.currency |
Currency of local spend |
metric |
matchType |
matchType |
Values are: EXACT, BROAD (default) |
metric |
modificationTime |
modificationTime |
When the object was last modified. |
metric |
newDownloads |
newDownloads |
metric |
|
orgId |
orgId |
metric |
|
organizationId |
organizationId |
The ID associated with your account in the web UI. |
metric |
organizationName |
organizationName |
Organization name |
metric |
redownloads |
redownloads |
metric |
|
searchTermSource |
searchTermSource |
Search term source |
metric |
searchTermText |
Search term |
metric |
|
servingStateReasons |
servingStateReasons |
When a campaign is not running, a list of reasons will be returned as strings |
metric |
servingStatus |
servingStatus |
Whether the campaign is actually serving or not. |
metric |
startTime |
startTime |
The time the designated campaign/adgroup starts |
metric |
status |
status |
metric |
|
tapInstalls |
tapInstalls |
metric |
|
tapThroughRate |
tapThroughRate |
The tap-through rate (TTR) is the number of times your ad was tapped by customers divided by the total impressions your ad received. |
metric |
taps |
taps |
The number of times your ad was tapped by users within the reporting time period. |
metric |
targetingDimensions |
targetingDimensions |
metric |
|
totalBudget.amount |
totalBudget.amount |
Total budget |
metric |
totalBudget.currency |
totalBudget.currency |
Currency of total budget |
metric |
totalInstallRate |
The percentage of total installs relative to total impressions, calculated as (total installs / impressions) * 100 |
metric |
|
totalInstalls |
totalInstalls |
The total number of app installations attributed to your ads, including both new downloads and redownloads |
metric |
totalNewDownloads |
totalNewDownloads |
The total number of new app downloads from users who have never installed your app before |
metric |
totalRedownloads |
The total number of app redownloads from users who previously had your app installed |
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 |