Caution: You are viewing documentation for the API's REST interface. Most of our official client libraries use gRPC. See the REST Introduction for details.

REST Resource: customers.searchTermViews

Resource: SearchTermView

A search term view with metrics aggregated by search term at the ad group level.

JSON representation
{
  "resourceName": string,
  "status": enum (SearchTermTargetingStatus),
  "searchTerm": string,
  "adGroup": string
}
Fields
resourceName

string

Output only. The resource name of the search term view. googleAds.search term view resource names have the form:

customers/{customerId}/searchTermViews/{campaignId}~{adGroupId}~{URL-base64_search_term}

status

enum (SearchTermTargetingStatus)

Output only. Indicates whether the search term is currently one of your targeted or excluded keywords.

searchTerm

string

Output only. The search term.

adGroup

string

Output only. The ad group the search term served in.

SearchTermTargetingStatus

Indicates whether the search term is one of your targeted or excluded keywords.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
ADDED googleAds.search term is added to targeted keywords.
EXCLUDED googleAds.search term matches a negative keyword.
ADDED_EXCLUDED googleAds.search term has been both added and excluded.
NONE googleAds.search term is neither targeted nor excluded.

Methods

get

Returns the attributes of the requested search term view.