Package google.ads.searchads360.v0.common

Index

• AdScheduleInfo (message)
• AdTextAsset (message)
• AgeRangeInfo (message)
• AssetInteractionTarget (message)
• AssetUsage (message)
• AudienceInfo (message)
• BusinessProfileLocation (message)
• CallToActionAsset (message)
• CustomParameter (message)
• DeviceInfo (message)
• EnhancedCpc (message)
• FrequencyCapEntry (message)
• GenderInfo (message)
• ImageAsset (message)
• ImageDimension (message)
• Keyword (message)
• KeywordInfo (message)
• LanguageInfo (message)
• ListingGroupInfo (message)
• LocationGroupInfo (message)
• LocationInfo (message)
• ManualCpa (message)
• ManualCpc (message)
• ManualCpm (message)
• MaximizeConversionValue (message)
• MaximizeConversions (message)
• Metrics (message)
• MobileAppAsset (message)
• PercentCpc (message)
• RealTimeBiddingSetting (message)
• SearchAds360ExpandedDynamicSearchAdInfo (message)
• SearchAds360ExpandedTextAdInfo (message)
• SearchAds360ProductAdInfo (message)
• SearchAds360ResponsiveSearchAdInfo (message)
• SearchAds360TextAdInfo (message)
• Segments (message)
• TargetCpa (message)
• TargetCpm (message)
• TargetImpressionShare (message)
• TargetOutrankShare (message)
• TargetRestriction (message)
• TargetRoas (message)
• TargetSpend (message)
• TargetingSetting (message)
• TextAsset (message)
• TextLabel (message)
• UnifiedCallAsset (message)
• UnifiedCalloutAsset (message)
• UnifiedLocationAsset (message)
• UnifiedPageFeedAsset (message)
• UnifiedSitelinkAsset (message)
• UserListInfo (message)
• Value (message)
• WebpageConditionInfo (message)
• WebpageInfo (message)
• YoutubeVideoAsset (message)

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.
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.
start_hour	int32 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	int32 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.

AdTextAsset

A text asset used inside an ad.

Fields
text	string Asset text.

AgeRangeInfo

An age range criterion.

Fields
type	AgeRangeType Type of the age range.

AssetInteractionTarget

An AssetInteractionTarget segment.

Fields
asset	string The asset resource name.
interaction_on_this_asset	bool Only used with CustomerAsset, CampaignAsset and AdGroupAsset metrics. Indicates whether the interaction metrics occurred on the asset itself or a different asset or ad unit.

AssetUsage

Contains the usage information of the asset.

Fields
asset	string Resource name of the asset.
served_asset_field_type	ServedAssetFieldType The served field type of the asset.

AudienceInfo

An audience criterion.

Fields
audience	string The Audience resource name.

BusinessProfileLocation

Business Profile location data synced from the linked Business Profile account.

Fields
labels[]	string Advertiser specified label for the location on the Business Profile account. This is synced from the Business Profile account.
store_code	string Business Profile store code of this location. This is synced from the Business Profile account.
listing_id	int64 Listing ID of this Business Profile location. This is synced from the linked Business Profile account.

CallToActionAsset

A call to action asset.

Fields
call_to_action	CallToActionType Call to action.

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

This type has no fields.

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

This type has no fields.

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.

ImageAsset

An Image asset.

Fields
mime_type	MimeType MIME type of the image asset.
full_size	ImageDimension Metadata for this image at its original size.
file_size	int64 File size of the image asset in bytes.

ImageDimension

Metadata for an image at a certain size, either original or resized.

Fields
height_pixels	int64 Height of the image.
width_pixels	int64 Width of the image.
url	string A URL that returns the image with this height and width.

Keyword

A Keyword criterion segment.

Fields
info	KeywordInfo Keyword info.
ad_group_criterion	string The AdGroupCriterion resource name.

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

This type has no fields.

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

