For the complete documentation index, see llms.txt. This page is also available as Markdown.

Google Ads - Supported Columns

Every column the Google Ads connector can download.

These are the columns available to a Google Ads connector. The recommended template uses a small subset, listed on the Google Ads page. The rest can be added to a connector through the Advanced Editor, which stops that connector receiving template updates.

Column names follow the Google Ads API, so a name here matches what Google's own documentation calls it.

Metrics

Column
Type
Description

absolute_top_impression_percentage

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

active_view_cpm

Double

Average cost of viewable impressions (active_view_impressions).

active_view_ctr

Double

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

active_view_impressions

Long

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

active_view_measurability

Double

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

active_view_measurable_cost_micros

Long

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

active_view_measurable_impressions

Long

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

active_view_viewability

Double

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

all_conversions

Double

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

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/google-ads/answer/9549009.

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_rate

Double

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

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_location_asset_click_to_call

Double

Number of call button clicks on any location surface after a chargeable ad event (click or impression). This measure is coming from Asset based location.

all_conversions_from_location_asset_directions

Double

Number of driving directions clicks on any location surface after a chargeable ad event (click or impression). This measure is coming from Asset based location.

all_conversions_from_location_asset_menu

Double

Number of menu link clicks on any location surface after a chargeable ad event (click or impression). This measure is coming from Asset based location.

all_conversions_from_location_asset_order

Double

Number of order clicks on any location surface after a chargeable ad event (click or impression). This measure is coming from Asset based location.

all_conversions_from_location_asset_other_engagement

Double

Number of other types of local action clicks on any location surface after a chargeable ad event (click or impression). This measure is coming from Asset based location.

all_conversions_from_location_asset_store_visits

Double

Estimated number of visits to the store after a chargeable ad event (click or impression). This measure is coming from Asset based location.

all_conversions_from_location_asset_website

Double

Number of website URL clicks on any location surface after a chargeable ad event (click or impression). This measure is coming from Asset based location.

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.

all_conversions_value

Double

The value of all conversions.

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/google-ads/answer/9549009.

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_new_customer_lifetime_value

Double

All of new customers' lifetime conversion value. If you have set up customer acquisition goal at either account level or campaign level, this will include the additional conversion value from new customers for both biddable and non-biddable conversions. If your campaign has adopted the customer acquisition goal and selected "bid higher for new customers", these values will be included in "all_conversions_value". See https://support.google.com/google-ads/answer/12080169 for more details.

auction_insight_search_absolute_top_impression_percentage

Double

This metric is part of the Auction Insights report, and tells how often the ads of another participant showed as the very first ad above the organic search results. This percentage is computed only over the auctions that you appeared in the page. This metric is not publicly available.

auction_insight_search_impression_share

Double

This metric is part of the Auction Insights report, and tells the percentage of impressions that another participant obtained, over the total number of impressions that your ads were eligible for. Any value below 0.1 is reported as 0.0999. This metric is not publicly available.

auction_insight_search_outranking_share

Double

This metric is part of the Auction Insights report, and tells the percentage of impressions that your ads outranked (showed above) another participant in the auction, compared to the total number of impressions that your ads were eligible for. Any value below 0.1 is reported as 0.0999. This metric is not publicly available.

auction_insight_search_overlap_rate

Double

This metric is part of the Auction Insights report, and tells how often another participant's ad received an impression when your ad also received an impression. This metric is not publicly available.

auction_insight_search_position_above_rate

Double

This metric is part of the Auction Insights report, and tells how often another participant's ad was shown in a higher position than yours, when both of your ads were shown at the same page. This metric is not publicly available.

auction_insight_search_top_impression_percentage

Double

This metric is part of the Auction Insights report, and tells how often the ads of another participant showed above the organic search results. This percentage is computed only over the auctions that you appeared in the page. This metric is not publicly available.

average_cart_size

Double

Average cart size is the average number of products in each order attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. Average cart size is the total number of products sold divided by the total number of orders you received. Example: You received 2 orders, the first included 3 products and the second included 2. The average cart size is 2.5 products = (3+2)/2. This metric is only available if you report conversions with cart data.

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_cpe

Double

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

Double

Average cost-per-thousand impressions (CPM).

trueview_average_cpv

Double

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 TrueView views.

average_impression_frequency_per_user

Double

The average number of times a unique user saw your ad during the requested time period. This metric cannot be aggregated, and can only be requested for date ranges of 92 days or less. This metric is available for following campaign types - Display, Video, Discovery and App.

average_order_value_micros

Long

Average order value is the average revenue you made per order attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. Average order value is the total revenue from your orders divided by the total number of orders. Example: You received 3 orders which made $10, $15 and $20 worth of revenue. The average order value is $15 = ($10 + $15 + $20)/3. This metric is only available if you report conversions with cart data.

average_page_views

Double

Average number of pages viewed per session.

average_target_cpa_micros

Long

The average Target CPA, or unset if not available (for example, for campaigns that had traffic from portfolio bidding strategies or non-tCPA).

average_target_roas

Double

The average Target ROAS, or unset if not available (for example, for campaigns that had traffic from portfolio bidding strategies or non-tROAS).

average_time_on_site

Double

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

benchmark_average_max_cpc

Double

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

benchmark_ctr

Double

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.

biddable_app_install_conversions

Double

Number of app installs.

biddable_app_post_install_conversions

Double

Number of in-app actions.

bounce_rate

Double

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

clicks

Long

The number of clicks.

combined_clicks

Long

The number of times your ad or your site's listing in the unpaid results was clicked. See the help page at https://support.google.com/google-ads/answer/3097241 for details.

combined_clicks_per_query

Double

The number of times your ad or your site's listing in the unpaid results was clicked (combined_clicks) divided by combined_queries. See the help page at https://support.google.com/google-ads/answer/3097241 for details.

combined_queries

Long

The number of searches that returned pages from your site in the unpaid results or showed one of your text ads. See the help page at https://support.google.com/google-ads/answer/3097241 for details.

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.

conversion_last_conversion_date

DateTime

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

conversion_last_received_request_date_time

DateTime

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.

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_by_conversion_date

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. 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/google-ads/answer/9549009.

conversions_from_interactions_rate

Double

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

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.

conversions_value

Double

The value 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_by_conversion_date

Double

The value 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. 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/google-ads/answer/9549009.

conversions_value_per_cost

Double

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

cost_micros

Long

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

cost_of_goods_sold_micros

Long

Cost of goods sold (COGS) is the total cost of the products you sold in orders attributed to your ads. How it works: You can add a cost of goods sold value to every product in Merchant Center. If you report conversions with cart data, the products you sold are matched with their cost of goods sold value and this can be used to calculate the gross profit you made on each order. 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 cost of goods sold for this order is $8 = $3 + $5. This metric is only available if you report conversions with cart data.

cost_per_all_conversions

Double

The cost of ad interactions divided by all conversions.

cost_per_conversion

Double

The cost of ad interactions divided by 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.

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 a Google Ads 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_micros

Double

The sum of the value of cross-device conversions, in micros.

cross_sell_cost_of_goods_sold_micros

Long

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.

cross_sell_gross_profit_micros

Long

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.

cross_sell_revenue_micros

Long

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.

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.

ctr

Double

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

current_model_attributed_conversions

Double

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

current_model_attributed_conversions_from_interactions_rate

Double

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

current_model_attributed_conversions_from_interactions_value_per_interaction

Double

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

current_model_attributed_conversions_value

Double

The value of 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.

current_model_attributed_conversions_value_per_cost

Double

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

eligible_impressions_from_location_asset_store_reach

Long

Number of impressions in which the store location was shown or the location was used for targeting. This measure is coming from Asset based location.

engagement_rate

Double

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

Long

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.

gmail_forwards

Long

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

gmail_saves

Long

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

gmail_secondary_clicks

Long

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

gross_profit_margin

Double

Gross profit margin is the percentage gross profit you made from orders attributed to your ads, after taking out the cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. Gross profit margin is the gross profit you made divided by your total revenue and multiplied by 100%. Gross profit margin calculations only include products that have a cost of goods sold value in Merchant Center. Example: Someone bought a hat and a shirt in an order on your website. The hat is priced $10 and has a cost of goods sold value of $3. The shirt is priced $20 but has no cost of goods sold value. Gross profit margin for this order will only take into account the hat because it has a cost of goods sold value, so it's 70% = ($10 - $3)/$10 x 100%. This metric is only available if you report conversions with cart data.

gross_profit_micros

Double

Gross profit is the profit you made from orders attributed to your ads minus the cost of goods sold (COGS). How it works: Gross profit is the revenue you made from sales attributed to your ads minus cost of goods sold. Gross profit calculations only include products that have a cost of goods sold value in Merchant Center. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt in an order from your website. The hat is priced $10 and the shirt is priced $20. The hat has a cost of goods sold value of $3, but the shirt has no cost of goods sold value. Gross profit for this order will only take into account the hat, so it's $7 = $10 - $3. This metric is only available if you report conversions with cart data.

historical_creative_quality_score

String

The creative historical quality score.

historical_landing_page_quality_score

String

The quality of historical landing page experience.

historical_quality_score

Long

The historical quality score.

historical_search_predicted_ctr

String

The historical search predicted click through rate (CTR).

hotel_average_lead_value_micros

Double

Average lead value based on clicks.

hotel_commission_rate_micros

Long

Commission bid rate in micros. A 20% commission is represented as 200,000.

hotel_eligible_impressions

Long

The number of impressions that hotel partners could have had given their feed performance.

hotel_expected_commission_cost

Double

Expected commission cost. The result of multiplying the commission value times the hotel_commission_rate in advertiser currency.

hotel_price_difference_percentage

Double

The average price difference between the price offered by reporting hotel advertiser and the cheapest price offered by the competing advertiser.

impressions

Long

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

impressions_from_store_reach

Long

The number of times a store's location-based ad was shown. This metric applies to feed items only.

interaction_event_types

String

The types of payable and free interactions.

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

Long

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

Long

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

lead_cost_of_goods_sold_micros

Long

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.

lead_gross_profit_micros

Long

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.

lead_revenue_micros

Long

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.

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.

message_chat_rate

Double

Number of message chats initiated (message_chats) divided by the number of message impressions (message_impressions). Rate at which a user initiates a message chat from an ad impression with a messaging option and message tracking enabled. Note that this rate can be more than 1.0 for a given message impression.

message_chats

Long

Number of message chats initiated for Click To Message impressions that were message tracking eligible.

message_impressions

Long

Number of Click To Message impressions that were message tracking eligible.

mobile_friendly_clicks_percentage

Double

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

new_customer_lifetime_value

Double

New customers' lifetime conversion value. If you have set up customer acquisition goal at either account level or campaign level, this will include the additional conversion value from new customers for biddable conversions. If your campaign has adopted the customer acquisition goal and selected "bid higher for new customers", these values will be included in "conversions_value" for optimization. See https://support.google.com/google-ads/answer/12080169 for more details.

optimization_score_uplift

Double

Total optimization score uplift of all recommendations.

optimization_score_url

String

URL for the optimization score page in the Google Ads web interface. This metric can be selected from customer or campaign, and can be segmented by segments.recommendation_type. For example, SELECT metrics.optimization_score_url, segments.recommendation_type FROM customer will return a URL for each unique (customer, recommendation_type) combination.

orders

Double

Orders is the total number of purchase conversions you received attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. If a conversion is attributed to previous interactions with your ads (clicks for text or Shopping ads, views for video ads etc.) it's counted as an order. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt in an order on your website. Even though they bought 2 products, this would count as 1 order. This metric is only available if you report conversions with cart data.

organic_clicks

Long

The number of times someone clicked your site's listing in the unpaid results for a particular query. See the help page at https://support.google.com/google-ads/answer/3097241 for details.

organic_clicks_per_query

Double

The number of times someone clicked your site's listing in the unpaid results (organic_clicks) divided by the total number of searches that returned pages from your site (organic_queries). See the help page at https://support.google.com/google-ads/answer/3097241 for details.

organic_impressions

Long

The number of listings for your site in the unpaid search results. See the help page at https://support.google.com/google-ads/answer/3097241 for details.

organic_impressions_per_query

Double

The number of times a page from your site was listed in the unpaid search results (organic_impressions) divided by the number of searches returning your site's listing in the unpaid results (organic_queries). See the help page at https://support.google.com/google-ads/answer/3097241 for details.

organic_queries

Long

The total number of searches that returned your site's listing in the unpaid results. See the help page at https://support.google.com/google-ads/answer/3097241 for details.

percent_new_visitors

Double

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

phone_calls

Long

Number of offline phone calls.

phone_impressions

Long

Number of offline phone impressions.

phone_through_rate

Double

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

publisher_organic_clicks

Long

Clicks from properties for which the traffic the publisher has not paid for or acquired through incentivized activity

publisher_purchased_clicks

Long

Clicks from properties not owned by the publisher for which the traffic the publisher has paid for or acquired through incentivized activity

publisher_unknown_clicks

Long

Clicks from traffic which is not identified as "Publisher Purchased" or "Publisher Organic"

relative_ctr

Double

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.

revenue_micros

Long

Revenue is the total amount you made from orders attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. Revenue is the total value of all the orders you received attributed to your ads, minus any discount. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt in an order from your website. The hat is priced $10 and the shirt is priced $20. The entire order has a $5 discount. The revenue from this order is $25 = ($10 + $20) - $5. This metric is only available if you report conversions with cart data.

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/google-ads/answer/7501826 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.

search_volume

String

Search volume range for a search term insight category.

sk_ad_network_installs

Long

The number of iOS Store Kit Ad Network conversions.

sk_ad_network_total_conversions

Long

The total number of iOS Store Kit Ad Network conversions.

speed_score

Long

A measure of how quickly your page loads after clicks on your mobile ads. The score is a range from 1 to 10, 10 being the fastest.

top_impression_percentage

Double

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

unique_users

Long

The number of unique users who saw your ad during the requested time period. This metric cannot be aggregated, and can only be requested for date ranges of 92 days or less. This metric is available for following campaign types - Display, Video, Discovery and App.

units_sold

Double

Units sold is the total number of products sold from orders attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. Units sold is the total number of products sold 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 units sold in this order is 3. This metric is only available if you report conversions with cart data.

valid_accelerated_mobile_pages_clicks_percentage

Double

The percentage of ad clicks to Accelerated Mobile Pages (AMP) landing pages that reach a valid AMP page.

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/google-ads/answer/9549009.

value_per_conversion

Double

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

value_per_conversions_by_conversion_date

