Package google.ads.googleads.v0.common

Index

AdScheduleInfo

Represents an AdSchedule criterion.

AdSchedule is specified as the day of the week and a time interval within which ads will be shown.

No more than six AdSchedules can be added for the same day.

Fields
start_minute

MinuteOfHour

Minutes after the start hour at which this schedule starts.

This field is required for CREATE operations and is prohibited on UPDATE operations.

end_minute

MinuteOfHour

Minutes after the end hour at which this schedule ends. The schedule is exclusive of the end minute.

This field is required for CREATE operations and is prohibited on UPDATE operations.

start_hour

Int32Value

Starting hour in 24 hour time. This field must be between 0 and 23, inclusive.

This field is required for CREATE operations and is prohibited on UPDATE operations.

end_hour

Int32Value

Ending hour in 24 hour time; 24 signifies end of the day. This field must be between 0 and 24, inclusive.

This field is required for CREATE operations and is prohibited on UPDATE operations.

day_of_week

DayOfWeek

Day of the week the schedule applies to.

This field is required for CREATE operations and is prohibited on UPDATE operations.

AddressInfo

Address for proximity criterion.

Fields
postal_code

StringValue

Postal code.

province_code

StringValue

Province or state code.

country_code

StringValue

Country code.

province_name

StringValue

Province or state name.

street_address

StringValue

Street address line 1.

street_address2

StringValue

Street address line 2. This field is write-only. It is only used for calculating the longitude and latitude of an address when geo_point is empty.

city_name

StringValue

Name of the city.

AgeRangeInfo

An age range criterion.

Fields
type

AgeRangeType

Type of the age range.

AppPaymentModelInfo

An app payment model criterion.

Fields
type

AppPaymentModelType

Type of the app payment model.

BasicUserListInfo

User list targeting as a collection of conversions or remarketing actions.

Fields
actions[]

UserListActionInfo

Actions associated with this user list.

CallOnlyAdInfo

A call-only ad.

Fields
country_code

StringValue

The country code in the ad.

phone_number

StringValue

The phone number in the ad.

business_name

StringValue

The business name in the ad.

description1

StringValue

The first line of the ad's description.

description2

StringValue

The second line of the ad's description.

call_tracked

BoolValue

Whether to enable call tracking for the creative. Enabling call tracking also enables call conversions.

disable_call_conversion

BoolValue

Whether to disable call conversion for the creative. If set to true, disables call conversions even when call_tracked is true. If call_tracked is false, this field is ignored.

phone_number_verification_url

StringValue

The URL to be used for phone number verification.

conversion_action

StringValue

The conversion action to attribute a call conversion to. If not set a default conversion action is used. This field only has effect if call_tracked is set to true. Otherwise this field is ignored.

conversion_reporting_state

CallConversionReportingState

The call conversion behavior of this call only ad. It can use its own call conversion setting, inherit the account level setting, or be disabled.

CarrierInfo

Represents a Carrier Criterion.

Fields
carrier_constant

StringValue

The Carrier constant resource name.

CombinedRuleUserListInfo

User lists defined by combining two rules, left operand and right operand. There are two operators: AND where left operand and right operand have to be true; AND_NOT where left operand is true but right operand is false.

Fields
left_operand

UserListRuleInfo

Left operand of the combined rule. This field is required and must be populated when creating new combined rule based user list.

right_operand

UserListRuleInfo

Right operand of the combined rule. This field is required and must be populated when creating new combined rule based user list.

rule_operator

UserListCombinedRuleOperator

Operator to connect the two operands.

Required for creating a combined rule user list.

ContentLabelInfo

Content Label for category exclusion.

Fields
type

ContentLabelType

Content label type, required for CREATE operations.

CriterionCategoryAvailability

Information of category availability, per advertising channel.

Fields
channel

CriterionCategoryChannelAvailability

Channel types and subtypes that are available to the category.

locale[]

CriterionCategoryLocaleAvailability

Locales that are available to the category for the channel.

CriterionCategoryChannelAvailability

Information of advertising channel type and subtypes a category is available in.

Fields
availability_mode

CriterionCategoryChannelAvailabilityMode

Format of the channel availability. Can be ALL_CHANNELS (the rest of the fields will not be set), CHANNEL_TYPE (only advertising_channel_type type will be set, the category is available to all sub types under it) or CHANNEL_TYPE_AND_SUBTYPES (advertising_channel_type, advertising_channel_sub_type, and include_default_channel_sub_type will all be set).

advertising_channel_type

AdvertisingChannelType

Channel type the category is available to.

advertising_channel_sub_type[]

AdvertisingChannelSubType

Channel subtypes under the channel type the category is available to.

include_default_channel_sub_type

BoolValue

Whether default channel sub type is included. For example, advertising_channel_type being DISPLAY and include_default_channel_sub_type being false means that the default display campaign where channel sub type is not set is not included in this availability configuration.

CriterionCategoryLocaleAvailability

Information about which locales a category is available in.

Fields
availability_mode

CriterionCategoryLocaleAvailabilityMode

Format of the locale availability. Can be LAUNCHED_TO_ALL (both country and language will be empty), COUNTRY (only country will be set), LANGUAGE (only language wil be set), COUNTRY_AND_LANGUAGE (both country and language will be set).

country_code

StringValue

Code of the country.

language_code

StringValue

Code of the language.

CrmBasedUserListInfo

UserList of CRM users provided by the advertiser.

Fields
app_id

StringValue