This type has no fields.

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.
conversion_custom_metrics[]	Value The conversion custom metrics.
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.
raw_event_conversion_metrics[]	Value The raw event conversion metrics.
absolute_top_impression_percentage	double Search absolute top impression share is the percentage of your Search ad impressions that are shown in the most prominent Search position.
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.
visits	double Clicks that Search Ads 360 has successfully recorded and forwarded to an advertiser's landing page.
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. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause
average_cpm	double Average cost-per-thousand impressions (CPM). This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause
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. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause
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_by_conversion_date	double The number of cross-device conversions by conversion date. Details for the by_conversion_date columns are available at https://support.google.com/sa360/answer/9250611.
cross_device_conversions_value	double The sum of the value of cross-device conversions.
cross_device_conversions_value_by_conversion_date	double The sum of cross-device conversions value by conversion date. Details for the by_conversion_date columns are available at https://support.google.com/sa360/answer/9250611.
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.
average_quality_score	double The average quality score.
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.
general_invalid_click_rate	double The percentage of clicks that have been filtered out of your total number of clicks (filtered + non-filtered clicks) due to being general invalid clicks. These are clicks Google considers illegitimate that are detected through routine means of filtration (that is, known invalid data-center traffic, bots and spiders or other crawlers, irregular patterns, etc). You're not charged for them, and they don't affect your account statistics. See the help page at https://support.google.com/campaignmanager/answer/6076504 for details.
general_invalid_clicks	int64 Number of general invalid clicks. These are a subset of your invalid clicks that are detected through routine means of filtration (such as known invalid data-center traffic, bots and spiders or other crawlers, irregular patterns, etc.). You're not charged for them, and they don't affect your account statistics. See the help page at https://support.google.com/campaignmanager/answer/6076504 for details.
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 among the top ads in the 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 adjacent to the top 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 among the top ads in the 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 adjacent to the top 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 among the top ads compared to the estimated number of impressions you were eligible to receive among the top ads. 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 ads are generally above the top organic results, although they may show below the top organic results on certain queries.
top_impression_percentage	double The percent of your ad impressions that are shown adjacent to the top 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.
client_account_cross_sell_cost_of_goods_sold_micros	int64 Client account cross-sell cost of goods sold (COGS) is the total cost of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell cost of goods sold is the total cost of the products sold that weren't advertised. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The cross-sell cost of goods sold for this order is $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause
cross_sell_cost_of_goods_sold_micros	int64 Cross-sell cost of goods sold (COGS) is the total cost of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell cost of goods sold is the total cost of the products sold that weren't advertised. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The cross-sell cost of goods sold for this order is $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause
client_account_cross_sell_gross_profit_micros	int64 Client account cross-sell gross profit is the profit you made from products sold as a result of advertising a different product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the purchase is a sold product. If these products don't match then this is considered cross-sell. Cross-sell gross profit is the revenue you made from cross-sell attributed to your ads minus the cost of the goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The shirt is priced $20 and has a cost of goods sold value of $5. The cross-sell gross profit of this order is $15 = $20 - $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause
cross_sell_gross_profit_micros	int64 Cross-sell gross profit is the profit you made from products sold as a result of advertising a different product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the purchase is a sold product. If these products don't match then this is considered cross-sell. Cross-sell gross profit is the revenue you made from cross-sell attributed to your ads minus the cost of the goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The shirt is priced $20 and has a cost of goods sold value of $5. The cross-sell gross profit of this order is $15 = $20 - $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause
client_account_cross_sell_revenue_micros	int64 Client account cross-sell revenue is the total amount you made from products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell revenue is the total value you made from cross-sell attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The cross-sell revenue of this order is $20. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause
cross_sell_revenue_micros	int64 Cross-sell revenue is the total amount you made from products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell revenue is the total value you made from cross-sell attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The cross-sell revenue of this order is $20. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause
client_account_cross_sell_units_sold	double Client account cross-sell units sold is the total number of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell units sold is the total number of cross-sold products from all orders attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The cross-sell units sold in this order is 2. This metric is only available if you report conversions with cart data.
cross_sell_units_sold	double Cross-sell units sold is the total number of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell units sold is the total number of cross-sold products from all orders attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The cross-sell units sold in this order is 2. This metric is only available if you report conversions with cart data.
client_account_lead_cost_of_goods_sold_micros	int64 Client account lead cost of goods sold (COGS) is the total cost of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the cost of these goods is counted under lead cost of goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The lead cost of goods sold for this order is $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause
lead_cost_of_goods_sold_micros	int64 Lead cost of goods sold (COGS) is the total cost of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the cost of these goods is counted under lead cost of goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The lead cost of goods sold for this order is $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause
client_account_lead_gross_profit_micros	int64 Client account lead gross profit is the profit you made from products sold as a result of advertising the same product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the revenue you made from these sales minus the cost of goods sold is your lead gross profit. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and has a cost of goods sold value of $3. The lead gross profit of this order is $7 = $10 - $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause
lead_gross_profit_micros	int64 Lead gross profit is the profit you made from products sold as a result of advertising the same product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the revenue you made from these sales minus the cost of goods sold is your lead gross profit. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and has a cost of goods sold value of $3. The lead gross profit of this order is $7 = $10 - $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause
client_account_lead_revenue_micros	int64 Client account lead revenue is the total amount you made from products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total value you made from the sales of these products is shown under lead revenue. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The lead revenue of this order is $10. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause
lead_revenue_micros	int64 Lead revenue is the total amount you made from products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total value you made from the sales of these products is shown under lead revenue. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The lead revenue of this order is $10. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause
client_account_lead_units_sold	double Client account lead units sold is the total number of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total number of these products sold is shown under lead units sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The lead units sold in this order is 1. This metric is only available if you report conversions with cart data.
lead_units_sold	double Lead units sold is the total number of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total number of these products sold is shown under lead units sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The lead units sold in this order is 1. This metric is only available if you report conversions with cart data.