Double

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. If you use conversion-based bidding, your bid strategies will optimize for these 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/google-ads/answer/9549009.

value_per_current_model_attributed_conversion

Double

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

video_quartile_p100_rate

Double

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

video_quartile_p25_rate

Double

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

video_quartile_p50_rate

Double

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

video_quartile_p75_rate

Double

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

video_trueview_view_rate

Double

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

video_trueview_views

Long

The number of TrueView views your video ads received.

view_through_conversions

Long

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.

view_through_conversions_from_location_asset_click_to_call

Double

Number of call button clicks on any location surface after an impression. This measure is coming from Asset based location.

view_through_conversions_from_location_asset_directions

Double

Number of driving directions clicks on any location surface after an impression. This measure is coming from Asset based location.

view_through_conversions_from_location_asset_menu

Double

Number of menu link clicks on any location surface after an impression. This measure is coming from Asset based location.

view_through_conversions_from_location_asset_order

Double

Number of order clicks on any location surface after an impression. This measure is coming from Asset based location.

view_through_conversions_from_location_asset_other_engagement

Double

Number of other types of local action clicks on any location surface after an impression. This measure is coming from Asset based location.

view_through_conversions_from_location_asset_store_visits

Double

Estimated number of visits to the store after an impression. This measure is coming from Asset based location.

view_through_conversions_from_location_asset_website

Double

Number of website URL clicks on any location surface after an impression. This measure is coming from Asset based location.

Segments

Segments split the figures by a dimension such as date, device or network.

Column
Type
Description

activity_account_id

Long

Activity account ID.

activity_city

String

The city where the travel activity is available.

activity_country

String

The country where the travel activity is available.

activity_rating

Long

Activity rating.

activity_state

String

The state where the travel activity is available.

ad_destination_type

String

Ad Destination type.

ad_group

String

Resource name of the ad group.

ad_network_type

String

Ad network type.

asset_group

String

Resource name of the asset group.

asset_interaction_target.asset

String

The asset resource name.

asset_interaction_target.interaction_on_this_asset

Boolean

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.

auction_insight_domain

String

Domain (visible URL) of a participant in the Auction Insights report.

budget_campaign_association_status.campaign

String

The campaign resource name.

budget_campaign_association_status.status

String

Budget campaign association status.

campaign

String

Resource name of the campaign.

click_type

String

Click type.

conversion_action

String

Resource name of the conversion action.

conversion_action_category

String

Conversion action category.

conversion_action_name

String

Conversion action name.

conversion_adjustment

Boolean

This segments your conversion columns by the original conversion and conversion value vs. the delta if conversions were adjusted. False row has the data as originally stated; While true row has the delta between data now and the data as originally stated. Summing the two together results post-adjustment data.

conversion_attribution_event_type

String

Conversion attribution event type.

conversion_lag_bucket

String

An enum value representing the number of days between the impression and the conversion.

conversion_or_adjustment_lag_bucket

String

An enum value representing the number of days between the impression and the conversion or between the impression and adjustments to the conversion.

conversion_value_rule_primary_dimension

String

Primary dimension of applied conversion value rules. NO_RULE_APPLIED shows the total recorded value of conversions that do not have a value rule applied. ORIGINAL shows the original value of conversions to which a value rule has been applied. GEO_LOCATION, DEVICE, AUDIENCE show the net adjustment after value rules were applied.

date

DateTime

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

day_of_week

String

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

device

String

Device to which metrics apply.

external_activity_id

String

Advertiser supplied activity ID.

external_conversion_source

String

External conversion source.

geo_target_airport

String

Resource name of the geo target constant that represents an airport.

geo_target_canton

String

Resource name of the geo target constant that represents a canton.

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_county

String

Resource name of the geo target constant that represents a county.

geo_target_district

String

Resource name of the geo target constant that represents a district.

geo_target_metro

String

Resource name of the geo target constant that represents a metro.

geo_target_most_specific_location

String

Resource name of the geo target constant that represents the most specific location.

geo_target_postal_code

String

Resource name of the geo target constant that represents a postal code.

geo_target_province

String

Resource name of the geo target constant that represents a province.

geo_target_region

String

Resource name of the geo target constant that represents a region.

geo_target_state

String

Resource name of the geo target constant that represents a state.

hotel_booking_window_days

Long

Hotel booking window in days.

hotel_center_id

Long

Hotel center ID.

hotel_check_in_date

DateTime

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

hotel_check_in_day_of_week

String

Hotel check-in day of week.

hotel_city

String

Hotel city.

hotel_class

Int

Hotel class.

hotel_country

String

Hotel country.

hotel_date_selection_type

String

Hotel date selection type.

hotel_length_of_stay

Int

Hotel length of stay.

hotel_price_bucket

String

Hotel price bucket.

hotel_rate_rule_id

String

Hotel rate rule ID.

hotel_rate_type

String

Hotel rate type.

hotel_state

String

Hotel state.

hour

Int

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

interaction_on_this_extension

Boolean

Only used with feed item metrics. Indicates whether the interaction metrics occurred on the feed item itself or a different extension or ad unit.

keyword.ad_group_criterion

String

The AdGroupCriterion resource name.

keyword.info.match_type

String

The match type of the keyword.

keyword.info.text

String

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

month

DateTime

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

month_of_year

String

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

new_versus_returning_customers

String

This is for segmenting conversions by whether the user is a new customer or a returning customer. This segmentation is typically used to measure the impact of customer acquisition goal.

partner_hotel_id

String

Partner hotel ID.

placeholder_type

String

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

product_aggregator_id

Long

Aggregator ID of the product.

product_brand

String

Brand of the product.

product_category_level1

String

Category (level 1) of the product.

product_category_level2

String

Category (level 2) of the product.

product_category_level3

String

Category (level 3) of the product.

product_category_level4

String

Category (level 4) of the product.

product_category_level5

String

Category (level 5) of the product.

product_channel

String

Channel of the product.

product_channel_exclusivity

String

Channel exclusivity of the product.

product_condition

String

Condition 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_feed_label

String

Feed label 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_merchant_id

Long

Merchant ID of the product.

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

DateTime

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.

recommendation_type

String

Recommendation type.

search_engine_results_page_type

String

Type of the search engine results page.

search_subcategory

String

A search term subcategory. An empty string denotes the catch-all subcategory for search terms that didn't fit into another subcategory.

search_term

String

A search term.

search_term_match_type

String

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

sk_ad_network_ad_event_type

String

iOS Store Kit Ad Network ad event type.

sk_ad_network_attribution_credit

String

iOS Store Kit Ad Network attribution credit

sk_ad_network_coarse_conversion_value

String

iOS Store Kit Ad Network coarse conversion value.

sk_ad_network_fine_conversion_value

Long

iOS Store Kit Ad Network conversion value. Null value means this segment is not applicable, e.g. non-iOS campaign.

sk_ad_network_postback_sequence_index

Long

iOS Store Kit Ad Network postback sequence index.

sk_ad_network_source_app.sk_ad_network_source_app_id

String

App id where the ad that drove the iOS Store Kit Ad Network install was shown.

sk_ad_network_source_domain

String

Website where the ad that drove the iOS Store Kit Ad Network install was shown. Null value means this segment is not applicable, for example, non-iOS campaign, or was not present in any postbacks sent by Apple.

sk_ad_network_source_type

String

The source type where the ad that drove the iOS Store Kit Ad Network install was shown. Null value means this segment is not applicable, for example, non-iOS campaign, or neither source domain nor source app were present in any postbacks sent by Apple.

sk_ad_network_user_type

String

iOS Store Kit Ad Network user type.

slot

String

Position of the ad.

webpage

String

Resource name of the ad group criterion that represents webpage criterion.

week

DateTime

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

year

Int

Year, formatted as yyyy.

Resource fields

Attributes of the campaign, ad group, ad and other objects. Which of these are available depends on the report type the connector reads.

Column
Type
Description

ad_group.ad_rotation_mode

String

The ad rotation mode of the ad group.

ad_group.audience_setting.use_audience_grouped

Boolean

Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead.

ad_group.base_ad_group

String

Output only. For draft or experiment ad groups, this field is the resource name of the base ad group from which this ad group was created. If a draft or experiment ad group does not have a base ad group, then this field is null. For base ad groups, this field equals the ad group resource name. This field is read-only.

ad_group.campaign

String

Immutable. The campaign to which the ad group belongs.

ad_group.cpc_bid_micros

Long

The maximum CPC (cost-per-click) bid.

ad_group.cpm_bid_micros

Long

The maximum CPM (cost-per-thousand viewable impressions) bid.

ad_group.cpv_bid_micros

Long

Output only. The CPV (cost-per-view) bid.

ad_group.display_custom_bid_dimension

String

Allows advertisers to specify a targeting dimension on which to place absolute bids. This is only applicable for campaigns that target only the display network and not search.

ad_group.effective_cpc_bid_micros

Long

Output only. Value will be same as that of the CPC (cost-per-click) bid value when the bidding strategy is one of manual cpc, enhanced cpc, page one promoted or target outrank share, otherwise the value will be null.

ad_group.effective_target_cpa_micros

Long

Output only. The effective target CPA (cost-per-acquisition). This field is read-only.

ad_group.effective_target_cpa_source

String

Output only. Source of the effective target CPA. This field is read-only.

ad_group.effective_target_roas

Double

Output only. The effective target ROAS (return-on-ad-spend). This field is read-only.

ad_group.effective_target_roas_source

String

Output only. Source of the effective target ROAS. This field is read-only.

ad_group.excluded_parent_asset_field_types

Other

The asset field types that should be excluded from this ad group. Asset links with these field types will not be inherited by this ad group from the upper levels.

ad_group.excluded_parent_asset_set_types

String

The asset set types that should be excluded from this ad group. Asset set links with these types will not be inherited by this ad group from the upper levels. Location group types (GMB_DYNAMIC_LOCATION_GROUP, CHAIN_DYNAMIC_LOCATION_GROUP, and STATIC_LOCATION_GROUP) are child types of LOCATION_SYNC. Therefore, if LOCATION_SYNC is set for this field, all location group asset sets are not allowed to be linked to this ad group, and all Location Extension (LE) and Affiliate Location Extensions (ALE) will not be served under this ad group. Only LOCATION_SYNC is currently supported.

ad_group.final_url_suffix

String

URL template for appending params to Final URL.

ad_group.id

Long

Output only. The ID of the ad group.

ad_group.labels

Other

Output only. The resource names of labels attached to this ad group.

ad_group.name

String

The name of the ad group. This field is required and should not be empty when creating new ad groups. It must contain fewer than 255 UTF-8 full-width characters. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters.

ad_group.optimized_targeting_enabled

Boolean

True if optimized targeting is enabled. Optimized Targeting is the replacement for Audience Expansion.

ad_group.percent_cpc_bid_micros

Long

The percent cpc bid amount, expressed as a fraction of the advertised price for some good or service. The valid range for the fraction is [0,1) and the value stored here is 1,000,000 * [fraction].

ad_group.primary_status

String

Output only. Provides aggregated view into why an ad group is not serving or not serving optimally.

ad_group.primary_status_reasons

String

Output only. Provides reasons for why an ad group is not serving or not serving optimally.

ad_group.resource_name

String

Immutable. The resource name of the ad group. Ad group resource names have the form: customers/{customer_id}/adGroups/{ad_group_id}

ad_group.status

String

The status of the ad group.

ad_group.target_cpa_micros

Long

The target CPA (cost-per-acquisition). If the ad group's campaign bidding strategy is TargetCpa or MaximizeConversions (with its target_cpa field set), then this field overrides the target CPA specified in the campaign's bidding strategy. Otherwise, this value is ignored.

ad_group.target_cpm_micros

Long

Average amount in micros that the advertiser is willing to pay for every thousand times the ad is shown.

ad_group.target_roas

Double

The target ROAS (return-on-ad-spend) override. If the ad group's campaign bidding strategy is TargetRoas or MaximizeConversionValue (with its target_roas field set), then this field overrides the target ROAS specified in the campaign's bidding strategy. Otherwise, this value is ignored.

ad_group.targeting_setting.target_restrictions

Other

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

ad_group.tracking_url_template

String

The URL template for constructing a tracking URL.

ad_group.type

String

Immutable. The type of the ad group.

ad_group.url_custom_parameters

Other

The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls.

ad_group_ad.action_items

Other

Output only. A list of recommendations to improve the ad strength. For example, a recommendation could be "Your headlines are a little too similar. Try adding more distinct headlines.".

ad_group_ad.ad.added_by_google_ads

Boolean

Output only. Indicates if this ad was automatically added by Google Ads and not by a user. For example, this could happen when ads are automatically created as suggestions for new ads based on knowledge of how existing ads are performing.

ad_group_ad.ad.app_ad.descriptions

Other

List of text assets for descriptions. When the ad serves the descriptions will be selected from this list.

ad_group_ad.ad.app_ad.headlines

Other

List of text assets for headlines. When the ad serves the headlines will be selected from this list.

ad_group_ad.ad.app_ad.html5_media_bundles

Other

List of media bundle assets that may be used with the ad.

ad_group_ad.ad.app_ad.html5_media_bundles.asset

String

The Asset resource name of this media bundle.

ad_group_ad.ad.app_ad.images

Other

List of image assets that may be displayed with the ad.

ad_group_ad.ad.app_ad.images.asset

String

The Asset resource name of this image.

ad_group_ad.ad.app_ad.mandatory_ad_text

String

Mandatory ad text.

ad_group_ad.ad.app_ad.youtube_videos

Other

List of YouTube video assets that may be displayed with the ad.

ad_group_ad.ad.app_ad.youtube_videos.asset

String

The Asset resource name of this video.

ad_group_ad.ad.app_engagement_ad.descriptions

Other

List of text assets for descriptions. When the ad serves the descriptions will be selected from this list.

ad_group_ad.ad.app_engagement_ad.headlines

Other

List of text assets for headlines. When the ad serves the headlines will be selected from this list.

ad_group_ad.ad.app_engagement_ad.images

Other

List of image assets that may be displayed with the ad.

ad_group_ad.ad.app_engagement_ad.images.asset

String

The Asset resource name of this image.

ad_group_ad.ad.app_engagement_ad.videos

Other

List of video assets that may be displayed with the ad.

ad_group_ad.ad.app_engagement_ad.videos.asset

String

The Asset resource name of this video.

ad_group_ad.ad.app_pre_registration_ad.descriptions

Other

List of text assets for descriptions. When the ad serves the descriptions will be selected from this list.

