Contents

ReportingSearchTerm

The response to a request to fetch search term-level reports.

Declaration

object ReportingSearchTerm

Properties

NameTypeDescription
adGroupDeletedboolean

An indicator of whether the ad group is soft-deleted.

You can use the EQUALS and IN selector Condition operators with Get Search Term-Level Reports.

adGroupIdint64

The unique identifier for the ad group the search term belongs to.

You can use the EQUALS, IN, and STARTSWITH selector Condition operators with Get Search Term-Level Reports.

adGroupNamestring

The name of the ad group, which is unique within the campaign. Responses don’t include deleted ad groups.

You can use the EQUALS, IN, and STARTSWITH selector Condition operators with Get Search Term-Level Reports.

bidAmountMoney

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.

campaignIdint64

The unique identifier for the campaign.

You can use the EQUALS, IN, and STARTSWITH Selector Condition operators with Get Search Term-Level Reports.

deletedboolean

An indicator of whether the search term is soft-deleted.

You can use the EQUALS and IN selector Condition operators with Get Search Term-Level Reports.

keywordstring

The targeting or negative keywords.

You can use the EQUALS, IN, and STARTSWITH selector Condition operators with Get Search Term-Level Reports.

keywordDisplayStatusstring

The state of the keyword display operation.

You can use the EQUALS and IN selector Condition operators with Get Search Term-Level Reports.

keywordIdint64

The unique identifier for a keyword that belongs to an ad group.

keywordStatusstring

The condition of the keyword.

You can use the EQUALS selector Condition operator with Get Search Term-Level Reports.

matchTypestring

An automated keyword and bidding strategy. See Ad Groups for Search Match use cases.

Auto

Specifies the system serves impressions with optimized keywords, in addition to those you explicitly add to the ad group.

Broad

Ensures 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

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

You can use the EQUALS selector Condition operator with Get Search Term-Level Reports.

modificationTimedate-time

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

orgIdint64

The identifier of the organization that owns the campaign. Your orgId is the same as your account in Apple Ads.

searchTermSourcestring

The source of the keyword to use as a search term.

If searchTermSource is AUTO, MatchType is AUTO.

If searchTermSource is TARGETED, MatchType is either BROAD or EXACT.

AUTO

The value to use to ensure Search Match automatically matches your ads.

TARGETED

A bidded keyword.

You can use the EQUALS and IN selector Condition operators with Get Search Term-Level Reports.

searchTermTextstring

The search terms to use for app searches.

You can use the EQUALS, IN, and STARTSWITH selector Condition operators with Get Search Term-Level Reports.

See Also

Reports Request and Response Objects