Contents

Keyword

Targeting keyword parameters to use in requests and responses.

Declaration

object Keyword

Properties

NameTypeDescription
adGroupIdint64

The unique identifier for the ad group that the targeting keyword belongs to.

You can use the EQUALS and IN selector Condition operators with Find Targeting Keywords in a Campaign.

bidAmount RequiredMoney

The maximum cost-per-tap/impression bid amount. This is the offer price for a keyword in a bidding auction. If the bidAmount field is null, the bidAmount uses the defaultBidAmount of the corresponding ad group.

If you set automatedKeywordsOptIn=true in Update an Ad Group, the bid uses optimized keywords with the defaultBidAmount. Returned as 0 for keywords in MAX_CONVERSIONS campaigns. Required for MANUAL_CPT campaigns.

campaignIdint64

The unique identifier for the campaign.

creationTimedate-time

The date and time of the creation of the keyword object.

You can use the EQUALS and IN selector Condition operators with Find Targeting Keywords in a Campaign.

deletedboolean

An indicator of whether the keyword is soft-deleted.

You can use the EQUALS and IN selector Condition operators with Find Targeting Keywords in a Campaign.

idint64

A unique identifier for the targeting keyword in the payload to update keyword bids or statuses. This keywordId is specific to a particular ad group and match type that you use to update bid amounts.

You can use the EQUALS and IN selector Condition operators with Find Targeting Keywords in a Campaign.

matchType Requiredstring

An automated keyword and bidding strategy. Match type can be either Broad or Exact. See Ad Groups for Search Match use cases.

Value

Description

Broad

Use this value to ensure your ads don’t run on relevant, close variants of a keyword, such as singulars, plurals, misspellings, synonyms, related searches, and phrases that include that term (fully or partially).

Exact

Use this value for the most control over searches your ad may appear in. You can target a specific term and its close variants, such as common misspellings and plurals. Your ad may receive fewer impressions as a result, but your tap-through rates (TTRs) and conversions on those impressions may be higher because you’re reaching users most interested in your app.

modificationTimedate-time

The date and time of the most recent modification of the object.

You can use the EQUALS and IN selector Condition operators with Find Targeting Keywords in a Campaign.

statusstring

The user-controlled status to enable or pause the keyword.

text Requiredstring

The word or phrase to match in App Store user searches to show your ad.

See Also

Keywords Request and Response Objects