ad_group_ad.ad.app_pre_registration_ad.headlines

Other

List of text assets for headlines. When the ad serves the headlines will be selected from this list.

ad_group_ad.ad.app_pre_registration_ad.images

Other

List of image asset IDs whose images may be displayed with the ad.

ad_group_ad.ad.app_pre_registration_ad.images.asset

String

The Asset resource name of this image.

ad_group_ad.ad.app_pre_registration_ad.youtube_videos

Other

List of YouTube video asset IDs whose videos may be displayed with the ad.

ad_group_ad.ad.app_pre_registration_ad.youtube_videos.asset

String

The Asset resource name of this video.

ad_group_ad.ad.call_ad.business_name

String

The business name in the ad.

ad_group_ad.ad.call_ad.call_tracked

Boolean

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

ad_group_ad.ad.call_ad.conversion_action

String

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.

ad_group_ad.ad.call_ad.conversion_reporting_state

String

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

ad_group_ad.ad.call_ad.country_code

String

The country code in the ad.

ad_group_ad.ad.call_ad.description1

String

The first line of the ad's description.

ad_group_ad.ad.call_ad.description2

String

The second line of the ad's description.

ad_group_ad.ad.call_ad.disable_call_conversion

Boolean

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.

ad_group_ad.ad.call_ad.headline1

String

First headline in the ad.

ad_group_ad.ad.call_ad.headline2

String

Second headline in the ad.

ad_group_ad.ad.call_ad.path1

String

First part of text that can be appended to the URL in the ad. Optional.

ad_group_ad.ad.call_ad.path2

String

Second part of text that can be appended to the URL in the ad. This field can only be set when path1 is also set. Optional.

ad_group_ad.ad.call_ad.phone_number

String

The phone number in the ad.

ad_group_ad.ad.call_ad.phone_number_verification_url

String

The URL to be used for phone number verification.

ad_group_ad.ad.demand_gen_product_ad.breadcrumb1

String

First part of text that appears in the ad with the displayed URL.

ad_group_ad.ad.demand_gen_product_ad.breadcrumb2

String

Second part of text that appears in the ad with the displayed URL.

ad_group_ad.ad.demand_gen_product_ad.business_name

String

Required. The advertiser/brand name.

ad_group_ad.ad.demand_gen_product_ad.call_to_action

String

Asset of type CallToActionAsset used for the "Call To Action" button.

ad_group_ad.ad.demand_gen_product_ad.call_to_action.asset

String

The Asset resource name of this call to action asset.

ad_group_ad.ad.demand_gen_product_ad.description

String

Required. Text asset used for the description.

ad_group_ad.ad.demand_gen_product_ad.headline

String

Required. Text asset used for the short headline.

ad_group_ad.ad.demand_gen_product_ad.logo_image

String

Required. Logo image to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 128x128 and the aspect ratio must be 1:1 (+-1%).

ad_group_ad.ad.demand_gen_product_ad.logo_image.asset

String

The Asset resource name of this image.

ad_group_ad.ad.device_preference

String

The device preference for the ad. You can only specify a preference for mobile devices. When this preference is set the ad will be preferred over other ads when being displayed on a mobile device. The ad can still be displayed on other device types, e.g. if no other ads are available. If unspecified (no device preference), all devices are targeted. This is only supported by some ad types.

ad_group_ad.ad.demand_gen_carousel_ad.business_name

String

Required. The Advertiser/brand name.

ad_group_ad.ad.demand_gen_carousel_ad.call_to_action_text

String

Call to action text.

ad_group_ad.ad.demand_gen_carousel_ad.carousel_cards

String

Required. Carousel cards that will display with the ad. Min 2 max 10.

ad_group_ad.ad.demand_gen_carousel_ad.carousel_cards.asset

String

The Asset resource name of this discovery carousel card.

ad_group_ad.ad.demand_gen_carousel_ad.description

String

Required. The descriptive text of the ad.

ad_group_ad.ad.demand_gen_carousel_ad.headline

String

Required. Headline of the ad.

ad_group_ad.ad.demand_gen_carousel_ad.logo_image

String

Required. Logo image to be used in the ad. The minimum size is 128x128 and the aspect ratio must be 1:1 (+-1%).

ad_group_ad.ad.demand_gen_carousel_ad.logo_image.asset

String

The Asset resource name of this image.

ad_group_ad.ad.demand_gen_multi_asset_ad.business_name

String

The Advertiser/brand name. Maximum display width is 25. Required.

ad_group_ad.ad.demand_gen_multi_asset_ad.call_to_action_text

String

Call to action text.

ad_group_ad.ad.demand_gen_multi_asset_ad.descriptions

String

The descriptive text of the ad. Maximum display width is 90. At least 1 and max 5 descriptions can be specified.

ad_group_ad.ad.demand_gen_multi_asset_ad.headlines

String

Headline text asset of the ad. Maximum display width is 30. At least 1 and max 5 headlines can be specified.

ad_group_ad.ad.demand_gen_multi_asset_ad.lead_form_only

Boolean

Boolean option that indicates if this ad must be served with lead form.

ad_group_ad.ad.demand_gen_multi_asset_ad.logo_images

String

Logo image assets to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 128x128 and the aspect ratio must be 1:1 (+-1%). At least 1 and max 5 logo images can be specified.

ad_group_ad.ad.demand_gen_multi_asset_ad.logo_images.asset

String

The Asset resource name of this image.

ad_group_ad.ad.demand_gen_multi_asset_ad.marketing_images

String

Marketing image assets to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 600x314 and the aspect ratio must be 1.91:1 (+-1%). Required if square_marketing_images is not present. Combined with square_marketing_images and portrait_marketing_images the maximum is 20.

ad_group_ad.ad.demand_gen_multi_asset_ad.marketing_images.asset

String

The Asset resource name of this image.

ad_group_ad.ad.demand_gen_multi_asset_ad.portrait_marketing_images

String

Portrait marketing image assets to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 480x600 and the aspect ratio must be 4:5 (+-1%). Combined with marketing_images and square_marketing_images the maximum is 20.

ad_group_ad.ad.demand_gen_multi_asset_ad.portrait_marketing_images.asset

String

The Asset resource name of this image.

ad_group_ad.ad.demand_gen_multi_asset_ad.square_marketing_images

String

Square marketing image assets to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 300x300 and the aspect ratio must be 1:1 (+-1%). Required if marketing_images is not present. Combined with marketing_images and portrait_marketing_images the maximum is 20.

ad_group_ad.ad.demand_gen_multi_asset_ad.square_marketing_images.asset

String

The Asset resource name of this image.

ad_group_ad.ad.demand_gen_video_responsive_ad.breadcrumb1

String

First part of text that appears in the ad with the displayed URL.

ad_group_ad.ad.demand_gen_video_responsive_ad.breadcrumb2

String

Second part of text that appears in the ad with the displayed URL.

ad_group_ad.ad.demand_gen_video_responsive_ad.business_name

String

Required. The advertiser/brand name.

ad_group_ad.ad.demand_gen_video_responsive_ad.call_to_actions

String

Assets of type CallToActionAsset used for the "Call To Action" button.

ad_group_ad.ad.demand_gen_video_responsive_ad.call_to_actions.asset

String

The Asset resource name of this call to action asset.

ad_group_ad.ad.demand_gen_video_responsive_ad.descriptions

String

List of text assets used for the description.

ad_group_ad.ad.demand_gen_video_responsive_ad.headlines

String

List of text assets used for the short headline.

ad_group_ad.ad.demand_gen_video_responsive_ad.logo_images

String

Logo image to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 128x128 and the aspect ratio must be 1:1 (+-1%).

ad_group_ad.ad.demand_gen_video_responsive_ad.logo_images.asset

String

The Asset resource name of this image.

ad_group_ad.ad.demand_gen_video_responsive_ad.long_headlines

String

List of text assets used for the long headline.

ad_group_ad.ad.demand_gen_video_responsive_ad.videos

String

List of YouTube video assets used for the ad.

ad_group_ad.ad.demand_gen_video_responsive_ad.videos.asset

String

The Asset resource name of this video.

ad_group_ad.ad.display_upload_ad.display_upload_product_type

String

The product type of this ad. See comments on the enum for details.

ad_group_ad.ad.display_upload_ad.media_bundle

String

A media bundle asset to be used in the ad. For information about the media bundle for HTML5_UPLOAD_AD, see https://support.google.com/google-ads/answer/1722096 Media bundles that are part of dynamic product types use a special format that needs to be created through the Google Web Designer. See https://support.google.com/webdesigner/answer/7543898 for more information.

ad_group_ad.ad.display_upload_ad.media_bundle.asset

String

The Asset resource name of this media bundle.

ad_group_ad.ad.display_url

String

The URL that appears in the ad description for some ad formats.

ad_group_ad.ad.expanded_dynamic_search_ad.description

String

The description of the ad.

ad_group_ad.ad.expanded_dynamic_search_ad.description2

String

The second description of the ad.

ad_group_ad.ad.expanded_text_ad.description

String

The description of the ad.

ad_group_ad.ad.expanded_text_ad.description2

String

The second description of the ad.

ad_group_ad.ad.expanded_text_ad.headline_part1

String

The first part of the ad's headline.

ad_group_ad.ad.expanded_text_ad.headline_part2

String

The second part of the ad's headline.

ad_group_ad.ad.expanded_text_ad.headline_part3

String

The third part of the ad's headline.

ad_group_ad.ad.expanded_text_ad.path1

String

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

ad_group_ad.ad.expanded_text_ad.path2

String

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

ad_group_ad.ad.final_app_urls

Other

A list of final app URLs that will be used on mobile if the user has the specific app installed.

ad_group_ad.ad.final_mobile_urls

Other

The list of possible final mobile URLs after all cross-domain redirects for the ad.

ad_group_ad.ad.final_url_suffix

String

The suffix to use when constructing a final URL.

ad_group_ad.ad.final_urls

Other

The list of possible final URLs after all cross-domain redirects for the ad.

ad_group_ad.ad.hotel_ad

String

Details pertaining to a hotel ad.

ad_group_ad.ad.id

Long

Output only. The ID of the ad.

ad_group_ad.ad.image_ad.image_asset.asset

String

The Asset resource name of this image.

ad_group_ad.ad.image_ad.image_url

String

URL of the full size image.

ad_group_ad.ad.image_ad.mime_type

String

The mime type of the image.

ad_group_ad.ad.image_ad.name

String

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.

ad_group_ad.ad.image_ad.pixel_height

Long

Height in pixels of the full size image.

ad_group_ad.ad.image_ad.pixel_width

Long

Width in pixels of the full size image.

ad_group_ad.ad.image_ad.preview_image_url

String

URL of the preview size image.

ad_group_ad.ad.image_ad.preview_pixel_height

Long

Height in pixels of the preview size image.

ad_group_ad.ad.image_ad.preview_pixel_width

Long

Width in pixels of the preview size image.

ad_group_ad.ad.legacy_app_install_ad

String

Immutable. Details pertaining to a legacy app install ad.

ad_group_ad.ad.legacy_responsive_display_ad.accent_color

String

The accent color of the ad in hexadecimal, e.g. #ffffff for white. If one of main_color and accent_color is set, the other is required as well.

ad_group_ad.ad.legacy_responsive_display_ad.allow_flexible_color

Boolean

Advertiser's consent to allow flexible color. When true, the ad may be served with different color if necessary. When false, the ad will be served with the specified colors or a neutral color. The default value is true. Must be true if main_color and accent_color are not set.

ad_group_ad.ad.legacy_responsive_display_ad.business_name

String

The business name in the ad.

ad_group_ad.ad.legacy_responsive_display_ad.call_to_action_text

String

The call-to-action text for the ad.

ad_group_ad.ad.legacy_responsive_display_ad.description

String

The description of the ad.

ad_group_ad.ad.legacy_responsive_display_ad.format_setting

String

Specifies which format the ad will be served in. Default is ALL_FORMATS.

ad_group_ad.ad.legacy_responsive_display_ad.logo_image

String

The MediaFile resource name of the logo image used in the ad.

ad_group_ad.ad.legacy_responsive_display_ad.long_headline

String

The long version of the ad's headline.

ad_group_ad.ad.legacy_responsive_display_ad.main_color

String

The main color of the ad in hexadecimal, e.g. #ffffff for white. If one of main_color and accent_color is set, the other is required as well.

ad_group_ad.ad.legacy_responsive_display_ad.marketing_image

String

The MediaFile resource name of the marketing image used in the ad.

ad_group_ad.ad.legacy_responsive_display_ad.price_prefix

String

Prefix before price. E.g. 'as low as'.

ad_group_ad.ad.legacy_responsive_display_ad.promo_text

String

Promotion text used for dynamic formats of responsive ads. For example 'Free two-day shipping'.

ad_group_ad.ad.legacy_responsive_display_ad.short_headline

String

The short version of the ad's headline.

ad_group_ad.ad.legacy_responsive_display_ad.square_logo_image

String

The MediaFile resource name of the square logo image used in the ad.

ad_group_ad.ad.legacy_responsive_display_ad.square_marketing_image

String

The MediaFile resource name of the square marketing image used in the ad.

ad_group_ad.ad.local_ad.call_to_actions

Other

List of text assets for call-to-actions. When the ad serves the call-to-actions will be selected from this list. Call-to-actions are optional and at most 5 can be specified.

ad_group_ad.ad.local_ad.descriptions

Other

List of text assets for descriptions. When the ad serves the descriptions will be selected from this list. At least 1 and at most 5 descriptions must be specified.

ad_group_ad.ad.local_ad.headlines

Other

List of text assets for headlines. When the ad serves the headlines will be selected from this list. At least 1 and at most 5 headlines must be specified.

ad_group_ad.ad.local_ad.logo_images

Other

List of logo image assets that may be displayed with the ad. The images must be 128x128 pixels and not larger than 120KB. At least 1 and at most 5 image assets must be specified.

ad_group_ad.ad.local_ad.logo_images.asset

String

The Asset resource name of this image.

ad_group_ad.ad.local_ad.marketing_images

Other

List of marketing image assets that may be displayed with the ad. The images must be 314x600 pixels or 320x320 pixels. At least 1 and at most 20 image assets must be specified.

ad_group_ad.ad.local_ad.marketing_images.asset

String

The Asset resource name of this image.

ad_group_ad.ad.local_ad.path1

String

First part of optional text that can be appended to the URL in the ad.

ad_group_ad.ad.local_ad.path2

String