MobileAppAsset

An asset representing a mobile app.

Fields
app_id	string Required. A string that uniquely identifies a mobile application. It should just contain the platform native id, like "com.android.ebay" for Android or "12345689" for iOS.
app_store	MobileAppVendor Required. The application store that distributes this specific app.

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.

SearchAds360ExpandedDynamicSearchAdInfo

An expanded dynamic search ad.

Fields
description1	string The first line of the ad's description.
description2	string The second line of the ad's description.
ad_tracking_id	int64 The tracking id of the ad.

SearchAds360ExpandedTextAdInfo

A Search Ads 360 expanded text ad.

Fields
headline	string The headline of the ad.
headline2	string The second headline of the ad.
headline3	string The third headline of the ad.
description1	string The first line of the ad's description.
description2	string The second line of the ad's description.
path1	string Text appended to the auto-generated visible URL with a delimiter.
path2	string Text appended to path1 with a delimiter.
ad_tracking_id	int64 The tracking id of the ad.

SearchAds360ProductAdInfo

This type has no fields.

A Search Ads 360 product ad.

SearchAds360ResponsiveSearchAdInfo

A Search Ads 360 responsive search ad.

Fields
headlines[]	AdTextAsset List of text assets for headlines. When the ad serves the headlines will be selected from this list.
descriptions[]	AdTextAsset List of text assets for descriptions. When the ad serves the descriptions will be selected from this list.
path1	string Text appended to the auto-generated visible URL with a delimiter.
path2	string Text appended to path1 with a delimiter.
ad_tracking_id	int64 The tracking id of the ad.

SearchAds360TextAdInfo

A Search Ads 360 text ad.

Fields
headline	string The headline of the ad.
description1	string The first line of the ad's description.
description2	string The second line of the ad's description.
display_url	string The displayed URL of the ad.
display_mobile_url	string The displayed mobile URL of the ad.
ad_tracking_id	int64 The tracking id of the ad.

Segments

Segment only fields.

