Package google.ads.searchads360.v0.common

Stay organized with collections Save and categorize content based on your preferences.

Index

AgeRangeInfo

An age range criterion.

Fields
type

AgeRangeType

Type of the age range.

CustomParameter

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

Fields
key

string

The key matching the parameter tag name.

value

string

The value to be substituted.

DeviceInfo

A device criterion.

Fields
type

Device

Type of the device.

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.

This bidding strategy is deprecated and cannot be created anymore. Use ManualCpc with enhanced_cpc_enabled set to true for equivalent functionality.

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.

GenderInfo

A gender criterion.

Fields
type

GenderType

Type of the gender.

KeywordInfo

A keyword criterion.

Fields
match_type

KeywordMatchType

The match type of the keyword.

text

string

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

LanguageInfo

A language criterion.

Fields
language_constant

string

The language constant resource name.

ListingGroupInfo

A listing group criterion.

Fields
type

ListingGroupType

Type of the listing group.

LocationGroupInfo

A radius around a list of locations specified through a feed.

Fields
geo_target_constants[]

string

Geo target constant(s) restricting the scope of the geographic area within the feed. Currently only one geo target constant is allowed.

radius_units

LocationGroupRadiusUnits

Unit of the radius. Miles and meters are supported for geo target constants. Milli miles and meters are supported for feed item sets. This is required and must be set in CREATE operations.

feed_item_sets[]

string

FeedItemSets whose FeedItems are targeted. If multiple IDs are specified, then all items that appear in at least one set are targeted. This field cannot be used with geo_target_constants. This is optional and can only be set in CREATE operations.

radius

int64

Distance in units specifying the radius around targeted locations. This is required and must be set in CREATE operations.

LocationInfo

A location criterion.

Fields
geo_target_constant

string

The geo target constant resource name.

ManualCpa

Manual bidding strategy that allows advertiser to set the bid per advertiser-specified action.

ManualCpc

Manual click-based bidding where user pays per click.

Fields
enhanced_cpc_enabled

bool

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

ManualCpm

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

MaximizeConversionValue

An automated bidding strategy to help get the most conversion value for your campaigns while spending your budget.

Fields
cpc_bid_ceiling_micros

int64

Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. Mutable for portfolio bidding strategies only.

cpc_bid_floor_micros

int64

Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. Mutable for portfolio bidding strategies only.

target_roas

double

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 to help get the most conversions for your campaigns while spending your budget.

Fields
cpc_bid_ceiling_micros

int64

Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. Mutable for portfolio bidding strategies only.

cpc_bid_floor_micros

int64

Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. Mutable for portfolio bidding strategies only.

target_cpa_micros

int64

The target cost-per-action (CPA) option. This is the average amount that you would like to spend per conversion action specified in micro units of the bidding strategy's currency. If set, the bid strategy will get as many conversions as possible at or below the target cost-per-action. If the target CPA is not set, the bid strategy will aim to achieve the lowest possible CPA given the budget.

Metrics

Metrics data.

Fields
all_conversions_value_by_conversion_date

double

The value of all conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/sa360/answer/9250611.

all_conversions_by_conversion_date

double

The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/sa360/answer/9250611.

conversions_value_by_conversion_date

double

The sum of biddable conversions value by conversion date. When this column is selected with date, the values in date column means the conversion date.

conversions_by_conversion_date

double

The sum of conversions by conversion date for biddable conversion types. Can be fractional due to attribution modeling. When this column is selected with date, the values in date column means the conversion date.

historical_creative_quality_score

QualityScoreBucket

The creative historical quality score.

historical_landing_page_quality_score

QualityScoreBucket

The quality of historical landing page experience.

historical_search_predicted_ctr

QualityScoreBucket

The historical search predicted click through rate (CTR).

interaction_event_types[]

InteractionEventType

The types of payable and free interactions.

absolute_top_impression_percentage

double

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

all_conversions_from_interactions_rate

double

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

all_conversions_value

double

The value of all conversions.

all_conversions

double

The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric.

all_conversions_value_per_cost

double

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_click_to_call

double

The number of times people clicked the "Call" button to call a store during or after clicking an ad. This number doesn't include whether or not calls were connected, or the duration of any calls. This metric applies to feed items only.

all_conversions_from_directions

double

The number of times people clicked a "Get directions" button to navigate to a store after clicking an ad. This metric applies to feed items only.

all_conversions_from_interactions_value_per_interaction

double

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

all_conversions_from_menu

double

The number of times people clicked a link to view a store's menu after clicking an ad. This metric applies to feed items only.

all_conversions_from_order

double

The number of times people placed an order at a store after clicking an ad. This metric applies to feed items only.

all_conversions_from_other_engagement

double

The number of other conversions (for example, posting a review or saving a location for a store) that occurred after people clicked an ad. This metric applies to feed items only.

all_conversions_from_store_visit

double

Estimated number of times people visited a store after clicking an ad. This metric applies to feed items only.

all_conversions_from_store_website

double

The number of times that people were taken to a store's URL after clicking an ad. This metric applies to feed items only.

average_cost