Second part of optional text that can be appended to the URL in the ad. This field can only be set when path1 is also set.

ad_group_ad.ad.local_ad.videos

Other

List of YouTube video assets that may be displayed with the ad. Videos are optional and at most 20 can be specified.

ad_group_ad.ad.local_ad.videos.asset

String

The Asset resource name of this video.

ad_group_ad.ad.name

String

Immutable. The name of the ad. This is only used to be able to identify the ad. It does not need to be unique and does not affect the served ad. The name field is currently only supported for DisplayUploadAd, ImageAd, ShoppingComparisonListingAd and VideoAd.

ad_group_ad.ad.resource_name

String

Immutable. The resource name of the ad. Ad resource names have the form: customers/{customer_id}/ads/{ad_id}

ad_group_ad.ad.responsive_display_ad.accent_color

String

The accent color of the ad in hexadecimal, e.g. #ffffff for white. If one of main_color and accent_color is set, the other is required as well.

ad_group_ad.ad.responsive_display_ad.allow_flexible_color

Boolean

Advertiser's consent to allow flexible color. When true, the ad may be served with different color if necessary. When false, the ad will be served with the specified colors or a neutral color. The default value is true. Must be true if main_color and accent_color are not set.

ad_group_ad.ad.responsive_display_ad.business_name

String

The advertiser/brand name. Maximum display width is 25.

ad_group_ad.ad.responsive_display_ad.call_to_action_text

String

The call-to-action text for the ad. Maximum display width is 30.

ad_group_ad.ad.responsive_display_ad.control_spec.enable_asset_enhancements

Boolean

Whether the advertiser has opted into the asset enhancements feature.

ad_group_ad.ad.responsive_display_ad.control_spec.enable_autogen_video

Boolean

Whether the advertiser has opted into auto-gen video feature.

ad_group_ad.ad.responsive_display_ad.descriptions

Other

Descriptive texts for the ad. The maximum length is 90 characters. At least 1 and max 5 headlines can be specified.

ad_group_ad.ad.responsive_display_ad.format_setting

String

Specifies which format the ad will be served in. Default is ALL_FORMATS.

ad_group_ad.ad.responsive_display_ad.headlines

Other

Short format headlines for the ad. The maximum length is 30 characters. At least 1 and max 5 headlines can be specified.

ad_group_ad.ad.responsive_display_ad.logo_images

Other

Logo images to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 512x128 and the aspect ratio must be 4:1 (+-1%). Combined with square_logo_images, the maximum is 5.

ad_group_ad.ad.responsive_display_ad.logo_images.asset

String

The Asset resource name of this image.

ad_group_ad.ad.responsive_display_ad.long_headline

String

A required long format headline. The maximum length is 90 characters.

ad_group_ad.ad.responsive_display_ad.main_color

String

The main color of the ad in hexadecimal, e.g. #ffffff for white. If one of main_color and accent_color is set, the other is required as well.

ad_group_ad.ad.responsive_display_ad.marketing_images

Other

Marketing images to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 600x314 and the aspect ratio must be 1.91:1 (+-1%). At least one marketing_image is required. Combined with square_marketing_images, the maximum is 15.

ad_group_ad.ad.responsive_display_ad.marketing_images.asset

String

The Asset resource name of this image.

ad_group_ad.ad.responsive_display_ad.price_prefix

String

Prefix before price. E.g. 'as low as'.

ad_group_ad.ad.responsive_display_ad.promo_text

String

Promotion text used for dynamic formats of responsive ads. For example 'Free two-day shipping'.

ad_group_ad.ad.responsive_display_ad.square_logo_images

Other

Square logo images to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 128x128 and the aspect ratio must be 1:1 (+-1%). Combined with square_logo_images, the maximum is 5.

ad_group_ad.ad.responsive_display_ad.square_logo_images.asset

String

The Asset resource name of this image.

ad_group_ad.ad.responsive_display_ad.square_marketing_images

Other

Square marketing images to be used in the ad. Valid image types are GIF, JPEG, and PNG. The minimum size is 300x300 and the aspect ratio must be 1:1 (+-1%). At least one square marketing_image is required. Combined with marketing_images, the maximum is 15.

ad_group_ad.ad.responsive_display_ad.square_marketing_images.asset

String

The Asset resource name of this image.

ad_group_ad.ad.responsive_display_ad.youtube_videos

Other

Optional YouTube videos for the ad. A maximum of 5 videos can be specified.

ad_group_ad.ad.responsive_display_ad.youtube_videos.asset

String

The Asset resource name of this video.

ad_group_ad.ad.responsive_search_ad.descriptions

Other

List of text assets for descriptions. When the ad serves the descriptions will be selected from this list.

ad_group_ad.ad.responsive_search_ad.headlines

Other

List of text assets for headlines. When the ad serves the headlines will be selected from this list.

ad_group_ad.ad.responsive_search_ad.path1

String

First part of text that can be appended to the URL in the ad.

ad_group_ad.ad.responsive_search_ad.path2

String

Second part of text that can be appended to the URL in the ad. This field can only be set when path1 is also set.

ad_group_ad.ad.shopping_comparison_listing_ad.headline

String

Headline of the ad. This field is required. Allowed length is between 25 and 45 characters.

ad_group_ad.ad.shopping_product_ad

String

Details pertaining to a Shopping product ad.

ad_group_ad.ad.shopping_smart_ad

String

Details pertaining to a Smart Shopping ad.

ad_group_ad.ad.smart_campaign_ad.descriptions

Other

List of text assets for descriptions. When the ad serves the descriptions will be selected from this list. 2 descriptions must be specified.

ad_group_ad.ad.smart_campaign_ad.headlines

Other

List of text assets for headlines. When the ad serves the headlines will be selected from this list. 3 headlines must be specified.

ad_group_ad.ad.system_managed_resource_source

String

Output only. If this ad is system managed, then this field will indicate the source. This field is read-only.

ad_group_ad.ad.text_ad.description1

String

The first line of the ad's description.

ad_group_ad.ad.text_ad.description2

String

The second line of the ad's description.

ad_group_ad.ad.text_ad.headline

String

The headline of the ad.

ad_group_ad.ad.tracking_url_template

String

The URL template for constructing a tracking URL.

ad_group_ad.ad.travel_ad

String

Details pertaining to a travel ad.

ad_group_ad.ad.type

String

Output only. The type of ad.

ad_group_ad.ad.url_collections

Other

Additional URLs for the ad that are tagged with a unique identifier that can be referenced from other fields in the ad.

ad_group_ad.ad.url_custom_parameters

Other

The list of mappings that can be used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls. For mutates, please use url custom parameter operations.

ad_group_ad.ad.video_ad.bumper.action_button_label

String

Label on the "Call To Action" button taking the user to the video ad's final URL.

ad_group_ad.ad.video_ad.bumper.action_headline

String

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

ad_group_ad.ad.video_ad.bumper.companion_banner.asset

String

The Asset resource name of this image.

ad_group_ad.ad.video_ad.in_feed.description1

String

First text line for the ad.

ad_group_ad.ad.video_ad.in_feed.description2

String

Second text line for the ad.

ad_group_ad.ad.video_ad.in_feed.headline

String

The headline of the ad.

ad_group_ad.ad.video_ad.in_feed.thumbnail

String

Video thumbnail image to use.

ad_group_ad.ad.video_ad.in_stream.action_button_label

String

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.

ad_group_ad.ad.video_ad.in_stream.action_headline

String

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

ad_group_ad.ad.video_ad.in_stream.companion_banner.asset

String

The Asset resource name of this image.

ad_group_ad.ad.video_ad.non_skippable.action_button_label

String

Label on the "Call To Action" button taking the user to the video ad's final URL.

ad_group_ad.ad.video_ad.non_skippable.action_headline

String

Additional text displayed with the "Call To Action" button to give context and encourage clicking on the button.

ad_group_ad.ad.video_ad.non_skippable.companion_banner.asset

String

The Asset resource name of this image.

ad_group_ad.ad.video_ad.out_stream.description

String

The description line.

ad_group_ad.ad.video_ad.out_stream.headline

String

The headline of the ad.

ad_group_ad.ad.video_ad.video.asset

String

The Asset resource name of this video.

ad_group_ad.ad.video_responsive_ad.breadcrumb1

String

First part of text that appears in the ad with the displayed URL.

ad_group_ad.ad.video_responsive_ad.breadcrumb2

String

Second part of text that appears in the ad with the displayed URL.

ad_group_ad.ad.video_responsive_ad.call_to_actions

Other

List of text assets used for the button, e.g. the "Call To Action" button. Currently, only a single value for the button is supported.

ad_group_ad.ad.video_responsive_ad.companion_banners

Other

List of image assets used for the companion banner. Currently, only a single value for the companion banner asset is supported.

ad_group_ad.ad.video_responsive_ad.companion_banners.asset

String

The Asset resource name of this image.

ad_group_ad.ad.video_responsive_ad.descriptions

Other

List of text assets used for the description. Currently, only a single value for the description is supported.

ad_group_ad.ad.video_responsive_ad.headlines

Other

List of text assets used for the short headline, e.g. the "Call To Action" banner. Currently, only a single value for the short headline is supported.

ad_group_ad.ad.video_responsive_ad.long_headlines

Other

List of text assets used for the long headline. Currently, only a single value for the long headline is supported.

ad_group_ad.ad.video_responsive_ad.videos

Other

List of YouTube video assets used for the ad. Currently, only a single value for the YouTube video asset is supported.

ad_group_ad.ad.video_responsive_ad.videos.asset

String

The Asset resource name of this video.

ad_group_ad.ad_group

String

Immutable. The ad group to which the ad belongs.

ad_group_ad.ad_strength

String

Output only. Overall ad strength for this ad group ad.

ad_group_ad.labels

Other

Output only. The resource names of labels attached to this ad group ad.

ad_group_ad.policy_summary.approval_status

String

Output only. The overall approval status of this ad, calculated based on the status of its individual policy topic entries.

ad_group_ad.policy_summary.policy_topic_entries

Other

Output only. The list of policy findings for this ad.

ad_group_ad.policy_summary.review_status

String

Output only. Where in the review process this ad is.

ad_group_ad.primary_status

String

Output only. Provides aggregated view into why an ad group ad is not serving or not serving optimally.

ad_group_ad.primary_status_reasons

String

Output only. Provides reasons for why an ad group ad is not serving or not serving optimally.

ad_group_ad.resource_name

String

Immutable. The resource name of the ad. Ad group ad resource names have the form: customers/{customer_id}/adGroupAds/{ad_group_id}~{ad_id}

ad_group_ad.status

String

The status of the ad.

ad_group_ad_asset_combination_view.enabled

Boolean

Output only. The status between the asset combination and the latest version of the ad. If true, the asset combination is linked to the latest version of the ad. If false, it means the link once existed but has been removed and is no longer present in the latest version of the ad.

ad_group_ad_asset_combination_view.resource_name

String

Output only. The resource name of the ad group ad asset combination view. The combination ID is 128 bits long, where the upper 64 bits are stored in asset_combination_id_high, and the lower 64 bits are stored in asset_combination_id_low. AdGroupAd Asset Combination view resource names have the form: customers/{customer_id}/adGroupAdAssetCombinationViews/{AdGroupAd.ad_group_id}{AdGroupAd.ad.ad_id}{AssetCombination.asset_combination_id_low}~{AssetCombination.asset_combination_id_high}

ad_group_ad_asset_combination_view.served_assets

String

Output only. Served assets.

ad_group_ad_asset_view.ad_group_ad

String

Output only. The ad group ad to which the asset is linked.

ad_group_ad_asset_view.asset

String

Output only. The asset which is linked to the ad group ad.

ad_group_ad_asset_view.enabled

Boolean

Output only. The status between the asset and the latest version of the ad. If true, the asset is linked to the latest version of the ad. If false, it means the link once existed but has been removed and is no longer present in the latest version of the ad.

ad_group_ad_asset_view.field_type

String

Output only. Role that the asset takes in the ad.

ad_group_ad_asset_view.performance_label

String

Output only. Performance of an asset linkage.

ad_group_ad_asset_view.pinned_field

String

Output only. Pinned field.

ad_group_ad_asset_view.policy_summary

String

Output only. Policy information for the ad group ad asset.

ad_group_ad_asset_view.resource_name

String

Output only. The resource name of the ad group ad asset view. Ad group ad asset view resource names have the form (Before V4): customers/{customer_id}/adGroupAdAssets/{AdGroupAdAsset.ad_group_id}{AdGroupAdAsset.ad.ad_id}{AdGroupAdAsset.asset_id}{AdGroupAdAsset.field_type} Ad group ad asset view resource names have the form (Beginning from V4): customers/{customer_id}/adGroupAdAssetViews/{AdGroupAdAsset.ad_group_id}{AdGroupAdAsset.ad_id}{AdGroupAdAsset.asset_id}{AdGroupAdAsset.field_type}

ad_group_ad_asset_view.source

String

Output only. Source of the ad group ad asset.

ad_group_asset.ad_group

String

Required. Immutable. The ad group to which the asset is linked.

ad_group_asset.asset

String

Required. Immutable. The asset which is linked to the ad group.

ad_group_asset.field_type

String

Required. Immutable. Role that the asset takes under the linked ad group.

ad_group_asset.primary_status

String

Output only. Provides the PrimaryStatus of this asset link. Primary status is meant essentially to differentiate between the plain "status" field, which has advertiser set values of enabled, paused, or removed. The primary status takes into account other signals (for assets its mainly policy and quality approvals) to come up with a more comprehensive status to indicate its serving state.

ad_group_asset.primary_status_details

String

Output only. Provides the details of the primary status and its associated reasons.

ad_group_asset.primary_status_reasons

String

Output only. Provides a list of reasons for why an asset is not serving or not serving at full capacity.

ad_group_asset.resource_name

String

Immutable. The resource name of the ad group asset. AdGroupAsset resource names have the form: customers/{customer_id}/adGroupAssets/{ad_group_id}{asset_id}{field_type}

ad_group_asset.source

String

Output only. Source of the adgroup asset link.

ad_group_asset.status

String

Status of the ad group asset.

ad_group_audience_view.resource_name

String

Output only. The resource name of the ad group audience view. Ad group audience view resource names have the form: customers/{customer_id}/adGroupAudienceViews/{ad_group_id}~{criterion_id}

ad_schedule_view.resource_name

String

Output only. The resource name of the ad schedule view. AdSchedule view resource names have the form: customers/{customer_id}/adScheduleViews/{campaign_id}~{criterion_id}

