Dimensions

You can use dimensions to request additional entity metadata that is not provided by default in the cube tables.

If you want attributes from a certain dimension to be included in the report, then you must include the dimension’s ID field in the field list. For example, if you would like to include “Ad Landing URL” in a report from the performance_stats cube, then the “Ad ID” must also be requested along with the “Ad Landing URL” field.

The following dimensions are available for querying:

Advertiser

Name

Description

Type

Advertiser ID

The ID of the advertiser account.

long

Advertiser Name

The name of the advertiser account.

string

Advertiser Timezone

The advertiser account timezone, e.g., America/New_York.

enum

Advertiser Currency

Advertiser currency, e.g., USD

string

Advertiser Tracking URL

Represents the optional template at the Advertiser level to specify additional tracking parameters or redirects. New in the v3 Native & Search API.

string


Campaign

Name

Description

Type

Advertiser ID

The ID of the account associated with the campaign.

long

Campaign ID

The ID of the campaign. This is the primary key for this dimension and should be included in the report in order for other dimension attributes to be queried.

long

Campaign Name

The name of the campaign.

string

Campaign Bid Strategy

Represents the bidding strategy specified at the campaign level.

string

Campaign Start Date

The start date of the campaign.

yyyy-mm-dd format

Campaign End Date

The end date of the campaign.

yyyy-mm-dd format

Campaign Status

The status of the campaign (ACTIVE, PAUSED).

enum

Budget

The lifetime budget at the campaign level.

BigDecimal

Budget Type

The type of budget.

enum

Campaign Objective

The objective of the campaign as defined in the campaign settings.

string

Campaign Tracking URL

Represents the optional template at the Campaign level to specify additional tracking parameters or redirects. New in the v3 Native & Search API.

string

Campaign Custom Parameters

Represents the optional ValueTrack parameters at the Campaign level to which you can assign your own IDs. New in the v3 Native & Search API.

string

Conversion Counting

The latest setting of how conversions are counted for the campaign (ALL_PER_INTERACTION, ONE_PER_INTERACTION).

string


Ad Group

Name

Description

Type

Advertiser ID

The ID of the account associated with the ad group.

long

Campaign ID

The ID of the campaign associated with the ad group.

long

Ad Group ID

The ID of the ad group. This is the primary key for this dimension and should be included in the report in order for other dimension attributes to be queried.

long

Ad Group Name

The name of the ad group.

string

Ad Group Status

The status of the ad group (ACTIVE, PAUSED).

enum

Ad Group Tracking URL

Represents the optional template at the Ad Group level to specify additional additional tracking parameters or redirects. New in the v3 Native & Search API.

string

Campaign Custom Parameters

Represents the optional ValueTrack parameters at the Ad Group level to which you can assign your own IDs. New in the v3 Native & Search API.

string


Ad

Name

Description

Type

Advertiser ID

The ID of the account associated with the ad.

long

Campaign ID

The ID of the campaign associated with the ad.

long

Ad Group ID

The ID of the ad group associated with the ad.

long

Ad ID

The ID of the ad. This is the primary key for this dimension and should be included in the report in order for other dimension attributes to be queried.

long

Ad Title

The title of the ad that will be shown to the user. Limited to 50 characters.

string

Ad Title 2

The second line title of the ad that will be shown to the user. The limit is 30 characters of text. When used with Ad Title, then the Ad Title attribute is also limited to 30 characters of text. Supported for both v1 and v2 API calls.

string

Ad Description

The description of the ad that will be shown to the user. This field supports keyword insertion. Max length is 150 characters.

string

Ad SponsoredBy

The string shown against the sponsored by label in the ad.

string

Ad Landing URL

The URL where the user was redirected to upon clicking the ad.

string

Ad Display URL

The user-friendly URL that is displayed to the user.

string

Ad Image URL

The URL of the (uploaded thumbnail) image.

string

Ad Final URL

Represents the final URL for the Ad that a user ultimately sees in the browser bar after clicking an ad. New in the v3 Native & Search API.

string

Ad Mobile Final URL

Represents the final mobile URL for the Ad after all cross domain redirects. New in the v3 Native & Search API.

string

Ad Tracking URL

Represents the optional template at the Ad level to specify additional tracking parameters or redirects. New in the v3 Native & Search API.

string

Ad Custom Parameters

Represents the optional the optional ValueTrack parameters at the Ad level to which you can assign your own IDs. New in the v3 Native & Search API.

string


Keyword

Name

Description

Type

Keyword ID

The id of the keyword. This is the primary key for this dimension and should be included in the report in order for other dimension attributes to be queried.

long

Keyword Value

The keyword text.

string

Keyword Match Type

The keyword match type.

string

Keyword Status

The keyword status.

string

Keyword Param 1

The param1 value for the keyword.

string

Keyword Landing URL

The keyword landing URL.

string

Keyword Final URL

Represents the final URL for the Keyword that a user ultimately sees in the browser bar after clicking an ad. New in the v3 Native & Search API.

string

Keyword Mobile Final URL

Represents the final mobile URL for the Keyword after all cross domain redirects. New in the v3 Native & Search API.

string

Keyword Tracking URL

Represents the optional template at the Keyword level to specify additional tracking parameters or redirects. New in the v3 Native & Search API.

string

Keyword Custom Parameters

Represents the optional ValueTrack parameters at the Keyword level to which you can assign your own IDs. New in the v3 Native & Search API.

string


Ad Extension

Name

Description

Type

Ad Extn ID

The ID of the ad extension. This is the primary key for this dimension and should be included in the report in order for other dimension attributes to be queried.

long

Ad Extn Type

The type of the ad extension.

enum

Ad Extn Parent Type

The parent type of the ad extension.

enum

Ad Extn Title

The title of the ad extension. Populated only for sitelinks.

string

Ad Extn Phone Number

The phone number associated with the ad extension. Applies to call extensions.

string


Geo

Name

Description

Type

WOE ID

The location ID. This is the primary key for this dimension and should be included in the report in order for other dimension attributes to be queried.

long

WOE Type

country, state, city, dma, zip

enum

WOE Name

The location Name.

string


product_categories

Name

Description

Type

Category ID

ID of the product category

long

Parent Category ID

ID of the parent product category

long

Category Name

Product category name

string

Category Path

The full category path

string

structured_snippet

Name

Description

Type

Structured Snippet Extn ID

The ID of the Structured Snippet extension. This is the primary key for this dimension and should be included in the report in order for other dimension attributes to be queried.

long

Structured Snippet Header

Structured Snippet header for which the ad click happens.

string

Structured Snippet Values

Structured Snippet values for which the ad click happens.

string

Status

Tells if the structured snippet extension is ON or not.

string