Fields
ad_network_type	AdNetworkType Ad network type.
conversion_action_category	ConversionActionCategory Conversion action category.
conversion_custom_dimensions[]	Value The conversion custom dimensions.
day_of_week	DayOfWeek Day of the week, for example, MONDAY.
device	Device Device to which metrics apply.
keyword	Keyword Keyword criterion.
product_channel	ProductChannel Channel of the product.
product_channel_exclusivity	ProductChannelExclusivity Channel exclusivity of the product.
product_condition	ProductCondition Condition of the product.
product_sold_condition	ProductCondition Condition of the product sold.
raw_event_conversion_dimensions[]	Value The raw event conversion dimensions.
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.
geo_target_city	string Resource name of the geo target constant that represents a city.
geo_target_country	string Resource name of the geo target constant that represents a country.
geo_target_metro	string Resource name of the geo target constant that represents a metro.
geo_target_region	string Resource name of the geo target constant that represents a region.
hour	int32 Hour of day as a number between 0 and 23, inclusive.
month	string Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd.
product_bidding_category_level1	string Bidding category (level 1) of the product.
product_bidding_category_level2	string Bidding category (level 2) of the product.
product_bidding_category_level3	string Bidding category (level 3) of the product.
product_bidding_category_level4	string Bidding category (level 4) of the product.
product_bidding_category_level5	string Bidding category (level 5) of the product.
product_brand	string Brand of the product.
product_country	string Resource name of the geo target constant for the country of sale of the product.
product_custom_attribute0	string Custom attribute 0 of the product.
product_custom_attribute1	string Custom attribute 1 of the product.
product_custom_attribute2	string Custom attribute 2 of the product.
product_custom_attribute3	string Custom attribute 3 of the product.
product_custom_attribute4	string Custom attribute 4 of the product.
product_item_id	string Item ID of the product.
product_language	string Resource name of the language constant for the language of the product.
product_sold_bidding_category_level1	string Bidding category (level 1) of the product sold.
product_sold_bidding_category_level2	string Bidding category (level 2) of the product sold.
product_sold_bidding_category_level3	string Bidding category (level 3) of the product sold.
product_sold_bidding_category_level4	string Bidding category (level 4) of the product sold.
product_sold_bidding_category_level5	string Bidding category (level 5) of the product sold.
product_sold_brand	string Brand of the product sold.
product_sold_custom_attribute0	string Custom attribute 0 of the product sold.
product_sold_custom_attribute1	string Custom attribute 1 of the product sold.
product_sold_custom_attribute2	string Custom attribute 2 of the product sold.
product_sold_custom_attribute3	string Custom attribute 3 of the product sold.
product_sold_custom_attribute4	string Custom attribute 4 of the product sold.
product_sold_item_id	string Item ID of the product sold.
product_sold_title	string Title of the product sold.
product_sold_type_l1	string Type (level 1) of the product sold.
product_sold_type_l2	string Type (level 2) of the product sold.
product_sold_type_l3	string Type (level 3) of the product sold.
product_sold_type_l4	string Type (level 4) of the product sold.
product_sold_type_l5	string Type (level 5) of the product sold.
product_store_id	string Store ID of the product.
product_title	string Title of the product.
product_type_l1	string Type (level 1) of the product.
product_type_l2	string Type (level 2) of the product.
product_type_l3	string Type (level 3) of the product.
product_type_l4	string Type (level 4) of the product.
product_type_l5	string Type (level 5) of the product.
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.
asset_interaction_target	AssetInteractionTarget Only used with CustomerAsset, CampaignAsset and AdGroupAsset metrics. Indicates whether the interaction metrics occurred on the asset itself or a different asset or ad unit. Interactions (for example, clicks) are counted across all the parts of the served ad (for example, Ad itself and other components like Sitelinks) when they are served together. When interaction_on_this_asset is true, it means the interactions are on this specific asset and when interaction_on_this_asset is false, it means the interactions is not on this specific asset but on other parts of the served ad this asset is served with.

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

This type has no fields.

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.

TargetRestriction

The list of per-targeting-dimension targeting settings.

Fields
targeting_dimension	TargetingDimension The targeting dimension that these settings apply to.
bid_only	bool 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	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 This item is deprecated! Deprecated: 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.

TargetingSetting

Settings for the targeting-related features, at the campaign and ad group levels. For more details about the targeting setting, visit https://support.google.com/google-ads/answer/7365594

Fields
target_restrictions[]	TargetRestriction The per-targeting-dimension setting to restrict the reach of your campaign or ad group.

TextAsset

A Text asset.

Fields
text	string Text content of the text asset.

TextLabel

A type of label displaying text on a colored background.

Fields
background_color	string Background color of the label in HEX format. This string must match the regular expression '^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$'. Note: The background color may not be visible for manager accounts.
description	string A short description of the label. The length must be no more than 200 characters.