A string that uniquely identifies a mobile application from which the data was collected to the Google Ads API. For iOS, the ID string is the 9 digit string that appears at the end of an App Store URL (e.g., "476943146" for "Flood-It! 2" whose App Store link is http://itunes.apple.com/us/app/flood-it!-2/id476943146). For Android, the ID string is the application's package name (e.g., "com.labpixies.colordrips" for "Color Drips" given Google Play link https://play.google.com/store/apps/details?id=com.labpixies.colordrips). Required when creating CrmBasedUserList for uploading mobile advertising IDs.

upload_key_type

CustomerMatchUploadKeyType

Matching key type of the list. Mixed data types are not allowed on the same list. This field is required for an ADD operation.

data_source_type

UserListCrmDataSourceType

Data source of the list. Default value is FIRST_PARTY. Only whitelisted customers can create third-party sourced CRM lists.

CustomParameter

A mapping that can be used by custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls.

Fields
key

StringValue

The key matching the parameter tag name.

value

StringValue

The value to be substituted.

DateRange

A date range.

Fields
start_date

StringValue

The start date, in yyyy-mm-dd format.

end_date

StringValue

The end date, in yyyy-mm-dd format.

DateSpecificRuleUserListInfo

Visitors of a page during specific dates.

Fields
rule

UserListRuleInfo

Boolean rule that defines visitor of a page.

Required for creating a date specific rule user list.

start_date

StringValue

Start date of users visit. If set to 2000-01-01, then the list includes all users before end_date. The date's format should be YYYY-MM-DD.

Required for creating a data specific rule user list.

end_date

StringValue

End date of users visit. If set to 2037-12-30, then the list includes all users after start_date. The date's format should be YYYY-MM-DD.

Required for creating a data specific rule user list.

DeviceInfo

A device criterion.

Fields
type

Device

Type of the device.

DisplayCallToAction

Data for display call to action. The call to action is a piece of the ad that prompts the user to do something. Like clicking a link or making a phone call.

Fields
text

StringValue

Text for the display-call-to-action.

text_color

StringValue

Text color for the display-call-to-action in hexadecimal, e.g. #ffffff for white.

DynamicSearchAdInfo

A dynamic search ad.

Fields
description1

StringValue

The first line of the ad's description.

description2

StringValue

The second line of the ad's description.

EnhancedCpc

An automated bidding strategy that raises bids for clicks that seem more likely to lead to a conversion and lowers them for clicks where they seem less likely.

ExpandedDynamicSearchAdInfo

An expanded dynamic search ad.

Fields
description

StringValue

The description of the ad.

ExpandedTextAdInfo

An expanded text ad.

Fields
headline_part1

StringValue

The first part of the ad's headline.

headline_part2

StringValue

The second part of the ad's headline.

headline_part3

StringValue

The third part of the ad's headline.

description

StringValue

The description of the ad.

description2

StringValue

The second description of the ad.

path1

StringValue

The text that can appear alongside the ad's displayed URL.

path2

StringValue

Additional text that can appear alongside the ad's displayed URL.

ExplorerAutoOptimizerSetting

Settings for the Display Campaign Optimizer, initially termed "Explorer".

Fields
opt_in

BoolValue

Indicates whether the optimizer is turned on.

ExpressionRuleUserListInfo

Visitors of a page. The page visit is defined by one boolean rule expression.

Fields
rule

UserListRuleInfo

Boolean rule that defines this user list. The rule consists of a list of rule item groups and each rule item group consists of a list of rule items. All the rule item groups are ORed or ANDed together for evaluation based on rule.rule_type.

Required for creating an expression rule user list.

FrequencyCapEntry

A rule specifying the maximum number of times an ad (or some set of ads) can be shown to a user over a particular time period.

Fields
key

FrequencyCapKey

The key of a particular frequency cap. There can be no more than one frequency cap with the same key.

cap

Int32Value

Maximum number of events allowed during the time range by this cap.

FrequencyCapKey

A group of fields used as keys for a frequency cap. There can be no more than one frequency cap with the same key.

Fields
level

FrequencyCapLevel

The level on which the cap is to be applied (e.g. ad group ad, ad group). The cap is applied to all the entities of this level.

event_type

FrequencyCapEventType

The type of event that the cap applies to (e.g. impression).

time_unit

FrequencyCapTimeUnit

Unit of time the cap is defined at (e.g. day, week).

time_length

Int32Value

Number of time units the cap lasts.

GenderInfo

A gender criterion.

Fields
type

GenderType

Type of the gender.

GeoPointInfo

Geo point for proximity criterion.

Fields
longitude_in_micro_degrees

Int32Value

Micro degrees for the longitude.

latitude_in_micro_degrees

Int32Value

Micro degrees for the latitude.

GmailAdInfo

A Gmail ad.

Fields
teaser

GmailTeaser

The Gmail teaser.

header_image

StringValue

The MediaFile resource name of the header image. Valid image types are GIF, JPEG and PNG. The minimum size is 300x100 pixels and the aspect ratio must be between 3:1 and 5:1 (+-1%).

marketing_image

StringValue

The MediaFile resource name of the marketing image. Valid image types are GIF, JPEG and PNG. The image must either be landscape with a minimum size of 600x314 pixels and aspect ratio of 600:314 (+-1%) or square with a minimum size of 300x300 pixels and aspect ratio of 1:1 (+-1%)

marketing_image_headline

StringValue

Headline of the marketing image.

marketing_image_description

StringValue

Description of the marketing image.

marketing_image_display_call_to_action

DisplayCallToAction

Display-call-to-action of the marketing image.

GmailTeaser

Gmail teaser data. The teaser is a small header that acts as an invitation to view the rest of the ad (the body).

Fields
headline

StringValue

Headline of the teaser.

description

StringValue

Description of the teaser.

business_name

StringValue

Business name of the advertiser.

logo_image

StringValue

The MediaFile resource name of the logo image. Valid image types are GIF, JPEG and PNG. The minimum size is 144x144 pixels and the aspect ratio must be 1:1 (+-1%).

HotelAdInfo

A hotel ad.

HotelAdvanceBookingWindowInfo

Criterion for number of days prior to the stay the booking is being made.

Fields
min_days

Int64Value

Low end of the number of days prior to the stay.

max_days

Int64Value

High end of the number of days prior to the stay.

HotelCheckInDayInfo

Criterion for day of the week the booking is for.

Fields
day_of_week

DayOfWeek

The day of the week.

HotelCityInfo

City the hotel is located in.

Fields
city_criterion

StringValue

The Geo Target Constant resource name.

HotelClassInfo

Class of the hotel as a number of stars 1 to 5.

Fields
value

Int64Value

Long value of the hotel class.

HotelCountryRegionInfo

Country or Region the hotel is located in.

Fields
country_region_criterion

StringValue

The Geo Target Constant resource name.

HotelDateSelectionTypeInfo

Criterion for hotel date selection (default dates vs. user selected).

Fields
type

HotelDateSelectionType

Type of the hotel date selection

HotelIdInfo

Advertiser-specific hotel ID.

Fields
value

StringValue

String value of the hotel ID.

HotelLengthOfStayInfo

Criterion for length of hotel stay in nights.

Fields
min_nights

Int64Value

Low end of the number of nights in the stay.

max_nights

Int64Value

High end of the number of nights in the stay.

HotelStateInfo

State the hotel is located in.

Fields
state_criterion

StringValue

The Geo Target Constant resource name.

ImageAdInfo

An image ad.

Fields
pixel_width

Int64Value

Width in pixels of the full size image.

pixel_height

Int64Value

Height in pixels of the full size image.

image_url

StringValue

URL of the full size image.

preview_pixel_width

Int64Value

Width in pixels of the preview size image.

preview_pixel_height

Int64Value

Height in pixels of the preview size image.

preview_image_url

StringValue

URL of the preview size image.

mime_type

MimeType

The mime type of the image.

name

StringValue

The name of the image. If the image was created from a MediaFile, this is the MediaFile's name. If the image was created from bytes, this is empty.

Union field image. The image to create the ImageAd from. This can be specified in one of two ways. 1. An existing MediaFile resource. 2. The raw image data as bytes. image can be only one of the following:
media_file

StringValue

The MediaFile resource to use for the image.

data

BytesValue

Raw image data as bytes.

IncomeRangeInfo

An income range criterion.

Fields
type

IncomeRangeType

Type of the income range.

InteractionTypeInfo

Criterion for Interaction Type.

Fields
type

InteractionType

The interaction type.

IpBlockInfo

An IpBlock criterion used for IP exclusions. We allow: - IPv4 and IPv6 addresses - individual addresses (192.168.0.1) - masks for individual addresses (192.168.0.1/32) - masks for Class C networks (192.168.0.1/24)

Fields
ip_address

StringValue

The IP address of this IP block.

KeywordInfo

A keyword criterion.

Fields
text

StringValue

The text of the keyword (at most 80 characters and 10 words).

match_type

KeywordMatchType

The match type of the keyword.

KeywordPlanHistoricalMetrics

Historical metrics.

Fields
avg_monthly_searches

Int64Value

Average monthly searches for the past 12 months.

competition

KeywordPlanCompetitionLevel

The competition level for the query.

LanguageInfo

A language criterion.

Fields
language_constant

StringValue

The language constant resource name.

ListingBrandInfo

Brand of the listing.

Fields
value

StringValue

String value of the listing brand.

ListingCustomAttributeInfo

Listing custom attribute.

Fields
value

StringValue

String value of the listing custom attribute.

index

ListingCustomAttributeIndex

Indicates the index of the custom attribute.

ListingDimensionInfo

Listing dimensions for listing group criterion.

Fields
Union field dimension. Dimension of one of the types below is always present. dimension can be only one of the following:
listing_brand

ListingBrandInfo

Brand of the listing.

hotel_id

HotelIdInfo

Advertiser-specific hotel ID.

hotel_class

HotelClassInfo

Class of the hotel as a number of stars 1 to 5.

hotel_country_region

HotelCountryRegionInfo

Country or Region the hotel is located in.

hotel_state

HotelStateInfo

State the hotel is located in.

hotel_city

HotelCityInfo

City the hotel is located in.

listing_custom_attribute

ListingCustomAttributeInfo

Listing custom attribute.

product_channel

ProductChannelInfo

Locality of a product offer.

product_channel_exclusivity

ProductChannelExclusivityInfo

Availability of a product offer.

product_condition

ProductConditionInfo

Condition of a product offer.

product_item_id

ProductItemIdInfo

Item id of a product offer.

product_type

ProductTypeInfo

Type of a product offer.

ListingGroupInfo

A listing group criterion.

Fields
type

ListingGroupType

Type of the listing group.

case_value

ListingDimensionInfo

Dimension value with which this listing group is refining its parent. Undefined for the root group.

parent_ad_group_criterion

StringValue

Resource name of ad group criterion which is the parent listing group subdivision. Null for the root group.

ListingScopeInfo

A listing scope criterion.

Fields
dimensions[]

ListingDimensionInfo

Scope of the campaign criterion.

LocationInfo

A location criterion.

Fields
geo_target_constant

StringValue

The geo target constant resource name.

LogicalUserListInfo

Represents a user list that is a custom combination of user lists.

Fields
rules[]

UserListLogicalRuleInfo

Logical list rules that define this user list. The rules are defined as a logical operator (ALL/ANY/NONE) and a list of user lists. All the rules are ANDed when they are evaluated.

Required for creating a logical user list.

LogicalUserListOperandInfo

Operand of logical user list that consists of a user list.

Fields
user_list

StringValue

Resource name of a user list as an operand.

ManualCpc

Manual click-based bidding where user pays per click.

Fields
enhanced_cpc_enabled

BoolValue

Whether bids are to be enhanced based on conversion optimizer data.

ManualCpm

Manual impression-based bidding where user pays per thousand impressions.

ManualCpv

View based bidding where user pays per video view.

MatchingFunction

Matching function associated with a CustomerFeed, CampaignFeed, or AdGroupFeed. The matching function is used to filter the set of feed items selected.

Fields
function_string

StringValue

String representation of the Function.

Examples: 1) IDENTITY(true) or IDENTITY(false). All or none feed items serve. 2) EQUALS(CONTEXT.DEVICE,"Mobile") 3) IN(FEED_ITEM_ID,{1000001,1000002,1000003}) 4) CONTAINS_ANY(FeedAttribute[12345678,0],{"Mars cruise","Venus cruise"}) 5) AND(IN(FEED_ITEM_ID,{10001,10002}),EQUALS(CONTEXT.DEVICE,"Mobile")) See