double

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

double

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

average_cpm

double

Average cost-per-thousand impressions (CPM).

clicks

int64

The number of clicks.

content_budget_lost_impression_share

double

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

double

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.

content_rank_lost_impression_share

double

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

double

Average biddable conversions (from interaction) per conversion eligible interaction. Shows how often, on average, an ad interaction leads to a biddable conversion.

client_account_conversions_value

double

The value of client account conversions. This only includes conversion actions which include_in_client_account_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.

conversions_value_per_cost

double

The value of biddable conversion divided by the total cost of conversion eligible interactions.

conversions_from_interactions_value_per_interaction

double

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. If you use conversion-based bidding, your bid strategies will optimize for these conversions.

client_account_conversions

double

The number of client account conversions. This only includes conversion actions which include_in_client_account_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.

cost_micros

int64

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

cost_per_all_conversions

double

The cost of ad interactions divided by all conversions.

cost_per_conversion

double

Average conversion eligible cost per biddable conversion.

cost_per_current_model_attributed_conversion

double

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. If you use conversion-based bidding, your bid strategies will optimize for these conversions.

cross_device_conversions

double

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

cross_device_conversions_value

double

The sum of the value of cross-device conversions.

ctr

double

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

conversions

double

The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.

conversions_value

double

The sum of conversion values for the conversions included in the "conversions" field. This metric is useful only if you entered a value for your conversion actions.

historical_quality_score

int64

The historical quality score.

impressions

int64

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

interaction_rate

double

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

int64

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.

invalid_click_rate

double

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

invalid_clicks

int64

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

mobile_friendly_clicks_percentage

double

The percentage of mobile clicks that go to a mobile-friendly page.

search_absolute_top_impression_share

double

The percentage of the customer's Shopping or Search ad impressions that are shown in the most prominent Shopping position. See https://support.google.com/sa360/answer/9566729 for details. Any value below 0.1 is reported as 0.0999.

search_budget_lost_absolute_top_impression_share

double

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

double

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

double

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

double

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

double

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

double

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

double

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

double

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

double

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

double

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

double

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

value_per_all_conversions

double

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

value_per_all_conversions_by_conversion_date

double

The value of all conversions divided by the number of all conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/sa360/answer/9250611.

value_per_conversion

double

The value of biddable conversion divided by the number of biddable conversions. Shows how much, on average, each of the biddable conversions is worth.

value_per_conversions_by_conversion_date

double

Biddable conversions value by conversion date divided by biddable conversions by conversion date. Shows how much, on average, each of the biddable conversions is worth (by conversion date). When this column is selected with date, the values in date column means the conversion date.

client_account_view_through_conversions

int64

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 (for example, clicking on) another ad.

PercentCpc

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

Fields
cpc_bid_ceiling_micros

int64

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

bool

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.

RealTimeBiddingSetting

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

Fields
opt_in

bool

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

Segments

Segment only fields.

Fields
conversion_action_category

ConversionActionCategory

Conversion action category.

day_of_week

DayOfWeek

Day of the week, for example, MONDAY.

device

Device

Device to which metrics apply.

conversion_action

string

Resource name of the conversion action.

conversion_action_name

string

Conversion action name.

date

string

Date to which metrics apply. yyyy-MM-dd format, for example, 2018-04-17.

month

string

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

quarter

string

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

week

string

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

year

int32

Year, formatted as yyyy.

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

int64

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

int64

Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies.

cpc_bid_floor_micros

int64

Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies.

TargetCpm

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

TargetImpressionShare

An automated bidding strategy that sets bids so that a certain percentage of search ads are shown at the top of the first page (or other targeted location).

Fields
location

TargetImpressionShareLocation

The targeted location on the search results page.

location_fraction_micros

int64

The chosen fraction of ads to be shown in the targeted location in micros. For example, 1% equals 10,000.

cpc_bid_ceiling_micros

int64

The highest CPC bid the automated bidding system is permitted to specify. This is a required field entered by the advertiser that sets the ceiling and specified in local micros.

TargetOutrankShare

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

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

TargetRoas

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

Fields
target_roas

double

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

cpc_bid_ceiling_micros

int64

Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies.

cpc_bid_floor_micros

int64

Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies.

TargetSpend

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

Fields
target_spend_micros
(deprecated)

int64

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. This field is deprecated and should no longer be used. See https://ads-developers.googleblog.com/2020/05/reminder-about-sunset-creation-of.html for details.

cpc_bid_ceiling_micros

int64

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

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.

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

string

Argument of webpage targeting condition.

WebpageInfo

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

Fields
conditions[]

WebpageConditionInfo

Conditions, or logical expressions, for webpage targeting. The list of webpage targeting conditions are and-ed together when evaluated for targeting. An empty list of conditions indicates all pages of the campaign's website are targeted.

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

coverage_percentage

double

Website criteria coverage percentage. This is the computed percentage of website coverage based on the website target, negative website target and negative keywords in the ad group and campaign. For instance, when coverage returns as 1, it indicates it has 100% coverage. This field is read-only.

criterion_name

string

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.