age_range_view.resource_name

String

Output only. The resource name of the age range view. Age range view resource names have the form: customers/{customer_id}/ageRangeViews/{ad_group_id}~{criterion_id}

asset_field_type_view.field_type

String

Output only. The asset field type of the asset field type view.

asset_field_type_view.resource_name

String

Output only. The resource name of the asset field type view. Asset field type view resource names have the form: customers/{customer_id}/assetFieldTypeViews/{field_type}

asset_group.ad_strength

String

Output only. Overall ad strength of this asset group.

asset_group.campaign

String

Immutable. The campaign with which this asset group is associated. The asset which is linked to the asset group.

asset_group.final_mobile_urls

String

A list of final mobile URLs after all cross domain redirects. In performance max, by default, the urls are eligible for expansion unless opted out.

asset_group.final_urls

String

A list of final URLs after all cross domain redirects. In performance max, by default, the urls are eligible for expansion unless opted out.

asset_group.id

Long

Output only. The ID of the asset group.

asset_group.name

String

Required. Name of the asset group. Required. It must have a minimum length of 1 and maximum length of 128. It must be unique under a campaign.

asset_group.path1

String

First part of text that may appear appended to the url displayed in the ad.

asset_group.path2

String

Second part of text that may appear appended to the url displayed in the ad. This field can only be set when path1 is set.

asset_group.primary_status

String

Output only. The primary status of the asset group. Provides insights into why an asset group is not serving or not serving optimally.

asset_group.primary_status_reasons

String

Output only. Provides reasons into why an asset group is not serving or not serving optimally. It will be empty when the asset group is serving without issues.

asset_group.resource_name

String

Immutable. The resource name of the asset group. Asset group resource names have the form: customers/{customer_id}/assetGroups/{asset_group_id}

asset_group.status

String

The status of the asset group.

asset_group_product_group_view.asset_group

String

Output only. The asset group associated with the listing group filter.

asset_group_product_group_view.asset_group_listing_group_filter

String

Output only. The resource name of the asset group listing group filter.

asset_group_product_group_view.resource_name

String

Output only. The resource name of the asset group product group view. Asset group product group view resource names have the form: customers/{customer_id}/assetGroupProductGroupViews/{asset_group_id}~{listing_group_filter_id}

asset_set_asset.asset

String

Immutable. The asset which this asset set asset is linking to.

asset_set_asset.asset_set

String

Immutable. The asset set which this asset set asset is linking to.

asset_set_asset.resource_name

String

Immutable. The resource name of the asset set asset. Asset set asset resource names have the form: customers/{customer_id}/assetSetAssets/{asset_set_id}~{asset_id}

asset_set_asset.status

String

Output only. The status of the asset set asset. Read-only.

asset_set_type_view.asset_set_type

String

Output only. The asset set type of the asset set type view.

asset_set_type_view.resource_name

String

Output only. The resource name of the asset set type view. Asset set type view resource names have the form: customers/{customer_id}/assetSetTypeViews/{asset_set_type}

bidding_strategy.aligned_campaign_budget_id

long

ID of the campaign budget that this portfolio bidding strategy is aligned with. When a portfolio and a campaign budget are aligned, that means that they are attached to the same set of campaigns. After a bidding strategy is aligned with a campaign budget, campaigns that are added to the bidding strategy must also use the aligned campaign budget.

bidding_strategy.campaign_count

Long

Output only. The number of campaigns attached to this bidding strategy. This field is read-only.

bidding_strategy.currency_code

String

Immutable. The currency used by the bidding strategy (ISO 4217 three-letter code). For bidding strategies in manager customers, this currency can be set on creation and defaults to the manager customer's currency. For serving customers, this field cannot be set; all strategies in a serving customer implicitly use the serving customer's currency. In all cases the effective_currency_code field returns the currency used by the strategy.

bidding_strategy.effective_currency_code

String

Output only. The currency used by the bidding strategy (ISO 4217 three-letter code). For bidding strategies in manager customers, this is the currency set by the advertiser when creating the strategy. For serving customers, this is the customer's currency_code. Bidding strategy metrics are reported in this currency. This field is read-only.

bidding_strategy.enhanced_cpc

String

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

bidding_strategy.id

Long

Output only. The ID of the bidding strategy.

bidding_strategy.maximize_conversion_value.cpc_bid_ceiling_micros

Long

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.

bidding_strategy.maximize_conversion_value.cpc_bid_floor_micros

Long

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.

bidding_strategy.maximize_conversion_value.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.

bidding_strategy.maximize_conversions.cpc_bid_ceiling_micros

Long

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.

bidding_strategy.maximize_conversions.cpc_bid_floor_micros

Long

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.

bidding_strategy.maximize_conversions.target_cpa_micros

Long

Output only. The target cost per acquisition (CPA) option. This is the average amount that you would like to spend per acquisition.

bidding_strategy.name

String

The name of the bidding strategy. All bidding strategies within an account must be named distinctly. The length of this string should be between 1 and 255, inclusive, in UTF-8 bytes, (trimmed).

bidding_strategy.non_removed_campaign_count

Long

Output only. The number of non-removed campaigns attached to this bidding strategy. This field is read-only.

bidding_strategy.resource_name

String

Immutable. The resource name of the bidding strategy. Bidding strategy resource names have the form: customers/{customer_id}/biddingStrategies/{bidding_strategy_id}

bidding_strategy.status

String

Output only. The status of the bidding strategy. This field is read-only.

bidding_strategy.target_cpa.cpc_bid_ceiling_micros

Long

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.

bidding_strategy.target_cpa.cpc_bid_floor_micros

Long

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.

bidding_strategy.target_cpa.target_cpa_micros

Long

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

bidding_strategy.target_impression_share.cpc_bid_ceiling_micros

Long

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.

bidding_strategy.target_impression_share.location

String

The targeted location on the search results page.

bidding_strategy.target_impression_share.location_fraction_micros

Long

The desired fraction of ads to be shown in the targeted location in micros. E.g. 1% equals 10,000.

bidding_strategy.target_roas.cpc_bid_ceiling_micros

Long

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.

bidding_strategy.target_roas.cpc_bid_floor_micros

Long

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.

bidding_strategy.target_roas.target_roas

Double

Output only. The desired revenue (based on conversion data) per unit of spend.

bidding_strategy.target_spend.cpc_bid_ceiling_micros

Long

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

bidding_strategy.target_spend.target_spend_micros

Long

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.

bidding_strategy.type

String

Output only. The type of the bidding strategy. Create a bidding strategy by setting the bidding scheme. This field is read-only.

campaign.accessible_bidding_strategy

String

Output only. Resource name of AccessibleBiddingStrategy, a read-only view of the unrestricted attributes of the attached portfolio bidding strategy identified by 'bidding_strategy'. Empty, if the campaign does not use a portfolio strategy. Unrestricted strategy attributes are available to all customers with whom the strategy is shared and are read from the AccessibleBiddingStrategy resource. In contrast, restricted attributes are only available to the owner customer of the strategy and their managers. Restricted attributes can only be read from the BiddingStrategy resource.

campaign.ad_serving_optimization_status

String

The ad serving optimization status of the campaign.

campaign.advertising_channel_sub_type

String

Immutable. Optional refinement to advertising_channel_type. Must be a valid sub-type of the parent channel type. Can be set only when creating campaigns. After campaign is created, the field can not be changed.

campaign.advertising_channel_type

String

Immutable. The primary serving target for ads within the campaign. The targeting options can be refined in network_settings. This field is required and should not be empty when creating new campaigns. Can be set only when creating campaigns. After the campaign is created, the field can not be changed.

campaign.app_campaign_setting.app_id

String

Immutable. A string that uniquely identifies a mobile application.

campaign.app_campaign_setting.app_store

String

Immutable. The application store that distributes this specific app.

campaign.app_campaign_setting.bidding_strategy_goal_type

String

Represents the goal which the bidding strategy of this app campaign should optimize towards.

campaign.asset_automation_settings

String

Contains the opt-in/out status of each AssetAutomationType. See documentation of each asset automation type enum for default opt in/out behavior.

campaign.audience_setting.use_audience_grouped

Boolean

Immutable. If true, this campaign uses an Audience resource for audience targeting. If false, this campaign may use audience segment criteria instead.

campaign.base_campaign

String

Output only. The resource name of the base campaign of a draft or experiment campaign. For base campaigns, this is equal to resource_name. This field is read-only.

campaign.bidding_strategy

String

Portfolio bidding strategy used by campaign.

campaign.bidding_strategy_system_status

String

Output only. The system status of the campaign's bidding strategy.

campaign.bidding_strategy_type

String

Output only. The type of bidding strategy. A bidding strategy can be created by setting either the bidding scheme to create a standard bidding strategy or the bidding_strategy field to create a portfolio bidding strategy. This field is read-only.

campaign.campaign_budget

String

The budget of the campaign.

campaign.campaign_group

String

The campaign group this campaign belongs to.

campaign.commission.commission_rate_micros

Long

Commission rate defines the portion of the conversion value that the advertiser will be billed. A commission rate of x should be passed into this field as (x * 1,000,000). For example, 106,000 represents a commission rate of 0.106 (10.6%).

campaign.discovery_campaign_settings.upgraded_targeting

Boolean

Immutable. Specifies whether this campaign uses upgraded targeting options. When this field is set to true, you can use location and language targeting at the ad group level as opposed to the standard campaign-level targeting. This field defaults to false, and can only be set when creating a campaign.

campaign.dynamic_search_ads_setting.domain_name

String

Required. The Internet domain name that this setting represents, e.g., "google.com" or "www.google.com".

campaign.dynamic_search_ads_setting.feeds

Other

The list of page feeds associated with the campaign.

campaign.dynamic_search_ads_setting.language_code

String

Required. The language code specifying the language of the domain, e.g., "en".

campaign.dynamic_search_ads_setting.use_supplied_urls_only

Boolean

Whether the campaign uses advertiser supplied URLs exclusively.

campaign.end_date

DateTime

The last day of the campaign (in the context of campaign's account's time zone).

campaign.excluded_parent_asset_field_types

Other

The asset field types that should be excluded from this campaign. Asset links with these field types will not be inherited by this campaign from the upper level.

campaign.excluded_parent_asset_set_types

String

The asset set types that should be excluded from this campaign. Asset set links with these types will not be inherited by this campaign from the upper level. Location group types (GMB_DYNAMIC_LOCATION_GROUP, CHAIN_DYNAMIC_LOCATION_GROUP, and STATIC_LOCATION_GROUP) are child types of LOCATION_SYNC. Therefore, if LOCATION_SYNC is set for this field, all location group asset sets are not allowed to be linked to this campaign, and all Location Extension (LE) and Affiliate Location Extensions (ALE) will not be served under this campaign. Only LOCATION_SYNC is currently supported.

campaign.experiment_type

String

Output only. The type of campaign: normal, draft, or experiment.

campaign.final_url_suffix

String

Suffix used to append query parameters to landing pages that are served with parallel tracking.

campaign.frequency_caps

Other

A list that limits how often each user will see this campaign's ads.

campaign.geo_target_type_setting.negative_geo_target_type

String

The setting used for negative geotargeting in this particular campaign.

campaign.geo_target_type_setting.positive_geo_target_type

String

The setting used for positive geotargeting in this particular campaign.

campaign.hotel_property_asset_set

String

Immutable. The set of hotel properties for Performance Max for travel goals campaigns.

campaign.hotel_setting.hotel_center_id

Long

Immutable. The linked Hotel Center account.

campaign.id

Long

Output only. The ID of the campaign.

campaign.labels

Other

Output only. The resource names of labels attached to this campaign.

campaign.listing_type

String

Immutable. Listing type of ads served for this campaign. Field is restricted for usage with Performance Max campaigns.

campaign.local_campaign_setting.location_source_type

String

The location source type for this local campaign.

campaign.local_services_campaign_settings.category_bids

String

Categorical level bids associated with MANUAL_CPA bidding strategy.

campaign.manual_cpa

String

Standard Manual CPA bidding strategy. Manual bidding strategy that allows advertiser to set the bid per advertiser-specified action. Supported only for Local Services campaigns.

campaign.manual_cpc.enhanced_cpc_enabled

Boolean

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

campaign.manual_cpm

String

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

campaign.manual_cpv

String

Output only. A bidding strategy that pays a configurable amount per video view.

campaign.maximize_conversion_value.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.

campaign.maximize_conversions.target_cpa_micros

Long

Output only. The target cost per acquisition (CPA) option. This is the average amount that you would like to spend per acquisition.

campaign.name

String

The name of the campaign. This field is required and should not be empty when creating new campaigns. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters.

campaign.network_settings.target_content_network

Boolean

Whether ads will be served on specified placements in the Google Display Network. Placements are specified using the Placement criterion.

campaign.network_settings.target_google_search

Boolean

Whether ads will be served with google.com search results.

campaign.network_settings.target_google_tv_network

Boolean

Whether ads will be served on the Google TV network.

campaign.network_settings.target_partner_search_network

Boolean

Whether ads will be served on the Google Partner Network. This is available only to some select Google partner accounts.

campaign.network_settings.target_search_network

Boolean

Whether ads will be served on partner sites in the Google Search Network (requires target_google_search to also be true).

campaign.network_settings.target_youtube

Boolean

Whether ads will be served on YouTube.

campaign.optimization_goal_setting.optimization_goal_types

Other

The list of optimization goal types.

campaign.optimization_score

Double

Output only. Optimization score of the campaign. Optimization score is an estimate of how well a campaign is set to perform. It ranges from 0% (0.0) to 100% (1.0), with 100% indicating that the campaign is performing at full potential. This field is null for unscored campaigns. See About optimization score at https://support.google.com/google-ads/answer/9061546. This field is read-only.

campaign.payment_mode

String

Payment mode for the campaign.

campaign.percent_cpc.cpc_bid_ceiling_micros

Long

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.

campaign.percent_cpc.enhanced_cpc_enabled

Boolean

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.

campaign.performance_max_upgrade.performance_max_campaign

String

Output only. Indicates which Performance Max campaign the campaign is upgraded to.

campaign.performance_max_upgrade.pre_upgrade_campaign

String

Output only. Indicates legacy campaign upgraded to Performance Max.

campaign.performance_max_upgrade.status

String

Output only. The upgrade status of a campaign requested to be upgraded to Performance Max.

campaign.primary_status

String

Output only. The primary status of the campaign. Provides insight into why a campaign is not serving or not serving optimally. Modification to the campaign and its related entities might take a while to be reflected in this status.