https: //developers.google.com/adwords/api/docs/guides/feed-matching-functions

Note that because multiple strings may represent the same underlying function (whitespace and single versus double quotation marks, for example), the value returned may not be identical to the string sent in a mutate request.

MaximizeConversionValue

An automated bidding strategy which tries to maximize conversion value given a daily budget.

Fields
target_roas

DoubleValue

The target return on ad spend (ROAS) option. If set, the bid strategy will maximize revenue while averaging the target return on ad spend. If the target ROAS is high, the bid strategy may not be able to spend the full budget. If the target ROAS is not set, the bid strategy will aim to achieve the highest possible ROAS for the budget.

MaximizeConversions

An automated bidding strategy that sets bids to help get the most conversions for your campaign while spending your budget.

Metrics

Metrics data.

Fields
absolute_top_impression_percentage

DoubleValue

The percent of your ad impressions that are shown as the very first ad above the organic search results.

active_view_cpm

DoubleValue

Average cost of viewable impressions (active_view_impressions).

active_view_ctr

DoubleValue

Active view measurable clicks divided by active view viewable impressions. This metric is reported only for display network.

active_view_impressions

Int64Value

A measurement of how often your ad has become viewable on a Display Network site.

active_view_measurability

DoubleValue

The ratio of impressions that could be measured by Active View over the number of served impressions.

