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

Resource: ClickView

A click view with metrics aggregated at each click level, including both valid and invalid clicks. For non-googleAds.search campaigns, metrics.clicks represents the number of valid and invalid interactions. Queries including ClickView must have a filter limiting the results to one day and can be requested for dates back to 90 days before the time of the request.

JSON representation
{
  "resourceName": string,
  "areaOfInterest": {
    object (ClickLocation)
  },
  "locationOfPresence": {
    object (ClickLocation)
  },
  "keyword": string,
  "keywordInfo": {
    object (KeywordInfo)
  },
  "gclid": string,
  "pageNumber": string,
  "adGroupAd": string,
  "campaignLocationTarget": string,
  "userList": string
}
Fields
resourceName

string

Output only. The resource name of the click view. Click view resource names have the form:

customers/{customerId}/clickViews/{date (yyyy-MM-dd)}~{gclid}

areaOfInterest

object (ClickLocation)

Output only. The location criteria matching the area of interest associated with the impression.

locationOfPresence

object (ClickLocation)

Output only. The location criteria matching the location of presence associated with the impression.

keyword

string

Output only. The associated keyword, if one exists and the click corresponds to the SEARCH channel.

keywordInfo

object (KeywordInfo)

Output only. Basic information about the associated keyword, if it exists.

gclid

string

Output only. The Google Click ID.

pageNumber

string (int64 format)

Output only. Page number in search results where the ad was shown.

adGroupAd

string

Output only. The associated ad.

campaignLocationTarget

string

Output only. The associated campaign location target, if one exists.

userList

string

Output only. The associated user list, if one exists.

ClickLocation

Location criteria associated with a click.

JSON representation
{
  "city": string,
  "country": string,
  "metro": string,
  "mostSpecific": string,
  "region": string
}
Fields
city

string

The city location criterion associated with the impression.

country

string

The country location criterion associated with the impression.

metro

string

The metro location criterion associated with the impression.

mostSpecific

string

The most specific location criterion associated with the impression.

region

string

The region location criterion associated with the impression.

Methods

get

Returns the requested click view in full detail.