campaign.primary_status_reasons

String

Output only. The primary status reasons of the campaign. Provides insight into why a campaign is not serving or not serving optimally. These reasons are aggregated to determine an overall CampaignPrimaryStatus.

campaign.real_time_bidding_setting.opt_in

Boolean

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

campaign.resource_name

String

Immutable. The resource name of the campaign. Campaign resource names have the form: customers/{customer_id}/campaigns/{campaign_id}

campaign.selective_optimization.conversion_actions

Other

The selected set of conversion actions for optimizing this campaign.

campaign.serving_status

String

Output only. The ad serving status of the campaign.

campaign.shopping_setting.advertising_partner_ids

Long

Immutable. The ads account IDs of advertising partners cooperating within the campaign.

campaign.shopping_setting.campaign_priority

Int

Priority of the campaign. Campaigns with numerically higher priorities take precedence over those with lower priorities. This field is required for Shopping campaigns, with values between 0 and 2, inclusive. This field is optional for Smart Shopping campaigns, but must be equal to 3 if set.

campaign.shopping_setting.disable_product_feed

Boolean

Disable the optional product feed. This field is currently supported only for Demand Gen campaigns. See https://support.google.com/google-ads/answer/13721750 to learn more about this feature.

campaign.shopping_setting.enable_local

Boolean

Whether to include local products.

campaign.shopping_setting.feed_label

String

Feed label of products to include in the campaign. Only one of feed_label or sales_country can be set. If used instead of sales_country, the feed_label field accepts country codes in the same format for example: 'XX'. Otherwise can be any string used for feed label in Google Merchant Center.

campaign.shopping_setting.merchant_id

Long

Immutable. ID of the Merchant Center account. This field is required for create operations. This field is immutable for Shopping campaigns.

campaign.shopping_setting.use_vehicle_inventory

Boolean

Immutable. Whether to target Vehicle Listing inventory. This field is supported only in Smart Shopping Campaigns. For setting Vehicle Listing inventory in Performance Max campaigns, use listing_type instead.

campaign.start_date

DateTime

The date when campaign started (in the context of campaign's account's time zone).

campaign.status

String

The status of the campaign. When a new campaign is added, the status defaults to ENABLED.

campaign.target_cpa.cpc_bid_ceiling_micros

Long

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.

campaign.target_cpa.cpc_bid_floor_micros

Long

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.

campaign.target_cpa.target_cpa_micros

Long

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

campaign.target_cpm.target_frequency_goal.target_count

Long

Target Frequency count representing how many times you want to reach a single user.

campaign.target_cpm.target_frequency_goal.time_unit

String

Time window expressing the period over which you want to reach the specified target_count.

campaign.target_cpm

String

A bidding strategy that automatically optimizes cost per thousand impressions.

campaign.target_impression_share.cpc_bid_ceiling_micros

Long

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.

campaign.target_impression_share.location

String

The targeted location on the search results page.

campaign.target_impression_share.location_fraction_micros

Long

The desired fraction of ads to be shown in the targeted location in micros. E.g. 1% equals 10,000.

campaign.target_roas.cpc_bid_ceiling_micros

Long

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.

campaign.target_roas.cpc_bid_floor_micros

Long

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.

campaign.target_roas.target_roas

Double

Output only. The desired revenue (based on conversion data) per unit of spend.

campaign.target_spend.cpc_bid_ceiling_micros

Long

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

campaign.target_spend.target_spend_micros

Long

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.

campaign.targeting_setting.target_restrictions

Other

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

campaign.tracking_setting.tracking_url

String

Output only. The url used for dynamic tracking.

campaign.tracking_url_template

String

The URL template for constructing a tracking URL.

campaign.travel_campaign_settings.travel_account_id

Long

Immutable. The Travel account ID associated with the Travel campaign.

campaign.url_custom_parameters

Other

The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls.

campaign.url_expansion_opt_out

Boolean

Represents opting out of URL expansion to more targeted URLs. If opted out (true), only the final URLs in the asset group or URLs specified in the advertiser's Google Merchant Center or business data feeds are targeted. If opted in (false), the entire domain will be targeted. This field can only be set for Performance Max campaigns, where the default value is false.

campaign.vanity_pharma.vanity_pharma_display_url_mode

String

The display mode for vanity pharma URLs.

campaign.vanity_pharma.vanity_pharma_text

String

The text that will be displayed in display URL of the text ad when website description is the selected display mode for vanity pharma URLs.

campaign.video_brand_safety_suitability

String

Output only. 3-Tier Brand Safety setting for the campaign.

campaign_asset.asset

String

Immutable. The asset which is linked to the campaign.

campaign_asset.campaign

String

Immutable. The campaign to which the asset is linked.

campaign_asset.field_type

String

Immutable. Role that the asset takes under the linked campaign. Required.

campaign_asset.primary_status

String

Output only. Provides the PrimaryStatus of this asset link. Primary status is meant essentially to differentiate between the plain "status" field, which has advertiser set values of enabled, paused, or removed. The primary status takes into account other signals (for assets its mainly policy and quality approvals) to come up with a more comprehensive status to indicate its serving state.

campaign_asset.primary_status_details

String

Output only. Provides the details of the primary status and its associated reasons.

campaign_asset.primary_status_reasons

String

Output only. Provides a list of reasons for why an asset is not serving or not serving at full capacity.

campaign_asset.resource_name

String

Immutable. The resource name of the campaign asset. CampaignAsset resource names have the form: customers/{customer_id}/campaignAssets/{campaign_id}{asset_id}{field_type}

campaign_asset.source

String

Output only. Source of the campaign asset link.

campaign_asset.status

String

Status of the campaign asset.

campaign_audience_view.resource_name

String

Output only. The resource name of the campaign audience view. Campaign audience view resource names have the form: customers/{customer_id}/campaignAudienceViews/{campaign_id}~{criterion_id}

campaign_bid_modifier.bid_modifier

Double

The modifier for the bid when the criterion matches.

campaign_bid_modifier.campaign

String

Output only. The campaign to which this criterion belongs.

campaign_bid_modifier.criterion_id

Long

Output only. The ID of the criterion to bid modify. This field is ignored for mutates.

campaign_bid_modifier.interaction_type.type

String

The interaction type.

campaign_bid_modifier.resource_name

String

Immutable. The resource name of the campaign bid modifier. Campaign bid modifier resource names have the form: customers/{customer_id}/campaignBidModifiers/{campaign_id}~{criterion_id}

campaign_budget.aligned_bidding_strategy_id

Long

ID of the portfolio bidding strategy that this shared campaign budget is aligned with. When a bidding strategy and a campaign budget are aligned, they are attached to the same set of campaigns. After a campaign budget is aligned with a bidding strategy, campaigns that are added to the campaign budget must also use the aligned bidding strategy.

campaign_budget.amount_micros

Long

The amount of the budget, in the local currency for the account. Amount is specified in micros, where one million is equivalent to one currency unit. Monthly spend is capped at 30.4 times this amount.

campaign_budget.delivery_method

String

The delivery method that determines the rate at which the campaign budget is spent. Defaults to STANDARD if unspecified in a create operation.

campaign_budget.explicitly_shared

Boolean

Specifies whether the budget is explicitly shared. Defaults to true if unspecified in a create operation. If true, the budget was created with the purpose of sharing across one or more campaigns. If false, the budget was created with the intention of only being used with a single campaign. The budget's name and status will stay in sync with the campaign's name and status. Attempting to share the budget with a second campaign will result in an error. A non-shared budget can become an explicitly shared. The same operation must also assign the budget a name. A shared campaign budget can never become non-shared.

campaign_budget.has_recommended_budget

Boolean

Output only. Indicates whether there is a recommended budget for this campaign budget. This field is read-only.

campaign_budget.id

Long

Output only. The ID of the campaign budget. A campaign budget is created using the CampaignBudgetService create operation and is assigned a budget ID. A budget ID can be shared across different campaigns; the system will then allocate the campaign budget among different campaigns to get optimum results.

campaign_budget.name

String

The name of the campaign budget. When creating a campaign budget through CampaignBudgetService, every explicitly shared campaign budget must have a non-null, non-empty name. Campaign budgets that are not explicitly shared derive their name from the attached campaign's name. The length of this string must be between 1 and 255, inclusive, in UTF-8 bytes, (trimmed).

campaign_budget.period

String

Immutable. Period over which to spend the budget. Defaults to DAILY if not specified.

campaign_budget.recommended_budget_amount_micros

Long

Output only. The recommended budget amount. If no recommendation is available, this will be set to the budget amount. Amount is specified in micros, where one million is equivalent to one currency unit. This field is read-only.

campaign_budget.recommended_budget_estimated_change_weekly_clicks

Long

Output only. The estimated change in weekly clicks if the recommended budget is applied. This field is read-only.

campaign_budget.recommended_budget_estimated_change_weekly_cost_micros

Long

Output only. The estimated change in weekly cost in micros if the recommended budget is applied. One million is equivalent to one currency unit. This field is read-only.

campaign_budget.recommended_budget_estimated_change_weekly_interactions

Long

Output only. The estimated change in weekly interactions if the recommended budget is applied. This field is read-only.

campaign_budget.recommended_budget_estimated_change_weekly_views

Long

Output only. The estimated change in weekly views if the recommended budget is applied. This field is read-only.

campaign_budget.reference_count

Long

Output only. The number of campaigns actively using the budget. This field is read-only.

campaign_budget.resource_name

String

Immutable. The resource name of the campaign budget. Campaign budget resource names have the form: customers/{customer_id}/campaignBudgets/{campaign_budget_id}

campaign_budget.status

String

Output only. The status of this campaign budget. This field is read-only.

campaign_budget.total_amount_micros

Long

The lifetime amount of the budget, in the local currency for the account. Amount is specified in micros, where one million is equivalent to one currency unit.

campaign_budget.type

String

Immutable. The type of the campaign budget.

campaign_group.id

Long

Output only. The ID of the campaign group.

campaign_group.name

String

The name of the campaign group. This field is required and should not be empty when creating new campaign groups. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters.

campaign_group.resource_name

String

Immutable. The resource name of the campaign group. Campaign group resource names have the form: customers/{customer_id}/campaignGroups/{campaign_group_id}

campaign_group.status

String

The status of the campaign group. When a new campaign group is added, the status defaults to ENABLED.

campaign_search_term_insight.campaign_id

Long

Output only. The ID of the campaign.

campaign_search_term_insight.category_label

String

Output only. The label for the search category. An empty string denotes the catch-all category for search terms that didn't fit into another category.

campaign_search_term_insight.id

Long

Output only. The ID of the insight.

campaign_search_term_insight.resource_name

String

Output only. The resource name of the campaign level search term insight. Campaign level search term insight resource names have the form: customers/{customer_id}/campaignSearchTermInsights/{campaign_id}~{category_id}

click_view.ad_group_ad

String

Output only. The associated ad.

click_view.area_of_interest.city

String

The city location criterion associated with the impression.

click_view.area_of_interest.country

String

The country location criterion associated with the impression.

click_view.area_of_interest.metro

String

The metro location criterion associated with the impression.

click_view.area_of_interest.most_specific

String

The most specific location criterion associated with the impression.

click_view.area_of_interest.region

String

The region location criterion associated with the impression.

click_view.campaign_location_target

String

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

click_view.gclid

String

Output only. The Google Click ID.

click_view.keyword

String

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

click_view.keyword_info.match_type

String

The match type of the keyword.

click_view.keyword_info.text

String

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

click_view.location_of_presence.city

String

The city location criterion associated with the impression.

click_view.location_of_presence.country

String

The country location criterion associated with the impression.

click_view.location_of_presence.metro

String

The metro location criterion associated with the impression.

click_view.location_of_presence.most_specific

String

The most specific location criterion associated with the impression.

click_view.location_of_presence.region

String

The region location criterion associated with the impression.

click_view.page_number

Long

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

click_view.resource_name

String

Output only. The resource name of the click view. Click view resource names have the form: customers/{customer_id}/clickViews/{date (yyyy-MM-dd)}~{gclid}

click_view.user_list

String

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

conversion_action.app_id

String

App ID for an app conversion action.

conversion_action.attribution_model_settings.attribution_model

String

The attribution model type of this conversion action.

conversion_action.attribution_model_settings.data_driven_model_status

String

Output only. The status of the data-driven attribution model for the conversion action.

conversion_action.category

String

The category of conversions reported for this conversion action.

conversion_action.click_through_lookback_window_days

Long

The maximum number of days that may elapse between an interaction (e.g., a click) and a conversion event.

conversion_action.counting_type

String

How to count conversion events for the conversion action.

conversion_action.firebase_settings.event_name

String

Output only. The event name of a Firebase conversion.

conversion_action.firebase_settings.project_id

String

Output only. The Firebase project ID of the conversion.

conversion_action.firebase_settings.property_id

Long

Output only. The GA property ID of the conversion.

conversion_action.firebase_settings.property_name

String

Output only. The GA property name of the conversion.

conversion_action.google_analytics_4_settings.event_name

String

Output only. The name of the GA 4 event.

conversion_action.google_analytics_4_settings.property_id

Long

Output only. The ID of the GA 4 property.

conversion_action.google_analytics_4_settings.property_name

String

Output only. The name of the GA 4 property.

conversion_action.id

Long

Output only. The ID of the conversion action.

conversion_action.include_in_conversions_metric

Boolean

Whether this conversion action should be included in the "conversions" metric.

conversion_action.mobile_app_vendor

String

Output only. Mobile app vendor for an app conversion action.

conversion_action.name

String

The name of the conversion action. This field is required and should not be empty when creating new conversion actions.

conversion_action.origin

String

Output only. The conversion origin of this conversion action.

conversion_action.owner_customer

String

Output only. The resource name of the conversion action owner customer, or null if this is a system-defined conversion action.

conversion_action.phone_call_duration_seconds

Long

The phone call duration in seconds after which a conversion should be reported for this conversion action. The value must be between 0 and 10000, inclusive.

conversion_action.primary_for_goal

Boolean

If a conversion action's primary_for_goal bit is false, the conversion action is non-biddable for all campaigns regardless of their customer conversion goal or campaign conversion goal. However, custom conversion goals do not respect primary_for_goal, so if a campaign has a custom conversion goal configured with a primary_for_goal = false conversion action, that conversion action is still biddable.

conversion_action.resource_name

String

Immutable. The resource name of the conversion action. Conversion action resource names have the form: customers/{customer_id}/conversionActions/{conversion_action_id}