active_view_measurable_cost_micros

Int64Value

The cost of the impressions you received that were measurable by Active View.

active_view_measurable_impressions

Int64Value

The number of times your ads are appearing on placements in positions where they can be seen.

active_view_viewability

DoubleValue

The percentage of time when your ad appeared on an Active View enabled site (measurable impressions) and was viewable (viewable impressions).

all_conversions_from_interactions_rate

DoubleValue

All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions.

all_conversions_value

DoubleValue

The total value of all conversions.

all_conversions

DoubleValue

The total number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true.

all_conversions_value_per_cost

DoubleValue

The value of all conversions divided by the total cost of ad interactions (such as clicks for text ads or views for video ads).

all_conversions_from_interactions_value_per_interaction

DoubleValue

The value of all conversions from interactions divided by the total number of interactions.

average_cost

DoubleValue

The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions.

average_cpc

DoubleValue

The total cost of all clicks divided by the total number of clicks received.

average_cpe

DoubleValue

The average amount that you've been charged for an ad engagement. This amount is the total cost of all ad engagements divided by the total number of ad engagements.

average_cpm

DoubleValue

Average cost-per-thousand impressions (CPM).

average_cpv

DoubleValue

The average amount you pay each time someone views your ad. The average CPV is defined by the total cost of all ad views divided by the number of views.

average_frequency

DoubleValue

Average number of times a unique cookie was exposed to your ad over a given time period. Imported from Google Analytics.

average_page_views

DoubleValue

Average number of pages viewed per session.

average_position

DoubleValue

Your ad's position relative to those of other advertisers.

average_time_on_site

DoubleValue

Total duration of all sessions (in seconds) / number of sessions. Imported from Google Analytics.

benchmark_average_max_cpc

DoubleValue

An indication of how other advertisers are bidding on similar products.

benchmark_ctr

DoubleValue

An indication on how other advertisers' Shopping ads for similar products are performing based on how often people who see their ad click on it.

bounce_rate

DoubleValue

Percentage of clicks where the user only visited a single page on your site. Imported from Google Analytics.

clicks

Int64Value

The number of clicks.

content_budget_lost_impression_share

DoubleValue

The estimated percent of times that your ad was eligible to show on the Display Network but didn't because your budget was too low. Note: Content budget lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.

content_impression_share

DoubleValue

The impressions you've received on the Display Network divided by the estimated number of impressions you were eligible to receive. Note: Content impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999.

conversion_last_received_request_date_time

StringValue

The last date/time a conversion tag for this conversion action successfully fired and was seen by Google Ads. This firing event may not have been the result of an attributable conversion (e.g. because the tag was fired from a browser that did not previously click an ad from an appropriate advertiser). The date/time is in the customer's time zone.

conversion_last_conversion_date

StringValue

The date of the most recent conversion for this conversion action. The date is in the customer's time zone.

content_rank_lost_impression_share

DoubleValue

The estimated percentage of impressions on the Display Network that your ads didn't receive due to poor Ad Rank. Note: Content rank lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.

conversions_from_interactions_rate

DoubleValue

Conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which include_in_conversions_metric attribute is set to true.

conversions_value

DoubleValue

The total value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true.

conversions_value_per_cost

DoubleValue

The value of conversions divided by the cost of ad interactions. This only includes conversion actions which include_in_conversions_metric attribute is set to true.

conversions_from_interactions_value_per_interaction

DoubleValue

The value of conversions from interactions divided by the number of ad interactions. This only includes conversion actions which include_in_conversions_metric attribute is set to true.

conversions

DoubleValue

The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true.

cost_micros

Int64Value

The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period.

cost_per_all_conversions

DoubleValue

The cost of ad interactions divided by all conversions.

cost_per_conversion

DoubleValue

The cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true.

cost_per_current_model_attributed_conversion

DoubleValue

The cost of ad interactions divided by current model attributed conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true.

cross_device_conversions

DoubleValue

Conversions from when a customer clicks on a Google Ads ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions.

ctr

DoubleValue

The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions).

current_model_attributed_conversions

DoubleValue

Shows how your historic conversions data would look under the attribution model you've currently selected. This only includes conversion actions which include_in_conversions_metric attribute is set to true.

current_model_attributed_conversions_from_interactions_rate

DoubleValue

Current model attributed conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which include_in_conversions_metric attribute is set to true.

current_model_attributed_conversions_from_interactions_value_per_interaction

DoubleValue

The value of current model attributed conversions from interactions divided by the number of ad interactions. This only includes conversion actions which include_in_conversions_metric attribute is set to true.

current_model_attributed_conversions_value

DoubleValue

The total value of current model attributed conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true.

current_model_attributed_conversions_value_per_cost

DoubleValue

The value of current model attributed conversions divided by the cost of ad interactions. This only includes conversion actions which include_in_conversions_metric attribute is set to true.

engagement_rate

DoubleValue

How often people engage with your ad after it's shown to them. This is the number of ad expansions divided by the number of times your ad is shown.

engagements

Int64Value

The number of engagements. An engagement occurs when a viewer expands your Lightbox ad. Also, in the future, other ad types may support engagement metrics.

hotel_average_lead_value_micros

DoubleValue

Average lead value of hotel.

historical_creative_quality_score

QualityScoreBucket

The creative historical quality score.

historical_landing_page_quality_score

QualityScoreBucket

The quality of historical landing page experience.

historical_quality_score

Int64Value

The historical quality score.

historical_search_predicted_ctr

QualityScoreBucket

The historical search predicted click through rate (CTR).

gmail_forwards

Int64Value

The number of times the ad was forwarded to someone else as a message.

gmail_saves

Int64Value

The number of times someone has saved your Gmail ad to their inbox as a message.

gmail_secondary_clicks

Int64Value

The number of clicks to the landing page on the expanded state of Gmail ads.

impression_reach

Int64Value

Number of unique cookies that were exposed to your ad over a given time period.

impressions

Int64Value

