Contents

ReportingKeyword

The response to a request to fetch keyword-level reports.

Declaration

object ReportingKeyword

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 Keyword-Level Reports.

adGroupIdint64

The unique identifier for the ad group.

You can use the EQUALS, IN, and STARTSWITH selector Condition operators with Get Keyword-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 Keyword-Level Reports.

bidAmountMoney

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.

campaignIdint64

The unique identifier for the campaign.

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

deletedboolean

An indicator of whether the keyword is soft-deleted.

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

keywordstring

The name of a keyword that belongs to an ad group.

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

keywordDisplayStatusstring

The state of the keyword display operation.

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

keywordIdint64

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

keywordStatusstring

The status of the keyword.

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

See Also

Reports Request and Response Objects