conversion_action.status

String

The status of this conversion action for conversion event accrual.

conversion_action.tag_snippets

Other

Output only. The snippets used for tracking conversions.

conversion_action.third_party_app_analytics_settings.event_name

String

Output only. The event name of a third-party app analytics conversion.

conversion_action.third_party_app_analytics_settings.provider_name

String

Output only. Name of the third-party app analytics provider.

conversion_action.type

String

Immutable. The type of this conversion action.

conversion_action.value_settings.always_use_default_value

Boolean

Controls whether the default value and default currency code are used in place of the value and currency code specified in conversion events for this conversion action.

conversion_action.value_settings.default_currency_code

String

The currency code to use when conversion events for this conversion action are sent with an invalid or missing currency code, or when this conversion action is configured to always use the default value.

conversion_action.value_settings.default_value

Double

The value to use when conversion events for this conversion action are sent with an invalid, disallowed or missing value, or when this conversion action is configured to always use the default value.

conversion_action.view_through_lookback_window_days

Long

The maximum number of days which may elapse between an impression and a conversion without an interaction.

customer.auto_tagging_enabled

Boolean

Whether auto-tagging is enabled for the customer.

customer.call_reporting_setting.call_conversion_action

String

Customer-level call conversion action to attribute a call conversion to. If not set a default conversion action is used. Only in effect when call_conversion_reporting_enabled is set to true.

customer.call_reporting_setting.call_conversion_reporting_enabled

Boolean

Whether to enable call conversion reporting.

customer.call_reporting_setting.call_reporting_enabled

Boolean

Enable reporting of phone call events by redirecting them via Google System.

customer.conversion_tracking_setting.accepted_customer_data_terms

Boolean

Output only. Whether the customer has accepted customer data terms. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only. For more information, see https://support.google.com/adspolicy/answer/7475709.

customer.conversion_tracking_setting.conversion_tracking_id

Long

Output only. The conversion tracking id used for this account. This id is automatically assigned after any conversion tracking feature is used. If the customer doesn't use conversion tracking, this is 0. This field is read-only.

customer.conversion_tracking_setting.conversion_tracking_status

String

Output only. Conversion tracking status. It indicates whether the customer is using conversion tracking, and who is the conversion tracking owner of this customer. If this customer is using cross-account conversion tracking, the value returned will differ based on the login-customer-id of the request.

customer.conversion_tracking_setting.cross_account_conversion_tracking_id

Long

Output only. The conversion tracking id of the customer's manager. This is set when the customer is opted into cross account conversion tracking, and it overrides conversion_tracking_id. This field can only be managed through the Google Ads UI. This field is read-only.

customer.conversion_tracking_setting.enhanced_conversions_for_leads_enabled

Boolean

Output only. Whether the customer is opted-in for enhanced conversions for leads. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only.

customer.conversion_tracking_setting.google_ads_conversion_customer

String

Output only. The resource name of the customer where conversions are created and managed. This field is read-only.

customer.currency_code

String

Immutable. The currency in which the account operates. A subset of the currency codes from the ISO 4217 standard is supported.

customer.customer_agreement_setting.accepted_lead_form_terms

Boolean

Output only. Whether the customer has accepted lead form term of service.

customer.descriptive_name

String

Optional, non-unique descriptive name of the customer.

customer.final_url_suffix

String

The URL template for appending params to the final URL

customer.has_partners_badge

Boolean

Output only. Whether the Customer has a Partners program badge. If the Customer is not associated with the Partners program, this will be false. For more information, see https://support.google.com/partners/answer/3125774.

customer.id

Long

Output only. The ID of the customer.

customer.image_asset_auto_migration_done

Boolean

Output only. True if feed based image has been migrated to asset based image.

customer.image_asset_auto_migration_done_date_time

DateTime

Output only. Timestamp of migration from feed based image to asset base image in yyyy-MM-dd HH🇲🇲ss format.

customer.local_services_settings.granular_insurance_statuses

String

Output only. A read-only list of geo vertical level insurance statuses.

customer.local_services_settings.granular_license_statuses

String

Output only. A read-only list of geo vertical level license statuses.

customer.location_asset_auto_migration_done

Boolean

Output only. True if feed based location has been migrated to asset based location.

customer.location_asset_auto_migration_done_date_time

DateTime

Output only. Timestamp of migration from feed based location to asset base location in yyyy-MM-dd HH🇲🇲ss format.

customer.manager

Boolean

Output only. Whether the customer is a manager.

customer.optimization_score

Double

Output only. Optimization score of the customer. Optimization score is an estimate of how well a customer's campaigns are set to perform. It ranges from 0% (0.0) to 100% (1.0). This field is null for all manager customers, and for unscored non-manager customers. See About optimization score at https://support.google.com/google-ads/answer/9061546. This field is read-only.

customer.optimization_score_weight

Double

Output only. Optimization score weight of the customer. Optimization score weight can be used to compare/aggregate optimization scores across multiple non-manager customers. The aggregate optimization score of a manager is computed as the sum over all of their customers of Customer.optimization_score * Customer.optimization_score_weight. This field is 0 for all manager customers, and for unscored non-manager customers. This field is read-only.

customer.pay_per_conversion_eligibility_failure_reasons

Other

Output only. Reasons why the customer is not eligible to use PaymentMode.CONVERSIONS. If the list is empty, the customer is eligible. This field is read-only.

customer.remarketing_setting.google_global_site_tag

String

Output only. The Google global site tag.

customer.resource_name

String

Immutable. The resource name of the customer. Customer resource names have the form: customers/{customer_id}

customer.status

String

Output only. The status of the customer.

customer.test_account

Boolean

Output only. Whether the customer is a test account.

customer.time_zone

String

Immutable. The local timezone ID of the customer.

customer.tracking_url_template

String

The URL template for constructing a tracking URL out of parameters.

customer_asset.asset

String

Required. Immutable. The asset which is linked to the customer.

customer_asset.field_type

String

Required. Immutable. Role that the asset takes for the customer link.

customer_asset.primary_status

String

Output only. Provides the PrimaryStatus of this asset link. Primary status is meant essentially to differentiate between the plain "status" field, which has advertiser set values of enabled, paused, or removed. The primary status takes into account other signals (for assets its mainly policy and quality approvals) to come up with a more comprehensive status to indicate its serving state.

customer_asset.primary_status_details

String

Output only. Provides the details of the primary status and its associated reasons.

customer_asset.primary_status_reasons

String

Output only. Provides a list of reasons for why an asset is not serving or not serving at full capacity.

customer_asset.resource_name

String

Immutable. The resource name of the customer asset. CustomerAsset resource names have the form: customers/{customer_id}/customerAssets/{asset_id}~{field_type}

customer_asset.source

String

Output only. Source of the customer asset link.

customer_asset.status

String

Status of the customer asset.

customer_search_term_insight.category_label

String

Output only. The label for the search category. An empty string denotes the catch-all category for search terms that didn't fit into another category.

customer_search_term_insight.id

Long

Output only. The ID of the insight.

customer_search_term_insight.resource_name

String

Output only. The resource name of the customer level search term insight. Customer level search term insight resource names have the form: customers/{customer_id}/customerSearchTermInsights/{category_id}

detail_placement_view.display_name

String

Output only. The display name is URL name for websites, YouTube video name for YouTube videos, and translated mobile app name for mobile apps.

detail_placement_view.group_placement_target_url

String

Output only. URL of the group placement, e.g. domain, link to the mobile application in app store, or a YouTube channel URL.

detail_placement_view.placement

String

Output only. The automatic placement string at detail level, e. g. website URL, mobile application ID, or a YouTube video ID.

detail_placement_view.placement_type

String

Output only. Type of the placement, e.g. Website, YouTube Video, and Mobile Application.

detail_placement_view.resource_name

String

Output only. The resource name of the detail placement view. Detail placement view resource names have the form: customers/{customer_id}/detailPlacementViews/{ad_group_id}~{base64_placement}

detail_placement_view.target_url

String

Output only. URL of the placement, e.g. website, link to the mobile application in app store, or a YouTube video URL.

display_keyword_view.resource_name

String

Output only. The resource name of the display keyword view. Display Keyword view resource names have the form: customers/{customer_id}/displayKeywordViews/{ad_group_id}~{criterion_id}

distance_view.distance_bucket

String

Output only. Grouping of user distance from location extensions.

distance_view.metric_system

Boolean

Output only. True if the DistanceBucket is using the metric system, false otherwise.

distance_view.resource_name

String

Output only. The resource name of the distance view. Distance view resource names have the form: customers/{customer_id}/distanceViews/1~{distance_bucket}

dynamic_search_ads_search_term_view.has_matching_keyword

Boolean

Output only. True if query is added to targeted keywords. This field is read-only.

dynamic_search_ads_search_term_view.has_negative_keyword

Boolean

Output only. True if query matches a negative keyword. This field is read-only.

dynamic_search_ads_search_term_view.has_negative_url

Boolean

Output only. True if query matches a negative url. This field is read-only.

dynamic_search_ads_search_term_view.headline

String

Output only. The dynamically generated headline of the Dynamic Search Ad. This field is read-only.

dynamic_search_ads_search_term_view.landing_page

String

Output only. The dynamically selected landing page URL of the impression. This field is read-only.

dynamic_search_ads_search_term_view.page_url

String

Output only. The URL of page feed item served for the impression. This field is read-only.

dynamic_search_ads_search_term_view.resource_name

String

Output only. The resource name of the dynamic search ads search term view. Dynamic search ads search term view resource names have the form: customers/{customer_id}/dynamicSearchAdsSearchTermViews/{ad_group_id}{search_term_fingerprint}{headline_fingerprint}{landing_page_fingerprint}{page_url_fingerprint}

dynamic_search_ads_search_term_view.search_term

String

Output only. Search term This field is read-only.

expanded_landing_page_view.expanded_final_url

String

Output only. The final URL that clicks are directed to.

expanded_landing_page_view.resource_name

String

Output only. The resource name of the expanded landing page view. Expanded landing page view resource names have the form: customers/{customer_id}/expandedLandingPageViews/{expanded_final_url_fingerprint}

extension_feed_item.ad_schedules

Other

List of non-overlapping schedules specifying all time intervals for which the feed item may serve. There can be a maximum of 6 schedules per day.

extension_feed_item.affiliate_location_feed_item.address_line_1

String

Line 1 of the business address.

extension_feed_item.affiliate_location_feed_item.address_line_2

String

Line 2 of the business address.

extension_feed_item.affiliate_location_feed_item.business_name

String

The name of the business.

extension_feed_item.affiliate_location_feed_item.chain_id

Long

Id of the retail chain that is advertised as a seller of your product.

extension_feed_item.affiliate_location_feed_item.chain_name

String

Name of chain.

extension_feed_item.affiliate_location_feed_item.city

String

City of the business address.

extension_feed_item.affiliate_location_feed_item.country_code

String

Country code of the business address.

extension_feed_item.affiliate_location_feed_item.phone_number

String

Phone number of the business.

extension_feed_item.affiliate_location_feed_item.postal_code

String

Postal code of the business address.

extension_feed_item.affiliate_location_feed_item.province

String

Province of the business address.

extension_feed_item.app_feed_item.app_id

String

The store-specific ID for the target application. This string must not be empty.

extension_feed_item.app_feed_item.app_store

String

The application store that the target application belongs to. This field is required.

extension_feed_item.app_feed_item.final_mobile_urls

Other

A list of possible final mobile URLs after all cross domain redirects.

extension_feed_item.app_feed_item.final_url_suffix

String

URL template for appending params to landing page URLs served with parallel tracking.

extension_feed_item.app_feed_item.final_urls

Other

A list of possible final URLs after all cross domain redirects. This list must not be empty.

extension_feed_item.app_feed_item.link_text

String

The visible text displayed when the link is rendered in an ad. This string must not be empty, and the length of this string should be between 1 and 25, inclusive.

extension_feed_item.app_feed_item.tracking_url_template

String

URL template for constructing a tracking URL. Default value is "{lpurl}".

extension_feed_item.call_feed_item.call_conversion_action

String

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_tracking_enabled is set to true. Otherwise this field is ignored.

extension_feed_item.call_feed_item.call_conversion_reporting_state

String

Enum value that indicates whether this call extension uses its own call conversion setting (or just have call conversion disabled), or following the account level setting.

extension_feed_item.call_feed_item.call_conversion_tracking_disabled

Boolean

If true, disable call conversion tracking. call_conversion_action should not be set if this is true. Optional.

extension_feed_item.call_feed_item.call_tracking_enabled

Boolean

Indicates whether call tracking is enabled. By default, call tracking is not enabled.

extension_feed_item.call_feed_item.country_code

String

Uppercase two-letter country code of the advertiser's phone number. This string must not be empty.

extension_feed_item.call_feed_item.phone_number

String

The advertiser's phone number to append to the ad. This string must not be empty.

extension_feed_item.callout_feed_item.callout_text

String

The callout text. The length of this string should be between 1 and 25, inclusive.

extension_feed_item.device

String

The targeted device.

extension_feed_item.end_date_time

DateTime

End time in which this feed item is no longer effective and will stop serving. The time is in the customer's time zone. The format is "YYYY-MM-DD HH:MM:SS". Examples: "2018-03-05 09:15: 00" or "2018-02-01 14:34:30"

extension_feed_item.extension_type

String

Output only. The extension type of the extension feed item. This field is read-only.

extension_feed_item.hotel_callout_feed_item.language_code

String

The language of the hotel callout text. IETF BCP 47 compliant language code.

extension_feed_item.hotel_callout_feed_item.text

String

The callout text. The length of this string should be between 1 and 25, inclusive.

extension_feed_item.id

Long

Output only. The ID of this feed item. Read-only.

extension_feed_item.image_feed_item.image_asset

String

Required. Resource name of the image asset.

extension_feed_item.location_feed_item.address_line_1

String

Line 1 of the business address.

extension_feed_item.location_feed_item.address_line_2

String

Line 2 of the business address.

extension_feed_item.location_feed_item.business_name

String

The name of the business.

extension_feed_item.location_feed_item.city

String

City of the business address.

extension_feed_item.location_feed_item.country_code

String

Country code of the business address.

extension_feed_item.location_feed_item.phone_number

String

Phone number of the business.

extension_feed_item.location_feed_item.postal_code

String

Postal code of the business address.

extension_feed_item.location_feed_item.province

String

Province of the business address.

extension_feed_item.price_feed_item.final_url_suffix

String