Count of how often your ad has appeared on a search results page or website on the Google Network.

interaction_rate

DoubleValue

How often people interact with your ad after it is shown to them. This is the number of interactions divided by the number of times your ad is shown.

interactions

Int64Value

The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on.

interaction_event_types[]

InteractionEventType

The types of payable and free interactions.

invalid_click_rate

DoubleValue

The percentage of clicks filtered out of your total number of clicks (filtered + non-filtered clicks) during the reporting period.

invalid_clicks

Int64Value

Number of clicks Google considers illegitimate and doesn't charge you for.

percent_new_visitors

DoubleValue

Percentage of first-time sessions (from people who had never visited your site before). Imported from Google Analytics.

phone_calls

Int64Value

Number of offline phone calls.

phone_impressions

Int64Value

Number of offline phone impressions.

phone_through_rate

DoubleValue

Number of phone calls received (phone_calls) divided by the number of times your phone number is shown (phone_impressions).

relative_ctr

DoubleValue

Your clickthrough rate (Ctr) divided by the average clickthrough rate of all advertisers on the websites that show your ads. Measures how your ads perform on Display Network sites compared to other ads on the same sites.

search_absolute_top_impression_share

DoubleValue

The percentage of the customer's Shopping or Search ad impressions that are shown in the most prominent Shopping position. See this Merchant Center article for details. Any value below 0.1 is reported as 0.0999.

search_budget_lost_absolute_top_impression_share

DoubleValue

The number estimating how often your ad wasn't the very first ad above the organic search results due to a low budget. Note: Search budget lost absolute top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.

search_budget_lost_impression_share

DoubleValue

The estimated percent of times that your ad was eligible to show on the Search Network but didn't because your budget was too low. Note: Search budget lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.

search_budget_lost_top_impression_share

DoubleValue

The number estimating how often your ad didn't show anywhere above the organic search results due to a low budget. Note: Search budget lost top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.

search_click_share

DoubleValue

The number of clicks you've received on the Search Network divided by the estimated number of clicks you were eligible to receive. Note: Search click share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999.

search_exact_match_impression_share

DoubleValue

The impressions you've received divided by the estimated number of impressions you were eligible to receive on the Search Network for search terms that matched your keywords exactly (or were close variants of your keyword), regardless of your keyword match types. Note: Search exact match impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999.

search_impression_share

DoubleValue

The impressions you've received on the Search Network divided by the estimated number of impressions you were eligible to receive. Note: Search impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999.

search_rank_lost_absolute_top_impression_share

DoubleValue

The number estimating how often your ad wasn't the very first ad above the organic search results due to poor Ad Rank. Note: Search rank lost absolute top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.

search_rank_lost_impression_share

DoubleValue

The estimated percentage of impressions on the Search Network that your ads didn't receive due to poor Ad Rank. Note: Search rank lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.

search_rank_lost_top_impression_share

DoubleValue

The number estimating how often your ad didn't show anywhere above the organic search results due to poor Ad Rank. Note: Search rank lost top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.

search_top_impression_share

DoubleValue

The impressions you've received in the top location (anywhere above the organic search results) compared to the estimated number of impressions you were eligible to receive in the top location. Note: Search top impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999.

top_impression_percentage

DoubleValue

The percent of your ad impressions that are shown anywhere above the organic search results.

value_per_all_conversions

DoubleValue

The value of all conversions divided by the number of all conversions.

value_per_conversion

DoubleValue

The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true.

value_per_current_model_attributed_conversion

DoubleValue

The value of current model attributed conversions divided by the number of the conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true.

video_quartile_100_rate

DoubleValue

Percentage of impressions where the viewer watched all of your video.

video_quartile_25_rate

DoubleValue

Percentage of impressions where the viewer watched 25% of your video.

video_quartile_50_rate

DoubleValue

Percentage of impressions where the viewer watched 50% of your video.

video_quartile_75_rate

DoubleValue

Percentage of impressions where the viewer watched 75% of your video.

video_view_rate

DoubleValue

The number of views your TrueView video ad receives divided by its number of impressions, including thumbnail impressions for TrueView in-display ads.

video_views

Int64Value

The number of times your video ads were viewed.

view_through_conversions

Int64Value

The total number of view-through conversions. These happen when a customer sees an image or rich media ad, then later completes a conversion on your site without interacting with (e.g., clicking on) another ad.

MobileAppCategoryInfo

A mobile app category criterion.

Fields
mobile_app_category_constant

StringValue

The mobile app category constant resource name.

Money

Represents a price in a particular currency.

Fields
currency_code

StringValue

Three-character ISO 4217 currency code.

amount_micros

Int64Value

Amount in micros. One million is equivalent to one unit.

OperatingSystemVersionInfo

Represents an operating system version to be targeted.

Fields
operating_system_version_constant

StringValue

The operating system version constant resource name.

PageOnePromoted

An automated bidding strategy which sets CPC bids to target impressions on page one, or page one promoted slots on google.com.

Fields
strategy_goal

PageOnePromotedStrategyGoal

The strategy goal of where impressions are desired to be shown on search result pages.

cpc_bid_ceiling_micros

Int64Value

Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy.

bid_modifier

DoubleValue

Bid multiplier to be applied to the relevant bid estimate (depending on the strategy_goal) in determining a keyword's new CPC bid.

only_raise_cpc_bids

BoolValue

Whether the strategy should always follow bid estimate changes, or only increase. If false, always sets a keyword's new bid to the current bid estimate. If true, only updates a keyword's bid if the current bid estimate is greater than the current bid.

raise_cpc_bid_when_budget_constrained

BoolValue

Whether the strategy is allowed to raise bids when the throttling rate of the budget it is serving out of rises above a threshold.

raise_cpc_bid_when_quality_score_is_low

BoolValue

Whether the strategy is allowed to raise bids on keywords with lower-range quality scores.

ParentalStatusInfo

A parental status criterion.

Fields
type

ParentalStatusType

Type of the parental status.

PercentCpc

A bidding strategy where bids are a fraction of the advertised price for some good or service.

Fields
cpc_bid_ceiling_micros

Int64Value

Maximum bid limit that can be set by the bid strategy. This is an optional field entered by the advertiser and specified in local micros. Note: A zero value is interpreted in the same way as having bid_ceiling undefined.

enhanced_cpc_enabled

BoolValue

