xref: /aosp_15_r20/external/googleapis/google/ads/googleads/v15/common/metrics.proto (revision d5c09012810ac0c9f33fe448fb6da8260d444cc9)
1// Copyright 2023 Google LLC
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15syntax = "proto3";
16
17package google.ads.googleads.v15.common;
18
19import "google/ads/googleads/v15/enums/interaction_event_type.proto";
20import "google/ads/googleads/v15/enums/quality_score_bucket.proto";
21
22option csharp_namespace = "Google.Ads.GoogleAds.V15.Common";
23option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v15/common;common";
24option java_multiple_files = true;
25option java_outer_classname = "MetricsProto";
26option java_package = "com.google.ads.googleads.v15.common";
27option objc_class_prefix = "GAA";
28option php_namespace = "Google\\Ads\\GoogleAds\\V15\\Common";
29option ruby_package = "Google::Ads::GoogleAds::V15::Common";
30
31// Proto file describing metrics.
32
33// Metrics data.
34message Metrics {
35  // The percent of your ad impressions that are shown as the very first ad
36  // above the organic search results.
37  optional double absolute_top_impression_percentage = 183;
38
39  // Average cost of viewable impressions (`active_view_impressions`).
40  optional double active_view_cpm = 184;
41
42  // Active view measurable clicks divided by active view viewable impressions.
43  //
44  // This metric is reported only for the Display Network.
45  optional double active_view_ctr = 185;
46
47  // A measurement of how often your ad has become viewable on a Display
48  // Network site.
49  optional int64 active_view_impressions = 186;
50
51  // The ratio of impressions that could be measured by Active View over the
52  // number of served impressions.
53  optional double active_view_measurability = 187;
54
55  // The cost of the impressions you received that were measurable by Active
56  // View.
57  optional int64 active_view_measurable_cost_micros = 188;
58
59  // The number of times your ads are appearing on placements in positions
60  // where they can be seen.
61  optional int64 active_view_measurable_impressions = 189;
62
63  // The percentage of time when your ad appeared on an Active View enabled site
64  // (measurable impressions) and was viewable (viewable impressions).
65  optional double active_view_viewability = 190;
66
67  // All conversions from interactions (as oppose to view through conversions)
68  // divided by the number of ad interactions.
69  optional double all_conversions_from_interactions_rate = 191;
70
71  // The value of all conversions.
72  optional double all_conversions_value = 192;
73
74  // The value of all conversions. When this column is selected with date, the
75  // values in date column means the conversion date. Details for the
76  // by_conversion_date columns are available at
77  // https://support.google.com/google-ads/answer/9549009.
78  double all_conversions_value_by_conversion_date = 240;
79
80  // All of new customers' lifetime conversion value. If you have set up
81  // customer acquisition goal at either account level or campaign level, this
82  // will include the additional conversion value from new customers for both
83  // biddable and non-biddable conversions. If your campaign has adopted the
84  // customer acquisition goal and selected "bid higher for new customers",
85  // these values will be included in "all_conversions_value". See
86  // https://support.google.com/google-ads/answer/12080169 for more details.
87  optional double all_new_customer_lifetime_value = 294;
88
89  // The total number of conversions. This includes all conversions regardless
90  // of the value of include_in_conversions_metric.
91  optional double all_conversions = 193;
92
93  // The total number of conversions. This includes all conversions regardless
94  // of the value of include_in_conversions_metric. When this column is selected
95  // with date, the values in date column means the conversion date. Details for
96  // the by_conversion_date columns are available at
97  // https://support.google.com/google-ads/answer/9549009.
98  double all_conversions_by_conversion_date = 241;
99
100  // The value of all conversions divided by the total cost of ad interactions
101  // (such as clicks for text ads or views for video ads).
102  optional double all_conversions_value_per_cost = 194;
103
104  // The number of times people clicked the "Call" button to call a store during
105  // or after clicking an ad. This number doesn't include whether or not calls
106  // were connected, or the duration of any calls.
107  //
108  // This metric applies to feed items only.
109  optional double all_conversions_from_click_to_call = 195;
110
111  // The number of times people clicked a "Get directions" button to navigate to
112  // a store after clicking an ad.
113  //
114  // This metric applies to feed items only.
115  optional double all_conversions_from_directions = 196;
116
117  // The value of all conversions from interactions divided by the total number
118  // of interactions.
119  optional double all_conversions_from_interactions_value_per_interaction = 197;
120
121  // The number of times people clicked a link to view a store's menu after
122  // clicking an ad.
123  //
124  // This metric applies to feed items only.
125  optional double all_conversions_from_menu = 198;
126
127  // The number of times people placed an order at a store after clicking an ad.
128  //
129  // This metric applies to feed items only.
130  optional double all_conversions_from_order = 199;
131
132  // The number of other conversions (for example, posting a review or saving a
133  // location for a store) that occurred after people clicked an ad.
134  //
135  // This metric applies to feed items only.
136  optional double all_conversions_from_other_engagement = 200;
137
138  // Estimated number of times people visited a store after clicking an ad.
139  //
140  // This metric applies to feed items only.
141  optional double all_conversions_from_store_visit = 201;
142
143  // The number of times that people were taken to a store's URL after clicking
144  // an ad.
145  //
146  // This metric applies to feed items only.
147  optional double all_conversions_from_store_website = 202;
148
149  // This metric is part of the Auction Insights report, and tells how often
150  // the ads of another participant showed as the very first ad above the
151  // organic search results.
152  // This percentage is computed only over the auctions that you appeared in
153  // the page.
154  //
155  // This metric is not publicly available.
156  optional double auction_insight_search_absolute_top_impression_percentage =
157      258;
158
159  // This metric is part of the Auction Insights report, and tells the
160  // percentage of impressions that another participant obtained, over the total
161  // number of impressions that your ads were eligible for.
162  // Any value below 0.1 is reported as 0.0999.
163  //
164  // This metric is not publicly available.
165  optional double auction_insight_search_impression_share = 259;
166
167  // This metric is part of the Auction Insights report, and tells the
168  // percentage of impressions that your ads outranked (showed above)
169  // another participant in the auction, compared to the total number of
170  // impressions that your ads were eligible for.
171  // Any value below 0.1 is reported as 0.0999.
172  //
173  // This metric is not publicly available.
174  optional double auction_insight_search_outranking_share = 260;
175
176  // This metric is part of the Auction Insights report, and tells how often
177  // another participant's ad received an impression when your ad also received
178  // an impression.
179  //
180  // This metric is not publicly available.
181  optional double auction_insight_search_overlap_rate = 261;
182
183  // This metric is part of the Auction Insights report, and tells how often
184  // another participant's ad was shown in a higher position than yours, when
185  // both of your ads were shown at the same page.
186  //
187  // This metric is not publicly available.
188  optional double auction_insight_search_position_above_rate = 262;
189
190  // This metric is part of the Auction Insights report, and tells how often
191  // the ads of another participant showed above the organic search results.
192  // This percentage is computed only over the auctions that you appeared in
193  // the page.
194  //
195  // This metric is not publicly available.
196  optional double auction_insight_search_top_impression_percentage = 263;
197
198  // The average amount you pay per interaction. This amount is the total cost
199  // of your ads divided by the total number of interactions.
200  optional double average_cost = 203;
201
202  // The total cost of all clicks divided by the total number of clicks
203  // received.
204  optional double average_cpc = 204;
205
206  // The average amount that you've been charged for an ad engagement. This
207  // amount is the total cost of all ad engagements divided by the total number
208  // of ad engagements.
209  optional double average_cpe = 205;
210
211  // Average cost-per-thousand impressions (CPM).
212  optional double average_cpm = 206;
213
214  // The average amount you pay each time someone views your ad.
215  // The average CPV is defined by the total cost of all ad views divided by
216  // the number of views.
217  optional double average_cpv = 207;
218
219  // Average number of pages viewed per session.
220  optional double average_page_views = 208;
221
222  // Total duration of all sessions (in seconds) / number of sessions. Imported
223  // from Google Analytics.
224  optional double average_time_on_site = 209;
225
226  // An indication of how other advertisers are bidding on similar products.
227  optional double benchmark_average_max_cpc = 210;
228
229  // Number of app installs.
230  optional double biddable_app_install_conversions = 254;
231
232  // Number of in-app actions.
233  optional double biddable_app_post_install_conversions = 255;
234
235  // An indication on how other advertisers' Shopping ads for similar products
236  // are performing based on how often people who see their ad click on it.
237  optional double benchmark_ctr = 211;
238
239  // Percentage of clicks where the user only visited a single page on your
240  // site. Imported from Google Analytics.
241  optional double bounce_rate = 212;
242
243  // The number of clicks.
244  optional int64 clicks = 131;
245
246  // The number of times your ad or your site's listing in the unpaid
247  // results was clicked. See the help page at
248  // https://support.google.com/google-ads/answer/3097241 for details.
249  optional int64 combined_clicks = 156;
250
251  // The number of times your ad or your site's listing in the unpaid
252  // results was clicked (combined_clicks) divided by combined_queries. See the
253  // help page at https://support.google.com/google-ads/answer/3097241 for
254  // details.
255  optional double combined_clicks_per_query = 157;
256
257  // The number of searches that returned pages from your site in the unpaid
258  // results or showed one of your text ads. See the help page at
259  // https://support.google.com/google-ads/answer/3097241 for details.
260  optional int64 combined_queries = 158;
261
262  // The estimated percent of times that your ad was eligible to show
263  // on the Display Network but didn't because your budget was too low.
264  // Note: Content budget lost impression share is reported in the range of 0
265  // to 0.9. Any value above 0.9 is reported as 0.9001.
266  optional double content_budget_lost_impression_share = 159;
267
268  // The impressions you've received on the Display Network divided
269  // by the estimated number of impressions you were eligible to receive.
270  // Note: Content impression share is reported in the range of 0.1 to 1. Any
271  // value below 0.1 is reported as 0.0999.
272  optional double content_impression_share = 160;
273
274  // The last date/time a conversion tag for this conversion action successfully
275  // fired and was seen by Google Ads. This firing event may not have been the
276  // result of an attributable conversion (for example, because the tag was
277  // fired from a browser that did not previously click an ad from an
278  // appropriate advertiser). The date/time is in the customer's time zone.
279  optional string conversion_last_received_request_date_time = 161;
280
281  // The date of the most recent conversion for this conversion action. The date
282  // is in the customer's time zone.
283  optional string conversion_last_conversion_date = 162;
284
285  // The estimated percentage of impressions on the Display Network
286  // that your ads didn't receive due to poor Ad Rank.
287  // Note: Content rank lost impression share is reported in the range of 0
288  // to 0.9. Any value above 0.9 is reported as 0.9001.
289  optional double content_rank_lost_impression_share = 163;
290
291  // Conversions from interactions divided by the number of ad interactions
292  // (such as clicks for text ads or views for video ads). This only includes
293  // conversion actions which include_in_conversions_metric attribute is set to
294  // true. If you use conversion-based bidding, your bid strategies will
295  // optimize for these conversions.
296  optional double conversions_from_interactions_rate = 164;
297
298  // The value of conversions. This only includes conversion actions which
299  // include_in_conversions_metric attribute is set to true. If you use
300  // conversion-based bidding, your bid strategies will optimize for these
301  // conversions.
302  optional double conversions_value = 165;
303
304  // The value of conversions. This only includes conversion actions which
305  // include_in_conversions_metric attribute is set to true. If you use
306  // conversion-based bidding, your bid strategies will optimize for these
307  // conversions. When this column is selected with date, the values in date
308  // column means the conversion date. Details for the by_conversion_date
309  // columns are available at
310  // https://support.google.com/google-ads/answer/9549009.
311  double conversions_value_by_conversion_date = 242;
312
313  // New customers' lifetime conversion value. If you have set up
314  // customer acquisition goal at either account level or campaign level, this
315  // will include the additional conversion value from new customers for
316  // biddable conversions. If your campaign has adopted the customer
317  // acquisition goal and selected "bid higher for new customers", these values
318  // will be included in "conversions_value" for optimization. See
319  // https://support.google.com/google-ads/answer/12080169 for more details.
320  optional double new_customer_lifetime_value = 293;
321
322  // The value of conversions divided by the cost of ad interactions. This only
323  // includes conversion actions which include_in_conversions_metric attribute
324  // is set to true. If you use conversion-based bidding, your bid strategies
325  // will optimize for these conversions.
326  optional double conversions_value_per_cost = 166;
327
328  // The value of conversions from interactions divided by the number of ad
329  // interactions. This only includes conversion actions which
330  // include_in_conversions_metric attribute is set to true. If you use
331  // conversion-based bidding, your bid strategies will optimize for these
332  // conversions.
333  optional double conversions_from_interactions_value_per_interaction = 167;
334
335  // The number of conversions. This only includes conversion actions which
336  // include_in_conversions_metric attribute is set to true. If you use
337  // conversion-based bidding, your bid strategies will optimize for these
338  // conversions.
339  optional double conversions = 168;
340
341  // The number of conversions. This only includes conversion actions which
342  // include_in_conversions_metric attribute is set to true. If you use
343  // conversion-based bidding, your bid strategies will optimize for these
344  // conversions. When this column is selected with date, the values in date
345  // column means the conversion date. Details for the by_conversion_date
346  // columns are available at
347  // https://support.google.com/google-ads/answer/9549009.
348  double conversions_by_conversion_date = 243;
349
350  // The sum of your cost-per-click (CPC) and cost-per-thousand impressions
351  // (CPM) costs during this period.
352  optional int64 cost_micros = 169;
353
354  // The cost of ad interactions divided by all conversions.
355  optional double cost_per_all_conversions = 170;
356
357  // The cost of ad interactions divided by conversions. This only includes
358  // conversion actions which include_in_conversions_metric attribute is set to
359  // true. If you use conversion-based bidding, your bid strategies will
360  // optimize for these conversions.
361  optional double cost_per_conversion = 171;
362
363  // The cost of ad interactions divided by current model attributed
364  // conversions. This only includes conversion actions which
365  // include_in_conversions_metric attribute is set to true. If you use
366  // conversion-based bidding, your bid strategies will optimize for these
367  // conversions.
368  optional double cost_per_current_model_attributed_conversion = 172;
369
370  // Conversions from when a customer clicks on a Google Ads ad on one device,
371  // then converts on a different device or browser.
372  // Cross-device conversions are already included in all_conversions.
373  optional double cross_device_conversions = 173;
374
375  // The sum of the value of cross-device conversions, in micros.
376  optional int64 cross_device_conversions_value_micros = 312;
377
378  // The number of clicks your ad receives (Clicks) divided by the number
379  // of times your ad is shown (Impressions).
380  optional double ctr = 174;
381
382  // Shows how your historic conversions data would look under the attribution
383  // model you've currently selected. This only includes conversion actions
384  // which include_in_conversions_metric attribute is set to true. If you use
385  // conversion-based bidding, your bid strategies will optimize for these
386  // conversions.
387  optional double current_model_attributed_conversions = 175;
388
389  // Current model attributed conversions from interactions divided by the
390  // number of ad interactions (such as clicks for text ads or views for video
391  // ads). This only includes conversion actions which
392  // include_in_conversions_metric attribute is set to true. If you use
393  // conversion-based bidding, your bid strategies will optimize for these
394  // conversions.
395  optional double current_model_attributed_conversions_from_interactions_rate =
396      176;
397
398  // The value of current model attributed conversions from interactions divided
399  // by the number of ad interactions. This only includes conversion actions
400  // which include_in_conversions_metric attribute is set to true. If you use
401  // conversion-based bidding, your bid strategies will optimize for these
402  // conversions.
403  optional double
404      current_model_attributed_conversions_from_interactions_value_per_interaction =
405          177;
406
407  // The value of current model attributed conversions. This only includes
408  // conversion actions which include_in_conversions_metric attribute is set to
409  // true. If you use conversion-based bidding, your bid strategies will
410  // optimize for these conversions.
411  optional double current_model_attributed_conversions_value = 178;
412
413  // The value of current model attributed conversions divided by the cost of ad
414  // interactions. This only includes conversion actions which
415  // include_in_conversions_metric attribute is set to true. If you use
416  // conversion-based bidding, your bid strategies will optimize for these
417  // conversions.
418  optional double current_model_attributed_conversions_value_per_cost = 179;
419
420  // How often people engage with your ad after it's shown to them. This is the
421  // number of ad expansions divided by the number of times your ad is shown.
422  optional double engagement_rate = 180;
423
424  // The number of engagements.
425  // An engagement occurs when a viewer expands your Lightbox ad. Also, in the
426  // future, other ad types may support engagement metrics.
427  optional int64 engagements = 181;
428
429  // Average lead value based on clicks.
430  optional double hotel_average_lead_value_micros = 213;
431
432  // Commission bid rate in micros. A 20% commission is represented as
433  // 200,000.
434  optional int64 hotel_commission_rate_micros = 256;
435
436  // Expected commission cost. The result of multiplying the commission value
437  // times the hotel_commission_rate in advertiser currency.
438  optional double hotel_expected_commission_cost = 257;
439
440  // The average price difference between the price offered by reporting hotel
441  // advertiser and the cheapest price offered by the competing advertiser.
442  optional double hotel_price_difference_percentage = 214;
443
444  // The number of impressions that hotel partners could have had given their
445  // feed performance.
446  optional int64 hotel_eligible_impressions = 215;
447
448  // The creative historical quality score.
449  google.ads.googleads.v15.enums.QualityScoreBucketEnum.QualityScoreBucket
450      historical_creative_quality_score = 80;
451
452  // The quality of historical landing page experience.
453  google.ads.googleads.v15.enums.QualityScoreBucketEnum.QualityScoreBucket
454      historical_landing_page_quality_score = 81;
455
456  // The historical quality score.
457  optional int64 historical_quality_score = 216;
458
459  // The historical search predicted click through rate (CTR).
460  google.ads.googleads.v15.enums.QualityScoreBucketEnum.QualityScoreBucket
461      historical_search_predicted_ctr = 83;
462
463  // The number of times the ad was forwarded to someone else as a message.
464  optional int64 gmail_forwards = 217;
465
466  // The number of times someone has saved your Gmail ad to their inbox as a
467  // message.
468  optional int64 gmail_saves = 218;
469
470  // The number of clicks to the landing page on the expanded state of Gmail
471  // ads.
472  optional int64 gmail_secondary_clicks = 219;
473
474  // The number of times a store's location-based ad was shown.
475  //
476  // This metric applies to feed items only.
477  optional int64 impressions_from_store_reach = 220;
478
479  // Count of how often your ad has appeared on a search results page or
480  // website on the Google Network.
481  optional int64 impressions = 221;
482
483  // How often people interact with your ad after it is shown to them.
484  // This is the number of interactions divided by the number of times your ad
485  // is shown.
486  optional double interaction_rate = 222;
487
488  // The number of interactions.
489  // An interaction is the main user action associated with an ad format-clicks
490  // for text and shopping ads, views for video ads, and so on.
491  optional int64 interactions = 223;
492
493  // The types of payable and free interactions.
494  repeated google.ads.googleads.v15.enums.InteractionEventTypeEnum
495      .InteractionEventType interaction_event_types = 100;
496
497  // The percentage of clicks filtered out of your total number of clicks
498  // (filtered + non-filtered clicks) during the reporting period.
499  optional double invalid_click_rate = 224;
500
501  // Number of clicks Google considers illegitimate and doesn't charge you for.
502  optional int64 invalid_clicks = 225;
503
504  // Number of message chats initiated for Click To Message impressions that
505  // were message tracking eligible.
506  optional int64 message_chats = 226;
507
508  // Number of Click To Message impressions that were message tracking eligible.
509  optional int64 message_impressions = 227;
510
511  // Number of message chats initiated (message_chats) divided by the number
512  // of message impressions (message_impressions).
513  // Rate at which a user initiates a message chat from an ad impression with
514  // a messaging option and message tracking enabled.
515  // Note that this rate can be more than 1.0 for a given message impression.
516  optional double message_chat_rate = 228;
517
518  // The percentage of mobile clicks that go to a mobile-friendly page.
519  optional double mobile_friendly_clicks_percentage = 229;
520
521  // Total optimization score uplift of all recommendations.
522  optional double optimization_score_uplift = 247;
523
524  // URL for the optimization score page in the Google Ads web interface.
525  // This metric can be selected from `customer` or `campaign`, and can be
526  // segmented by `segments.recommendation_type`. For example, `SELECT
527  // metrics.optimization_score_url, segments.recommendation_type FROM
528  // customer` will return a URL for each unique (customer, recommendation_type)
529  // combination.
530  optional string optimization_score_url = 248;
531
532  // The number of times someone clicked your site's listing in the unpaid
533  // results for a particular query. See the help page at
534  // https://support.google.com/google-ads/answer/3097241 for details.
535  optional int64 organic_clicks = 230;
536
537  // The number of times someone clicked your site's listing in the unpaid
538  // results (organic_clicks) divided by the total number of searches that
539  // returned pages from your site (organic_queries). See the help page at
540  // https://support.google.com/google-ads/answer/3097241 for details.
541  optional double organic_clicks_per_query = 231;
542
543  // The number of listings for your site in the unpaid search results. See the
544  // help page at https://support.google.com/google-ads/answer/3097241 for
545  // details.
546  optional int64 organic_impressions = 232;
547
548  // The number of times a page from your site was listed in the unpaid search
549  // results (organic_impressions) divided by the number of searches returning
550  // your site's listing in the unpaid results (organic_queries). See the help
551  // page at https://support.google.com/google-ads/answer/3097241 for details.
552  optional double organic_impressions_per_query = 233;
553
554  // The total number of searches that returned your site's listing in the
555  // unpaid results. See the help page at
556  // https://support.google.com/google-ads/answer/3097241 for details.
557  optional int64 organic_queries = 234;
558
559  // Percentage of first-time sessions (from people who had never visited your
560  // site before). Imported from Google Analytics.
561  optional double percent_new_visitors = 235;
562
563  // Number of offline phone calls.
564  optional int64 phone_calls = 236;
565
566  // Number of offline phone impressions.
567  optional int64 phone_impressions = 237;
568
569  // Number of phone calls received (phone_calls) divided by the number of
570  // times your phone number is shown (phone_impressions).
571  optional double phone_through_rate = 238;
572
573  // Your clickthrough rate (Ctr) divided by the average clickthrough rate of
574  // all advertisers on the websites that show your ads. Measures how your ads
575  // perform on Display Network sites compared to other ads on the same sites.
576  optional double relative_ctr = 239;
577
578  // The percentage of the customer's Shopping or Search ad impressions that are
579  // shown in the most prominent Shopping position. See
580  // https://support.google.com/google-ads/answer/7501826
581  // for details. Any value below 0.1 is reported as 0.0999.
582  optional double search_absolute_top_impression_share = 136;
583
584  // The number estimating how often your ad wasn't the very first ad above the
585  // organic search results due to a low budget. Note: Search
586  // budget lost absolute top impression share is reported in the range of 0 to
587  // 0.9. Any value above 0.9 is reported as 0.9001.
588  optional double search_budget_lost_absolute_top_impression_share = 137;
589
590  // The estimated percent of times that your ad was eligible to show on the
591  // Search Network but didn't because your budget was too low. Note: Search
592  // budget lost impression share is reported in the range of 0 to 0.9. Any
593  // value above 0.9 is reported as 0.9001.
594  optional double search_budget_lost_impression_share = 138;
595
596  // The number estimating how often your ad didn't show anywhere above the
597  // organic search results due to a low budget. Note: Search
598  // budget lost top impression share is reported in the range of 0 to 0.9. Any
599  // value above 0.9 is reported as 0.9001.
600  optional double search_budget_lost_top_impression_share = 139;
601
602  // The number of clicks you've received on the Search Network
603  // divided by the estimated number of clicks you were eligible to receive.
604  // Note: Search click share is reported in the range of 0.1 to 1. Any value
605  // below 0.1 is reported as 0.0999.
606  optional double search_click_share = 140;
607
608  // The impressions you've received divided by the estimated number of
609  // impressions you were eligible to receive on the Search Network for search
610  // terms that matched your keywords exactly (or were close variants of your
611  // keyword), regardless of your keyword match types. Note: Search exact match
612  // impression share is reported in the range of 0.1 to 1. Any value below 0.1
613  // is reported as 0.0999.
614  optional double search_exact_match_impression_share = 141;
615
616  // The impressions you've received on the Search Network divided
617  // by the estimated number of impressions you were eligible to receive.
618  // Note: Search impression share is reported in the range of 0.1 to 1. Any
619  // value below 0.1 is reported as 0.0999.
620  optional double search_impression_share = 142;
621
622  // The number estimating how often your ad wasn't the very first ad above the
623  // organic search results due to poor Ad Rank.
624  // Note: Search rank lost absolute top impression share is reported in the
625  // range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.
626  optional double search_rank_lost_absolute_top_impression_share = 143;
627
628  // The estimated percentage of impressions on the Search Network
629  // that your ads didn't receive due to poor Ad Rank.
630  // Note: Search rank lost impression share is reported in the range of 0 to
631  // 0.9. Any value above 0.9 is reported as 0.9001.
632  optional double search_rank_lost_impression_share = 144;
633
634  // The number estimating how often your ad didn't show anywhere above the
635  // organic search results due to poor Ad Rank.
636  // Note: Search rank lost top impression share is reported in the range of 0
637  // to 0.9. Any value above 0.9 is reported as 0.9001.
638  optional double search_rank_lost_top_impression_share = 145;
639
640  // The impressions you've received in the top location (anywhere above the
641  // organic search results) compared to the estimated number of impressions you
642  // were eligible to receive in the top location.
643  // Note: Search top impression share is reported in the range of 0.1 to 1. Any
644  // value below 0.1 is reported as 0.0999.
645  optional double search_top_impression_share = 146;
646
647  // Search volume range for a search term insight category.
648  optional SearchVolumeRange search_volume = 295;
649
650  // A measure of how quickly your page loads after clicks on your mobile ads.
651  // The score is a range from 1 to 10, 10 being the fastest.
652  optional int64 speed_score = 147;
653
654  // The average Target CPA, or unset if not available (for example, for
655  // campaigns that had traffic from portfolio bidding strategies or non-tCPA).
656  optional int64 average_target_cpa_micros = 290;
657
658  // The average Target ROAS, or unset if not available (for example, for
659  // campaigns that had traffic from portfolio bidding strategies or non-tROAS).
660  optional double average_target_roas = 250;
661
662  // The percent of your ad impressions that are shown anywhere above the
663  // organic search results.
664  optional double top_impression_percentage = 148;
665
666  // The percentage of ad clicks to Accelerated Mobile Pages (AMP) landing pages
667  // that reach a valid AMP page.
668  optional double valid_accelerated_mobile_pages_clicks_percentage = 149;
669
670  // The value of all conversions divided by the number of all conversions.
671  optional double value_per_all_conversions = 150;
672
673  // The value of all conversions divided by the number of all conversions. When
674  // this column is selected with date, the values in date column means the
675  // conversion date. Details for the by_conversion_date columns are available
676  // at https://support.google.com/google-ads/answer/9549009.
677  optional double value_per_all_conversions_by_conversion_date = 244;
678
679  // The value of conversions divided by the number of conversions. This only
680  // includes conversion actions which include_in_conversions_metric attribute
681  // is set to true. If you use conversion-based bidding, your bid strategies
682  // will optimize for these conversions.
683  optional double value_per_conversion = 151;
684
685  // The value of conversions divided by the number of conversions. This only
686  // includes conversion actions which include_in_conversions_metric attribute
687  // is set to true. If you use conversion-based bidding, your bid strategies
688  // will optimize for these conversions. When this column is selected with
689  // date, the values in date column means the conversion date. Details for the
690  // by_conversion_date columns are available at
691  // https://support.google.com/google-ads/answer/9549009.
692  optional double value_per_conversions_by_conversion_date = 245;
693
694  // The value of current model attributed conversions divided by the number of
695  // the conversions. This only includes conversion actions which
696  // include_in_conversions_metric attribute is set to true. If you use
697  // conversion-based bidding, your bid strategies will optimize for these
698  // conversions.
699  optional double value_per_current_model_attributed_conversion = 152;
700
701  // Percentage of impressions where the viewer watched all of your video.
702  optional double video_quartile_p100_rate = 132;
703
704  // Percentage of impressions where the viewer watched 25% of your video.
705  optional double video_quartile_p25_rate = 133;
706
707  // Percentage of impressions where the viewer watched 50% of your video.
708  optional double video_quartile_p50_rate = 134;
709
710  // Percentage of impressions where the viewer watched 75% of your video.
711  optional double video_quartile_p75_rate = 135;
712
713  // The number of views your TrueView video ad receives divided by its number
714  // of impressions, including thumbnail impressions for TrueView in-display
715  // ads.
716  optional double video_view_rate = 153;
717
718  // The number of times your video ads were viewed.
719  optional int64 video_views = 154;
720
721  // The total number of view-through conversions.
722  // These happen when a customer sees an image or rich media ad, then later
723  // completes a conversion on your site without interacting with (for example,
724  // clicking on) another ad.
725  optional int64 view_through_conversions = 155;
726
727  // The number of iOS Store Kit Ad Network conversions.
728  int64 sk_ad_network_installs = 246;
729
730  // The total number of iOS Store Kit Ad Network conversions.
731  int64 sk_ad_network_total_conversions = 292;
732
733  // Clicks from properties not owned by the publisher for which the traffic
734  // the publisher has paid for or acquired through incentivized activity
735  int64 publisher_purchased_clicks = 264;
736
737  // Clicks from properties for which the traffic the publisher has not paid
738  // for or acquired through incentivized activity
739  int64 publisher_organic_clicks = 265;
740
741  // Clicks from traffic which is not identified as "Publisher Purchased" or
742  // "Publisher Organic"
743  int64 publisher_unknown_clicks = 266;
744
745  // Number of call button clicks on any location surface after a chargeable ad
746  // event (click or impression). This measure is coming from Asset based
747  // location.
748  optional double all_conversions_from_location_asset_click_to_call = 267;
749
750  // Number of driving directions clicks on any location surface after a
751  // chargeable ad event (click or impression). This measure is coming
752  // from Asset based location.
753  optional double all_conversions_from_location_asset_directions = 268;
754
755  // Number of menu link clicks on any location surface after a chargeable ad
756  // event (click or impression). This measure is coming from Asset based
757  // location.
758  optional double all_conversions_from_location_asset_menu = 269;
759
760  // Number of order clicks on any location surface after a chargeable ad event
761  // (click or impression). This measure is coming from Asset based
762  // location.
763  optional double all_conversions_from_location_asset_order = 270;
764
765  // Number of other types of local action clicks on any location surface after
766  // a chargeable ad event (click or impression). This measure is coming
767  // from Asset based location.
768  optional double all_conversions_from_location_asset_other_engagement = 271;
769
770  // Estimated number of visits to the store after a chargeable
771  // ad event (click or impression). This measure is coming from Asset
772  // based location.
773  optional double all_conversions_from_location_asset_store_visits = 272;
774
775  // Number of website URL clicks on any location surface after a chargeable ad
776  // event (click or impression). This measure is coming from Asset based
777  // location.
778  optional double all_conversions_from_location_asset_website = 273;
779
780  // Number of impressions in which the store location was shown or the location
781  // was used for targeting. This measure is coming from Asset based
782  // location.
783  optional int64 eligible_impressions_from_location_asset_store_reach = 274;
784
785  // Number of call button clicks on any location surface after an impression.
786  // This measure is coming from Asset based location.
787  optional double view_through_conversions_from_location_asset_click_to_call =
788      275;
789
790  // Number of driving directions clicks on any location surface after an
791  // impression. This measure is coming from Asset based location.
792  optional double view_through_conversions_from_location_asset_directions = 276;
793
794  // Number of menu link clicks on any location surface after an impression.
795  // This measure is coming from Asset based location.
796  optional double view_through_conversions_from_location_asset_menu = 277;
797
798  // Number of order clicks on any location surface after an impression. This
799  // measure is coming from Asset based location.
800  optional double view_through_conversions_from_location_asset_order = 278;
801
802  // Number of other types of local action clicks on any location surface after
803  // an impression. This measure is coming from Asset based location.
804  optional double
805      view_through_conversions_from_location_asset_other_engagement = 279;
806
807  // Estimated number of visits to the store after an impression.
808  // This measure is coming from Asset based location.
809  optional double view_through_conversions_from_location_asset_store_visits =
810      280;
811
812  // Number of website URL clicks on any location surface after an impression.
813  // This measure is coming from Asset based location.
814  optional double view_through_conversions_from_location_asset_website = 281;
815
816  // Orders is the total number of purchase conversions you received attributed
817  // to your ads.
818  // How it works: You report conversions with cart data for
819  // completed purchases on your website. If a conversion is attributed to
820  // previous interactions with your ads (clicks for text or Shopping ads, views
821  // for video ads etc.) it's counted as an order.
822  // Example: Someone clicked on a Shopping ad for a hat then bought the same
823  // hat and a shirt in an order on your website. Even though they bought 2
824  // products, this would count as 1 order.
825  // This metric is only available if you report conversions with cart data.
826  optional double orders = 296;
827
828  // Average order value is the average revenue you made per order attributed to
829  // your ads.
830  // How it works: You report conversions with cart data for completed purchases
831  // on your website. Average order value is the total revenue from your orders
832  // divided by the total number of orders.
833  // Example: You received 3 orders which made $10, $15 and $20 worth of
834  // revenue. The average order value is $15 = ($10 + $15 + $20)/3.
835  // This metric is only available if you report conversions with cart data.
836  optional int64 average_order_value_micros = 297;
837
838  // Average cart size is the average number of products in each order
839  // attributed to your ads.
840  // How it works: You report conversions with cart data for completed purchases
841  // on your website. Average cart size is the total number of products sold
842  // divided by the total number of orders you received.
843  // Example: You received 2 orders, the first included 3 products and the
844  // second included 2. The average cart size is 2.5 products = (3+2)/2.
845  // This metric is only available if you report conversions with cart data.
846  optional double average_cart_size = 298;
847
848  // Cost of goods sold (COGS) is the total cost of the products you sold in
849  // orders attributed to your ads.
850  // How it works: You can add a cost of goods sold value to every product in
851  // Merchant Center. If you report conversions with cart data, the products you
852  // sold are matched with their cost of goods sold value and this can be used
853  // to calculate the gross profit you made on each order.
854  // Example: Someone clicked on a Shopping ad for a hat then bought the same
855  // hat and a shirt. The hat has a cost of goods sold value of $3, the shirt
856  // has a cost of goods sold value of $5. The cost of goods sold for this order
857  // is $8 = $3 + $5.
858  // This metric is only available if you report conversions with cart data.
859  optional int64 cost_of_goods_sold_micros = 299;
860
861  // Gross profit is the profit you made from orders attributed to your ads
862  // minus the cost of goods sold (COGS).
863  // How it works: Gross profit is the revenue you made from sales attributed to
864  // your ads minus cost of goods sold. Gross profit calculations only include
865  // products that have a cost of goods sold value in Merchant Center.
866  // Example: Someone clicked on a Shopping ad for a hat then bought the same
867  // hat and a shirt in an order from your website. The hat is priced $10 and
868  // the shirt is priced $20. The hat has a cost of goods sold value of $3, but
869  // the shirt has no cost of goods sold value. Gross profit for this order will
870  // only take into account the hat, so it's $7 = $10 - $3.
871  // This metric is only available if you report conversions with cart data.
872  optional int64 gross_profit_micros = 300;
873
874  // Gross profit margin is the percentage gross profit you made from orders
875  // attributed to your ads, after taking out the cost of goods sold (COGS).
876  // How it works: You report conversions with cart data for completed purchases
877  // on your website. Gross profit margin is the gross profit you made divided
878  // by your total revenue and multiplied by 100%. Gross profit margin
879  // calculations only include products that have a cost of goods sold value in
880  // Merchant Center.
881  // Example: Someone bought a hat and a shirt in an order on your website. The
882  // hat is priced $10 and has a cost of goods sold value of $3. The shirt is
883  // priced $20 but has no cost of goods sold value. Gross profit margin for
884  // this order will only take into account the hat because it has a cost of
885  // goods sold value, so it's 70% = ($10 - $3)/$10 x 100%.
886  // This metric is only available if you report conversions with cart data.
887  optional double gross_profit_margin = 301;
888
889  // Revenue is the total amount you made from orders attributed to your ads.
890  // How it works: You report conversions with cart data for completed purchases
891  // on your website. Revenue is the total value of all the orders you received
892  // attributed to your ads, minus any discount.
893  // Example: Someone clicked on a Shopping ad  for a hat then bought the same
894  // hat and a shirt in an order from your website. The hat is priced $10 and
895  // the shirt is priced $20. The entire order has a $5 discount. The revenue
896  // from this order is $25 = ($10 + $20) - $5.
897  // This metric is only available if you report conversions with cart data.
898  optional int64 revenue_micros = 302;
899
900  // Units sold is the total number of products sold from orders attributed to
901  // your ads.
902  // How it works: You report conversions with cart data for completed purchases
903  // on your website. Units sold is the total number of products sold from all
904  // orders attributed to your ads.
905  // Example: Someone clicked on a Shopping ad for a hat then bought the same
906  // hat, a shirt and a jacket. The units sold in this order is 3.
907  // This metric is only available if you report conversions with cart data.
908  optional double units_sold = 303;
909
910  // Cross-sell cost of goods sold (COGS) is the total cost of products sold as
911  // a result of advertising a different product.
912  // How it works: You report conversions with cart data for completed purchases
913  // on your website. If the ad that was interacted with before the purchase has
914  // an associated product (see Shopping Ads) then this product is considered
915  // the advertised product. Any product included in the order the customer
916  // places is a sold product. If these products don't match then this is
917  // considered cross-sell. Cross-sell cost of goods sold is the total cost of
918  // the products sold that weren't advertised.
919  // Example: Someone clicked on a Shopping ad for a hat then bought the same
920  // hat and a shirt. The hat has a cost of goods sold value of $3, the shirt
921  // has a cost of goods sold value of $5. The cross-sell cost of goods sold for
922  // this order is $5.
923  // This metric is only available if you report conversions with cart data.
924  optional int64 cross_sell_cost_of_goods_sold_micros = 304;
925
926  // Cross-sell gross profit is the profit you made from products sold as a
927  // result of advertising a different product, minus cost of goods sold (COGS).
928  // How it works: You report conversions with cart data for completed purchases
929  // on your website. If the ad that was interacted with before the purchase has
930  // an associated product (see Shopping Ads) then this product is considered
931  // the advertised product. Any product included in the purchase is a sold
932  // product. If these products don't match then this is considered cross-sell.
933  // Cross-sell gross profit is the revenue you made from cross-sell attributed
934  // to your ads minus the cost of the goods sold.
935  // Example: Someone clicked on a Shopping ad for a hat then bought the same
936  // hat and a shirt. The shirt is priced $20 and has a cost of goods sold value
937  // of $5. The cross-sell gross profit of this order is $15 = $20 - $5.
938  // This metric is only available if you report conversions with cart data.
939  optional int64 cross_sell_gross_profit_micros = 305;
940
941  // Cross-sell revenue is the total amount you made from products sold as a
942  // result of advertising a different product.
943  // How it works: You report conversions with cart data for completed purchases
944  // on your website. If the ad that was interacted with before the purchase has
945  // an associated product (see Shopping Ads) then this product is considered
946  // the advertised product. Any product included in the order the customer
947  // places is a sold product. If these products don't match then this is
948  // considered cross-sell. Cross-sell revenue is the total value you made from
949  // cross-sell attributed to your ads.
950  // Example: Someone clicked on a Shopping ad for a hat then bought the same
951  // hat and a shirt. The hat is priced $10 and the shirt is priced $20. The
952  // cross-sell revenue of this order is $20.
953  // This metric is only available if you report conversions with cart data.
954  optional int64 cross_sell_revenue_micros = 306;
955
956  // Cross-sell units sold is the total number of products sold as a result of
957  // advertising a different product.
958  // How it works: You report conversions with cart data for completed purchases
959  // on your website. If the ad that was interacted with before the purchase has
960  // an associated product (see Shopping Ads) then this product is considered
961  // the advertised product. Any product included in the order the customer
962  // places is a sold product. If these products don't match then this is
963  // considered cross-sell. Cross-sell units sold is the total number of
964  // cross-sold products from all orders attributed to your ads.
965  // Example: Someone clicked on a Shopping ad for a hat then bought the same
966  // hat, a shirt and a jacket. The cross-sell units sold in this order is 2.
967  // This metric is only available if you report conversions with cart data.
968  optional double cross_sell_units_sold = 307;
969
970  // Lead cost of goods sold (COGS) is the total cost of products sold as a
971  // result of advertising the same product.
972  // How it works: You report conversions with cart data for completed purchases
973  // on your website. If the ad that was interacted with has an associated
974  // product (see Shopping Ads) then this product is considered the advertised
975  // product. Any product included in the order the customer places is a sold
976  // product. If the advertised and sold products match, then the cost of these
977  // goods is counted under lead cost of goods sold.
978  // Example: Someone clicked on a Shopping ad for a hat then bought the same
979  // hat and a shirt. The hat has a cost of goods sold value of $3, the shirt
980  // has a cost of goods sold value of $5. The lead cost of goods sold for this
981  // order is $3.
982  // This metric is only available if you report conversions with cart data.
983  optional int64 lead_cost_of_goods_sold_micros = 308;
984
985  // Lead gross profit is the profit you made from products sold as a result of
986  // advertising the same product, minus cost of goods sold (COGS).
987  // How it works: You report conversions with cart data for completed purchases
988  // on your website. If the ad that was interacted with before the purchase has
989  // an associated product (see Shopping Ads) then this product is considered
990  // the advertised product. Any product included in the order the customer
991  // places is a sold product. If the advertised and sold products match, then
992  // the revenue you made from these sales minus the cost of goods sold is your
993  // lead gross profit.
994  // Example: Someone clicked on a Shopping ad for a hat then bought the same
995  // hat and a shirt. The hat is priced $10 and has a cost of goods sold value
996  // of $3. The lead gross profit of this order is $7 = $10 - $3.
997  // This metric is only available if you report conversions with cart data.
998  optional int64 lead_gross_profit_micros = 309;
999
1000  // Lead revenue is the total amount you made from products sold as a result of
1001  // advertising the same product.
1002  // How it works: You report conversions with cart data for completed purchases
1003  // on your website. If the ad that was interacted with before the purchase has
1004  // an associated product (see Shopping Ads) then this product is considered
1005  // the advertised product. Any product included in the order the customer
1006  // places is a sold product. If the advertised and sold products match, then
1007  // the total value you made from the sales of these products is shown under
1008  // lead revenue.
1009  // Example: Someone clicked on a Shopping ad for a hat then bought the same
1010  // hat and a shirt. The hat is priced $10 and the shirt is priced $20. The
1011  // lead revenue of this order is $10.
1012  // This metric is only available if you report conversions with cart data.
1013  optional int64 lead_revenue_micros = 310;
1014
1015  // Lead units sold is the total number of products sold as a result of
1016  // advertising the same product.
1017  // How it works: You report conversions with cart data for completed purchases
1018  // on your website. If the ad that was interacted with before the purchase has
1019  // an associated product (see Shopping Ads) then this product is considered
1020  // the advertised product. Any product included in the order the customer
1021  // places is a sold product. If the advertised and sold products match, then
1022  // the total number of these products sold is shown under lead units sold.
1023  // Example: Someone clicked on a Shopping ad for a hat then bought the same
1024  // hat, a shirt and a jacket. The lead units sold in this order is 1.
1025  // This metric is only available if you report conversions with cart data.
1026  optional double lead_units_sold = 311;
1027
1028  // The number of unique users who saw your ad during the requested time
1029  // period. This metric cannot be aggregated, and can only be requested for
1030  // date ranges of 92 days or less. This metric is available for following
1031  // campaign types - Display, Video, Discovery and App.
1032  optional int64 unique_users = 319;
1033
1034  // The average number of times a unique user saw your ad during the requested
1035  // time period. This metric cannot be aggregated, and can only be requested
1036  // for date ranges of 92 days or less. This metric is available for following
1037  // campaign types - Display, Video, Discovery and App.
1038  optional double average_impression_frequency_per_user = 320;
1039}
1040
1041// Search volume range.
1042// Actual search volume falls within this range.
1043message SearchVolumeRange {
1044  // Lower bound of search volume.
1045  optional int64 min = 1;
1046
1047  // Upper bound of search volume.
1048  optional int64 max = 2;
1049}
1050