Apple Search Ads

adChannelType

dimension

adFormat

dimension

adGroupCreativeSetId

metric

adGroupDeleted

string

Indicates whether the adgroup has been soft deleted or not.

dimension

adGroupDisplayStatus

string

Values are: RUNNING, ON_HOLD, PAUSED, DELETED

dimension

adGroupId

string

Search Ads-assigned, globally unique identifier

dimension

adGroupName

string

Has to be unique within the organization.

dimension

adGroupServingStateReasons

string

When an adgroup is not running, a list of reasons will be returned as strings

dimension

adGroupServingStateReasons.0

metric

adGroupServingStatus

string

Whether the adgroup is actually serving or not.

dimension

adGroupStatus

string

Values are: ENABLED (default), PAUSED

dimension

ageRange

string

Age range

dimension

app.adamId

string

AdamID of the promoted app

dimension

app.appName

string

App name

dimension

automatedKeywordsOptIn

string

Indicates whether Search Match has been enabled for this adgroup or not.

dimension

avgCPA.amount

currency

Average cost-per-acquisition is total spend divided by the number of conversions received within a period.

metric

avgCPA.currency

string

The currency of the average cost-per-acquisition

dimension

avgCPT.amount

currency

Average cost per thousand.

metric

avgCPT.currency

string

Currency of the average cost per thousand

dimension

bidAmount.amount

currency

Your bid amount to display your ad for the matching text value.

metric

bidAmount.currency

string

Currency of the bid amount

dimension

bidRecommendation.bidMax

metric

bidRecommendation.bidMin

metric

campaignId

string

Search Ads-assigned, globally unique identifier

dimension

campaignName

string

Has to be unique within the organization.

dimension

campaignStatus

string

Values are: ENABLED (default), PAUSED

dimension

conversionRate

float

The conversion rate (CR) is the total number of conversions received within a period divided by total number of taps within the same period.

metric

conversions

long

The total number of downloads or redownloads resulting from an ad within the reporting period. Search Ads conversions are attributed within a 30 day tap-through window.

metric

conversionsLATOff

long

Conversions from users who have not enabled Limit Ad Tracking (LAT) on their device.

metric

conversionsLATOn

long

Conversions from users who have enabled Limit Ad Tracking (LAT) on their device.

metric

conversionsNewDownloads

long

These represent app downloads from new users who have never before installed your app.

metric

conversionsRedownloads

long

Redownloads occur when a user downloads your app, deletes it, and downloads the same app again following a tap on an ad on the App Store, or downloads the same app to an additional device.

metric

countriesOrRegions

dimension

countryCode

string

Country code

dimension

cpaGoal.amount

currency

You may optionally define your Cost Per Acquisition goal

metric

cpaGoal.currency

string

Currency of the Cost per acquisition goal

dimension

creationTime

metric

creativeSetId

dimension

creativeSetLanguageDisplayName

dimension

creativeSetName

dimension

dailyBudget.amount

currency

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

string

Currency of the daily budget

dimension

date

date

Date

dimension

defaultCpcBid.amount

currency

You must define your default Cost Per Click bid when creating a campaign

metric

defaultCpcBid.currency

string

Currency of the default cost per click bid

dimension

deleted

string

Indicates whether the campaign/adgroup/keyword has been soft deleted or not.

dimension

deviceClass

string

Device class

dimension

displayStatus

string

Values are: RUNNING, ON_HOLD, PAUSED, DELETED

dimension

endTime

datetime

The time the designated campaign/adgroup ends

dimension

gender

string

Gender

dimension

impressions

long

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

metric

installs

metric

keyword

string

Keyword

dimension

keywordDisplayStatus

string

Keyword display status

dimension

keywordId

string

Keyword ID

dimension

keywordStatus

string

Values are: ACTIVE (default), PAUSED

dimension

latOffInstalls

metric

latOnInstalls

metric

localSpend.amount

currency

Local spend

metric

localSpend.currency

string

Currency of local spend

dimension

matchType

string

Values are: EXACT, BROAD (default)

dimension

modificationTime

datetime

When the object was last modified.

dimension

newDownloads

metric

orgId

dimension

organizationId

string

The ID associated with your account in the web UI.

dimension

organizationName

string

Organization name

dimension

redownloads

metric

searchTermSource

string

Search term source

dimension

searchTermText

string

Search term

dimension

servingStateReasons

string

When a campaign is not running, a list of reasons will be returned as strings

dimension

servingStatus

string

Whether the campaign is actually serving or not.

dimension

startTime

datetime

The time the designated campaign/adgroup starts

dimension

status

dimension

storefront

string

The app store territory in which you want to promote your app.

dimension

tapThroughRate

float

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

long

The number of times your ad was tapped by users within the reporting time period.

metric

targetingDimensions

metric

totalBudget.amount

currency

Total budget

metric

totalBudget.currency

string

Currency of total budget

dimension

ttr

metric