Adjusts the bid for each auction upward or downward, depending on the likelihood of a conversion. Individual bids may exceed cpc_bid_ceiling_micros, but the average bid amount for a campaign should not.

PlacementInfo

A placement criterion. This can be used to modify bids for sites when targeting the content network.

Fields
url

StringValue

URL of the placement.

For example, "http://www.domain.com".

PolicyTopicConstraint

Describes the effect on serving that a policy topic entry will have.

Next Id: 5

Fields
Union field value. Specific information about the constraint. value can be only one of the following:
country_constraint_list

CountryConstraintList

Countries where the resource cannot serve.

reseller_constraint

ResellerConstraint

Reseller constraint.

certificate_missing_in_country_list

CountryConstraintList

Countries where a certificate is required for serving.

certificate_domain_mismatch_in_country_list

CountryConstraintList

Countries where the resource's domain is not covered by the certificates associated with it.

CountryConstraint

Indicates that a resource's ability to serve in a particular country is constrained.

Next Id: 2

Fields
country_criterion

StringValue

Geo target constant resource name of the country in which serving is constrained.

CountryConstraintList

A list of countries where a resource's serving is constrained.

Next Id: 3

Fields
total_targeted_countries

Int32Value

Total number of countries targeted by the resource.

countries[]

CountryConstraint

Countries in which serving is restricted.

ResellerConstraint

Indicates that a policy topic was constrained due to disapproval of the website for reseller purposes.

Next Id: 1

PolicyTopicEntry

Policy finding attached to a resource (e.g. alcohol policy associated with a site that sells alcohol).

Each PolicyTopicEntry has a topic that indicates the specific ads policy the entry is about and a type to indicate the effect that the entry will have on serving. It may optionally have one or more evidences that indicate the reason for the finding. It may also optionally have one or more constraints that provide details about how serving may be restricted.

Next tag: 5

Fields
topic

StringValue

Policy topic this finding refers to. For example, "ALCOHOL", "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible policy topics is not fixed for a particular API version and may change at any time.

type

PolicyTopicEntryType

Describes the negative or positive effect this policy will have on serving.

evidences[]

PolicyTopicEvidence

Additional information that explains policy finding (e.g. the brand name for a trademark finding).

constraints[]

PolicyTopicConstraint

Indicates how serving of this resource may be affected (e.g. not serving in a country).

PolicyTopicEvidence

Additional information that explains a policy finding.

Next Id: 8

Fields
Union field value. Specific evidence information depending on the evidence type. value can be only one of the following:
http_code

Int32Value

HTTP code returned when the final URL was crawled.

website_list

WebsiteList

List of websites linked with this resource.

text_list

TextList

List of evidence found in the text of a resource.

language_code

StringValue

The language the resource was detected to be written in. This is an IETF language tag such as "en-US".

destination_text_list

DestinationTextList

The text in the destination of the resource that is causing a policy finding.

destination_mismatch

DestinationMismatch

Mismatch between the destinations of a resource's URLs.

DestinationMismatch

Evidence of mismatches between the URLs of a resource.

Next Id: 2

Fields
url_types[]

PolicyTopicEvidenceDestinationMismatchUrlType

The set of URLs that did not match each other.

DestinationTextList

A list of strings found in a destination page that caused a policy finding.

Next Id: 2

Fields
destination_texts[]

StringValue

List of text found in the resource's destination page.

TextList

A list of fragments of text that violated a policy.

Next Id: 2

Fields
texts[]

StringValue

The fragments of text from the resource that caused the policy finding.

WebsiteList

A list of websites that caused a policy finding. Used for ONE_WEBSITE_PER_AD_GROUP policy topic, for example. In case there are more than five websites, only the top five (those that appear in resources the most) will be listed here.

Next Id: 2

Fields
websites[]

StringValue

Websites that caused the policy finding.

PolicyValidationParameter

Parameter for controlling how policy exemption is done. Ignorable policy topics are only usable with expanded text ads and responsive search ads. All other ad types must use policy violation keys.

Fields
ignorable_policy_topics[]

StringValue

The list of policy topics that should not cause a PolicyFindingError to be reported. This field is currently only compatible with Enhanced Text Ad. It corresponds to the PolicyTopicEntry.topic field.

Resources violating these policies will be saved, but will not be eligible to serve. They may begin serving at a later time due to a change in policies, re-review of the resource, or a change in advertiser certificates.

PolicyViolationKey

Key of the violation. The key is used for referring to a violation when filing an exemption request.

Fields
policy_name

StringValue

Unique ID of the violated policy.

violating_text

StringValue

The text that violates the policy if specified. Otherwise, refers to the policy in general (e.g., when requesting to be exempt from the whole policy). If not specified for criterion exemptions, the whole policy is implied. Must be specified for ad exemptions.

PreferredContentInfo

A preferred content criterion.

Fields
type

PreferredContentType

Type of the preferred content.

ProductChannelExclusivityInfo

Availability of a product offer.

Fields
channel_exclusivity

ProductChannelExclusivity

Value of the availability.

ProductChannelInfo

Locality of a product offer.

Fields
channel

ProductChannel

Value of the locality.

ProductConditionInfo

Condition of a product offer.

Fields
condition

ProductCondition

Value of the condition.

ProductItemIdInfo

Item id of a product offer.

Fields
value

StringValue

Value of the id.

ProductTypeInfo

Type of a product offer.

Fields
value

StringValue

Value of the type.

level

ProductTypeLevel

Level of the type.

ProximityInfo

A Proximity criterion. The geo point and radius determine what geographical area is included. The address is a description of the geo point that does not affect ad serving.

There are two ways to create a proximity. First, by setting an address and radius. The geo point will be automatically computed. Second, by setting a geo point and radius. The address is an optional label that won't be validated.

Fields
geo_point

GeoPointInfo

Latitude and longitude.

radius

DoubleValue

The radius of the proximity.

radius_units

ProximityRadiusUnits

The unit of measurement of the radius. Default is KILOMETERS.

address

AddressInfo

Full address.

RealTimeBiddingSetting

Settings for Real-Time Bidding, a feature only available for campaigns targeting the Ad Exchange network.

Fields
opt_in

BoolValue

Whether the campaign is opted in to real-time bidding.

RuleBasedUserListInfo

Representation of a userlist that is generated by a rule.

Fields
prepopulation_status

UserListPrepopulationStatus