UnifiedCallAsset

A unified call asset.

Fields
country_code	string Two-letter country code of the phone number. Examples: 'US', 'us'.
phone_number	string The advertiser's raw phone number. Examples: '1234567890', '[phone]'
call_conversion_reporting_state	CallConversionReportingState Indicates whether this CallAsset should use its own call conversion setting, follow the account level setting, or disable call conversion.
call_conversion_action	string The conversion action to attribute a call conversion to. If not set, the default conversion action is used. This field only has effect if call_conversion_reporting_state is set to USE_RESOURCE_LEVEL_CALL_CONVERSION_ACTION.
ad_schedule_targets[]	AdScheduleInfo List of non-overlapping schedules specifying all time intervals for which the asset may serve. There can be a maximum of 6 schedules per day, 42 in total.
call_only	bool Whether the call only shows the phone number without a link to the website. Applies to Microsoft Ads.
call_tracking_enabled	bool Whether the call should be enabled on call tracking. Applies to Microsoft Ads.
use_searcher_time_zone	bool Whether to show the call extension in search user's time zone. Applies to Microsoft Ads.
start_date	string Start date of when this asset is effective and can begin serving, in yyyy-MM-dd format.
end_date	string Last date of when this asset is effective and still serving, in yyyy-MM-dd format.

UnifiedCalloutAsset

A unified callout asset.

Fields
callout_text	string The callout text. The length of this string should be between 1 and 25, inclusive.
start_date	string Start date of when this asset is effective and can begin serving, in yyyy-MM-dd format.
end_date	string Last date of when this asset is effective and still serving, in yyyy-MM-dd format.
ad_schedule_targets[]	AdScheduleInfo List of non-overlapping schedules specifying all time intervals for which the asset may serve. There can be a maximum of 6 schedules per day, 42 in total.
use_searcher_time_zone	bool Whether to show the asset in search user's time zone. Applies to Microsoft Ads.

UnifiedLocationAsset

A unified location asset.

Fields
place_id	string Place IDs uniquely identify a place in the Google Places database and on Google Maps. This field is unique for a given customer ID and asset type. See https://developers.google.com/places/web-service/place-id to learn more about Place ID.
business_profile_locations[]	BusinessProfileLocation The list of business locations for the customer. This will only be returned if the Location Asset is syncing from the Business Profile account. It is possible to have multiple Business Profile listings under the same account that point to the same Place ID.
location_ownership_type	LocationOwnershipType The type of location ownership. If the type is BUSINESS_OWNER, it will be served as a location extension. If the type is AFFILIATE, it will be served as an affiliate location.

UnifiedPageFeedAsset

A Unified Page Feed asset.

Fields
page_url	string The webpage that advertisers want to target.
labels[]	string Labels used to group the page urls.

UnifiedSitelinkAsset

A unified sitelink asset.

Fields
link_text	string URL display text for the sitelink. The length of this string should be between 1 and 25, inclusive.
description1	string First line of the description for the sitelink. If set, the length should be between 1 and 35, inclusive, and description2 must also be set.
description2	string Second line of the description for the sitelink. If set, the length should be between 1 and 35, inclusive, and description1 must also be set.
start_date	string Start date of when this asset is effective and can begin serving, in yyyy-MM-dd format.
end_date	string Last date of when this asset is effective and still serving, in yyyy-MM-dd format.
ad_schedule_targets[]	AdScheduleInfo List of non-overlapping schedules specifying all time intervals for which the asset may serve. There can be a maximum of 6 schedules per day, 42 in total.
tracking_id	int64 ID used for tracking clicks for the sitelink asset. This is a Yahoo! Japan only field.
use_searcher_time_zone	bool Whether to show the sitelink asset in search user's time zone. Applies to Microsoft Ads.
mobile_preferred	bool Whether the preference is for the sitelink asset to be displayed on mobile devices. Applies to Microsoft Ads.

UserListInfo

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

Fields
user_list	string The User List resource name.

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.

YoutubeVideoAsset

A YouTube asset.

Fields
youtube_video_title	string YouTube video title.
youtube_video_id	string YouTube video id. This is the 11 character string value used in the YouTube video URL.