Tracking URL template for all offers of this price extension.

extension_feed_item.price_feed_item.language_code

String

The code of the language used for this price extension.

extension_feed_item.price_feed_item.price_offerings

Other

The price offerings in this price extension.

extension_feed_item.price_feed_item.price_qualifier

String

Price qualifier for all offers of this price extension.

extension_feed_item.price_feed_item.tracking_url_template

String

Tracking URL template for all offers of this price extension.

extension_feed_item.price_feed_item.type

String

Price extension type of this extension.

extension_feed_item.promotion_feed_item.discount_modifier

String

Enum that modifies the qualification of the discount.

extension_feed_item.promotion_feed_item.final_mobile_urls

Other

A list of possible final mobile URLs after all cross domain redirects.

extension_feed_item.promotion_feed_item.final_url_suffix

String

URL template for appending params to landing page URLs served with parallel tracking.

extension_feed_item.promotion_feed_item.final_urls

Other

A list of possible final URLs after all cross domain redirects. This field is required.

extension_feed_item.promotion_feed_item.language_code

String

The language of the promotion. Represented as BCP 47 language tag.

extension_feed_item.promotion_feed_item.money_amount_off.amount_micros

Long

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

extension_feed_item.promotion_feed_item.money_amount_off.currency_code

String

Three-character ISO 4217 currency code.

extension_feed_item.promotion_feed_item.occasion

String

The occasion the promotion was intended for. If an occasion is set, the redemption window will need to fall within the date range associated with the occasion.

extension_feed_item.promotion_feed_item.orders_over_amount.amount_micros

Long

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

extension_feed_item.promotion_feed_item.orders_over_amount.currency_code

String

Three-character ISO 4217 currency code.

extension_feed_item.promotion_feed_item.percent_off

Long

Percentage off discount in the promotion in micros. One million is equivalent to one percent. Either this or money_off_amount is required.

extension_feed_item.promotion_feed_item.promotion_code

String

A code the user should use in order to be eligible for the promotion.

extension_feed_item.promotion_feed_item.promotion_end_date

DateTime

Last date when the promotion is eligible to be redeemed.

extension_feed_item.promotion_feed_item.promotion_start_date

DateTime

Start date of when the promotion is eligible to be redeemed.

extension_feed_item.promotion_feed_item.promotion_target

String

A freeform description of what the promotion is targeting. This field is required.

extension_feed_item.promotion_feed_item.tracking_url_template

String

URL template for constructing a tracking URL.

extension_feed_item.resource_name

String

Immutable. The resource name of the extension feed item. Extension feed item resource names have the form: customers/{customer_id}/extensionFeedItems/{feed_item_id}

extension_feed_item.sitelink_feed_item.final_mobile_urls

Other

A list of possible final mobile URLs after all cross domain redirects.

extension_feed_item.sitelink_feed_item.final_url_suffix

String

Final URL suffix to be appended to landing page URLs served with parallel tracking.

extension_feed_item.sitelink_feed_item.final_urls

Other

A list of possible final URLs after all cross domain redirects.

extension_feed_item.sitelink_feed_item.line1

String

First line of the description for the sitelink. If this value is set, line2 must also be set. The length of this string should be between 0 and 35, inclusive.

extension_feed_item.sitelink_feed_item.line2

String

Second line of the description for the sitelink. If this value is set, line1 must also be set. The length of this string should be between 0 and 35, inclusive.

extension_feed_item.sitelink_feed_item.link_text

String

URL display text for the sitelink. The length of this string should be between 1 and 25, inclusive.

extension_feed_item.sitelink_feed_item.tracking_url_template

String

URL template for constructing a tracking URL.

extension_feed_item.start_date_time

DateTime

Start time in which this feed item is effective and can begin serving. The time is in the customer's time zone. The format is "YYYY-MM-DD HH:MM:SS". Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30"

extension_feed_item.status

String

Output only. Status of the feed item. This field is read-only.

extension_feed_item.structured_snippet_feed_item.header

String

The header of the snippet. This string must not be empty.

extension_feed_item.structured_snippet_feed_item.values

Other

The values in the snippet. The maximum size of this collection is 10.

extension_feed_item.targeted_ad_group

String

The targeted ad group.

extension_feed_item.targeted_campaign

String

The targeted campaign.

extension_feed_item.targeted_geo_target_constant

String

The targeted geo target constant.

extension_feed_item.targeted_keyword.match_type

String

The match type of the keyword.

extension_feed_item.targeted_keyword.text

String

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

extension_feed_item.text_message_feed_item.business_name

String

The business name to prepend to the message text. This field is required.

extension_feed_item.text_message_feed_item.country_code

String

Uppercase two-letter country code of the advertiser's phone number. This field is required.

extension_feed_item.text_message_feed_item.extension_text

String

The message extension_text populated in the messaging app.

extension_feed_item.text_message_feed_item.phone_number

String

The advertiser's phone number the message will be sent to. Required.

extension_feed_item.text_message_feed_item.text

String

The text to show in the ad. This field is required.

feed_item.attribute_values

Other

The feed item's attribute values.

feed_item.end_date_time

DateTime

End time in which this feed item is no longer effective and will stop serving. The time is in the customer's time zone. The format is "YYYY-MM-DD HH:MM:SS". Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30"

feed_item.feed

String

Immutable. The feed to which this feed item belongs.

feed_item.geo_targeting_restriction

String

Geo targeting restriction specifies the type of location that can be used for targeting.

feed_item.id

Long

Output only. The ID of this feed item.

feed_item.policy_infos

Other

Output only. List of info about a feed item's validation and approval state for active feed mappings. There will be an entry in the list for each type of feed mapping associated with the feed, e.g. a feed with a sitelink and a call feed mapping would cause every feed item associated with that feed to have an entry in this list for both sitelink and call. This field is read-only.

feed_item.resource_name

String

Immutable. The resource name of the feed item. Feed item resource names have the form: customers/{customer_id}/feedItems/{feed_id}~{feed_item_id}

feed_item.start_date_time

DateTime

Start time in which this feed item is effective and can begin serving. The time is in the customer's time zone. The format is "YYYY-MM-DD HH:MM:SS". Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30"

feed_item.status

String

Output only. Status of the feed item. This field is read-only.

feed_item.url_custom_parameters

Other

The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls.

feed_placeholder_view.placeholder_type

String

Output only. The placeholder type of the feed placeholder view.

feed_placeholder_view.resource_name

String

Output only. The resource name of the feed placeholder view. Feed placeholder view resource names have the form: customers/{customer_id}/feedPlaceholderViews/{placeholder_type}

gender_view.resource_name

String

Output only. The resource name of the gender view. Gender view resource names have the form: customers/{customer_id}/genderViews/{ad_group_id}~{criterion_id}

geographic_view.country_criterion_id

Long

Output only. Criterion Id for the country.

geographic_view.location_type

String

Output only. Type of the geo targeting of the campaign.

geographic_view.resource_name

String

Output only. The resource name of the geographic view. Geographic view resource names have the form: customers/{customer_id}/geographicViews/{country_criterion_id}~{location_type}

group_placement_view.display_name

String

Output only. Domain name for websites and YouTube channel name for YouTube channels.

group_placement_view.placement

String

Output only. The automatic placement string at group level, e. g. web domain, mobile app ID, or a YouTube channel ID.

group_placement_view.placement_type

String

Output only. Type of the placement, e.g. Website, YouTube Channel, Mobile Application.

group_placement_view.resource_name

String

Output only. The resource name of the group placement view. Group placement view resource names have the form: customers/{customer_id}/groupPlacementViews/{ad_group_id}~{base64_placement}

group_placement_view.target_url

String

Output only. URL of the group placement, e.g. domain, link to the mobile application in app store, or a YouTube channel URL.

hotel_group_view.resource_name

String

Output only. The resource name of the hotel group view. Hotel Group view resource names have the form: customers/{customer_id}/hotelGroupViews/{ad_group_id}~{criterion_id}

hotel_performance_view.resource_name

String

Output only. The resource name of the hotel performance view. Hotel performance view resource names have the form: customers/{customer_id}/hotelPerformanceView

hotel_reconciliation.billed

Boolean

Output only. Whether a given booking has been billed. Once billed, a booking can't be modified.

hotel_reconciliation.campaign

String

Output only. The resource name for the Campaign associated with the conversion.

hotel_reconciliation.check_in_date

DateTime

Output only. Check-in date recorded when the booking is made. If the check-in date is modified at reconciliation, the revised date will then take the place of the original date in this column. Format is YYYY-MM-DD.

hotel_reconciliation.check_out_date

DateTime

Output only. Check-out date recorded when the booking is made. If the check-in date is modified at reconciliation, the revised date will then take the place of the original date in this column. Format is YYYY-MM-DD.

hotel_reconciliation.commission_id

String

Required. Output only. The commission ID is Google's ID for this booking. Every booking event is assigned a Commission ID to help you match it to a guest stay.

hotel_reconciliation.hotel_center_id

Long

Output only. Identifier for the Hotel Center account which provides the rates for the Hotel campaign.

hotel_reconciliation.hotel_id

String

Output only. Unique identifier for the booked property, as provided in the Hotel Center feed. The hotel ID comes from the 'ID' parameter of the conversion tracking tag.

hotel_reconciliation.order_id

String

Output only. The order ID is the identifier for this booking as provided in the 'transaction_id' parameter of the conversion tracking tag.

hotel_reconciliation.reconciled_value_micros

Long

Required. Output only. Reconciled value is the final value of a booking as paid by the guest. If original booking value changes for any reason, such as itinerary changes or room upsells, the reconciled value should be the full final amount collected. If a booking is canceled, the reconciled value should include the value of any cancellation fees or non-refundable nights charged. Value is in millionths of the base unit currency. For example, $12.35 would be represented as 12350000. Currency unit is in the default customer currency.

hotel_reconciliation.resource_name

String

Immutable. The resource name of the hotel reconciliation. Hotel reconciliation resource names have the form: customers/{customer_id}/hotelReconciliations/{commission_id}

hotel_reconciliation.status

String

Required. Output only. Current status of a booking with regards to reconciliation and billing. Bookings should be reconciled within 45 days after the check-out date. Any booking not reconciled within 45 days will be billed at its original value.

income_range_view.resource_name

String

Output only. The resource name of the income range view. Income range view resource names have the form: customers/{customer_id}/incomeRangeViews/{ad_group_id}~{criterion_id}

keyword_view.resource_name

String

Output only. The resource name of the keyword view. Keyword view resource names have the form: customers/{customer_id}/keywordViews/{ad_group_id}~{criterion_id}

landing_page_view.resource_name

String

Output only. The resource name of the landing page view. Landing page view resource names have the form: customers/{customer_id}/landingPageViews/{unexpanded_final_url_fingerprint}

landing_page_view.unexpanded_final_url

String

Output only. The advertiser-specified final URL.

location_view.resource_name

String

Output only. The resource name of the location view. Location view resource names have the form: customers/{customer_id}/locationViews/{campaign_id}~{criterion_id}

managed_placement_view.resource_name

String

Output only. The resource name of the Managed Placement view. Managed placement view resource names have the form: customers/{customer_id}/managedPlacementViews/{ad_group_id}~{criterion_id}

paid_organic_search_term_view.resource_name

String

Output only. The resource name of the search term view. Search term view resource names have the form: customers/{customer_id}/paidOrganicSearchTermViews/{campaign_id}~ {ad_group_id}~{URL-base64 search term}

paid_organic_search_term_view.search_term

String

Output only. The search term.

parental_status_view.resource_name

String

Output only. The resource name of the parental status view. Parental Status view resource names have the form: customers/{customer_id}/parentalStatusViews/{ad_group_id}~{criterion_id}

per_store_view.place_id

String

Output only. The place ID of the per store view.

per_store_view.resource_name

String

Output only. The resource name of the per store view. Per Store view resource names have the form: customers/{customer_id}/perStoreViews/{place_id}

product_group_view.resource_name

String

Output only. The resource name of the product group view. Product group view resource names have the form: customers/{customer_id}/productGroupViews/{ad_group_id}~{criterion_id}

search_term_view.ad_group

String

Output only. The ad group the search term served in.

search_term_view.resource_name

String

Output only. The resource name of the search term view. Search term view resource names have the form: customers/{customer_id}/searchTermViews/{campaign_id}{ad_group_id}{URL-base64_search_term}

search_term_view.search_term

String

Output only. The search term.

search_term_view.status

String

Output only. Indicates whether the search term is currently one of your targeted or excluded keywords.

shopping_performance_view.resource_name

String

Output only. The resource name of the Shopping performance view. Shopping performance view resource names have the form: customers/{customer_id}/shoppingPerformanceView

smart_campaign_search_term_view.campaign

String

Output only. The Smart campaign the search term served in.

smart_campaign_search_term_view.resource_name

String

Output only. The resource name of the Smart campaign search term view. Smart campaign search term view resource names have the form: customers/{customer_id}/smartCampaignSearchTermViews/{campaign_id}~{URL-base64_search_term}

smart_campaign_search_term_view.search_term

String

Output only. The search term.

topic_view.resource_name

String

Output only. The resource name of the topic view. Topic view resource names have the form: customers/{customer_id}/topicViews/{ad_group_id}~{criterion_id}

travel_activity_group_view.resource_name

String

Output only. The resource name of the travel activity group view. Travel Activity Group view resource names have the form: customers/{customer_id}/travelActivityGroupViews/{ad_group_id}~{criterion_id}

travel_activity_performance_view.resource_name

String

Output only. The resource name of the travel activity performance view. Travel Activity performance view resource names have the form: customers/{customer_id}/travelActivityPerformanceView

user_location_view.country_criterion_id

Long

Output only. Criterion Id for the country.

user_location_view.resource_name

String

Output only. The resource name of the user location view. UserLocation view resource names have the form: customers/{customer_id}/userLocationViews/{country_criterion_id}~{targeting_location}

user_location_view.targeting_location

Boolean

Output only. Indicates whether location was targeted or not.

video.channel_id

String

Output only. The owner channel id of the video.

video.duration_millis

Long

Output only. The duration of the video in milliseconds.

video.id

String

Output only. The ID of the video.

video.resource_name

String

Output only. The resource name of the video. Video resource names have the form: customers/{customer_id}/videos/{video_id}

video.title

String

Output only. The title of the video.

webpage_view.resource_name

String

Output only. The resource name of the webpage view. Webpage view resource names have the form: customers/{customer_id}/webpageViews/{ad_group_id}~{criterion_id}

Was this helpful?