The status of pre-population. The field is default to NONE if not set which means the previous users will not be considered. If set to REQUESTED, past site visitors or app users who match the list definition will be included in the list (works on the Display Network only). This will only add past users from within the last 30 days, depending on the list's membership duration and the date when the remarketing tag is added. The status will be updated to FINISHED once request is processed, or FAILED if the request fails.

Union field rule_based_user_list. Subtypes of rule based user lists. rule_based_user_list can be only one of the following:
combined_rule_user_list

CombinedRuleUserListInfo

User lists defined by combining two rules. There are two operators: AND, where the left and right operands have to be true; AND_NOT where left operand is true but right operand is false.

date_specific_rule_user_list

DateSpecificRuleUserListInfo

Visitors of a page during specific dates. The visiting periods are defined as follows: Between start_date (inclusive) and end_date (inclusive); Before end_date (exclusive) with start_date = 2000-01-01; After start_date (exclusive) with end_date = 2037-12-30.

expression_rule_user_list

ExpressionRuleUserListInfo

Visitors of a page. The page visit is defined by one boolean rule expression.

Segments

Segment only fields.

Fields
ad_network_type

AdNetworkType

Ad network type.

conversion_attribution_event_type

ConversionAttributionEventType

Conversion attribution event type.

date

StringValue

Date to which metrics apply. yyyy-MM-dd format, e.g., 2018-04-17.

day_of_week

DayOfWeek

Day of the week, e.g., MONDAY.

device

Device

Device to which metrics apply.

hotel_booking_window_days

Int64Value

Hotel booking window in days.

hotel_center_id

Int64Value

Hotel center ID.

hotel_check_in_date

StringValue

Hotel check-in date. Formatted as yyyy-MM-dd.

hotel_check_in_day_of_week

DayOfWeek

Hotel check-in day of week.

hotel_city

StringValue

Hotel city.

hotel_class

Int32Value

Hotel class.

hotel_country

StringValue

Hotel country.

hotel_date_selection_type

HotelDateSelectionType

Hotel date selection type.

hotel_length_of_stay

Int32Value

Hotel length of stay.

hotel_state

StringValue

Hotel state.

hour

Int32Value

Hour of day as a number between 0 and 23, inclusive.

month

StringValue

Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd.

month_of_year

MonthOfYear

Month of the year, e.g., January.

partner_hotel_id

StringValue

Partner hotel ID.

placeholder_type

PlaceholderType

Placeholder type. This is only used with feed item metrics.

quarter

StringValue

Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, e.g., the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd.

search_term_match_type

SearchTermMatchType

Match type of the keyword that triggered the ad, including variants.

slot

Slot

Position of the ad.

week

StringValue

Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd.

year

Int32Value

Year, formatted as yyyy.

ShoppingProductAdInfo

A standard Shopping ad.

ShoppingSmartAdInfo

A Smart Shopping ad.

SimilarUserListInfo

SimilarUserList is a list of users which are similar to users from another UserList. These lists are read-only and automatically created by Google.

Fields
seed_user_list

StringValue

Seed UserList from which this list is derived.

TagSnippet

The site tag and event snippet pair for a TrackingCodeType.

Fields
type

TrackingCodeType

The type of the generated tag snippets for tracking conversions.

page_format

TrackingCodePageFormat

The format of the web page where the tracking tag and snippet will be installed, e.g. HTML.

global_site_tag

StringValue

The site tag that adds visitors to your basic remarketing lists and sets new cookies on your domain.

event_snippet

StringValue

The event snippet that works with the site tag to track actions that should be counted as conversions.

TargetCpa

An automated bid strategy that sets bids to help get as many conversions as possible at the target cost-per-acquisition (CPA) you set.

Fields
target_cpa_micros

Int64Value

Average CPA target. This target should be greater than or equal to minimum billable unit based on the currency for the account.

cpc_bid_ceiling_micros

Int64Value

Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy.

cpc_bid_floor_micros

Int64Value

Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy.

TargetCpm

Target CPM (cost per thousand impressions) is an automated bidding strategy that sets bids to optimize performance given the target CPM you set.

TargetOutrankShare

An automated bidding strategy that sets bids based on the target fraction of auctions where the advertiser should outrank a specific competitor.

Fields
target_outrank_share_micros

Int32Value

The target fraction of auctions where the advertiser should outrank the competitor. The advertiser outranks the competitor in an auction if either the advertiser appears above the competitor in the search results, or appears in the search results when the competitor does not. Value must be between 1 and 1000000, inclusive.

competitor_domain

StringValue

Competitor's visible domain URL.

cpc_bid_ceiling_micros

Int64Value

Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy.

only_raise_cpc_bids

BoolValue

Whether the strategy should always follow bid estimate changes, or only increase. If false, always set a keyword's new bid to the current bid estimate. If true, only updates a keyword's bid if the current bid estimate is greater than the current bid.

raise_cpc_bid_when_quality_score_is_low

BoolValue

Whether the strategy is allowed to raise bids on keywords with lower-range quality scores.

TargetRestriction

The list of per-targeting-dimension targeting settings.

Fields
targeting_dimension

TargetingDimension

The targeting dimension that these settings apply to.

bid_only

BoolValue

Indicates whether to restrict your ads to show only for the criteria you have selected for this targeting_dimension, or to target all values for this targeting_dimension and show ads based on your targeting in other TargetingDimensions. A value of 'true' means that these criteria will only apply bid modifiers, and not affect targeting. A value of 'false' means that these criteria will restrict targeting as well as applying bid modifiers.

TargetRoas

An automated bidding strategy that helps you maximize revenue while averaging a specific target return on ad spend (ROAS).

Fields
target_roas

DoubleValue

Required. The desired revenue (based on conversion data) per unit of spend. Value must be between 0.01 and 1000.0, inclusive.

cpc_bid_ceiling_micros

Int64Value

Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy.

cpc_bid_floor_micros

Int64Value

Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy.

TargetSpend

An automated bid strategy that sets your bids to help get as many clicks as possible within your budget.

Fields
target_spend_micros

Int64Value

The spend target under which to maximize clicks. A TargetSpend bidder will attempt to spend the smaller of this value or the natural throttling spend amount. If not specified, the budget is used as the spend target.

cpc_bid_ceiling_micros

Int64Value

Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy.

TargetingSetting

Settings for the targeting related features, at Campaign and AdGroup level.

Fields
target_restrictions[]

TargetRestriction

The per-targeting-dimension setting to restrict the reach of your campaign or ad group.

TextAdInfo

A text ad.

Fields
headline

StringValue

The headline of the ad.

description1

StringValue

The first line of the ad's description.

description2

StringValue

The second line of the ad's description.

TopicInfo

A topic criterion. Use topics to target or exclude placements in the Google Display Network based on the category into which the placement falls (for example, "Pets & Animals/Pets/Dogs").

Fields
topic_constant

StringValue

The Topic Constant resource name.

path[]

StringValue

The category to target or exclude. Each subsequent element in the array describes a more specific sub-category. For example, "Pets & Animals", "Pets", "Dogs" represents the "Pets & Animals/Pets/Dogs" category.

UserInterestInfo

Represents a particular interest-based topic to be targeted.

Fields
user_interest_category

StringValue

The UserInterest resource name.

UserListActionInfo

Represents an action type used for building remarketing user lists.

Fields
Union field user_list_action. Subtypes of user list action. user_list_action can be only one of the following:
conversion_action

StringValue

A conversion action that's not generated from remarketing.

remarketing_action

StringValue

A remarketing action.

UserListDateRuleItemInfo

A rule item composed of date operation.

Fields
operator

UserListDateRuleItemOperator

Date comparison operator. This field is required and must be populated when creating new date rule item.

value

StringValue

String representing date value to be compared with the rule variable. Supported date format is YYYY-MM-DD. Times are reported in the customer's time zone.

offset_in_days

Int64Value

The relative date value of the right hand side denoted by number of days offset from now. The value field will override this field when both are present.

UserListInfo

A User List criterion. Represents a user list that is defined by the advertiser to be targeted.

Fields
user_list

StringValue

The User List resource name.

UserListLogicalRuleInfo

A user list logical rule. A rule has a logical operator (and/or/not) and a list of user lists as operands.

Fields
operator

UserListLogicalRuleOperator

The logical operator of the rule.

rule_operands[]

LogicalUserListOperandInfo

The list of operands of the rule.

UserListNumberRuleItemInfo

A rule item composed of number operation.

Fields
operator

UserListNumberRuleItemOperator

Number comparison operator. This field is required and must be populated when creating a new number rule item.

value

DoubleValue

Number value to be compared with the variable. This field is required and must be populated when creating a new number rule item.

UserListRuleInfo

A client defined rule based on custom parameters sent by web sites or uploaded by the advertiser.

Fields
rule_type

UserListRuleType

Rule type is used to determine how to group rule items.

The default is OR of ANDs (disjunctive normal form). That is, rule items will be ANDed together within rule item groups and the groups themselves will be ORed together.

Currently AND of ORs (conjunctive normal form) is only supported for ExpressionRuleUserList.

rule_item_groups[]

UserListRuleItemGroupInfo

List of rule item groups that defines this rule. Rule item groups are grouped together based on rule_type.

UserListRuleItemGroupInfo

A group of rule items.

Fields
rule_items[]

UserListRuleItemInfo

Rule items that will be grouped together based on rule_type.

UserListRuleItemInfo

An atomic rule fragment.

Fields
name

StringValue

Rule variable name. It should match the corresponding key name fired by the pixel. A name must begin with US-ascii letters or underscore or UTF8 code that is greater than 127 and consist of US-ascii letters or digits or underscore or UTF8 code that is greater than 127. For websites, there are two built-in variable URL (name = 'url__') and referrer URL (name = 'ref_url__'). This field must be populated when creating a new rule item.

Union field rule_item. An atomic rule fragment. rule_item can be only one of the following:
number_rule_item

UserListNumberRuleItemInfo

An atomic rule fragment composed of a number operation.

string_rule_item

UserListStringRuleItemInfo

An atomic rule fragment composed of a string operation.

date_rule_item

UserListDateRuleItemInfo

An atomic rule fragment composed of a date operation.

UserListStringRuleItemInfo

A rule item fragment composed of date operation.

Fields
operator

UserListStringRuleItemOperator

String comparison operator. This field is required and must be populated when creating a new string rule item.

value

StringValue

The right hand side of the string rule item. For URLs or referrer URLs, the value can not contain illegal URL chars such as newlines, quotes, tabs, or parentheses. This field is required and must be populated when creating a new string rule item.

Value

A generic data container.

Fields
Union field value. A value. value can be only one of the following:
boolean_value

bool

A boolean.

int64_value

int64

An int64.

float_value

float

A float.

double_value

double

A double.

string_value

string

A string.

VideoAdInfo

A video ad.

Fields
media_file

StringValue

The MediaFile resource to use for the video.

in_stream

VideoTrueViewInStreamAdInfo

Video TrueView in-stream ad format.

VideoTrueViewInStreamAdInfo

Representation of video TrueView in-stream ad format (ad shown during video playback, often at beginning, which displays a skip button a few seconds into the video).

Fields
action_button_label

StringValue

Label on the CTA (call-to-action) button taking the user to the video ad's final URL. Required for TrueView for action campaigns, optional otherwise.

action_headline

StringValue

Additional text displayed with the CTA (call-to-action) button to give context and encourage clicking on the button.

WebpageConditionInfo

Logical expression for targeting webpages of an advertiser's website.

Fields
operand

WebpageConditionOperand

Operand of webpage targeting condition.

operator

WebpageConditionOperator

Operator of webpage targeting condition.

argument

StringValue

Argument of webpage targeting condition.

WebpageInfo

Represents a criterion for targeting webpages of an advertiser's website.

Fields
criterion_name

StringValue

The name of the criterion that is defined by this parameter. The name value will be used for identifying, sorting and filtering criteria with this type of parameters.

This field is required for CREATE operations and is prohibited on UPDATE operations.

conditions[]

WebpageConditionInfo

Conditions, or logical expressions, for webpage targeting. The list of webpage targeting conditions are and-ed together when evaluated for targeting.

This field is required for CREATE operations and is prohibited on UPDATE operations.

YouTubeChannelInfo

A YouTube Channel criterion.

Fields
channel_id

StringValue

The YouTube uploader channel id or the channel code of a YouTube channel.

YouTubeVideoInfo

A YouTube Video criterion.

Fields
video_id

StringValue

YouTube video id as it appears on the YouTube watch page.

Send feedback about...

Google Ads API
Google Ads API
Need help? Visit our support page.