google.ads.googleads.v23.common.Metrics */ class Metrics extends \Google\Protobuf\Internal\Message { /** * Search absolute top impression share is the percentage of your Search ad * impressions that are shown in the most prominent Search position. * * Generated from protobuf field optional double absolute_top_impression_percentage = 183; */ protected $absolute_top_impression_percentage = null; /** * Average cost of viewable impressions (`active_view_impressions`). * * Generated from protobuf field optional double active_view_cpm = 184; */ protected $active_view_cpm = null; /** * Active view measurable clicks divided by active view viewable impressions. * This metric is reported only for the Display Network. * * Generated from protobuf field optional double active_view_ctr = 185; */ protected $active_view_ctr = null; /** * A measurement of how often your ad has become viewable on a Display * Network site. * * Generated from protobuf field optional int64 active_view_impressions = 186; */ protected $active_view_impressions = null; /** * The ratio of impressions that could be measured by Active View over the * number of served impressions. * * Generated from protobuf field optional double active_view_measurability = 187; */ protected $active_view_measurability = null; /** * The cost of the impressions you received that were measurable by Active * View. * * Generated from protobuf field optional int64 active_view_measurable_cost_micros = 188; */ protected $active_view_measurable_cost_micros = null; /** * The number of times your ads are appearing on placements in positions * where they can be seen. * * Generated from protobuf field optional int64 active_view_measurable_impressions = 189; */ protected $active_view_measurable_impressions = null; /** * The percentage of time when your ad appeared on an Active View enabled site * (measurable impressions) and was viewable (viewable impressions). * * Generated from protobuf field optional double active_view_viewability = 190; */ protected $active_view_viewability = null; /** * All conversions from interactions (as oppose to view through conversions) * divided by the number of ad interactions. * * Generated from protobuf field optional double all_conversions_from_interactions_rate = 191; */ protected $all_conversions_from_interactions_rate = null; /** * The value of all conversions. * * Generated from protobuf field optional double all_conversions_value = 192; */ protected $all_conversions_value = null; /** * 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. * * Generated from protobuf field optional double all_conversions_value_by_conversion_date = 240; */ protected $all_conversions_value_by_conversion_date = null; /** * 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. * * Generated from protobuf field optional double all_new_customer_lifetime_value = 294; */ protected $all_new_customer_lifetime_value = null; /** * The total number of conversions. This includes all conversions regardless * of the value of include_in_conversions_metric. * * Generated from protobuf field optional double all_conversions = 193; */ protected $all_conversions = null; /** * 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. * * Generated from protobuf field optional double all_conversions_by_conversion_date = 241; */ protected $all_conversions_by_conversion_date = null; /** * The value of all conversions divided by the total cost of ad interactions * (such as clicks for text ads or views for video ads). * * Generated from protobuf field optional double all_conversions_value_per_cost = 194; */ protected $all_conversions_value_per_cost = null; /** * The number of times people clicked the "Call" button to call a business * 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. * * Generated from protobuf field optional double all_conversions_from_click_to_call = 195; */ protected $all_conversions_from_click_to_call = null; /** * The number of times people clicked a "Get directions" button to navigate to * a business after clicking an ad. * This metric applies to feed items only. * * Generated from protobuf field optional double all_conversions_from_directions = 196; */ protected $all_conversions_from_directions = null; /** * The value of all conversions from interactions divided by the total number * of interactions. * * Generated from protobuf field optional double all_conversions_from_interactions_value_per_interaction = 197; */ protected $all_conversions_from_interactions_value_per_interaction = null; /** * The number of times people clicked a link to view a business's menu after * clicking an ad. * This metric applies to feed items only. * * Generated from protobuf field optional double all_conversions_from_menu = 198; */ protected $all_conversions_from_menu = null; /** * The number of times people placed an order at a business after clicking an * ad. * This metric applies to feed items only. * * Generated from protobuf field optional double all_conversions_from_order = 199; */ protected $all_conversions_from_order = null; /** * The number of other conversions (for example, posting a review or saving a * location for a business) that occurred after people clicked an ad. * This metric applies to feed items only. * * Generated from protobuf field optional double all_conversions_from_other_engagement = 200; */ protected $all_conversions_from_other_engagement = null; /** * Estimated number of times people visited a business after clicking an ad. * This metric applies to feed items only. * * Generated from protobuf field optional double all_conversions_from_store_visit = 201; */ protected $all_conversions_from_store_visit = null; /** * The number of times that people were taken to a business's URL after * clicking an ad. * This metric applies to feed items only. * * Generated from protobuf field optional double all_conversions_from_store_website = 202; */ protected $all_conversions_from_store_website = null; /** * This metric is part of the Auction Insights report, and tells how often * the ads of another participant showed in the most prominent position on the * search results page. * This percentage is computed only over the auctions that you appeared in * the page. * This metric is not publicly available. * * Generated from protobuf field optional double auction_insight_search_absolute_top_impression_percentage = 258; */ protected $auction_insight_search_absolute_top_impression_percentage = null; /** * 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. * * Generated from protobuf field optional double auction_insight_search_impression_share = 259; */ protected $auction_insight_search_impression_share = null; /** * 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. * * Generated from protobuf field optional double auction_insight_search_outranking_share = 260; */ protected $auction_insight_search_outranking_share = null; /** * 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. * * Generated from protobuf field optional double auction_insight_search_overlap_rate = 261; */ protected $auction_insight_search_overlap_rate = null; /** * 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. * * Generated from protobuf field optional double auction_insight_search_position_above_rate = 262; */ protected $auction_insight_search_position_above_rate = null; /** * This metric is part of the Auction Insights report, and tells how often * the ads of another participant showed adjacent to the top organic search * results. This percentage is computed only over the auctions that you * appeared in the page. * This metric is not publicly available. * * Generated from protobuf field optional double auction_insight_search_top_impression_percentage = 263; */ protected $auction_insight_search_top_impression_percentage = null; /** * The average amount you pay per interaction. This amount is the total cost * of your ads divided by the total number of interactions. * * Generated from protobuf field optional double average_cost = 203; */ protected $average_cost = null; /** * The total cost of all clicks divided by the total number of clicks * received. * * Generated from protobuf field optional double average_cpc = 204; */ protected $average_cpc = null; /** * 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. * * Generated from protobuf field optional double average_cpe = 205; */ protected $average_cpe = null; /** * Average cost-per-thousand impressions (CPM). * * Generated from protobuf field optional double average_cpm = 206; */ protected $average_cpm = null; /** * 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. * * Generated from protobuf field optional double trueview_average_cpv = 405; */ protected $trueview_average_cpv = null; /** * Average number of pages viewed per session. * * Generated from protobuf field optional double average_page_views = 208; */ protected $average_page_views = null; /** * Total duration of all sessions (in seconds) / number of sessions. Imported * from Google Analytics. * * Generated from protobuf field optional double average_time_on_site = 209; */ protected $average_time_on_site = null; /** * An indication of how other advertisers are bidding on similar products. * * Generated from protobuf field optional double benchmark_average_max_cpc = 210; */ protected $benchmark_average_max_cpc = null; /** * Number of app installs. * * Generated from protobuf field optional double biddable_app_install_conversions = 254; */ protected $biddable_app_install_conversions = null; /** * Number of in-app actions. * * Generated from protobuf field optional double biddable_app_post_install_conversions = 255; */ protected $biddable_app_post_install_conversions = null; /** * Participated in-app actions. The number of in app actions that come * directly or indirectly from the campaign. * * Generated from protobuf field optional double biddable_cohort_app_post_install_conversions = 378; */ protected $biddable_cohort_app_post_install_conversions = null; /** * 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. * * Generated from protobuf field optional double benchmark_ctr = 211; */ protected $benchmark_ctr = null; /** * Percentage of clicks where the user only visited a single page on your * site. Imported from Google Analytics. * * Generated from protobuf field optional double bounce_rate = 212; */ protected $bounce_rate = null; /** * The number of clicks. * * Generated from protobuf field optional int64 clicks = 131; */ protected $clicks = null; /** * 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. * * Generated from protobuf field optional int64 combined_clicks = 156; */ protected $combined_clicks = null; /** * 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. * * Generated from protobuf field optional double combined_clicks_per_query = 157; */ protected $combined_clicks_per_query = null; /** * 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. * * Generated from protobuf field optional int64 combined_queries = 158; */ protected $combined_queries = null; /** * 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. * * Generated from protobuf field optional double content_budget_lost_impression_share = 159; */ protected $content_budget_lost_impression_share = null; /** * 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. * * Generated from protobuf field optional double content_impression_share = 160; */ protected $content_impression_share = null; /** * 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 (for example, 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. * * Generated from protobuf field optional string conversion_last_received_request_date_time = 161; */ protected $conversion_last_received_request_date_time = null; /** * The date of the most recent conversion for this conversion action. The date * is in the customer's time zone. * * Generated from protobuf field optional string conversion_last_conversion_date = 162; */ protected $conversion_last_conversion_date = null; /** * 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. * * Generated from protobuf field optional double content_rank_lost_impression_share = 163; */ protected $content_rank_lost_impression_share = null; /** * 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. * * Generated from protobuf field optional double conversions_from_interactions_rate = 164; */ protected $conversions_from_interactions_rate = null; /** * 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. * * Generated from protobuf field optional double conversions_value = 165; */ protected $conversions_value = null; /** * 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. * * Generated from protobuf field optional double conversions_value_by_conversion_date = 242; */ protected $conversions_value_by_conversion_date = null; /** * 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. * * Generated from protobuf field optional double new_customer_lifetime_value = 293; */ protected $new_customer_lifetime_value = null; /** * 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. * * Generated from protobuf field optional double conversions_value_per_cost = 166; */ protected $conversions_value_per_cost = null; /** * 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. * * Generated from protobuf field optional double conversions_from_interactions_value_per_interaction = 167; */ protected $conversions_from_interactions_value_per_interaction = null; /** * 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. * * Generated from protobuf field optional double conversions = 168; */ protected $conversions = null; /** * 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. * * Generated from protobuf field optional double conversions_by_conversion_date = 243; */ protected $conversions_by_conversion_date = null; /** * The sum of your cost-per-click (CPC) and cost-per-thousand impressions * (CPM) costs during this period. * * Generated from protobuf field optional int64 cost_micros = 169; */ protected $cost_micros = null; /** * The cost of ad interactions divided by all conversions. * * Generated from protobuf field optional double cost_per_all_conversions = 170; */ protected $cost_per_all_conversions = null; /** * 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. * * Generated from protobuf field optional double cost_per_conversion = 171; */ protected $cost_per_conversion = null; /** * 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. * * Generated from protobuf field optional double cost_per_current_model_attributed_conversion = 172; */ protected $cost_per_current_model_attributed_conversion = null; /** * 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. * * Generated from protobuf field optional double cross_device_conversions = 173; */ protected $cross_device_conversions = null; /** * The number of cross-device conversions by conversion date. * Details for the by_conversion_date columns are available at * https://support.google.com/google-ads/answer/9549009. * * Generated from protobuf field optional double cross_device_conversions_by_conversion_date = 372; */ protected $cross_device_conversions_by_conversion_date = null; /** * The sum of the value of cross-device conversions. * * Generated from protobuf field optional double cross_device_conversions_value = 253; */ protected $cross_device_conversions_value = null; /** * The sum of the value of cross-device conversions, in micros. * * Generated from protobuf field optional int64 cross_device_conversions_value_micros = 312; */ protected $cross_device_conversions_value_micros = null; /** * The sum of cross-device conversions value by conversion date. * Details for the by_conversion_date columns are available at * https://support.google.com/google-ads/answer/9549009. * * Generated from protobuf field optional double cross_device_conversions_value_by_conversion_date = 373; */ protected $cross_device_conversions_value_by_conversion_date = null; /** * The number of clicks your ad receives (Clicks) divided by the number * of times your ad is shown (Impressions). * * Generated from protobuf field optional double ctr = 174; */ protected $ctr = null; /** * 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. * * Generated from protobuf field optional double current_model_attributed_conversions = 175; */ protected $current_model_attributed_conversions = null; /** * 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. * * Generated from protobuf field optional double current_model_attributed_conversions_from_interactions_rate = 176; */ protected $current_model_attributed_conversions_from_interactions_rate = null; /** * 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. * * Generated from protobuf field optional double current_model_attributed_conversions_from_interactions_value_per_interaction = 177; */ protected $current_model_attributed_conversions_from_interactions_value_per_interaction = null; /** * 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. * * Generated from protobuf field optional double current_model_attributed_conversions_value = 178; */ protected $current_model_attributed_conversions_value = null; /** * 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. * * Generated from protobuf field optional double current_model_attributed_conversions_value_per_cost = 179; */ protected $current_model_attributed_conversions_value_per_cost = null; /** * 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. * * Generated from protobuf field optional double engagement_rate = 180; */ protected $engagement_rate = null; /** * 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. * * Generated from protobuf field optional int64 engagements = 181; */ protected $engagements = null; /** * Average lead value based on clicks. * * Generated from protobuf field optional double hotel_average_lead_value_micros = 213; */ protected $hotel_average_lead_value_micros = null; /** * Commission bid rate in micros. A 20% commission is represented as * 200,000. * * Generated from protobuf field optional int64 hotel_commission_rate_micros = 256; */ protected $hotel_commission_rate_micros = null; /** * Expected commission cost. The result of multiplying the commission value * times the hotel_commission_rate in advertiser currency. * * Generated from protobuf field optional double hotel_expected_commission_cost = 257; */ protected $hotel_expected_commission_cost = null; /** * The average price difference between the price offered by reporting hotel * advertiser and the cheapest price offered by the competing advertiser. * * Generated from protobuf field optional double hotel_price_difference_percentage = 214; */ protected $hotel_price_difference_percentage = null; /** * The number of impressions that hotel partners could have had given their * feed performance. * * Generated from protobuf field optional int64 hotel_eligible_impressions = 215; */ protected $hotel_eligible_impressions = null; /** * The creative historical quality score. * * Generated from protobuf field .google.ads.googleads.v23.enums.QualityScoreBucketEnum.QualityScoreBucket historical_creative_quality_score = 80; */ protected $historical_creative_quality_score = 0; /** * The quality of historical landing page experience. * * Generated from protobuf field .google.ads.googleads.v23.enums.QualityScoreBucketEnum.QualityScoreBucket historical_landing_page_quality_score = 81; */ protected $historical_landing_page_quality_score = 0; /** * The historical quality score. * * Generated from protobuf field optional int64 historical_quality_score = 216; */ protected $historical_quality_score = null; /** * The historical search predicted click through rate (CTR). * * Generated from protobuf field .google.ads.googleads.v23.enums.QualityScoreBucketEnum.QualityScoreBucket historical_search_predicted_ctr = 83; */ protected $historical_search_predicted_ctr = 0; /** * The number of times the ad was forwarded to someone else as a message. * * Generated from protobuf field optional int64 gmail_forwards = 217; */ protected $gmail_forwards = null; /** * The number of times someone has saved your Gmail ad to their inbox as a * message. * * Generated from protobuf field optional int64 gmail_saves = 218; */ protected $gmail_saves = null; /** * The number of clicks to the landing page on the expanded state of Gmail * ads. * * Generated from protobuf field optional int64 gmail_secondary_clicks = 219; */ protected $gmail_secondary_clicks = null; /** * The number of times a business's location-based ad was shown. * This metric applies to feed items only. * * Generated from protobuf field optional int64 impressions_from_store_reach = 220; */ protected $impressions_from_store_reach = null; /** * Count of how often your ad has appeared on a search results page or * website on the Google Network. * * Generated from protobuf field optional int64 impressions = 221; */ protected $impressions = null; /** * 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. * * Generated from protobuf field optional double interaction_rate = 222; */ protected $interaction_rate = null; /** * 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. * * Generated from protobuf field optional int64 interactions = 223; */ protected $interactions = null; /** * The types of payable and free interactions. * * Generated from protobuf field repeated .google.ads.googleads.v23.enums.InteractionEventTypeEnum.InteractionEventType interaction_event_types = 100; */ private $interaction_event_types; /** * The percentage of clicks filtered out of your total number of clicks * (filtered + non-filtered clicks) during the reporting period. * * Generated from protobuf field optional double invalid_click_rate = 224; */ protected $invalid_click_rate = null; /** * Number of clicks Google considers illegitimate and doesn't charge you for. * * Generated from protobuf field optional int64 invalid_clicks = 225; */ protected $invalid_clicks = null; /** * The percentage of clicks that have been filtered out of your total number * of clicks (filtered + non-filtered clicks) due to being general invalid * clicks. These are clicks Google considers illegitimate that are detected * through routine means of filtration (that is, known invalid data-center * traffic, bots and spiders or other crawlers, irregular patterns, etc). * You're not charged for them, and they don't affect your account statistics. * See the help page at * https://support.google.com/campaignmanager/answer/6076504 for * details. * * Generated from protobuf field optional double general_invalid_click_rate = 370; */ protected $general_invalid_click_rate = null; /** * Number of general invalid clicks. These are a subset of your invalid clicks * that are detected through routine means of filtration (such as known * invalid data-center traffic, bots and spiders or other crawlers, irregular * patterns, etc.). You're not charged for them, and they don't affect your * account statistics. See the help page at * https://support.google.com/campaignmanager/answer/6076504 for * details. * * Generated from protobuf field optional int64 general_invalid_clicks = 371; */ protected $general_invalid_clicks = null; /** * Number of message chats initiated for Click To Message impressions that * were message tracking eligible. * * Generated from protobuf field optional int64 message_chats = 226; */ protected $message_chats = null; /** * Number of Click To Message impressions that were message tracking eligible. * * Generated from protobuf field optional int64 message_impressions = 227; */ protected $message_impressions = null; /** * 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. * * Generated from protobuf field optional double message_chat_rate = 228; */ protected $message_chat_rate = null; /** * The percentage of mobile clicks that go to a mobile-friendly page. * * Generated from protobuf field optional double mobile_friendly_clicks_percentage = 229; */ protected $mobile_friendly_clicks_percentage = null; /** * Total optimization score uplift of all recommendations. * * Generated from protobuf field optional double optimization_score_uplift = 247; */ protected $optimization_score_uplift = null; /** * 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. * * Generated from protobuf field optional string optimization_score_url = 248; */ protected $optimization_score_url = null; /** * 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. * * Generated from protobuf field optional int64 organic_clicks = 230; */ protected $organic_clicks = null; /** * 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. * * Generated from protobuf field optional double organic_clicks_per_query = 231; */ protected $organic_clicks_per_query = null; /** * 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. * * Generated from protobuf field optional int64 organic_impressions = 232; */ protected $organic_impressions = null; /** * 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. * * Generated from protobuf field optional double organic_impressions_per_query = 233; */ protected $organic_impressions_per_query = null; /** * 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. * * Generated from protobuf field optional int64 organic_queries = 234; */ protected $organic_queries = null; /** * Percentage of first-time sessions (from people who had never visited your * site before). Imported from Google Analytics. * * Generated from protobuf field optional double percent_new_visitors = 235; */ protected $percent_new_visitors = null; /** * Number of offline phone calls. * * Generated from protobuf field optional int64 phone_calls = 236; */ protected $phone_calls = null; /** * Number of offline phone impressions. * * Generated from protobuf field optional int64 phone_impressions = 237; */ protected $phone_impressions = null; /** * Number of phone calls received (phone_calls) divided by the number of * times your phone number is shown (phone_impressions). * * Generated from protobuf field optional double phone_through_rate = 238; */ protected $phone_through_rate = null; /** * 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. * * Generated from protobuf field optional double relative_ctr = 239; */ protected $relative_ctr = null; /** * 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. * * Generated from protobuf field optional double search_absolute_top_impression_share = 136; */ protected $search_absolute_top_impression_share = null; /** * The number estimating how often your ad wasn't the very first ad among the * top ads in the search results due to a low budget. Note: Search * budget lost absolute top impression share is reported in the range of 0 to * 0.9. Any value above 0.9 is reported as 0.9001. * * Generated from protobuf field optional double search_budget_lost_absolute_top_impression_share = 137; */ protected $search_budget_lost_absolute_top_impression_share = null; /** * 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. * * Generated from protobuf field optional double search_budget_lost_impression_share = 138; */ protected $search_budget_lost_impression_share = null; /** * The number estimating how often your ad didn't show adjacent to the top * organic search results due to a low budget. Note: Search * budget lost top impression share is reported in the range of 0 to 0.9. Any * value above 0.9 is reported as 0.9001. * * Generated from protobuf field optional double search_budget_lost_top_impression_share = 139; */ protected $search_budget_lost_top_impression_share = null; /** * 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. * * Generated from protobuf field optional double search_click_share = 140; */ protected $search_click_share = null; /** * 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. * * Generated from protobuf field optional double search_exact_match_impression_share = 141; */ protected $search_exact_match_impression_share = null; /** * 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. * * Generated from protobuf field optional double search_impression_share = 142; */ protected $search_impression_share = null; /** * The number estimating how often your ad wasn't the very first ad among the * top ads in the search results due to poor Ad Rank. * Note: Search rank lost absolute top impression share is reported in the * range of 0 to 0.9. Any value above 0.9 is reported as 0.9001. * * Generated from protobuf field optional double search_rank_lost_absolute_top_impression_share = 143; */ protected $search_rank_lost_absolute_top_impression_share = null; /** * 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. * * Generated from protobuf field optional double search_rank_lost_impression_share = 144; */ protected $search_rank_lost_impression_share = null; /** * The number estimating how often your ad didn't show adjacent to the top * organic search results due to poor Ad Rank. * Note: Search rank lost top impression share is reported in the range of 0 * to 0.9. Any value above 0.9 is reported as 0.9001. * * Generated from protobuf field optional double search_rank_lost_top_impression_share = 145; */ protected $search_rank_lost_top_impression_share = null; /** * The impressions you've received among the top ads compared to the estimated * number of impressions you were eligible to receive among the top ads. * Note: Search top impression share is reported in the range of 0.1 to 1. Any * value below 0.1 is reported as 0.0999. * Top ads are generally above the top organic results, although they may show * below the top organic results on certain queries. * * Generated from protobuf field optional double search_top_impression_share = 146; */ protected $search_top_impression_share = null; /** * Search volume range for a search term insight category. * * Generated from protobuf field optional .google.ads.googleads.v23.common.SearchVolumeRange search_volume = 295; */ protected $search_volume = null; /** * 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. * * Generated from protobuf field optional int64 speed_score = 147; */ protected $speed_score = null; /** * The average Target CPA, or unset if not available (for example, for * campaigns that had traffic from portfolio bidding strategies or non-tCPA). * * Generated from protobuf field optional int64 average_target_cpa_micros = 290; */ protected $average_target_cpa_micros = null; /** * The average Target ROAS, or unset if not available (for example, for * campaigns that had traffic from portfolio bidding strategies or non-tROAS). * * Generated from protobuf field optional double average_target_roas = 250; */ protected $average_target_roas = null; /** * The percent of your ad impressions that are shown adjacent to the top * organic search results. * * Generated from protobuf field optional double top_impression_percentage = 148; */ protected $top_impression_percentage = null; /** * The percentage of ad clicks to Accelerated Mobile Pages (AMP) landing pages * that reach a valid AMP page. * * Generated from protobuf field optional double valid_accelerated_mobile_pages_clicks_percentage = 149; */ protected $valid_accelerated_mobile_pages_clicks_percentage = null; /** * The value of all conversions divided by the number of all conversions. * * Generated from protobuf field optional double value_per_all_conversions = 150; */ protected $value_per_all_conversions = null; /** * 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. * * Generated from protobuf field optional double value_per_all_conversions_by_conversion_date = 244; */ protected $value_per_all_conversions_by_conversion_date = null; /** * 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. * * Generated from protobuf field optional double value_per_conversion = 151; */ protected $value_per_conversion = null; /** * 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. * * Generated from protobuf field optional double value_per_conversions_by_conversion_date = 245; */ protected $value_per_conversions_by_conversion_date = null; /** * 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. * * Generated from protobuf field optional double value_per_current_model_attributed_conversion = 152; */ protected $value_per_current_model_attributed_conversion = null; /** * Percentage of impressions where the viewer watched all of your video. * * Generated from protobuf field optional double video_quartile_p100_rate = 132; */ protected $video_quartile_p100_rate = null; /** * Percentage of impressions where the viewer watched 25% of your video. * * Generated from protobuf field optional double video_quartile_p25_rate = 133; */ protected $video_quartile_p25_rate = null; /** * Percentage of impressions where the viewer watched 50% of your video. * * Generated from protobuf field optional double video_quartile_p50_rate = 134; */ protected $video_quartile_p50_rate = null; /** * Percentage of impressions where the viewer watched 75% of your video. * * Generated from protobuf field optional double video_quartile_p75_rate = 135; */ protected $video_quartile_p75_rate = null; /** * The number of TrueView views your video ad receives divided by its number * of impressions, including thumbnail impressions for TrueView in-display * ads. * * Generated from protobuf field optional double video_trueview_view_rate = 406; */ protected $video_trueview_view_rate = null; /** * The number of TrueView views your video ads received. * * Generated from protobuf field optional int64 video_trueview_views = 407; */ protected $video_trueview_views = null; /** * The total number of view-through conversions. * These happen when a customer sees an image or rich media ad, then later * completes a conversion on your site without interacting with (for example, * clicking on) another ad. * * Generated from protobuf field optional int64 view_through_conversions = 155; */ protected $view_through_conversions = null; /** * The number of iOS Store Kit Ad Network conversions. * * Generated from protobuf field int64 sk_ad_network_installs = 246; */ protected $sk_ad_network_installs = 0; /** * The total number of iOS Store Kit Ad Network conversions. * * Generated from protobuf field int64 sk_ad_network_total_conversions = 292; */ protected $sk_ad_network_total_conversions = 0; /** * Clicks from properties not owned by the publisher for which the traffic * the publisher has paid for or acquired through incentivized activity * * Generated from protobuf field int64 publisher_purchased_clicks = 264; */ protected $publisher_purchased_clicks = 0; /** * Clicks from properties for which the traffic the publisher has not paid * for or acquired through incentivized activity * * Generated from protobuf field int64 publisher_organic_clicks = 265; */ protected $publisher_organic_clicks = 0; /** * Clicks from traffic which is not identified as "Publisher Purchased" or * "Publisher Organic" * * Generated from protobuf field int64 publisher_unknown_clicks = 266; */ protected $publisher_unknown_clicks = 0; /** * 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. * * Generated from protobuf field optional double all_conversions_from_location_asset_click_to_call = 267; */ protected $all_conversions_from_location_asset_click_to_call = null; /** * 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. * * Generated from protobuf field optional double all_conversions_from_location_asset_directions = 268; */ protected $all_conversions_from_location_asset_directions = null; /** * 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. * * Generated from protobuf field optional double all_conversions_from_location_asset_menu = 269; */ protected $all_conversions_from_location_asset_menu = null; /** * Number of order clicks on any location surface after a chargeable ad event * (click or impression). This measure is coming from Asset based * location. * * Generated from protobuf field optional double all_conversions_from_location_asset_order = 270; */ protected $all_conversions_from_location_asset_order = null; /** * 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. * * Generated from protobuf field optional double all_conversions_from_location_asset_other_engagement = 271; */ protected $all_conversions_from_location_asset_other_engagement = null; /** * Estimated number of visits to the business after a chargeable * ad event (click or impression). This measure is coming from Asset * based location. * * Generated from protobuf field optional double all_conversions_from_location_asset_store_visits = 272; */ protected $all_conversions_from_location_asset_store_visits = null; /** * 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. * * Generated from protobuf field optional double all_conversions_from_location_asset_website = 273; */ protected $all_conversions_from_location_asset_website = null; /** * Number of impressions in which the business location was shown or the * location was used for targeting. This measure is coming from Asset based * location. * * Generated from protobuf field optional int64 eligible_impressions_from_location_asset_store_reach = 274; */ protected $eligible_impressions_from_location_asset_store_reach = null; /** * Number of call button clicks on any location surface after an impression. * This measure is coming from Asset based location. * * Generated from protobuf field optional double view_through_conversions_from_location_asset_click_to_call = 275; */ protected $view_through_conversions_from_location_asset_click_to_call = null; /** * Number of driving directions clicks on any location surface after an * impression. This measure is coming from Asset based location. * * Generated from protobuf field optional double view_through_conversions_from_location_asset_directions = 276; */ protected $view_through_conversions_from_location_asset_directions = null; /** * Number of menu link clicks on any location surface after an impression. * This measure is coming from Asset based location. * * Generated from protobuf field optional double view_through_conversions_from_location_asset_menu = 277; */ protected $view_through_conversions_from_location_asset_menu = null; /** * Number of order clicks on any location surface after an impression. This * measure is coming from Asset based location. * * Generated from protobuf field optional double view_through_conversions_from_location_asset_order = 278; */ protected $view_through_conversions_from_location_asset_order = null; /** * Number of other types of local action clicks on any location surface after * an impression. This measure is coming from Asset based location. * * Generated from protobuf field optional double view_through_conversions_from_location_asset_other_engagement = 279; */ protected $view_through_conversions_from_location_asset_other_engagement = null; /** * Estimated number of visits to the business after an impression. * This measure is coming from Asset based location. * * Generated from protobuf field optional double view_through_conversions_from_location_asset_store_visits = 280; */ protected $view_through_conversions_from_location_asset_store_visits = null; /** * Number of website URL clicks on any location surface after an impression. * This measure is coming from Asset based location. * * Generated from protobuf field optional double view_through_conversions_from_location_asset_website = 281; */ protected $view_through_conversions_from_location_asset_website = null; /** * 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. * * Generated from protobuf field optional double orders = 296; */ protected $orders = null; /** * 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. * * Generated from protobuf field optional int64 average_order_value_micros = 297; */ protected $average_order_value_micros = null; /** * 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. * * Generated from protobuf field optional double average_cart_size = 298; */ protected $average_cart_size = null; /** * 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. * * Generated from protobuf field optional int64 cost_of_goods_sold_micros = 299; */ protected $cost_of_goods_sold_micros = null; /** * 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. * * Generated from protobuf field optional int64 gross_profit_micros = 300; */ protected $gross_profit_micros = null; /** * 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. * * Generated from protobuf field optional double gross_profit_margin = 301; */ protected $gross_profit_margin = null; /** * 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. * * Generated from protobuf field optional int64 revenue_micros = 302; */ protected $revenue_micros = null; /** * 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. * * Generated from protobuf field optional double units_sold = 303; */ protected $units_sold = null; /** * 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. * * Generated from protobuf field optional int64 cross_sell_cost_of_goods_sold_micros = 304; */ protected $cross_sell_cost_of_goods_sold_micros = null; /** * 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. * * Generated from protobuf field optional int64 cross_sell_gross_profit_micros = 305; */ protected $cross_sell_gross_profit_micros = null; /** * 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. * * Generated from protobuf field optional int64 cross_sell_revenue_micros = 306; */ protected $cross_sell_revenue_micros = null; /** * 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. * * Generated from protobuf field optional double cross_sell_units_sold = 307; */ protected $cross_sell_units_sold = null; /** * 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. * * Generated from protobuf field optional int64 lead_cost_of_goods_sold_micros = 308; */ protected $lead_cost_of_goods_sold_micros = null; /** * 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. * * Generated from protobuf field optional int64 lead_gross_profit_micros = 309; */ protected $lead_gross_profit_micros = null; /** * 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. * * Generated from protobuf field optional int64 lead_revenue_micros = 310; */ protected $lead_revenue_micros = null; /** * 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. * * Generated from protobuf field optional double lead_units_sold = 311; */ protected $lead_units_sold = null; /** * 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. * * Generated from protobuf field optional int64 unique_users = 319; */ protected $unique_users = null; /** * 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. * * Generated from protobuf field optional double average_impression_frequency_per_user = 320; */ protected $average_impression_frequency_per_user = null; /** * Number of linked resources in which the asset is used. * This metric can only be selected with ChannelAggregateAssetView and * CampaignAggregateAssetView. * * Generated from protobuf field optional int64 linked_entities_count = 341; */ protected $linked_entities_count = null; /** * A list of up to 20 sample linked resources in which the asset is used. * This metric can only be selected with ChannelAggregateAssetView and * CampaignAggregateAssetView. * * Generated from protobuf field repeated string linked_sample_entities = 342; */ private $linked_sample_entities; /** * Number of total usages in which the asset is pinned. * This metric can only be selected with ChannelAggregateAssetView and * CampaignAggregateAssetView. * This metric is only supported in Search channel. * * Generated from protobuf field optional int64 asset_pinned_total_count = 348; */ protected $asset_pinned_total_count = null; /** * Number of entities in which the asset is pinned to headline 1. * This metric can only be selected with ChannelAggregateAssetView and * CampaignAggregateAssetView. * This metric is only supported in Search channel. * * Generated from protobuf field optional int64 asset_pinned_as_headline_position_one_count = 349; */ protected $asset_pinned_as_headline_position_one_count = null; /** * Number of entities in which the asset is pinned to headline 2. * This metric can only be selected with ChannelAggregateAssetView and * CampaignAggregateAssetView. * This metric is only supported in Search channel. * * Generated from protobuf field optional int64 asset_pinned_as_headline_position_two_count = 350; */ protected $asset_pinned_as_headline_position_two_count = null; /** * Number of entities in which the asset is pinned to headline 3. * This metric can only be selected with ChannelAggregateAssetView and * CampaignAggregateAssetView. * This metric is only supported in Search channel. * * Generated from protobuf field optional int64 asset_pinned_as_headline_position_three_count = 351; */ protected $asset_pinned_as_headline_position_three_count = null; /** * Number of entities in which the asset is pinned to description 1. * This metric can only be selected with ChannelAggregateAssetView and * CampaignAggregateAssetView. * This metric is only supported in Search channel. * * Generated from protobuf field optional int64 asset_pinned_as_description_position_one_count = 352; */ protected $asset_pinned_as_description_position_one_count = null; /** * Number of entities in which the asset is pinned to description 2. * This metric can only be selected with ChannelAggregateAssetView and * CampaignAggregateAssetView. * This metric is only supported in Search channel. * * Generated from protobuf field optional int64 asset_pinned_as_description_position_two_count = 353; */ protected $asset_pinned_as_description_position_two_count = null; /** * The amount of business visits attributed by the last click model. * * Generated from protobuf field optional double store_visits_last_click_model_attributed_conversions = 365; */ protected $store_visits_last_click_model_attributed_conversions = null; /** * The purchase conversion stats for the unified goals results. * * Generated from protobuf field optional double results_conversions_purchase = 366; */ protected $results_conversions_purchase = null; /** * The number of TrueView views divided by number of impressions that can * potentially lead to TrueView views for in-feed formats. * * Generated from protobuf field optional double video_trueview_view_rate_in_feed = 408; */ protected $video_trueview_view_rate_in_feed = null; /** * The number of TrueView views divided by number of impressions that can * potentially lead to TrueView views for in-stream formats. * * Generated from protobuf field optional double video_trueview_view_rate_in_stream = 409; */ protected $video_trueview_view_rate_in_stream = null; /** * The number of TrueView views divided by number of impressions that can * potentially lead to TrueView views for Shorts ads. * * Generated from protobuf field optional double video_trueview_view_rate_shorts = 410; */ protected $video_trueview_view_rate_shorts = null; /** * All co-viewed impressions represent the total number of people who saw your * ad. This includes people who are signed into their Google Account, as well * as other people who are watching the same ad on a connected TV. This metric * is only available for the Campaign resource with adjusted_age_range and * adjusted_gender segments. These segmentations are mandatory to get the * all coviewed impressions. * * Generated from protobuf field optional int64 coviewed_impressions = 380; */ protected $coviewed_impressions = null; /** * Primary impression is counted each time your ad is served. This metric is * only available for the Campaign resource with adjusted_age_range and * adjusted_gender segments. These segmentations are mandatory to get the * primary impressions. * * Generated from protobuf field optional int64 primary_impressions = 381; */ protected $primary_impressions = null; /** * Platform comparable 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 for which include_in_conversions_metric * attribute is set to true. If you use conversion-based bidding, your bid * strategies will optimize for these conversions. * * Generated from protobuf field optional double platform_comparable_conversions_from_interactions_rate = 382; */ protected $platform_comparable_conversions_from_interactions_rate = null; /** * The number of platform comparable conversions. This only includes * conversion actions for which include_in_conversions_metric attribute is set * to true. If you use conversion-based bidding, your bid strategies will * optimize for these conversions. * * Generated from protobuf field optional double platform_comparable_conversions = 383; */ protected $platform_comparable_conversions = null; /** * The value of platform comparable 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. * * Generated from protobuf field optional double platform_comparable_conversions_value = 384; */ protected $platform_comparable_conversions_value = null; /** * The value of conversions divided by the cost of ad interactions. This only * includes conversion actions for which include_in_conversions_metric * attribute is set to true. If you use conversion-based bidding, your bid * strategies will optimize for these conversions. * * Generated from protobuf field optional double platform_comparable_conversions_value_per_cost = 385; */ protected $platform_comparable_conversions_value_per_cost = null; /** * The number of platform comparable conversions. When this metric is * segmented by date, the values in the date segment represent the conversion * date. This only includes conversion actions for which * include_in_conversions_metric attribute is set to true. If you use * conversion-based bidding, your bid strategies will optimize for these * conversions. * * Generated from protobuf field optional double platform_comparable_conversions_by_conversion_date = 386; */ protected $platform_comparable_conversions_by_conversion_date = null; /** * The value of platform comparable conversions. When this metric is segmented * by date, the values in the date segment represent the conversion date. This * only includes conversion actions for which include_in_conversions_metric * attribute is set to true. If you use conversion-based bidding, your bid * strategies will optimize for these conversions. * * Generated from protobuf field optional double platform_comparable_conversions_value_by_conversion_date = 387; */ protected $platform_comparable_conversions_value_by_conversion_date = null; /** * The value of platform comparable conversions from interactions divided by * the number of ad interactions. This only includes conversion actions for * which include_in_conversions_metric attribute is set to true. If you use * conversion-based bidding, your bid strategies will optimize for these * conversions. * * Generated from protobuf field optional double platform_comparable_conversions_from_interactions_value_per_interaction = 388; */ protected $platform_comparable_conversions_from_interactions_value_per_interaction = null; /** * The cost of ad interactions divided by the number of platform comparable * conversions. This only includes conversion actions for which * include_in_conversions_metric attribute is set to true. If you use * conversion-based bidding, your bid strategies will optimize for these * conversions. * * Generated from protobuf field optional double cost_per_platform_comparable_conversion = 389; */ protected $cost_per_platform_comparable_conversion = null; /** * The value of platform comparable conversions divided by the number of * platform comparable conversions. This only includes conversion actions for * which include_in_conversions_metric attribute is set to true. If you use * conversion-based bidding, your bid strategies will optimize for these * conversions. * * Generated from protobuf field optional double value_per_platform_comparable_conversion = 390; */ protected $value_per_platform_comparable_conversion = null; /** * The value of platform comparable conversions divided by the number of * platform comparable conversions. When this metric is segmented by date, the * values in the date segment represent the conversion date. This only * includes conversion actions for which include_in_conversions_metric * attribute is set to true. If you use conversion-based bidding, your bid * strategies will optimize for these conversions. * * Generated from protobuf field optional double value_per_platform_comparable_conversions_by_conversion_date = 391; */ protected $value_per_platform_comparable_conversions_by_conversion_date = null; /** * The cost of the platform comparable conversion in the currency of the * authorized customer. * * Generated from protobuf field optional double cost_converted_currency_per_platform_comparable_conversion = 392; */ protected $cost_converted_currency_per_platform_comparable_conversion = null; /** * This metric counts the unique individuals who were shown your video ad two * or more times within the selected date range. This metric cannot be * aggregated, and can only be requested for date ranges of 31 days or less. * * Generated from protobuf field optional int64 unique_users_two_plus = 393; */ protected $unique_users_two_plus = null; /** * This metric counts the unique individuals who were shown your video ad * three or more times within the selected date range. This metric cannot be * aggregated, and can only be requested for date ranges of 31 days or less. * * Generated from protobuf field optional int64 unique_users_three_plus = 394; */ protected $unique_users_three_plus = null; /** * This metric counts the unique individuals who were shown your video ad four * or more times within the selected date range. This metric cannot be * aggregated, and can only be requested for date ranges of 31 days or less. * * Generated from protobuf field optional int64 unique_users_four_plus = 395; */ protected $unique_users_four_plus = null; /** * This metric counts the unique individuals who were shown your video ad five * or more times within the selected date range. This metric cannot be * aggregated, and can only be requested for date ranges of 31 days or less. * * Generated from protobuf field optional int64 unique_users_five_plus = 396; */ protected $unique_users_five_plus = null; /** * This metric counts the unique individuals who were shown your video ad ten * or more times within the selected date range. This metric cannot be * aggregated, and can only be requested for date ranges of 31 days or less. * * Generated from protobuf field optional int64 unique_users_ten_plus = 397; */ protected $unique_users_ten_plus = null; /** * The conversion value rule adjustment from biddable conversions in all * conversion categories. * * Generated from protobuf field optional double value_adjustment = 398; */ protected $value_adjustment = null; /** * The conversion value rule adjustment from all conversions in all conversion * categories. * * Generated from protobuf field optional double all_value_adjustment = 399; */ protected $all_value_adjustment = null; /** * Unique query intent cluster count for clicks. * * Generated from protobuf field optional int64 clicks_unique_query_clusters = 400; */ protected $clicks_unique_query_clusters = null; /** * Unique query intent cluster count for conversions. * * Generated from protobuf field optional int64 conversions_unique_query_clusters = 401; */ protected $conversions_unique_query_clusters = null; /** * Unique query intent cluster count for impressions. * * Generated from protobuf field optional int64 impressions_unique_query_clusters = 402; */ protected $impressions_unique_query_clusters = null; /** * Total watch time duration in milliseconds for video impressions that * started playing. For a small percentage of impressions, we may not be able * to measure the watch time accurately. In such cases, we adjust the total * time to account for any unmeasured time by applying the average watch time * of impressions that were measured. * * Generated from protobuf field optional int64 video_watch_time_duration_millis = 403; */ protected $video_watch_time_duration_millis = null; /** * Average video watch time duration in milliseconds for video impressions * that started playing. * * Generated from protobuf field optional int64 average_video_watch_time_duration_millis = 404; */ protected $average_video_watch_time_duration_millis = null; /** * This feature is available to allowlisted accounts only. * * Generated from protobuf field optional int64 svr = 411; */ protected $svr = null; /** * The number of impressions for which Active View could measure if the ad was * audible. * * Generated from protobuf field optional int64 active_view_audibility_measurable_impressions = 412; */ protected $active_view_audibility_measurable_impressions = null; /** * The number of impressions for which Active View could measure if the ad was * audible, divided by the total number of impressions with Active View audio * enabled. * * Generated from protobuf field optional double active_view_audibility_measurable_impressions_rate = 413; */ protected $active_view_audibility_measurable_impressions_rate = null; /** * The number of impressions for which Active View could measure audibility, * but that were filtered out by traffic quality filters, divided by the * total number of impressions measurable for audibility. * * Generated from protobuf field optional double active_view_audibility_invalid_measurable_impressions_rate = 414; */ protected $active_view_audibility_invalid_measurable_impressions_rate = null; /** * The number of impressions for which Active View could measure audibility, * but that were filtered out by traffic quality filters, divided by the total * number of impressions measurable for audibility. Only includes GIVT * (general invalid traffic) impressions. * * Generated from protobuf field optional double active_view_audibility_invalid_givt_measurable_impressions_rate = 415; */ protected $active_view_audibility_invalid_givt_measurable_impressions_rate = null; /** * The number of impressions that were audible (volume > 0%) at any point * during the ad playback. * * Generated from protobuf field optional int64 active_view_audible_impressions = 416; */ protected $active_view_audible_impressions = null; /** * The number of impressions that were audible (volume > 0%) at any point * during the ad playback, divided by the total number of impressions * measurable for audibility. * * Generated from protobuf field optional double active_view_audible_impressions_rate = 417; */ protected $active_view_audible_impressions_rate = null; /** * The number of impressions that were audible for at least 2 seconds * (cumulative). * * Generated from protobuf field optional int64 active_view_audible_two_seconds_impressions = 418; */ protected $active_view_audible_two_seconds_impressions = null; /** * The number of impressions that were audible for at least 2 seconds * (cumulative), divided by the total number of impressions measurable for * audibility. * * Generated from protobuf field optional double active_view_audible_two_seconds_impressions_rate = 419; */ protected $active_view_audible_two_seconds_impressions_rate = null; /** * The number of impressions that were audible for at least 30 seconds * (cumulative). * * Generated from protobuf field optional int64 active_view_audible_thirty_seconds_impressions = 420; */ protected $active_view_audible_thirty_seconds_impressions = null; /** * The number of impressions that were audible for at least 30 seconds * (cumulative), divided by the total number of impressions measurable for * audibility. * * Generated from protobuf field optional double active_view_audible_thirty_seconds_impressions_rate = 421; */ protected $active_view_audible_thirty_seconds_impressions_rate = null; /** * The number of impressions that were audible at the first quartile of the * ad playback, divided by the total number of impressions measurable for * audibility. * * Generated from protobuf field optional double active_view_audible_quartile_p25_rate = 422; */ protected $active_view_audible_quartile_p25_rate = null; /** * The number of impressions that were audible at the second quartile of the * ad playback, divided by the total number of impressions measurable for * audibility. * * Generated from protobuf field optional double active_view_audible_quartile_p50_rate = 423; */ protected $active_view_audible_quartile_p50_rate = null; /** * The number of impressions that were audible at the third quartile of the * ad playback, divided by the total number of impressions measurable for * audibility. * * Generated from protobuf field optional double active_view_audible_quartile_p75_rate = 424; */ protected $active_view_audible_quartile_p75_rate = null; /** * The number of impressions that were audible at the fourth quartile of the * ad playback, divided by the total number of impressions measurable for * audibility. * * Generated from protobuf field optional double active_view_audible_quartile_p100_rate = 425; */ protected $active_view_audible_quartile_p100_rate = null; /** * The number of biddable first in app conversions where the app install was * driven by interaction with a web campaign. * * Generated from protobuf field optional int64 biddable_indirect_install_first_in_app_conversion_micros = 426; */ protected $biddable_indirect_install_first_in_app_conversion_micros = null; /** * Constructor. * * @param array $data { * Optional. Data for populating the Message object. * * @type float $absolute_top_impression_percentage * Search absolute top impression share is the percentage of your Search ad * impressions that are shown in the most prominent Search position. * @type float $active_view_cpm * Average cost of viewable impressions (`active_view_impressions`). * @type float $active_view_ctr * Active view measurable clicks divided by active view viewable impressions. * This metric is reported only for the Display Network. * @type int|string $active_view_impressions * A measurement of how often your ad has become viewable on a Display * Network site. * @type float $active_view_measurability * The ratio of impressions that could be measured by Active View over the * number of served impressions. * @type int|string $active_view_measurable_cost_micros * The cost of the impressions you received that were measurable by Active * View. * @type int|string $active_view_measurable_impressions * The number of times your ads are appearing on placements in positions * where they can be seen. * @type float $active_view_viewability * The percentage of time when your ad appeared on an Active View enabled site * (measurable impressions) and was viewable (viewable impressions). * @type float $all_conversions_from_interactions_rate * All conversions from interactions (as oppose to view through conversions) * divided by the number of ad interactions. * @type float $all_conversions_value * The value of all conversions. * @type float $all_conversions_value_by_conversion_date * 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. * @type float $all_new_customer_lifetime_value * 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. * @type float $all_conversions * The total number of conversions. This includes all conversions regardless * of the value of include_in_conversions_metric. * @type float $all_conversions_by_conversion_date * 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. * @type float $all_conversions_value_per_cost * The value of all conversions divided by the total cost of ad interactions * (such as clicks for text ads or views for video ads). * @type float $all_conversions_from_click_to_call * The number of times people clicked the "Call" button to call a business * 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. * @type float $all_conversions_from_directions * The number of times people clicked a "Get directions" button to navigate to * a business after clicking an ad. * This metric applies to feed items only. * @type float $all_conversions_from_interactions_value_per_interaction * The value of all conversions from interactions divided by the total number * of interactions. * @type float $all_conversions_from_menu * The number of times people clicked a link to view a business's menu after * clicking an ad. * This metric applies to feed items only. * @type float $all_conversions_from_order * The number of times people placed an order at a business after clicking an * ad. * This metric applies to feed items only. * @type float $all_conversions_from_other_engagement * The number of other conversions (for example, posting a review or saving a * location for a business) that occurred after people clicked an ad. * This metric applies to feed items only. * @type float $all_conversions_from_store_visit * Estimated number of times people visited a business after clicking an ad. * This metric applies to feed items only. * @type float $all_conversions_from_store_website * The number of times that people were taken to a business's URL after * clicking an ad. * This metric applies to feed items only. * @type float $auction_insight_search_absolute_top_impression_percentage * This metric is part of the Auction Insights report, and tells how often * the ads of another participant showed in the most prominent position on the * search results page. * This percentage is computed only over the auctions that you appeared in * the page. * This metric is not publicly available. * @type float $auction_insight_search_impression_share * 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. * @type float $auction_insight_search_outranking_share * 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. * @type float $auction_insight_search_overlap_rate * 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. * @type float $auction_insight_search_position_above_rate * 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. * @type float $auction_insight_search_top_impression_percentage * This metric is part of the Auction Insights report, and tells how often * the ads of another participant showed adjacent to the top organic search * results. This percentage is computed only over the auctions that you * appeared in the page. * This metric is not publicly available. * @type float $average_cost * The average amount you pay per interaction. This amount is the total cost * of your ads divided by the total number of interactions. * @type float $average_cpc * The total cost of all clicks divided by the total number of clicks * received. * @type float $average_cpe * 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. * @type float $average_cpm * Average cost-per-thousand impressions (CPM). * @type float $trueview_average_cpv * 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. * @type float $average_page_views * Average number of pages viewed per session. * @type float $average_time_on_site * Total duration of all sessions (in seconds) / number of sessions. Imported * from Google Analytics. * @type float $benchmark_average_max_cpc * An indication of how other advertisers are bidding on similar products. * @type float $biddable_app_install_conversions * Number of app installs. * @type float $biddable_app_post_install_conversions * Number of in-app actions. * @type float $biddable_cohort_app_post_install_conversions * Participated in-app actions. The number of in app actions that come * directly or indirectly from the campaign. * @type float $benchmark_ctr * 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. * @type float $bounce_rate * Percentage of clicks where the user only visited a single page on your * site. Imported from Google Analytics. * @type int|string $clicks * The number of clicks. * @type int|string $combined_clicks * 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. * @type float $combined_clicks_per_query * 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. * @type int|string $combined_queries * 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. * @type float $content_budget_lost_impression_share * 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. * @type float $content_impression_share * 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. * @type string $conversion_last_received_request_date_time * 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 (for example, 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. * @type string $conversion_last_conversion_date * The date of the most recent conversion for this conversion action. The date * is in the customer's time zone. * @type float $content_rank_lost_impression_share * 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. * @type float $conversions_from_interactions_rate * 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. * @type float $conversions_value * 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. * @type float $conversions_value_by_conversion_date * 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. * @type float $new_customer_lifetime_value * 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. * @type float $conversions_value_per_cost * 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. * @type float $conversions_from_interactions_value_per_interaction * 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. * @type float $conversions * 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. * @type float $conversions_by_conversion_date * 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. * @type int|string $cost_micros * The sum of your cost-per-click (CPC) and cost-per-thousand impressions * (CPM) costs during this period. * @type float $cost_per_all_conversions * The cost of ad interactions divided by all conversions. * @type float $cost_per_conversion * 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. * @type float $cost_per_current_model_attributed_conversion * 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. * @type float $cross_device_conversions * 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. * @type float $cross_device_conversions_by_conversion_date * The number of cross-device conversions by conversion date. * Details for the by_conversion_date columns are available at * https://support.google.com/google-ads/answer/9549009. * @type float $cross_device_conversions_value * The sum of the value of cross-device conversions. * @type int|string $cross_device_conversions_value_micros * The sum of the value of cross-device conversions, in micros. * @type float $cross_device_conversions_value_by_conversion_date * The sum of cross-device conversions value by conversion date. * Details for the by_conversion_date columns are available at * https://support.google.com/google-ads/answer/9549009. * @type float $ctr * The number of clicks your ad receives (Clicks) divided by the number * of times your ad is shown (Impressions). * @type float $current_model_attributed_conversions * 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. * @type float $current_model_attributed_conversions_from_interactions_rate * 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. * @type float $current_model_attributed_conversions_from_interactions_value_per_interaction * 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. * @type float $current_model_attributed_conversions_value * 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. * @type float $current_model_attributed_conversions_value_per_cost * 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. * @type float $engagement_rate * 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. * @type int|string $engagements * 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. * @type float $hotel_average_lead_value_micros * Average lead value based on clicks. * @type int|string $hotel_commission_rate_micros * Commission bid rate in micros. A 20% commission is represented as * 200,000. * @type float $hotel_expected_commission_cost * Expected commission cost. The result of multiplying the commission value * times the hotel_commission_rate in advertiser currency. * @type float $hotel_price_difference_percentage * The average price difference between the price offered by reporting hotel * advertiser and the cheapest price offered by the competing advertiser. * @type int|string $hotel_eligible_impressions * The number of impressions that hotel partners could have had given their * feed performance. * @type int $historical_creative_quality_score * The creative historical quality score. * @type int $historical_landing_page_quality_score * The quality of historical landing page experience. * @type int|string $historical_quality_score * The historical quality score. * @type int $historical_search_predicted_ctr * The historical search predicted click through rate (CTR). * @type int|string $gmail_forwards * The number of times the ad was forwarded to someone else as a message. * @type int|string $gmail_saves * The number of times someone has saved your Gmail ad to their inbox as a * message. * @type int|string $gmail_secondary_clicks * The number of clicks to the landing page on the expanded state of Gmail * ads. * @type int|string $impressions_from_store_reach * The number of times a business's location-based ad was shown. * This metric applies to feed items only. * @type int|string $impressions * Count of how often your ad has appeared on a search results page or * website on the Google Network. * @type float $interaction_rate * 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. * @type int|string $interactions * 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. * @type int[] $interaction_event_types * The types of payable and free interactions. * @type float $invalid_click_rate * The percentage of clicks filtered out of your total number of clicks * (filtered + non-filtered clicks) during the reporting period. * @type int|string $invalid_clicks * Number of clicks Google considers illegitimate and doesn't charge you for. * @type float $general_invalid_click_rate * The percentage of clicks that have been filtered out of your total number * of clicks (filtered + non-filtered clicks) due to being general invalid * clicks. These are clicks Google considers illegitimate that are detected * through routine means of filtration (that is, known invalid data-center * traffic, bots and spiders or other crawlers, irregular patterns, etc). * You're not charged for them, and they don't affect your account statistics. * See the help page at * https://support.google.com/campaignmanager/answer/6076504 for * details. * @type int|string $general_invalid_clicks * Number of general invalid clicks. These are a subset of your invalid clicks * that are detected through routine means of filtration (such as known * invalid data-center traffic, bots and spiders or other crawlers, irregular * patterns, etc.). You're not charged for them, and they don't affect your * account statistics. See the help page at * https://support.google.com/campaignmanager/answer/6076504 for * details. * @type int|string $message_chats * Number of message chats initiated for Click To Message impressions that * were message tracking eligible. * @type int|string $message_impressions * Number of Click To Message impressions that were message tracking eligible. * @type float $message_chat_rate * 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. * @type float $mobile_friendly_clicks_percentage * The percentage of mobile clicks that go to a mobile-friendly page. * @type float $optimization_score_uplift * Total optimization score uplift of all recommendations. * @type string $optimization_score_url * 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. * @type int|string $organic_clicks * 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. * @type float $organic_clicks_per_query * 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. * @type int|string $organic_impressions * 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. * @type float $organic_impressions_per_query * 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. * @type int|string $organic_queries * 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. * @type float $percent_new_visitors * Percentage of first-time sessions (from people who had never visited your * site before). Imported from Google Analytics. * @type int|string $phone_calls * Number of offline phone calls. * @type int|string $phone_impressions * Number of offline phone impressions. * @type float $phone_through_rate * Number of phone calls received (phone_calls) divided by the number of * times your phone number is shown (phone_impressions). * @type float $relative_ctr * 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. * @type float $search_absolute_top_impression_share * 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. * @type float $search_budget_lost_absolute_top_impression_share * The number estimating how often your ad wasn't the very first ad among the * top ads in the search results due to a low budget. Note: Search * budget lost absolute top impression share is reported in the range of 0 to * 0.9. Any value above 0.9 is reported as 0.9001. * @type float $search_budget_lost_impression_share * 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. * @type float $search_budget_lost_top_impression_share * The number estimating how often your ad didn't show adjacent to the top * organic search results due to a low budget. Note: Search * budget lost top impression share is reported in the range of 0 to 0.9. Any * value above 0.9 is reported as 0.9001. * @type float $search_click_share * 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. * @type float $search_exact_match_impression_share * 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. * @type float $search_impression_share * 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. * @type float $search_rank_lost_absolute_top_impression_share * The number estimating how often your ad wasn't the very first ad among the * top ads in the search results due to poor Ad Rank. * Note: Search rank lost absolute top impression share is reported in the * range of 0 to 0.9. Any value above 0.9 is reported as 0.9001. * @type float $search_rank_lost_impression_share * 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. * @type float $search_rank_lost_top_impression_share * The number estimating how often your ad didn't show adjacent to the top * organic search results due to poor Ad Rank. * Note: Search rank lost top impression share is reported in the range of 0 * to 0.9. Any value above 0.9 is reported as 0.9001. * @type float $search_top_impression_share * The impressions you've received among the top ads compared to the estimated * number of impressions you were eligible to receive among the top ads. * Note: Search top impression share is reported in the range of 0.1 to 1. Any * value below 0.1 is reported as 0.0999. * Top ads are generally above the top organic results, although they may show * below the top organic results on certain queries. * @type \Google\Ads\GoogleAds\V23\Common\SearchVolumeRange $search_volume * Search volume range for a search term insight category. * @type int|string $speed_score * 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. * @type int|string $average_target_cpa_micros * The average Target CPA, or unset if not available (for example, for * campaigns that had traffic from portfolio bidding strategies or non-tCPA). * @type float $average_target_roas * The average Target ROAS, or unset if not available (for example, for * campaigns that had traffic from portfolio bidding strategies or non-tROAS). * @type float $top_impression_percentage * The percent of your ad impressions that are shown adjacent to the top * organic search results. * @type float $valid_accelerated_mobile_pages_clicks_percentage * The percentage of ad clicks to Accelerated Mobile Pages (AMP) landing pages * that reach a valid AMP page. * @type float $value_per_all_conversions * The value of all conversions divided by the number of all conversions. * @type float $value_per_all_conversions_by_conversion_date * 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. * @type float $value_per_conversion * 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. * @type float $value_per_conversions_by_conversion_date * 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. * @type float $value_per_current_model_attributed_conversion * 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. * @type float $video_quartile_p100_rate * Percentage of impressions where the viewer watched all of your video. * @type float $video_quartile_p25_rate * Percentage of impressions where the viewer watched 25% of your video. * @type float $video_quartile_p50_rate * Percentage of impressions where the viewer watched 50% of your video. * @type float $video_quartile_p75_rate * Percentage of impressions where the viewer watched 75% of your video. * @type float $video_trueview_view_rate * The number of TrueView views your video ad receives divided by its number * of impressions, including thumbnail impressions for TrueView in-display * ads. * @type int|string $video_trueview_views * The number of TrueView views your video ads received. * @type int|string $view_through_conversions * The total number of view-through conversions. * These happen when a customer sees an image or rich media ad, then later * completes a conversion on your site without interacting with (for example, * clicking on) another ad. * @type int|string $sk_ad_network_installs * The number of iOS Store Kit Ad Network conversions. * @type int|string $sk_ad_network_total_conversions * The total number of iOS Store Kit Ad Network conversions. * @type int|string $publisher_purchased_clicks * Clicks from properties not owned by the publisher for which the traffic * the publisher has paid for or acquired through incentivized activity * @type int|string $publisher_organic_clicks * Clicks from properties for which the traffic the publisher has not paid * for or acquired through incentivized activity * @type int|string $publisher_unknown_clicks * Clicks from traffic which is not identified as "Publisher Purchased" or * "Publisher Organic" * @type float $all_conversions_from_location_asset_click_to_call * 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. * @type float $all_conversions_from_location_asset_directions * 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. * @type float $all_conversions_from_location_asset_menu * 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. * @type float $all_conversions_from_location_asset_order * Number of order clicks on any location surface after a chargeable ad event * (click or impression). This measure is coming from Asset based * location. * @type float $all_conversions_from_location_asset_other_engagement * 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. * @type float $all_conversions_from_location_asset_store_visits * Estimated number of visits to the business after a chargeable * ad event (click or impression). This measure is coming from Asset * based location. * @type float $all_conversions_from_location_asset_website * 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. * @type int|string $eligible_impressions_from_location_asset_store_reach * Number of impressions in which the business location was shown or the * location was used for targeting. This measure is coming from Asset based * location. * @type float $view_through_conversions_from_location_asset_click_to_call * Number of call button clicks on any location surface after an impression. * This measure is coming from Asset based location. * @type float $view_through_conversions_from_location_asset_directions * Number of driving directions clicks on any location surface after an * impression. This measure is coming from Asset based location. * @type float $view_through_conversions_from_location_asset_menu * Number of menu link clicks on any location surface after an impression. * This measure is coming from Asset based location. * @type float $view_through_conversions_from_location_asset_order * Number of order clicks on any location surface after an impression. This * measure is coming from Asset based location. * @type float $view_through_conversions_from_location_asset_other_engagement * Number of other types of local action clicks on any location surface after * an impression. This measure is coming from Asset based location. * @type float $view_through_conversions_from_location_asset_store_visits * Estimated number of visits to the business after an impression. * This measure is coming from Asset based location. * @type float $view_through_conversions_from_location_asset_website * Number of website URL clicks on any location surface after an impression. * This measure is coming from Asset based location. * @type float $orders * 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. * @type int|string $average_order_value_micros * 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. * @type float $average_cart_size * 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. * @type int|string $cost_of_goods_sold_micros * 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. * @type int|string $gross_profit_micros * 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. * @type float $gross_profit_margin * 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. * @type int|string $revenue_micros * 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. * @type float $units_sold * 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. * @type int|string $cross_sell_cost_of_goods_sold_micros * 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. * @type int|string $cross_sell_gross_profit_micros * 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. * @type int|string $cross_sell_revenue_micros * 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. * @type float $cross_sell_units_sold * 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. * @type int|string $lead_cost_of_goods_sold_micros * 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. * @type int|string $lead_gross_profit_micros * 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. * @type int|string $lead_revenue_micros * 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. * @type float $lead_units_sold * 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. * @type int|string $unique_users * 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. * @type float $average_impression_frequency_per_user * 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. * @type int|string $linked_entities_count * Number of linked resources in which the asset is used. * This metric can only be selected with ChannelAggregateAssetView and * CampaignAggregateAssetView. * @type string[] $linked_sample_entities * A list of up to 20 sample linked resources in which the asset is used. * This metric can only be selected with ChannelAggregateAssetView and * CampaignAggregateAssetView. * @type int|string $asset_pinned_total_count * Number of total usages in which the asset is pinned. * This metric can only be selected with ChannelAggregateAssetView and * CampaignAggregateAssetView. * This metric is only supported in Search channel. * @type int|string $asset_pinned_as_headline_position_one_count * Number of entities in which the asset is pinned to headline 1. * This metric can only be selected with ChannelAggregateAssetView and * CampaignAggregateAssetView. * This metric is only supported in Search channel. * @type int|string $asset_pinned_as_headline_position_two_count * Number of entities in which the asset is pinned to headline 2. * This metric can only be selected with ChannelAggregateAssetView and * CampaignAggregateAssetView. * This metric is only supported in Search channel. * @type int|string $asset_pinned_as_headline_position_three_count * Number of entities in which the asset is pinned to headline 3. * This metric can only be selected with ChannelAggregateAssetView and * CampaignAggregateAssetView. * This metric is only supported in Search channel. * @type int|string $asset_pinned_as_description_position_one_count * Number of entities in which the asset is pinned to description 1. * This metric can only be selected with ChannelAggregateAssetView and * CampaignAggregateAssetView. * This metric is only supported in Search channel. * @type int|string $asset_pinned_as_description_position_two_count * Number of entities in which the asset is pinned to description 2. * This metric can only be selected with ChannelAggregateAssetView and * CampaignAggregateAssetView. * This metric is only supported in Search channel. * @type float $store_visits_last_click_model_attributed_conversions * The amount of business visits attributed by the last click model. * @type float $results_conversions_purchase * The purchase conversion stats for the unified goals results. * @type float $video_trueview_view_rate_in_feed * The number of TrueView views divided by number of impressions that can * potentially lead to TrueView views for in-feed formats. * @type float $video_trueview_view_rate_in_stream * The number of TrueView views divided by number of impressions that can * potentially lead to TrueView views for in-stream formats. * @type float $video_trueview_view_rate_shorts * The number of TrueView views divided by number of impressions that can * potentially lead to TrueView views for Shorts ads. * @type int|string $coviewed_impressions * All co-viewed impressions represent the total number of people who saw your * ad. This includes people who are signed into their Google Account, as well * as other people who are watching the same ad on a connected TV. This metric * is only available for the Campaign resource with adjusted_age_range and * adjusted_gender segments. These segmentations are mandatory to get the * all coviewed impressions. * @type int|string $primary_impressions * Primary impression is counted each time your ad is served. This metric is * only available for the Campaign resource with adjusted_age_range and * adjusted_gender segments. These segmentations are mandatory to get the * primary impressions. * @type float $platform_comparable_conversions_from_interactions_rate * Platform comparable 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 for which include_in_conversions_metric * attribute is set to true. If you use conversion-based bidding, your bid * strategies will optimize for these conversions. * @type float $platform_comparable_conversions * The number of platform comparable conversions. This only includes * conversion actions for which include_in_conversions_metric attribute is set * to true. If you use conversion-based bidding, your bid strategies will * optimize for these conversions. * @type float $platform_comparable_conversions_value * The value of platform comparable 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. * @type float $platform_comparable_conversions_value_per_cost * The value of conversions divided by the cost of ad interactions. This only * includes conversion actions for which include_in_conversions_metric * attribute is set to true. If you use conversion-based bidding, your bid * strategies will optimize for these conversions. * @type float $platform_comparable_conversions_by_conversion_date * The number of platform comparable conversions. When this metric is * segmented by date, the values in the date segment represent the conversion * date. This only includes conversion actions for which * include_in_conversions_metric attribute is set to true. If you use * conversion-based bidding, your bid strategies will optimize for these * conversions. * @type float $platform_comparable_conversions_value_by_conversion_date * The value of platform comparable conversions. When this metric is segmented * by date, the values in the date segment represent the conversion date. This * only includes conversion actions for which include_in_conversions_metric * attribute is set to true. If you use conversion-based bidding, your bid * strategies will optimize for these conversions. * @type float $platform_comparable_conversions_from_interactions_value_per_interaction * The value of platform comparable conversions from interactions divided by * the number of ad interactions. This only includes conversion actions for * which include_in_conversions_metric attribute is set to true. If you use * conversion-based bidding, your bid strategies will optimize for these * conversions. * @type float $cost_per_platform_comparable_conversion * The cost of ad interactions divided by the number of platform comparable * conversions. This only includes conversion actions for which * include_in_conversions_metric attribute is set to true. If you use * conversion-based bidding, your bid strategies will optimize for these * conversions. * @type float $value_per_platform_comparable_conversion * The value of platform comparable conversions divided by the number of * platform comparable conversions. This only includes conversion actions for * which include_in_conversions_metric attribute is set to true. If you use * conversion-based bidding, your bid strategies will optimize for these * conversions. * @type float $value_per_platform_comparable_conversions_by_conversion_date * The value of platform comparable conversions divided by the number of * platform comparable conversions. When this metric is segmented by date, the * values in the date segment represent the conversion date. This only * includes conversion actions for which include_in_conversions_metric * attribute is set to true. If you use conversion-based bidding, your bid * strategies will optimize for these conversions. * @type float $cost_converted_currency_per_platform_comparable_conversion * The cost of the platform comparable conversion in the currency of the * authorized customer. * @type int|string $unique_users_two_plus * This metric counts the unique individuals who were shown your video ad two * or more times within the selected date range. This metric cannot be * aggregated, and can only be requested for date ranges of 31 days or less. * @type int|string $unique_users_three_plus * This metric counts the unique individuals who were shown your video ad * three or more times within the selected date range. This metric cannot be * aggregated, and can only be requested for date ranges of 31 days or less. * @type int|string $unique_users_four_plus * This metric counts the unique individuals who were shown your video ad four * or more times within the selected date range. This metric cannot be * aggregated, and can only be requested for date ranges of 31 days or less. * @type int|string $unique_users_five_plus * This metric counts the unique individuals who were shown your video ad five * or more times within the selected date range. This metric cannot be * aggregated, and can only be requested for date ranges of 31 days or less. * @type int|string $unique_users_ten_plus * This metric counts the unique individuals who were shown your video ad ten * or more times within the selected date range. This metric cannot be * aggregated, and can only be requested for date ranges of 31 days or less. * @type float $value_adjustment * The conversion value rule adjustment from biddable conversions in all * conversion categories. * @type float $all_value_adjustment * The conversion value rule adjustment from all conversions in all conversion * categories. * @type int|string $clicks_unique_query_clusters * Unique query intent cluster count for clicks. * @type int|string $conversions_unique_query_clusters * Unique query intent cluster count for conversions. * @type int|string $impressions_unique_query_clusters * Unique query intent cluster count for impressions. * @type int|string $video_watch_time_duration_millis * Total watch time duration in milliseconds for video impressions that * started playing. For a small percentage of impressions, we may not be able * to measure the watch time accurately. In such cases, we adjust the total * time to account for any unmeasured time by applying the average watch time * of impressions that were measured. * @type int|string $average_video_watch_time_duration_millis * Average video watch time duration in milliseconds for video impressions * that started playing. * @type int|string $svr * This feature is available to allowlisted accounts only. * @type int|string $active_view_audibility_measurable_impressions * The number of impressions for which Active View could measure if the ad was * audible. * @type float $active_view_audibility_measurable_impressions_rate * The number of impressions for which Active View could measure if the ad was * audible, divided by the total number of impressions with Active View audio * enabled. * @type float $active_view_audibility_invalid_measurable_impressions_rate * The number of impressions for which Active View could measure audibility, * but that were filtered out by traffic quality filters, divided by the * total number of impressions measurable for audibility. * @type float $active_view_audibility_invalid_givt_measurable_impressions_rate * The number of impressions for which Active View could measure audibility, * but that were filtered out by traffic quality filters, divided by the total * number of impressions measurable for audibility. Only includes GIVT * (general invalid traffic) impressions. * @type int|string $active_view_audible_impressions * The number of impressions that were audible (volume > 0%) at any point * during the ad playback. * @type float $active_view_audible_impressions_rate * The number of impressions that were audible (volume > 0%) at any point * during the ad playback, divided by the total number of impressions * measurable for audibility. * @type int|string $active_view_audible_two_seconds_impressions * The number of impressions that were audible for at least 2 seconds * (cumulative). * @type float $active_view_audible_two_seconds_impressions_rate * The number of impressions that were audible for at least 2 seconds * (cumulative), divided by the total number of impressions measurable for * audibility. * @type int|string $active_view_audible_thirty_seconds_impressions * The number of impressions that were audible for at least 30 seconds * (cumulative). * @type float $active_view_audible_thirty_seconds_impressions_rate * The number of impressions that were audible for at least 30 seconds * (cumulative), divided by the total number of impressions measurable for * audibility. * @type float $active_view_audible_quartile_p25_rate * The number of impressions that were audible at the first quartile of the * ad playback, divided by the total number of impressions measurable for * audibility. * @type float $active_view_audible_quartile_p50_rate * The number of impressions that were audible at the second quartile of the * ad playback, divided by the total number of impressions measurable for * audibility. * @type float $active_view_audible_quartile_p75_rate * The number of impressions that were audible at the third quartile of the * ad playback, divided by the total number of impressions measurable for * audibility. * @type float $active_view_audible_quartile_p100_rate * The number of impressions that were audible at the fourth quartile of the * ad playback, divided by the total number of impressions measurable for * audibility. * @type int|string $biddable_indirect_install_first_in_app_conversion_micros * The number of biddable first in app conversions where the app install was * driven by interaction with a web campaign. * } */ public function __construct($data = null) { \GPBMetadata\Google\Ads\GoogleAds\V23\Common\Metrics::initOnce(); parent::__construct($data); } /** * Search absolute top impression share is the percentage of your Search ad * impressions that are shown in the most prominent Search position. * * Generated from protobuf field optional double absolute_top_impression_percentage = 183; * * @return float */ public function getAbsoluteTopImpressionPercentage() { return isset($this->absolute_top_impression_percentage) ? $this->absolute_top_impression_percentage : 0.0; } public function hasAbsoluteTopImpressionPercentage() { return isset($this->absolute_top_impression_percentage); } public function clearAbsoluteTopImpressionPercentage() { unset($this->absolute_top_impression_percentage); } /** * Search absolute top impression share is the percentage of your Search ad * impressions that are shown in the most prominent Search position. * * Generated from protobuf field optional double absolute_top_impression_percentage = 183; * * @param float $var * @return $this */ public function setAbsoluteTopImpressionPercentage($var) { GPBUtil::checkDouble($var); $this->absolute_top_impression_percentage = $var; return $this; } /** * Average cost of viewable impressions (`active_view_impressions`). * * Generated from protobuf field optional double active_view_cpm = 184; * * @return float */ public function getActiveViewCpm() { return isset($this->active_view_cpm) ? $this->active_view_cpm : 0.0; } public function hasActiveViewCpm() { return isset($this->active_view_cpm); } public function clearActiveViewCpm() { unset($this->active_view_cpm); } /** * Average cost of viewable impressions (`active_view_impressions`). * * Generated from protobuf field optional double active_view_cpm = 184; * * @param float $var * @return $this */ public function setActiveViewCpm($var) { GPBUtil::checkDouble($var); $this->active_view_cpm = $var; return $this; } /** * Active view measurable clicks divided by active view viewable impressions. * This metric is reported only for the Display Network. * * Generated from protobuf field optional double active_view_ctr = 185; * * @return float */ public function getActiveViewCtr() { return isset($this->active_view_ctr) ? $this->active_view_ctr : 0.0; } public function hasActiveViewCtr() { return isset($this->active_view_ctr); } public function clearActiveViewCtr() { unset($this->active_view_ctr); } /** * Active view measurable clicks divided by active view viewable impressions. * This metric is reported only for the Display Network. * * Generated from protobuf field optional double active_view_ctr = 185; * * @param float $var * @return $this */ public function setActiveViewCtr($var) { GPBUtil::checkDouble($var); $this->active_view_ctr = $var; return $this; } /** * A measurement of how often your ad has become viewable on a Display * Network site. * * Generated from protobuf field optional int64 active_view_impressions = 186; * * @return int|string */ public function getActiveViewImpressions() { return isset($this->active_view_impressions) ? $this->active_view_impressions : 0; } public function hasActiveViewImpressions() { return isset($this->active_view_impressions); } public function clearActiveViewImpressions() { unset($this->active_view_impressions); } /** * A measurement of how often your ad has become viewable on a Display * Network site. * * Generated from protobuf field optional int64 active_view_impressions = 186; * * @param int|string $var * @return $this */ public function setActiveViewImpressions($var) { GPBUtil::checkInt64($var); $this->active_view_impressions = $var; return $this; } /** * The ratio of impressions that could be measured by Active View over the * number of served impressions. * * Generated from protobuf field optional double active_view_measurability = 187; * * @return float */ public function getActiveViewMeasurability() { return isset($this->active_view_measurability) ? $this->active_view_measurability : 0.0; } public function hasActiveViewMeasurability() { return isset($this->active_view_measurability); } public function clearActiveViewMeasurability() { unset($this->active_view_measurability); } /** * The ratio of impressions that could be measured by Active View over the * number of served impressions. * * Generated from protobuf field optional double active_view_measurability = 187; * * @param float $var * @return $this */ public function setActiveViewMeasurability($var) { GPBUtil::checkDouble($var); $this->active_view_measurability = $var; return $this; } /** * The cost of the impressions you received that were measurable by Active * View. * * Generated from protobuf field optional int64 active_view_measurable_cost_micros = 188; * * @return int|string */ public function getActiveViewMeasurableCostMicros() { return isset($this->active_view_measurable_cost_micros) ? $this->active_view_measurable_cost_micros : 0; } public function hasActiveViewMeasurableCostMicros() { return isset($this->active_view_measurable_cost_micros); } public function clearActiveViewMeasurableCostMicros() { unset($this->active_view_measurable_cost_micros); } /** * The cost of the impressions you received that were measurable by Active * View. * * Generated from protobuf field optional int64 active_view_measurable_cost_micros = 188; * * @param int|string $var * @return $this */ public function setActiveViewMeasurableCostMicros($var) { GPBUtil::checkInt64($var); $this->active_view_measurable_cost_micros = $var; return $this; } /** * The number of times your ads are appearing on placements in positions * where they can be seen. * * Generated from protobuf field optional int64 active_view_measurable_impressions = 189; * * @return int|string */ public function getActiveViewMeasurableImpressions() { return isset($this->active_view_measurable_impressions) ? $this->active_view_measurable_impressions : 0; } public function hasActiveViewMeasurableImpressions() { return isset($this->active_view_measurable_impressions); } public function clearActiveViewMeasurableImpressions() { unset($this->active_view_measurable_impressions); } /** * The number of times your ads are appearing on placements in positions * where they can be seen. * * Generated from protobuf field optional int64 active_view_measurable_impressions = 189; * * @param int|string $var * @return $this */ public function setActiveViewMeasurableImpressions($var) { GPBUtil::checkInt64($var); $this->active_view_measurable_impressions = $var; return $this; } /** * The percentage of time when your ad appeared on an Active View enabled site * (measurable impressions) and was viewable (viewable impressions). * * Generated from protobuf field optional double active_view_viewability = 190; * * @return float */ public function getActiveViewViewability() { return isset($this->active_view_viewability) ? $this->active_view_viewability : 0.0; } public function hasActiveViewViewability() { return isset($this->active_view_viewability); } public function clearActiveViewViewability() { unset($this->active_view_viewability); } /** * The percentage of time when your ad appeared on an Active View enabled site * (measurable impressions) and was viewable (viewable impressions). * * Generated from protobuf field optional double active_view_viewability = 190; * * @param float $var * @return $this */ public function setActiveViewViewability($var) { GPBUtil::checkDouble($var); $this->active_view_viewability = $var; return $this; } /** * All conversions from interactions (as oppose to view through conversions) * divided by the number of ad interactions. * * Generated from protobuf field optional double all_conversions_from_interactions_rate = 191; * * @return float */ public function getAllConversionsFromInteractionsRate() { return isset($this->all_conversions_from_interactions_rate) ? $this->all_conversions_from_interactions_rate : 0.0; } public function hasAllConversionsFromInteractionsRate() { return isset($this->all_conversions_from_interactions_rate); } public function clearAllConversionsFromInteractionsRate() { unset($this->all_conversions_from_interactions_rate); } /** * All conversions from interactions (as oppose to view through conversions) * divided by the number of ad interactions. * * Generated from protobuf field optional double all_conversions_from_interactions_rate = 191; * * @param float $var * @return $this */ public function setAllConversionsFromInteractionsRate($var) { GPBUtil::checkDouble($var); $this->all_conversions_from_interactions_rate = $var; return $this; } /** * The value of all conversions. * * Generated from protobuf field optional double all_conversions_value = 192; * * @return float */ public function getAllConversionsValue() { return isset($this->all_conversions_value) ? $this->all_conversions_value : 0.0; } public function hasAllConversionsValue() { return isset($this->all_conversions_value); } public function clearAllConversionsValue() { unset($this->all_conversions_value); } /** * The value of all conversions. * * Generated from protobuf field optional double all_conversions_value = 192; * * @param float $var * @return $this */ public function setAllConversionsValue($var) { GPBUtil::checkDouble($var); $this->all_conversions_value = $var; return $this; } /** * 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. * * Generated from protobuf field optional double all_conversions_value_by_conversion_date = 240; * * @return float */ public function getAllConversionsValueByConversionDate() { return isset($this->all_conversions_value_by_conversion_date) ? $this->all_conversions_value_by_conversion_date : 0.0; } public function hasAllConversionsValueByConversionDate() { return isset($this->all_conversions_value_by_conversion_date); } public function clearAllConversionsValueByConversionDate() { unset($this->all_conversions_value_by_conversion_date); } /** * 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. * * Generated from protobuf field optional double all_conversions_value_by_conversion_date = 240; * * @param float $var * @return $this */ public function setAllConversionsValueByConversionDate($var) { GPBUtil::checkDouble($var); $this->all_conversions_value_by_conversion_date = $var; return $this; } /** * 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. * * Generated from protobuf field optional double all_new_customer_lifetime_value = 294; * * @return float */ public function getAllNewCustomerLifetimeValue() { return isset($this->all_new_customer_lifetime_value) ? $this->all_new_customer_lifetime_value : 0.0; } public function hasAllNewCustomerLifetimeValue() { return isset($this->all_new_customer_lifetime_value); } public function clearAllNewCustomerLifetimeValue() { unset($this->all_new_customer_lifetime_value); } /** * 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. * * Generated from protobuf field optional double all_new_customer_lifetime_value = 294; * * @param float $var * @return $this */ public function setAllNewCustomerLifetimeValue($var) { GPBUtil::checkDouble($var); $this->all_new_customer_lifetime_value = $var; return $this; } /** * The total number of conversions. This includes all conversions regardless * of the value of include_in_conversions_metric. * * Generated from protobuf field optional double all_conversions = 193; * * @return float */ public function getAllConversions() { return isset($this->all_conversions) ? $this->all_conversions : 0.0; } public function hasAllConversions() { return isset($this->all_conversions); } public function clearAllConversions() { unset($this->all_conversions); } /** * The total number of conversions. This includes all conversions regardless * of the value of include_in_conversions_metric. * * Generated from protobuf field optional double all_conversions = 193; * * @param float $var * @return $this */ public function setAllConversions($var) { GPBUtil::checkDouble($var); $this->all_conversions = $var; return $this; } /** * 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. * * Generated from protobuf field optional double all_conversions_by_conversion_date = 241; * * @return float */ public function getAllConversionsByConversionDate() { return isset($this->all_conversions_by_conversion_date) ? $this->all_conversions_by_conversion_date : 0.0; } public function hasAllConversionsByConversionDate() { return isset($this->all_conversions_by_conversion_date); } public function clearAllConversionsByConversionDate() { unset($this->all_conversions_by_conversion_date); } /** * 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. * * Generated from protobuf field optional double all_conversions_by_conversion_date = 241; * * @param float $var * @return $this */ public function setAllConversionsByConversionDate($var) { GPBUtil::checkDouble($var); $this->all_conversions_by_conversion_date = $var; return $this; } /** * The value of all conversions divided by the total cost of ad interactions * (such as clicks for text ads or views for video ads). * * Generated from protobuf field optional double all_conversions_value_per_cost = 194; * * @return float */ public function getAllConversionsValuePerCost() { return isset($this->all_conversions_value_per_cost) ? $this->all_conversions_value_per_cost : 0.0; } public function hasAllConversionsValuePerCost() { return isset($this->all_conversions_value_per_cost); } public function clearAllConversionsValuePerCost() { unset($this->all_conversions_value_per_cost); } /** * The value of all conversions divided by the total cost of ad interactions * (such as clicks for text ads or views for video ads). * * Generated from protobuf field optional double all_conversions_value_per_cost = 194; * * @param float $var * @return $this */ public function setAllConversionsValuePerCost($var) { GPBUtil::checkDouble($var); $this->all_conversions_value_per_cost = $var; return $this; } /** * The number of times people clicked the "Call" button to call a business * 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. * * Generated from protobuf field optional double all_conversions_from_click_to_call = 195; * * @return float */ public function getAllConversionsFromClickToCall() { return isset($this->all_conversions_from_click_to_call) ? $this->all_conversions_from_click_to_call : 0.0; } public function hasAllConversionsFromClickToCall() { return isset($this->all_conversions_from_click_to_call); } public function clearAllConversionsFromClickToCall() { unset($this->all_conversions_from_click_to_call); } /** * The number of times people clicked the "Call" button to call a business * 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. * * Generated from protobuf field optional double all_conversions_from_click_to_call = 195; * * @param float $var * @return $this */ public function setAllConversionsFromClickToCall($var) { GPBUtil::checkDouble($var); $this->all_conversions_from_click_to_call = $var; return $this; } /** * The number of times people clicked a "Get directions" button to navigate to * a business after clicking an ad. * This metric applies to feed items only. * * Generated from protobuf field optional double all_conversions_from_directions = 196; * * @return float */ public function getAllConversionsFromDirections() { return isset($this->all_conversions_from_directions) ? $this->all_conversions_from_directions : 0.0; } public function hasAllConversionsFromDirections() { return isset($this->all_conversions_from_directions); } public function clearAllConversionsFromDirections() { unset($this->all_conversions_from_directions); } /** * The number of times people clicked a "Get directions" button to navigate to * a business after clicking an ad. * This metric applies to feed items only. * * Generated from protobuf field optional double all_conversions_from_directions = 196; * * @param float $var * @return $this */ public function setAllConversionsFromDirections($var) { GPBUtil::checkDouble($var); $this->all_conversions_from_directions = $var; return $this; } /** * The value of all conversions from interactions divided by the total number * of interactions. * * Generated from protobuf field optional double all_conversions_from_interactions_value_per_interaction = 197; * * @return float */ public function getAllConversionsFromInteractionsValuePerInteraction() { return isset($this->all_conversions_from_interactions_value_per_interaction) ? $this->all_conversions_from_interactions_value_per_interaction : 0.0; } public function hasAllConversionsFromInteractionsValuePerInteraction() { return isset($this->all_conversions_from_interactions_value_per_interaction); } public function clearAllConversionsFromInteractionsValuePerInteraction() { unset($this->all_conversions_from_interactions_value_per_interaction); } /** * The value of all conversions from interactions divided by the total number * of interactions. * * Generated from protobuf field optional double all_conversions_from_interactions_value_per_interaction = 197; * * @param float $var * @return $this */ public function setAllConversionsFromInteractionsValuePerInteraction($var) { GPBUtil::checkDouble($var); $this->all_conversions_from_interactions_value_per_interaction = $var; return $this; } /** * The number of times people clicked a link to view a business's menu after * clicking an ad. * This metric applies to feed items only. * * Generated from protobuf field optional double all_conversions_from_menu = 198; * * @return float */ public function getAllConversionsFromMenu() { return isset($this->all_conversions_from_menu) ? $this->all_conversions_from_menu : 0.0; } public function hasAllConversionsFromMenu() { return isset($this->all_conversions_from_menu); } public function clearAllConversionsFromMenu() { unset($this->all_conversions_from_menu); } /** * The number of times people clicked a link to view a business's menu after * clicking an ad. * This metric applies to feed items only. * * Generated from protobuf field optional double all_conversions_from_menu = 198; * * @param float $var * @return $this */ public function setAllConversionsFromMenu($var) { GPBUtil::checkDouble($var); $this->all_conversions_from_menu = $var; return $this; } /** * The number of times people placed an order at a business after clicking an * ad. * This metric applies to feed items only. * * Generated from protobuf field optional double all_conversions_from_order = 199; * * @return float */ public function getAllConversionsFromOrder() { return isset($this->all_conversions_from_order) ? $this->all_conversions_from_order : 0.0; } public function hasAllConversionsFromOrder() { return isset($this->all_conversions_from_order); } public function clearAllConversionsFromOrder() { unset($this->all_conversions_from_order); } /** * The number of times people placed an order at a business after clicking an * ad. * This metric applies to feed items only. * * Generated from protobuf field optional double all_conversions_from_order = 199; * * @param float $var * @return $this */ public function setAllConversionsFromOrder($var) { GPBUtil::checkDouble($var); $this->all_conversions_from_order = $var; return $this; } /** * The number of other conversions (for example, posting a review or saving a * location for a business) that occurred after people clicked an ad. * This metric applies to feed items only. * * Generated from protobuf field optional double all_conversions_from_other_engagement = 200; * * @return float */ public function getAllConversionsFromOtherEngagement() { return isset($this->all_conversions_from_other_engagement) ? $this->all_conversions_from_other_engagement : 0.0; } public function hasAllConversionsFromOtherEngagement() { return isset($this->all_conversions_from_other_engagement); } public function clearAllConversionsFromOtherEngagement() { unset($this->all_conversions_from_other_engagement); } /** * The number of other conversions (for example, posting a review or saving a * location for a business) that occurred after people clicked an ad. * This metric applies to feed items only. * * Generated from protobuf field optional double all_conversions_from_other_engagement = 200; * * @param float $var * @return $this */ public function setAllConversionsFromOtherEngagement($var) { GPBUtil::checkDouble($var); $this->all_conversions_from_other_engagement = $var; return $this; } /** * Estimated number of times people visited a business after clicking an ad. * This metric applies to feed items only. * * Generated from protobuf field optional double all_conversions_from_store_visit = 201; * * @return float */ public function getAllConversionsFromStoreVisit() { return isset($this->all_conversions_from_store_visit) ? $this->all_conversions_from_store_visit : 0.0; } public function hasAllConversionsFromStoreVisit() { return isset($this->all_conversions_from_store_visit); } public function clearAllConversionsFromStoreVisit() { unset($this->all_conversions_from_store_visit); } /** * Estimated number of times people visited a business after clicking an ad. * This metric applies to feed items only. * * Generated from protobuf field optional double all_conversions_from_store_visit = 201; * * @param float $var * @return $this */ public function setAllConversionsFromStoreVisit($var) { GPBUtil::checkDouble($var); $this->all_conversions_from_store_visit = $var; return $this; } /** * The number of times that people were taken to a business's URL after * clicking an ad. * This metric applies to feed items only. * * Generated from protobuf field optional double all_conversions_from_store_website = 202; * * @return float */ public function getAllConversionsFromStoreWebsite() { return isset($this->all_conversions_from_store_website) ? $this->all_conversions_from_store_website : 0.0; } public function hasAllConversionsFromStoreWebsite() { return isset($this->all_conversions_from_store_website); } public function clearAllConversionsFromStoreWebsite() { unset($this->all_conversions_from_store_website); } /** * The number of times that people were taken to a business's URL after * clicking an ad. * This metric applies to feed items only. * * Generated from protobuf field optional double all_conversions_from_store_website = 202; * * @param float $var * @return $this */ public function setAllConversionsFromStoreWebsite($var) { GPBUtil::checkDouble($var); $this->all_conversions_from_store_website = $var; return $this; } /** * This metric is part of the Auction Insights report, and tells how often * the ads of another participant showed in the most prominent position on the * search results page. * This percentage is computed only over the auctions that you appeared in * the page. * This metric is not publicly available. * * Generated from protobuf field optional double auction_insight_search_absolute_top_impression_percentage = 258; * * @return float */ public function getAuctionInsightSearchAbsoluteTopImpressionPercentage() { return isset($this->auction_insight_search_absolute_top_impression_percentage) ? $this->auction_insight_search_absolute_top_impression_percentage : 0.0; } public function hasAuctionInsightSearchAbsoluteTopImpressionPercentage() { return isset($this->auction_insight_search_absolute_top_impression_percentage); } public function clearAuctionInsightSearchAbsoluteTopImpressionPercentage() { unset($this->auction_insight_search_absolute_top_impression_percentage); } /** * This metric is part of the Auction Insights report, and tells how often * the ads of another participant showed in the most prominent position on the * search results page. * This percentage is computed only over the auctions that you appeared in * the page. * This metric is not publicly available. * * Generated from protobuf field optional double auction_insight_search_absolute_top_impression_percentage = 258; * * @param float $var * @return $this */ public function setAuctionInsightSearchAbsoluteTopImpressionPercentage($var) { GPBUtil::checkDouble($var); $this->auction_insight_search_absolute_top_impression_percentage = $var; return $this; } /** * 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. * * Generated from protobuf field optional double auction_insight_search_impression_share = 259; * * @return float */ public function getAuctionInsightSearchImpressionShare() { return isset($this->auction_insight_search_impression_share) ? $this->auction_insight_search_impression_share : 0.0; } public function hasAuctionInsightSearchImpressionShare() { return isset($this->auction_insight_search_impression_share); } public function clearAuctionInsightSearchImpressionShare() { unset($this->auction_insight_search_impression_share); } /** * 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. * * Generated from protobuf field optional double auction_insight_search_impression_share = 259; * * @param float $var * @return $this */ public function setAuctionInsightSearchImpressionShare($var) { GPBUtil::checkDouble($var); $this->auction_insight_search_impression_share = $var; return $this; } /** * 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. * * Generated from protobuf field optional double auction_insight_search_outranking_share = 260; * * @return float */ public function getAuctionInsightSearchOutrankingShare() { return isset($this->auction_insight_search_outranking_share) ? $this->auction_insight_search_outranking_share : 0.0; } public function hasAuctionInsightSearchOutrankingShare() { return isset($this->auction_insight_search_outranking_share); } public function clearAuctionInsightSearchOutrankingShare() { unset($this->auction_insight_search_outranking_share); } /** * 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. * * Generated from protobuf field optional double auction_insight_search_outranking_share = 260; * * @param float $var * @return $this */ public function setAuctionInsightSearchOutrankingShare($var) { GPBUtil::checkDouble($var); $this->auction_insight_search_outranking_share = $var; return $this; } /** * 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. * * Generated from protobuf field optional double auction_insight_search_overlap_rate = 261; * * @return float */ public function getAuctionInsightSearchOverlapRate() { return isset($this->auction_insight_search_overlap_rate) ? $this->auction_insight_search_overlap_rate : 0.0; } public function hasAuctionInsightSearchOverlapRate() { return isset($this->auction_insight_search_overlap_rate); } public function clearAuctionInsightSearchOverlapRate() { unset($this->auction_insight_search_overlap_rate); } /** * 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. * * Generated from protobuf field optional double auction_insight_search_overlap_rate = 261; * * @param float $var * @return $this */ public function setAuctionInsightSearchOverlapRate($var) { GPBUtil::checkDouble($var); $this->auction_insight_search_overlap_rate = $var; return $this; } /** * 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. * * Generated from protobuf field optional double auction_insight_search_position_above_rate = 262; * * @return float */ public function getAuctionInsightSearchPositionAboveRate() { return isset($this->auction_insight_search_position_above_rate) ? $this->auction_insight_search_position_above_rate : 0.0; } public function hasAuctionInsightSearchPositionAboveRate() { return isset($this->auction_insight_search_position_above_rate); } public function clearAuctionInsightSearchPositionAboveRate() { unset($this->auction_insight_search_position_above_rate); } /** * 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. * * Generated from protobuf field optional double auction_insight_search_position_above_rate = 262; * * @param float $var * @return $this */ public function setAuctionInsightSearchPositionAboveRate($var) { GPBUtil::checkDouble($var); $this->auction_insight_search_position_above_rate = $var; return $this; } /** * This metric is part of the Auction Insights report, and tells how often * the ads of another participant showed adjacent to the top organic search * results. This percentage is computed only over the auctions that you * appeared in the page. * This metric is not publicly available. * * Generated from protobuf field optional double auction_insight_search_top_impression_percentage = 263; * * @return float */ public function getAuctionInsightSearchTopImpressionPercentage() { return isset($this->auction_insight_search_top_impression_percentage) ? $this->auction_insight_search_top_impression_percentage : 0.0; } public function hasAuctionInsightSearchTopImpressionPercentage() { return isset($this->auction_insight_search_top_impression_percentage); } public function clearAuctionInsightSearchTopImpressionPercentage() { unset($this->auction_insight_search_top_impression_percentage); } /** * This metric is part of the Auction Insights report, and tells how often * the ads of another participant showed adjacent to the top organic search * results. This percentage is computed only over the auctions that you * appeared in the page. * This metric is not publicly available. * * Generated from protobuf field optional double auction_insight_search_top_impression_percentage = 263; * * @param float $var * @return $this */ public function setAuctionInsightSearchTopImpressionPercentage($var) { GPBUtil::checkDouble($var); $this->auction_insight_search_top_impression_percentage = $var; return $this; } /** * The average amount you pay per interaction. This amount is the total cost * of your ads divided by the total number of interactions. * * Generated from protobuf field optional double average_cost = 203; * * @return float */ public function getAverageCost() { return isset($this->average_cost) ? $this->average_cost : 0.0; } public function hasAverageCost() { return isset($this->average_cost); } public function clearAverageCost() { unset($this->average_cost); } /** * The average amount you pay per interaction. This amount is the total cost * of your ads divided by the total number of interactions. * * Generated from protobuf field optional double average_cost = 203; * * @param float $var * @return $this */ public function setAverageCost($var) { GPBUtil::checkDouble($var); $this->average_cost = $var; return $this; } /** * The total cost of all clicks divided by the total number of clicks * received. * * Generated from protobuf field optional double average_cpc = 204; * * @return float */ public function getAverageCpc() { return isset($this->average_cpc) ? $this->average_cpc : 0.0; } public function hasAverageCpc() { return isset($this->average_cpc); } public function clearAverageCpc() { unset($this->average_cpc); } /** * The total cost of all clicks divided by the total number of clicks * received. * * Generated from protobuf field optional double average_cpc = 204; * * @param float $var * @return $this */ public function setAverageCpc($var) { GPBUtil::checkDouble($var); $this->average_cpc = $var; return $this; } /** * 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. * * Generated from protobuf field optional double average_cpe = 205; * * @return float */ public function getAverageCpe() { return isset($this->average_cpe) ? $this->average_cpe : 0.0; } public function hasAverageCpe() { return isset($this->average_cpe); } public function clearAverageCpe() { unset($this->average_cpe); } /** * 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. * * Generated from protobuf field optional double average_cpe = 205; * * @param float $var * @return $this */ public function setAverageCpe($var) { GPBUtil::checkDouble($var); $this->average_cpe = $var; return $this; } /** * Average cost-per-thousand impressions (CPM). * * Generated from protobuf field optional double average_cpm = 206; * * @return float */ public function getAverageCpm() { return isset($this->average_cpm) ? $this->average_cpm : 0.0; } public function hasAverageCpm() { return isset($this->average_cpm); } public function clearAverageCpm() { unset($this->average_cpm); } /** * Average cost-per-thousand impressions (CPM). * * Generated from protobuf field optional double average_cpm = 206; * * @param float $var * @return $this */ public function setAverageCpm($var) { GPBUtil::checkDouble($var); $this->average_cpm = $var; return $this; } /** * 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. * * Generated from protobuf field optional double trueview_average_cpv = 405; * * @return float */ public function getTrueviewAverageCpv() { return isset($this->trueview_average_cpv) ? $this->trueview_average_cpv : 0.0; } public function hasTrueviewAverageCpv() { return isset($this->trueview_average_cpv); } public function clearTrueviewAverageCpv() { unset($this->trueview_average_cpv); } /** * 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. * * Generated from protobuf field optional double trueview_average_cpv = 405; * * @param float $var * @return $this */ public function setTrueviewAverageCpv($var) { GPBUtil::checkDouble($var); $this->trueview_average_cpv = $var; return $this; } /** * Average number of pages viewed per session. * * Generated from protobuf field optional double average_page_views = 208; * * @return float */ public function getAveragePageViews() { return isset($this->average_page_views) ? $this->average_page_views : 0.0; } public function hasAveragePageViews() { return isset($this->average_page_views); } public function clearAveragePageViews() { unset($this->average_page_views); } /** * Average number of pages viewed per session. * * Generated from protobuf field optional double average_page_views = 208; * * @param float $var * @return $this */ public function setAveragePageViews($var) { GPBUtil::checkDouble($var); $this->average_page_views = $var; return $this; } /** * Total duration of all sessions (in seconds) / number of sessions. Imported * from Google Analytics. * * Generated from protobuf field optional double average_time_on_site = 209; * * @return float */ public function getAverageTimeOnSite() { return isset($this->average_time_on_site) ? $this->average_time_on_site : 0.0; } public function hasAverageTimeOnSite() { return isset($this->average_time_on_site); } public function clearAverageTimeOnSite() { unset($this->average_time_on_site); } /** * Total duration of all sessions (in seconds) / number of sessions. Imported * from Google Analytics. * * Generated from protobuf field optional double average_time_on_site = 209; * * @param float $var * @return $this */ public function setAverageTimeOnSite($var) { GPBUtil::checkDouble($var); $this->average_time_on_site = $var; return $this; } /** * An indication of how other advertisers are bidding on similar products. * * Generated from protobuf field optional double benchmark_average_max_cpc = 210; * * @return float */ public function getBenchmarkAverageMaxCpc() { return isset($this->benchmark_average_max_cpc) ? $this->benchmark_average_max_cpc : 0.0; } public function hasBenchmarkAverageMaxCpc() { return isset($this->benchmark_average_max_cpc); } public function clearBenchmarkAverageMaxCpc() { unset($this->benchmark_average_max_cpc); } /** * An indication of how other advertisers are bidding on similar products. * * Generated from protobuf field optional double benchmark_average_max_cpc = 210; * * @param float $var * @return $this */ public function setBenchmarkAverageMaxCpc($var) { GPBUtil::checkDouble($var); $this->benchmark_average_max_cpc = $var; return $this; } /** * Number of app installs. * * Generated from protobuf field optional double biddable_app_install_conversions = 254; * * @return float */ public function getBiddableAppInstallConversions() { return isset($this->biddable_app_install_conversions) ? $this->biddable_app_install_conversions : 0.0; } public function hasBiddableAppInstallConversions() { return isset($this->biddable_app_install_conversions); } public function clearBiddableAppInstallConversions() { unset($this->biddable_app_install_conversions); } /** * Number of app installs. * * Generated from protobuf field optional double biddable_app_install_conversions = 254; * * @param float $var * @return $this */ public function setBiddableAppInstallConversions($var) { GPBUtil::checkDouble($var); $this->biddable_app_install_conversions = $var; return $this; } /** * Number of in-app actions. * * Generated from protobuf field optional double biddable_app_post_install_conversions = 255; * * @return float */ public function getBiddableAppPostInstallConversions() { return isset($this->biddable_app_post_install_conversions) ? $this->biddable_app_post_install_conversions : 0.0; } public function hasBiddableAppPostInstallConversions() { return isset($this->biddable_app_post_install_conversions); } public function clearBiddableAppPostInstallConversions() { unset($this->biddable_app_post_install_conversions); } /** * Number of in-app actions. * * Generated from protobuf field optional double biddable_app_post_install_conversions = 255; * * @param float $var * @return $this */ public function setBiddableAppPostInstallConversions($var) { GPBUtil::checkDouble($var); $this->biddable_app_post_install_conversions = $var; return $this; } /** * Participated in-app actions. The number of in app actions that come * directly or indirectly from the campaign. * * Generated from protobuf field optional double biddable_cohort_app_post_install_conversions = 378; * * @return float */ public function getBiddableCohortAppPostInstallConversions() { return isset($this->biddable_cohort_app_post_install_conversions) ? $this->biddable_cohort_app_post_install_conversions : 0.0; } public function hasBiddableCohortAppPostInstallConversions() { return isset($this->biddable_cohort_app_post_install_conversions); } public function clearBiddableCohortAppPostInstallConversions() { unset($this->biddable_cohort_app_post_install_conversions); } /** * Participated in-app actions. The number of in app actions that come * directly or indirectly from the campaign. * * Generated from protobuf field optional double biddable_cohort_app_post_install_conversions = 378; * * @param float $var * @return $this */ public function setBiddableCohortAppPostInstallConversions($var) { GPBUtil::checkDouble($var); $this->biddable_cohort_app_post_install_conversions = $var; return $this; } /** * 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. * * Generated from protobuf field optional double benchmark_ctr = 211; * * @return float */ public function getBenchmarkCtr() { return isset($this->benchmark_ctr) ? $this->benchmark_ctr : 0.0; } public function hasBenchmarkCtr() { return isset($this->benchmark_ctr); } public function clearBenchmarkCtr() { unset($this->benchmark_ctr); } /** * 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. * * Generated from protobuf field optional double benchmark_ctr = 211; * * @param float $var * @return $this */ public function setBenchmarkCtr($var) { GPBUtil::checkDouble($var); $this->benchmark_ctr = $var; return $this; } /** * Percentage of clicks where the user only visited a single page on your * site. Imported from Google Analytics. * * Generated from protobuf field optional double bounce_rate = 212; * * @return float */ public function getBounceRate() { return isset($this->bounce_rate) ? $this->bounce_rate : 0.0; } public function hasBounceRate() { return isset($this->bounce_rate); } public function clearBounceRate() { unset($this->bounce_rate); } /** * Percentage of clicks where the user only visited a single page on your * site. Imported from Google Analytics. * * Generated from protobuf field optional double bounce_rate = 212; * * @param float $var * @return $this */ public function setBounceRate($var) { GPBUtil::checkDouble($var); $this->bounce_rate = $var; return $this; } /** * The number of clicks. * * Generated from protobuf field optional int64 clicks = 131; * * @return int|string */ public function getClicks() { return isset($this->clicks) ? $this->clicks : 0; } public function hasClicks() { return isset($this->clicks); } public function clearClicks() { unset($this->clicks); } /** * The number of clicks. * * Generated from protobuf field optional int64 clicks = 131; * * @param int|string $var * @return $this */ public function setClicks($var) { GPBUtil::checkInt64($var); $this->clicks = $var; return $this; } /** * 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. * * Generated from protobuf field optional int64 combined_clicks = 156; * * @return int|string */ public function getCombinedClicks() { return isset($this->combined_clicks) ? $this->combined_clicks : 0; } public function hasCombinedClicks() { return isset($this->combined_clicks); } public function clearCombinedClicks() { unset($this->combined_clicks); } /** * 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. * * Generated from protobuf field optional int64 combined_clicks = 156; * * @param int|string $var * @return $this */ public function setCombinedClicks($var) { GPBUtil::checkInt64($var); $this->combined_clicks = $var; return $this; } /** * 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. * * Generated from protobuf field optional double combined_clicks_per_query = 157; * * @return float */ public function getCombinedClicksPerQuery() { return isset($this->combined_clicks_per_query) ? $this->combined_clicks_per_query : 0.0; } public function hasCombinedClicksPerQuery() { return isset($this->combined_clicks_per_query); } public function clearCombinedClicksPerQuery() { unset($this->combined_clicks_per_query); } /** * 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. * * Generated from protobuf field optional double combined_clicks_per_query = 157; * * @param float $var * @return $this */ public function setCombinedClicksPerQuery($var) { GPBUtil::checkDouble($var); $this->combined_clicks_per_query = $var; return $this; } /** * 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. * * Generated from protobuf field optional int64 combined_queries = 158; * * @return int|string */ public function getCombinedQueries() { return isset($this->combined_queries) ? $this->combined_queries : 0; } public function hasCombinedQueries() { return isset($this->combined_queries); } public function clearCombinedQueries() { unset($this->combined_queries); } /** * 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. * * Generated from protobuf field optional int64 combined_queries = 158; * * @param int|string $var * @return $this */ public function setCombinedQueries($var) { GPBUtil::checkInt64($var); $this->combined_queries = $var; return $this; } /** * 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. * * Generated from protobuf field optional double content_budget_lost_impression_share = 159; * * @return float */ public function getContentBudgetLostImpressionShare() { return isset($this->content_budget_lost_impression_share) ? $this->content_budget_lost_impression_share : 0.0; } public function hasContentBudgetLostImpressionShare() { return isset($this->content_budget_lost_impression_share); } public function clearContentBudgetLostImpressionShare() { unset($this->content_budget_lost_impression_share); } /** * 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. * * Generated from protobuf field optional double content_budget_lost_impression_share = 159; * * @param float $var * @return $this */ public function setContentBudgetLostImpressionShare($var) { GPBUtil::checkDouble($var); $this->content_budget_lost_impression_share = $var; return $this; } /** * 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. * * Generated from protobuf field optional double content_impression_share = 160; * * @return float */ public function getContentImpressionShare() { return isset($this->content_impression_share) ? $this->content_impression_share : 0.0; } public function hasContentImpressionShare() { return isset($this->content_impression_share); } public function clearContentImpressionShare() { unset($this->content_impression_share); } /** * 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. * * Generated from protobuf field optional double content_impression_share = 160; * * @param float $var * @return $this */ public function setContentImpressionShare($var) { GPBUtil::checkDouble($var); $this->content_impression_share = $var; return $this; } /** * 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 (for example, 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. * * Generated from protobuf field optional string conversion_last_received_request_date_time = 161; * * @return string */ public function getConversionLastReceivedRequestDateTime() { return isset($this->conversion_last_received_request_date_time) ? $this->conversion_last_received_request_date_time : ''; } public function hasConversionLastReceivedRequestDateTime() { return isset($this->conversion_last_received_request_date_time); } public function clearConversionLastReceivedRequestDateTime() { unset($this->conversion_last_received_request_date_time); } /** * 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 (for example, 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. * * Generated from protobuf field optional string conversion_last_received_request_date_time = 161; * * @param string $var * @return $this */ public function setConversionLastReceivedRequestDateTime($var) { GPBUtil::checkString($var, true); $this->conversion_last_received_request_date_time = $var; return $this; } /** * The date of the most recent conversion for this conversion action. The date * is in the customer's time zone. * * Generated from protobuf field optional string conversion_last_conversion_date = 162; * * @return string */ public function getConversionLastConversionDate() { return isset($this->conversion_last_conversion_date) ? $this->conversion_last_conversion_date : ''; } public function hasConversionLastConversionDate() { return isset($this->conversion_last_conversion_date); } public function clearConversionLastConversionDate() { unset($this->conversion_last_conversion_date); } /** * The date of the most recent conversion for this conversion action. The date * is in the customer's time zone. * * Generated from protobuf field optional string conversion_last_conversion_date = 162; * * @param string $var * @return $this */ public function setConversionLastConversionDate($var) { GPBUtil::checkString($var, true); $this->conversion_last_conversion_date = $var; return $this; } /** * 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. * * Generated from protobuf field optional double content_rank_lost_impression_share = 163; * * @return float */ public function getContentRankLostImpressionShare() { return isset($this->content_rank_lost_impression_share) ? $this->content_rank_lost_impression_share : 0.0; } public function hasContentRankLostImpressionShare() { return isset($this->content_rank_lost_impression_share); } public function clearContentRankLostImpressionShare() { unset($this->content_rank_lost_impression_share); } /** * 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. * * Generated from protobuf field optional double content_rank_lost_impression_share = 163; * * @param float $var * @return $this */ public function setContentRankLostImpressionShare($var) { GPBUtil::checkDouble($var); $this->content_rank_lost_impression_share = $var; return $this; } /** * 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. * * Generated from protobuf field optional double conversions_from_interactions_rate = 164; * * @return float */ public function getConversionsFromInteractionsRate() { return isset($this->conversions_from_interactions_rate) ? $this->conversions_from_interactions_rate : 0.0; } public function hasConversionsFromInteractionsRate() { return isset($this->conversions_from_interactions_rate); } public function clearConversionsFromInteractionsRate() { unset($this->conversions_from_interactions_rate); } /** * 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. * * Generated from protobuf field optional double conversions_from_interactions_rate = 164; * * @param float $var * @return $this */ public function setConversionsFromInteractionsRate($var) { GPBUtil::checkDouble($var); $this->conversions_from_interactions_rate = $var; return $this; } /** * 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. * * Generated from protobuf field optional double conversions_value = 165; * * @return float */ public function getConversionsValue() { return isset($this->conversions_value) ? $this->conversions_value : 0.0; } public function hasConversionsValue() { return isset($this->conversions_value); } public function clearConversionsValue() { unset($this->conversions_value); } /** * 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. * * Generated from protobuf field optional double conversions_value = 165; * * @param float $var * @return $this */ public function setConversionsValue($var) { GPBUtil::checkDouble($var); $this->conversions_value = $var; return $this; } /** * 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. * * Generated from protobuf field optional double conversions_value_by_conversion_date = 242; * * @return float */ public function getConversionsValueByConversionDate() { return isset($this->conversions_value_by_conversion_date) ? $this->conversions_value_by_conversion_date : 0.0; } public function hasConversionsValueByConversionDate() { return isset($this->conversions_value_by_conversion_date); } public function clearConversionsValueByConversionDate() { unset($this->conversions_value_by_conversion_date); } /** * 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. * * Generated from protobuf field optional double conversions_value_by_conversion_date = 242; * * @param float $var * @return $this */ public function setConversionsValueByConversionDate($var) { GPBUtil::checkDouble($var); $this->conversions_value_by_conversion_date = $var; return $this; } /** * 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. * * Generated from protobuf field optional double new_customer_lifetime_value = 293; * * @return float */ public function getNewCustomerLifetimeValue() { return isset($this->new_customer_lifetime_value) ? $this->new_customer_lifetime_value : 0.0; } public function hasNewCustomerLifetimeValue() { return isset($this->new_customer_lifetime_value); } public function clearNewCustomerLifetimeValue() { unset($this->new_customer_lifetime_value); } /** * 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. * * Generated from protobuf field optional double new_customer_lifetime_value = 293; * * @param float $var * @return $this */ public function setNewCustomerLifetimeValue($var) { GPBUtil::checkDouble($var); $this->new_customer_lifetime_value = $var; return $this; } /** * 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. * * Generated from protobuf field optional double conversions_value_per_cost = 166; * * @return float */ public function getConversionsValuePerCost() { return isset($this->conversions_value_per_cost) ? $this->conversions_value_per_cost : 0.0; } public function hasConversionsValuePerCost() { return isset($this->conversions_value_per_cost); } public function clearConversionsValuePerCost() { unset($this->conversions_value_per_cost); } /** * 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. * * Generated from protobuf field optional double conversions_value_per_cost = 166; * * @param float $var * @return $this */ public function setConversionsValuePerCost($var) { GPBUtil::checkDouble($var); $this->conversions_value_per_cost = $var; return $this; } /** * 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. * * Generated from protobuf field optional double conversions_from_interactions_value_per_interaction = 167; * * @return float */ public function getConversionsFromInteractionsValuePerInteraction() { return isset($this->conversions_from_interactions_value_per_interaction) ? $this->conversions_from_interactions_value_per_interaction : 0.0; } public function hasConversionsFromInteractionsValuePerInteraction() { return isset($this->conversions_from_interactions_value_per_interaction); } public function clearConversionsFromInteractionsValuePerInteraction() { unset($this->conversions_from_interactions_value_per_interaction); } /** * 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. * * Generated from protobuf field optional double conversions_from_interactions_value_per_interaction = 167; * * @param float $var * @return $this */ public function setConversionsFromInteractionsValuePerInteraction($var) { GPBUtil::checkDouble($var); $this->conversions_from_interactions_value_per_interaction = $var; return $this; } /** * 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. * * Generated from protobuf field optional double conversions = 168; * * @return float */ public function getConversions() { return isset($this->conversions) ? $this->conversions : 0.0; } public function hasConversions() { return isset($this->conversions); } public function clearConversions() { unset($this->conversions); } /** * 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. * * Generated from protobuf field optional double conversions = 168; * * @param float $var * @return $this */ public function setConversions($var) { GPBUtil::checkDouble($var); $this->conversions = $var; return $this; } /** * 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. * * Generated from protobuf field optional double conversions_by_conversion_date = 243; * * @return float */ public function getConversionsByConversionDate() { return isset($this->conversions_by_conversion_date) ? $this->conversions_by_conversion_date : 0.0; } public function hasConversionsByConversionDate() { return isset($this->conversions_by_conversion_date); } public function clearConversionsByConversionDate() { unset($this->conversions_by_conversion_date); } /** * 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. * * Generated from protobuf field optional double conversions_by_conversion_date = 243; * * @param float $var * @return $this */ public function setConversionsByConversionDate($var) { GPBUtil::checkDouble($var); $this->conversions_by_conversion_date = $var; return $this; } /** * The sum of your cost-per-click (CPC) and cost-per-thousand impressions * (CPM) costs during this period. * * Generated from protobuf field optional int64 cost_micros = 169; * * @return int|string */ public function getCostMicros() { return isset($this->cost_micros) ? $this->cost_micros : 0; } public function hasCostMicros() { return isset($this->cost_micros); } public function clearCostMicros() { unset($this->cost_micros); } /** * The sum of your cost-per-click (CPC) and cost-per-thousand impressions * (CPM) costs during this period. * * Generated from protobuf field optional int64 cost_micros = 169; * * @param int|string $var * @return $this */ public function setCostMicros($var) { GPBUtil::checkInt64($var); $this->cost_micros = $var; return $this; } /** * The cost of ad interactions divided by all conversions. * * Generated from protobuf field optional double cost_per_all_conversions = 170; * * @return float */ public function getCostPerAllConversions() { return isset($this->cost_per_all_conversions) ? $this->cost_per_all_conversions : 0.0; } public function hasCostPerAllConversions() { return isset($this->cost_per_all_conversions); } public function clearCostPerAllConversions() { unset($this->cost_per_all_conversions); } /** * The cost of ad interactions divided by all conversions. * * Generated from protobuf field optional double cost_per_all_conversions = 170; * * @param float $var * @return $this */ public function setCostPerAllConversions($var) { GPBUtil::checkDouble($var); $this->cost_per_all_conversions = $var; return $this; } /** * 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. * * Generated from protobuf field optional double cost_per_conversion = 171; * * @return float */ public function getCostPerConversion() { return isset($this->cost_per_conversion) ? $this->cost_per_conversion : 0.0; } public function hasCostPerConversion() { return isset($this->cost_per_conversion); } public function clearCostPerConversion() { unset($this->cost_per_conversion); } /** * 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. * * Generated from protobuf field optional double cost_per_conversion = 171; * * @param float $var * @return $this */ public function setCostPerConversion($var) { GPBUtil::checkDouble($var); $this->cost_per_conversion = $var; return $this; } /** * 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. * * Generated from protobuf field optional double cost_per_current_model_attributed_conversion = 172; * * @return float */ public function getCostPerCurrentModelAttributedConversion() { return isset($this->cost_per_current_model_attributed_conversion) ? $this->cost_per_current_model_attributed_conversion : 0.0; } public function hasCostPerCurrentModelAttributedConversion() { return isset($this->cost_per_current_model_attributed_conversion); } public function clearCostPerCurrentModelAttributedConversion() { unset($this->cost_per_current_model_attributed_conversion); } /** * 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. * * Generated from protobuf field optional double cost_per_current_model_attributed_conversion = 172; * * @param float $var * @return $this */ public function setCostPerCurrentModelAttributedConversion($var) { GPBUtil::checkDouble($var); $this->cost_per_current_model_attributed_conversion = $var; return $this; } /** * 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. * * Generated from protobuf field optional double cross_device_conversions = 173; * * @return float */ public function getCrossDeviceConversions() { return isset($this->cross_device_conversions) ? $this->cross_device_conversions : 0.0; } public function hasCrossDeviceConversions() { return isset($this->cross_device_conversions); } public function clearCrossDeviceConversions() { unset($this->cross_device_conversions); } /** * 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. * * Generated from protobuf field optional double cross_device_conversions = 173; * * @param float $var * @return $this */ public function setCrossDeviceConversions($var) { GPBUtil::checkDouble($var); $this->cross_device_conversions = $var; return $this; } /** * The number of cross-device conversions by conversion date. * Details for the by_conversion_date columns are available at * https://support.google.com/google-ads/answer/9549009. * * Generated from protobuf field optional double cross_device_conversions_by_conversion_date = 372; * * @return float */ public function getCrossDeviceConversionsByConversionDate() { return isset($this->cross_device_conversions_by_conversion_date) ? $this->cross_device_conversions_by_conversion_date : 0.0; } public function hasCrossDeviceConversionsByConversionDate() { return isset($this->cross_device_conversions_by_conversion_date); } public function clearCrossDeviceConversionsByConversionDate() { unset($this->cross_device_conversions_by_conversion_date); } /** * The number of cross-device conversions by conversion date. * Details for the by_conversion_date columns are available at * https://support.google.com/google-ads/answer/9549009. * * Generated from protobuf field optional double cross_device_conversions_by_conversion_date = 372; * * @param float $var * @return $this */ public function setCrossDeviceConversionsByConversionDate($var) { GPBUtil::checkDouble($var); $this->cross_device_conversions_by_conversion_date = $var; return $this; } /** * The sum of the value of cross-device conversions. * * Generated from protobuf field optional double cross_device_conversions_value = 253; * * @return float */ public function getCrossDeviceConversionsValue() { return isset($this->cross_device_conversions_value) ? $this->cross_device_conversions_value : 0.0; } public function hasCrossDeviceConversionsValue() { return isset($this->cross_device_conversions_value); } public function clearCrossDeviceConversionsValue() { unset($this->cross_device_conversions_value); } /** * The sum of the value of cross-device conversions. * * Generated from protobuf field optional double cross_device_conversions_value = 253; * * @param float $var * @return $this */ public function setCrossDeviceConversionsValue($var) { GPBUtil::checkDouble($var); $this->cross_device_conversions_value = $var; return $this; } /** * The sum of the value of cross-device conversions, in micros. * * Generated from protobuf field optional int64 cross_device_conversions_value_micros = 312; * * @return int|string */ public function getCrossDeviceConversionsValueMicros() { return isset($this->cross_device_conversions_value_micros) ? $this->cross_device_conversions_value_micros : 0; } public function hasCrossDeviceConversionsValueMicros() { return isset($this->cross_device_conversions_value_micros); } public function clearCrossDeviceConversionsValueMicros() { unset($this->cross_device_conversions_value_micros); } /** * The sum of the value of cross-device conversions, in micros. * * Generated from protobuf field optional int64 cross_device_conversions_value_micros = 312; * * @param int|string $var * @return $this */ public function setCrossDeviceConversionsValueMicros($var) { GPBUtil::checkInt64($var); $this->cross_device_conversions_value_micros = $var; return $this; } /** * The sum of cross-device conversions value by conversion date. * Details for the by_conversion_date columns are available at * https://support.google.com/google-ads/answer/9549009. * * Generated from protobuf field optional double cross_device_conversions_value_by_conversion_date = 373; * * @return float */ public function getCrossDeviceConversionsValueByConversionDate() { return isset($this->cross_device_conversions_value_by_conversion_date) ? $this->cross_device_conversions_value_by_conversion_date : 0.0; } public function hasCrossDeviceConversionsValueByConversionDate() { return isset($this->cross_device_conversions_value_by_conversion_date); } public function clearCrossDeviceConversionsValueByConversionDate() { unset($this->cross_device_conversions_value_by_conversion_date); } /** * The sum of cross-device conversions value by conversion date. * Details for the by_conversion_date columns are available at * https://support.google.com/google-ads/answer/9549009. * * Generated from protobuf field optional double cross_device_conversions_value_by_conversion_date = 373; * * @param float $var * @return $this */ public function setCrossDeviceConversionsValueByConversionDate($var) { GPBUtil::checkDouble($var); $this->cross_device_conversions_value_by_conversion_date = $var; return $this; } /** * The number of clicks your ad receives (Clicks) divided by the number * of times your ad is shown (Impressions). * * Generated from protobuf field optional double ctr = 174; * * @return float */ public function getCtr() { return isset($this->ctr) ? $this->ctr : 0.0; } public function hasCtr() { return isset($this->ctr); } public function clearCtr() { unset($this->ctr); } /** * The number of clicks your ad receives (Clicks) divided by the number * of times your ad is shown (Impressions). * * Generated from protobuf field optional double ctr = 174; * * @param float $var * @return $this */ public function setCtr($var) { GPBUtil::checkDouble($var); $this->ctr = $var; return $this; } /** * 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. * * Generated from protobuf field optional double current_model_attributed_conversions = 175; * * @return float */ public function getCurrentModelAttributedConversions() { return isset($this->current_model_attributed_conversions) ? $this->current_model_attributed_conversions : 0.0; } public function hasCurrentModelAttributedConversions() { return isset($this->current_model_attributed_conversions); } public function clearCurrentModelAttributedConversions() { unset($this->current_model_attributed_conversions); } /** * 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. * * Generated from protobuf field optional double current_model_attributed_conversions = 175; * * @param float $var * @return $this */ public function setCurrentModelAttributedConversions($var) { GPBUtil::checkDouble($var); $this->current_model_attributed_conversions = $var; return $this; } /** * 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. * * Generated from protobuf field optional double current_model_attributed_conversions_from_interactions_rate = 176; * * @return float */ public function getCurrentModelAttributedConversionsFromInteractionsRate() { return isset($this->current_model_attributed_conversions_from_interactions_rate) ? $this->current_model_attributed_conversions_from_interactions_rate : 0.0; } public function hasCurrentModelAttributedConversionsFromInteractionsRate() { return isset($this->current_model_attributed_conversions_from_interactions_rate); } public function clearCurrentModelAttributedConversionsFromInteractionsRate() { unset($this->current_model_attributed_conversions_from_interactions_rate); } /** * 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. * * Generated from protobuf field optional double current_model_attributed_conversions_from_interactions_rate = 176; * * @param float $var * @return $this */ public function setCurrentModelAttributedConversionsFromInteractionsRate($var) { GPBUtil::checkDouble($var); $this->current_model_attributed_conversions_from_interactions_rate = $var; return $this; } /** * 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. * * Generated from protobuf field optional double current_model_attributed_conversions_from_interactions_value_per_interaction = 177; * * @return float */ public function getCurrentModelAttributedConversionsFromInteractionsValuePerInteraction() { return isset($this->current_model_attributed_conversions_from_interactions_value_per_interaction) ? $this->current_model_attributed_conversions_from_interactions_value_per_interaction : 0.0; } public function hasCurrentModelAttributedConversionsFromInteractionsValuePerInteraction() { return isset($this->current_model_attributed_conversions_from_interactions_value_per_interaction); } public function clearCurrentModelAttributedConversionsFromInteractionsValuePerInteraction() { unset($this->current_model_attributed_conversions_from_interactions_value_per_interaction); } /** * 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. * * Generated from protobuf field optional double current_model_attributed_conversions_from_interactions_value_per_interaction = 177; * * @param float $var * @return $this */ public function setCurrentModelAttributedConversionsFromInteractionsValuePerInteraction($var) { GPBUtil::checkDouble($var); $this->current_model_attributed_conversions_from_interactions_value_per_interaction = $var; return $this; } /** * 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. * * Generated from protobuf field optional double current_model_attributed_conversions_value = 178; * * @return float */ public function getCurrentModelAttributedConversionsValue() { return isset($this->current_model_attributed_conversions_value) ? $this->current_model_attributed_conversions_value : 0.0; } public function hasCurrentModelAttributedConversionsValue() { return isset($this->current_model_attributed_conversions_value); } public function clearCurrentModelAttributedConversionsValue() { unset($this->current_model_attributed_conversions_value); } /** * 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. * * Generated from protobuf field optional double current_model_attributed_conversions_value = 178; * * @param float $var * @return $this */ public function setCurrentModelAttributedConversionsValue($var) { GPBUtil::checkDouble($var); $this->current_model_attributed_conversions_value = $var; return $this; } /** * 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. * * Generated from protobuf field optional double current_model_attributed_conversions_value_per_cost = 179; * * @return float */ public function getCurrentModelAttributedConversionsValuePerCost() { return isset($this->current_model_attributed_conversions_value_per_cost) ? $this->current_model_attributed_conversions_value_per_cost : 0.0; } public function hasCurrentModelAttributedConversionsValuePerCost() { return isset($this->current_model_attributed_conversions_value_per_cost); } public function clearCurrentModelAttributedConversionsValuePerCost() { unset($this->current_model_attributed_conversions_value_per_cost); } /** * 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. * * Generated from protobuf field optional double current_model_attributed_conversions_value_per_cost = 179; * * @param float $var * @return $this */ public function setCurrentModelAttributedConversionsValuePerCost($var) { GPBUtil::checkDouble($var); $this->current_model_attributed_conversions_value_per_cost = $var; return $this; } /** * 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. * * Generated from protobuf field optional double engagement_rate = 180; * * @return float */ public function getEngagementRate() { return isset($this->engagement_rate) ? $this->engagement_rate : 0.0; } public function hasEngagementRate() { return isset($this->engagement_rate); } public function clearEngagementRate() { unset($this->engagement_rate); } /** * 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. * * Generated from protobuf field optional double engagement_rate = 180; * * @param float $var * @return $this */ public function setEngagementRate($var) { GPBUtil::checkDouble($var); $this->engagement_rate = $var; return $this; } /** * 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. * * Generated from protobuf field optional int64 engagements = 181; * * @return int|string */ public function getEngagements() { return isset($this->engagements) ? $this->engagements : 0; } public function hasEngagements() { return isset($this->engagements); } public function clearEngagements() { unset($this->engagements); } /** * 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. * * Generated from protobuf field optional int64 engagements = 181; * * @param int|string $var * @return $this */ public function setEngagements($var) { GPBUtil::checkInt64($var); $this->engagements = $var; return $this; } /** * Average lead value based on clicks. * * Generated from protobuf field optional double hotel_average_lead_value_micros = 213; * * @return float */ public function getHotelAverageLeadValueMicros() { return isset($this->hotel_average_lead_value_micros) ? $this->hotel_average_lead_value_micros : 0.0; } public function hasHotelAverageLeadValueMicros() { return isset($this->hotel_average_lead_value_micros); } public function clearHotelAverageLeadValueMicros() { unset($this->hotel_average_lead_value_micros); } /** * Average lead value based on clicks. * * Generated from protobuf field optional double hotel_average_lead_value_micros = 213; * * @param float $var * @return $this */ public function setHotelAverageLeadValueMicros($var) { GPBUtil::checkDouble($var); $this->hotel_average_lead_value_micros = $var; return $this; } /** * Commission bid rate in micros. A 20% commission is represented as * 200,000. * * Generated from protobuf field optional int64 hotel_commission_rate_micros = 256; * * @return int|string */ public function getHotelCommissionRateMicros() { return isset($this->hotel_commission_rate_micros) ? $this->hotel_commission_rate_micros : 0; } public function hasHotelCommissionRateMicros() { return isset($this->hotel_commission_rate_micros); } public function clearHotelCommissionRateMicros() { unset($this->hotel_commission_rate_micros); } /** * Commission bid rate in micros. A 20% commission is represented as * 200,000. * * Generated from protobuf field optional int64 hotel_commission_rate_micros = 256; * * @param int|string $var * @return $this */ public function setHotelCommissionRateMicros($var) { GPBUtil::checkInt64($var); $this->hotel_commission_rate_micros = $var; return $this; } /** * Expected commission cost. The result of multiplying the commission value * times the hotel_commission_rate in advertiser currency. * * Generated from protobuf field optional double hotel_expected_commission_cost = 257; * * @return float */ public function getHotelExpectedCommissionCost() { return isset($this->hotel_expected_commission_cost) ? $this->hotel_expected_commission_cost : 0.0; } public function hasHotelExpectedCommissionCost() { return isset($this->hotel_expected_commission_cost); } public function clearHotelExpectedCommissionCost() { unset($this->hotel_expected_commission_cost); } /** * Expected commission cost. The result of multiplying the commission value * times the hotel_commission_rate in advertiser currency. * * Generated from protobuf field optional double hotel_expected_commission_cost = 257; * * @param float $var * @return $this */ public function setHotelExpectedCommissionCost($var) { GPBUtil::checkDouble($var); $this->hotel_expected_commission_cost = $var; return $this; } /** * The average price difference between the price offered by reporting hotel * advertiser and the cheapest price offered by the competing advertiser. * * Generated from protobuf field optional double hotel_price_difference_percentage = 214; * * @return float */ public function getHotelPriceDifferencePercentage() { return isset($this->hotel_price_difference_percentage) ? $this->hotel_price_difference_percentage : 0.0; } public function hasHotelPriceDifferencePercentage() { return isset($this->hotel_price_difference_percentage); } public function clearHotelPriceDifferencePercentage() { unset($this->hotel_price_difference_percentage); } /** * The average price difference between the price offered by reporting hotel * advertiser and the cheapest price offered by the competing advertiser. * * Generated from protobuf field optional double hotel_price_difference_percentage = 214; * * @param float $var * @return $this */ public function setHotelPriceDifferencePercentage($var) { GPBUtil::checkDouble($var); $this->hotel_price_difference_percentage = $var; return $this; } /** * The number of impressions that hotel partners could have had given their * feed performance. * * Generated from protobuf field optional int64 hotel_eligible_impressions = 215; * * @return int|string */ public function getHotelEligibleImpressions() { return isset($this->hotel_eligible_impressions) ? $this->hotel_eligible_impressions : 0; } public function hasHotelEligibleImpressions() { return isset($this->hotel_eligible_impressions); } public function clearHotelEligibleImpressions() { unset($this->hotel_eligible_impressions); } /** * The number of impressions that hotel partners could have had given their * feed performance. * * Generated from protobuf field optional int64 hotel_eligible_impressions = 215; * * @param int|string $var * @return $this */ public function setHotelEligibleImpressions($var) { GPBUtil::checkInt64($var); $this->hotel_eligible_impressions = $var; return $this; } /** * The creative historical quality score. * * Generated from protobuf field .google.ads.googleads.v23.enums.QualityScoreBucketEnum.QualityScoreBucket historical_creative_quality_score = 80; * * @return int */ public function getHistoricalCreativeQualityScore() { return $this->historical_creative_quality_score; } /** * The creative historical quality score. * * Generated from protobuf field .google.ads.googleads.v23.enums.QualityScoreBucketEnum.QualityScoreBucket historical_creative_quality_score = 80; * * @param int $var * @return $this */ public function setHistoricalCreativeQualityScore($var) { GPBUtil::checkEnum($var, \Google\Ads\GoogleAds\V23\Enums\QualityScoreBucketEnum\QualityScoreBucket::class); $this->historical_creative_quality_score = $var; return $this; } /** * The quality of historical landing page experience. * * Generated from protobuf field .google.ads.googleads.v23.enums.QualityScoreBucketEnum.QualityScoreBucket historical_landing_page_quality_score = 81; * * @return int */ public function getHistoricalLandingPageQualityScore() { return $this->historical_landing_page_quality_score; } /** * The quality of historical landing page experience. * * Generated from protobuf field .google.ads.googleads.v23.enums.QualityScoreBucketEnum.QualityScoreBucket historical_landing_page_quality_score = 81; * * @param int $var * @return $this */ public function setHistoricalLandingPageQualityScore($var) { GPBUtil::checkEnum($var, \Google\Ads\GoogleAds\V23\Enums\QualityScoreBucketEnum\QualityScoreBucket::class); $this->historical_landing_page_quality_score = $var; return $this; } /** * The historical quality score. * * Generated from protobuf field optional int64 historical_quality_score = 216; * * @return int|string */ public function getHistoricalQualityScore() { return isset($this->historical_quality_score) ? $this->historical_quality_score : 0; } public function hasHistoricalQualityScore() { return isset($this->historical_quality_score); } public function clearHistoricalQualityScore() { unset($this->historical_quality_score); } /** * The historical quality score. * * Generated from protobuf field optional int64 historical_quality_score = 216; * * @param int|string $var * @return $this */ public function setHistoricalQualityScore($var) { GPBUtil::checkInt64($var); $this->historical_quality_score = $var; return $this; } /** * The historical search predicted click through rate (CTR). * * Generated from protobuf field .google.ads.googleads.v23.enums.QualityScoreBucketEnum.QualityScoreBucket historical_search_predicted_ctr = 83; * * @return int */ public function getHistoricalSearchPredictedCtr() { return $this->historical_search_predicted_ctr; } /** * The historical search predicted click through rate (CTR). * * Generated from protobuf field .google.ads.googleads.v23.enums.QualityScoreBucketEnum.QualityScoreBucket historical_search_predicted_ctr = 83; * * @param int $var * @return $this */ public function setHistoricalSearchPredictedCtr($var) { GPBUtil::checkEnum($var, \Google\Ads\GoogleAds\V23\Enums\QualityScoreBucketEnum\QualityScoreBucket::class); $this->historical_search_predicted_ctr = $var; return $this; } /** * The number of times the ad was forwarded to someone else as a message. * * Generated from protobuf field optional int64 gmail_forwards = 217; * * @return int|string */ public function getGmailForwards() { return isset($this->gmail_forwards) ? $this->gmail_forwards : 0; } public function hasGmailForwards() { return isset($this->gmail_forwards); } public function clearGmailForwards() { unset($this->gmail_forwards); } /** * The number of times the ad was forwarded to someone else as a message. * * Generated from protobuf field optional int64 gmail_forwards = 217; * * @param int|string $var * @return $this */ public function setGmailForwards($var) { GPBUtil::checkInt64($var); $this->gmail_forwards = $var; return $this; } /** * The number of times someone has saved your Gmail ad to their inbox as a * message. * * Generated from protobuf field optional int64 gmail_saves = 218; * * @return int|string */ public function getGmailSaves() { return isset($this->gmail_saves) ? $this->gmail_saves : 0; } public function hasGmailSaves() { return isset($this->gmail_saves); } public function clearGmailSaves() { unset($this->gmail_saves); } /** * The number of times someone has saved your Gmail ad to their inbox as a * message. * * Generated from protobuf field optional int64 gmail_saves = 218; * * @param int|string $var * @return $this */ public function setGmailSaves($var) { GPBUtil::checkInt64($var); $this->gmail_saves = $var; return $this; } /** * The number of clicks to the landing page on the expanded state of Gmail * ads. * * Generated from protobuf field optional int64 gmail_secondary_clicks = 219; * * @return int|string */ public function getGmailSecondaryClicks() { return isset($this->gmail_secondary_clicks) ? $this->gmail_secondary_clicks : 0; } public function hasGmailSecondaryClicks() { return isset($this->gmail_secondary_clicks); } public function clearGmailSecondaryClicks() { unset($this->gmail_secondary_clicks); } /** * The number of clicks to the landing page on the expanded state of Gmail * ads. * * Generated from protobuf field optional int64 gmail_secondary_clicks = 219; * * @param int|string $var * @return $this */ public function setGmailSecondaryClicks($var) { GPBUtil::checkInt64($var); $this->gmail_secondary_clicks = $var; return $this; } /** * The number of times a business's location-based ad was shown. * This metric applies to feed items only. * * Generated from protobuf field optional int64 impressions_from_store_reach = 220; * * @return int|string */ public function getImpressionsFromStoreReach() { return isset($this->impressions_from_store_reach) ? $this->impressions_from_store_reach : 0; } public function hasImpressionsFromStoreReach() { return isset($this->impressions_from_store_reach); } public function clearImpressionsFromStoreReach() { unset($this->impressions_from_store_reach); } /** * The number of times a business's location-based ad was shown. * This metric applies to feed items only. * * Generated from protobuf field optional int64 impressions_from_store_reach = 220; * * @param int|string $var * @return $this */ public function setImpressionsFromStoreReach($var) { GPBUtil::checkInt64($var); $this->impressions_from_store_reach = $var; return $this; } /** * Count of how often your ad has appeared on a search results page or * website on the Google Network. * * Generated from protobuf field optional int64 impressions = 221; * * @return int|string */ public function getImpressions() { return isset($this->impressions) ? $this->impressions : 0; } public function hasImpressions() { return isset($this->impressions); } public function clearImpressions() { unset($this->impressions); } /** * Count of how often your ad has appeared on a search results page or * website on the Google Network. * * Generated from protobuf field optional int64 impressions = 221; * * @param int|string $var * @return $this */ public function setImpressions($var) { GPBUtil::checkInt64($var); $this->impressions = $var; return $this; } /** * 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. * * Generated from protobuf field optional double interaction_rate = 222; * * @return float */ public function getInteractionRate() { return isset($this->interaction_rate) ? $this->interaction_rate : 0.0; } public function hasInteractionRate() { return isset($this->interaction_rate); } public function clearInteractionRate() { unset($this->interaction_rate); } /** * 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. * * Generated from protobuf field optional double interaction_rate = 222; * * @param float $var * @return $this */ public function setInteractionRate($var) { GPBUtil::checkDouble($var); $this->interaction_rate = $var; return $this; } /** * 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. * * Generated from protobuf field optional int64 interactions = 223; * * @return int|string */ public function getInteractions() { return isset($this->interactions) ? $this->interactions : 0; } public function hasInteractions() { return isset($this->interactions); } public function clearInteractions() { unset($this->interactions); } /** * 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. * * Generated from protobuf field optional int64 interactions = 223; * * @param int|string $var * @return $this */ public function setInteractions($var) { GPBUtil::checkInt64($var); $this->interactions = $var; return $this; } /** * The types of payable and free interactions. * * Generated from protobuf field repeated .google.ads.googleads.v23.enums.InteractionEventTypeEnum.InteractionEventType interaction_event_types = 100; * * @return RepeatedField */ public function getInteractionEventTypes() { return $this->interaction_event_types; } /** * The types of payable and free interactions. * * Generated from protobuf field repeated .google.ads.googleads.v23.enums.InteractionEventTypeEnum.InteractionEventType interaction_event_types = 100; * * @param int[] $var * @return $this */ public function setInteractionEventTypes($var) { $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::ENUM, \Google\Ads\GoogleAds\V23\Enums\InteractionEventTypeEnum\InteractionEventType::class); $this->interaction_event_types = $arr; return $this; } /** * The percentage of clicks filtered out of your total number of clicks * (filtered + non-filtered clicks) during the reporting period. * * Generated from protobuf field optional double invalid_click_rate = 224; * * @return float */ public function getInvalidClickRate() { return isset($this->invalid_click_rate) ? $this->invalid_click_rate : 0.0; } public function hasInvalidClickRate() { return isset($this->invalid_click_rate); } public function clearInvalidClickRate() { unset($this->invalid_click_rate); } /** * The percentage of clicks filtered out of your total number of clicks * (filtered + non-filtered clicks) during the reporting period. * * Generated from protobuf field optional double invalid_click_rate = 224; * * @param float $var * @return $this */ public function setInvalidClickRate($var) { GPBUtil::checkDouble($var); $this->invalid_click_rate = $var; return $this; } /** * Number of clicks Google considers illegitimate and doesn't charge you for. * * Generated from protobuf field optional int64 invalid_clicks = 225; * * @return int|string */ public function getInvalidClicks() { return isset($this->invalid_clicks) ? $this->invalid_clicks : 0; } public function hasInvalidClicks() { return isset($this->invalid_clicks); } public function clearInvalidClicks() { unset($this->invalid_clicks); } /** * Number of clicks Google considers illegitimate and doesn't charge you for. * * Generated from protobuf field optional int64 invalid_clicks = 225; * * @param int|string $var * @return $this */ public function setInvalidClicks($var) { GPBUtil::checkInt64($var); $this->invalid_clicks = $var; return $this; } /** * The percentage of clicks that have been filtered out of your total number * of clicks (filtered + non-filtered clicks) due to being general invalid * clicks. These are clicks Google considers illegitimate that are detected * through routine means of filtration (that is, known invalid data-center * traffic, bots and spiders or other crawlers, irregular patterns, etc). * You're not charged for them, and they don't affect your account statistics. * See the help page at * https://support.google.com/campaignmanager/answer/6076504 for * details. * * Generated from protobuf field optional double general_invalid_click_rate = 370; * * @return float */ public function getGeneralInvalidClickRate() { return isset($this->general_invalid_click_rate) ? $this->general_invalid_click_rate : 0.0; } public function hasGeneralInvalidClickRate() { return isset($this->general_invalid_click_rate); } public function clearGeneralInvalidClickRate() { unset($this->general_invalid_click_rate); } /** * The percentage of clicks that have been filtered out of your total number * of clicks (filtered + non-filtered clicks) due to being general invalid * clicks. These are clicks Google considers illegitimate that are detected * through routine means of filtration (that is, known invalid data-center * traffic, bots and spiders or other crawlers, irregular patterns, etc). * You're not charged for them, and they don't affect your account statistics. * See the help page at * https://support.google.com/campaignmanager/answer/6076504 for * details. * * Generated from protobuf field optional double general_invalid_click_rate = 370; * * @param float $var * @return $this */ public function setGeneralInvalidClickRate($var) { GPBUtil::checkDouble($var); $this->general_invalid_click_rate = $var; return $this; } /** * Number of general invalid clicks. These are a subset of your invalid clicks * that are detected through routine means of filtration (such as known * invalid data-center traffic, bots and spiders or other crawlers, irregular * patterns, etc.). You're not charged for them, and they don't affect your * account statistics. See the help page at * https://support.google.com/campaignmanager/answer/6076504 for * details. * * Generated from protobuf field optional int64 general_invalid_clicks = 371; * * @return int|string */ public function getGeneralInvalidClicks() { return isset($this->general_invalid_clicks) ? $this->general_invalid_clicks : 0; } public function hasGeneralInvalidClicks() { return isset($this->general_invalid_clicks); } public function clearGeneralInvalidClicks() { unset($this->general_invalid_clicks); } /** * Number of general invalid clicks. These are a subset of your invalid clicks * that are detected through routine means of filtration (such as known * invalid data-center traffic, bots and spiders or other crawlers, irregular * patterns, etc.). You're not charged for them, and they don't affect your * account statistics. See the help page at * https://support.google.com/campaignmanager/answer/6076504 for * details. * * Generated from protobuf field optional int64 general_invalid_clicks = 371; * * @param int|string $var * @return $this */ public function setGeneralInvalidClicks($var) { GPBUtil::checkInt64($var); $this->general_invalid_clicks = $var; return $this; } /** * Number of message chats initiated for Click To Message impressions that * were message tracking eligible. * * Generated from protobuf field optional int64 message_chats = 226; * * @return int|string */ public function getMessageChats() { return isset($this->message_chats) ? $this->message_chats : 0; } public function hasMessageChats() { return isset($this->message_chats); } public function clearMessageChats() { unset($this->message_chats); } /** * Number of message chats initiated for Click To Message impressions that * were message tracking eligible. * * Generated from protobuf field optional int64 message_chats = 226; * * @param int|string $var * @return $this */ public function setMessageChats($var) { GPBUtil::checkInt64($var); $this->message_chats = $var; return $this; } /** * Number of Click To Message impressions that were message tracking eligible. * * Generated from protobuf field optional int64 message_impressions = 227; * * @return int|string */ public function getMessageImpressions() { return isset($this->message_impressions) ? $this->message_impressions : 0; } public function hasMessageImpressions() { return isset($this->message_impressions); } public function clearMessageImpressions() { unset($this->message_impressions); } /** * Number of Click To Message impressions that were message tracking eligible. * * Generated from protobuf field optional int64 message_impressions = 227; * * @param int|string $var * @return $this */ public function setMessageImpressions($var) { GPBUtil::checkInt64($var); $this->message_impressions = $var; return $this; } /** * 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. * * Generated from protobuf field optional double message_chat_rate = 228; * * @return float */ public function getMessageChatRate() { return isset($this->message_chat_rate) ? $this->message_chat_rate : 0.0; } public function hasMessageChatRate() { return isset($this->message_chat_rate); } public function clearMessageChatRate() { unset($this->message_chat_rate); } /** * 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. * * Generated from protobuf field optional double message_chat_rate = 228; * * @param float $var * @return $this */ public function setMessageChatRate($var) { GPBUtil::checkDouble($var); $this->message_chat_rate = $var; return $this; } /** * The percentage of mobile clicks that go to a mobile-friendly page. * * Generated from protobuf field optional double mobile_friendly_clicks_percentage = 229; * * @return float */ public function getMobileFriendlyClicksPercentage() { return isset($this->mobile_friendly_clicks_percentage) ? $this->mobile_friendly_clicks_percentage : 0.0; } public function hasMobileFriendlyClicksPercentage() { return isset($this->mobile_friendly_clicks_percentage); } public function clearMobileFriendlyClicksPercentage() { unset($this->mobile_friendly_clicks_percentage); } /** * The percentage of mobile clicks that go to a mobile-friendly page. * * Generated from protobuf field optional double mobile_friendly_clicks_percentage = 229; * * @param float $var * @return $this */ public function setMobileFriendlyClicksPercentage($var) { GPBUtil::checkDouble($var); $this->mobile_friendly_clicks_percentage = $var; return $this; } /** * Total optimization score uplift of all recommendations. * * Generated from protobuf field optional double optimization_score_uplift = 247; * * @return float */ public function getOptimizationScoreUplift() { return isset($this->optimization_score_uplift) ? $this->optimization_score_uplift : 0.0; } public function hasOptimizationScoreUplift() { return isset($this->optimization_score_uplift); } public function clearOptimizationScoreUplift() { unset($this->optimization_score_uplift); } /** * Total optimization score uplift of all recommendations. * * Generated from protobuf field optional double optimization_score_uplift = 247; * * @param float $var * @return $this */ public function setOptimizationScoreUplift($var) { GPBUtil::checkDouble($var); $this->optimization_score_uplift = $var; return $this; } /** * 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. * * Generated from protobuf field optional string optimization_score_url = 248; * * @return string */ public function getOptimizationScoreUrl() { return isset($this->optimization_score_url) ? $this->optimization_score_url : ''; } public function hasOptimizationScoreUrl() { return isset($this->optimization_score_url); } public function clearOptimizationScoreUrl() { unset($this->optimization_score_url); } /** * 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. * * Generated from protobuf field optional string optimization_score_url = 248; * * @param string $var * @return $this */ public function setOptimizationScoreUrl($var) { GPBUtil::checkString($var, true); $this->optimization_score_url = $var; return $this; } /** * 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. * * Generated from protobuf field optional int64 organic_clicks = 230; * * @return int|string */ public function getOrganicClicks() { return isset($this->organic_clicks) ? $this->organic_clicks : 0; } public function hasOrganicClicks() { return isset($this->organic_clicks); } public function clearOrganicClicks() { unset($this->organic_clicks); } /** * 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. * * Generated from protobuf field optional int64 organic_clicks = 230; * * @param int|string $var * @return $this */ public function setOrganicClicks($var) { GPBUtil::checkInt64($var); $this->organic_clicks = $var; return $this; } /** * 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. * * Generated from protobuf field optional double organic_clicks_per_query = 231; * * @return float */ public function getOrganicClicksPerQuery() { return isset($this->organic_clicks_per_query) ? $this->organic_clicks_per_query : 0.0; } public function hasOrganicClicksPerQuery() { return isset($this->organic_clicks_per_query); } public function clearOrganicClicksPerQuery() { unset($this->organic_clicks_per_query); } /** * 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. * * Generated from protobuf field optional double organic_clicks_per_query = 231; * * @param float $var * @return $this */ public function setOrganicClicksPerQuery($var) { GPBUtil::checkDouble($var); $this->organic_clicks_per_query = $var; return $this; } /** * 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. * * Generated from protobuf field optional int64 organic_impressions = 232; * * @return int|string */ public function getOrganicImpressions() { return isset($this->organic_impressions) ? $this->organic_impressions : 0; } public function hasOrganicImpressions() { return isset($this->organic_impressions); } public function clearOrganicImpressions() { unset($this->organic_impressions); } /** * 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. * * Generated from protobuf field optional int64 organic_impressions = 232; * * @param int|string $var * @return $this */ public function setOrganicImpressions($var) { GPBUtil::checkInt64($var); $this->organic_impressions = $var; return $this; } /** * 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. * * Generated from protobuf field optional double organic_impressions_per_query = 233; * * @return float */ public function getOrganicImpressionsPerQuery() { return isset($this->organic_impressions_per_query) ? $this->organic_impressions_per_query : 0.0; } public function hasOrganicImpressionsPerQuery() { return isset($this->organic_impressions_per_query); } public function clearOrganicImpressionsPerQuery() { unset($this->organic_impressions_per_query); } /** * 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. * * Generated from protobuf field optional double organic_impressions_per_query = 233; * * @param float $var * @return $this */ public function setOrganicImpressionsPerQuery($var) { GPBUtil::checkDouble($var); $this->organic_impressions_per_query = $var; return $this; } /** * 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. * * Generated from protobuf field optional int64 organic_queries = 234; * * @return int|string */ public function getOrganicQueries() { return isset($this->organic_queries) ? $this->organic_queries : 0; } public function hasOrganicQueries() { return isset($this->organic_queries); } public function clearOrganicQueries() { unset($this->organic_queries); } /** * 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. * * Generated from protobuf field optional int64 organic_queries = 234; * * @param int|string $var * @return $this */ public function setOrganicQueries($var) { GPBUtil::checkInt64($var); $this->organic_queries = $var; return $this; } /** * Percentage of first-time sessions (from people who had never visited your * site before). Imported from Google Analytics. * * Generated from protobuf field optional double percent_new_visitors = 235; * * @return float */ public function getPercentNewVisitors() { return isset($this->percent_new_visitors) ? $this->percent_new_visitors : 0.0; } public function hasPercentNewVisitors() { return isset($this->percent_new_visitors); } public function clearPercentNewVisitors() { unset($this->percent_new_visitors); } /** * Percentage of first-time sessions (from people who had never visited your * site before). Imported from Google Analytics. * * Generated from protobuf field optional double percent_new_visitors = 235; * * @param float $var * @return $this */ public function setPercentNewVisitors($var) { GPBUtil::checkDouble($var); $this->percent_new_visitors = $var; return $this; } /** * Number of offline phone calls. * * Generated from protobuf field optional int64 phone_calls = 236; * * @return int|string */ public function getPhoneCalls() { return isset($this->phone_calls) ? $this->phone_calls : 0; } public function hasPhoneCalls() { return isset($this->phone_calls); } public function clearPhoneCalls() { unset($this->phone_calls); } /** * Number of offline phone calls. * * Generated from protobuf field optional int64 phone_calls = 236; * * @param int|string $var * @return $this */ public function setPhoneCalls($var) { GPBUtil::checkInt64($var); $this->phone_calls = $var; return $this; } /** * Number of offline phone impressions. * * Generated from protobuf field optional int64 phone_impressions = 237; * * @return int|string */ public function getPhoneImpressions() { return isset($this->phone_impressions) ? $this->phone_impressions : 0; } public function hasPhoneImpressions() { return isset($this->phone_impressions); } public function clearPhoneImpressions() { unset($this->phone_impressions); } /** * Number of offline phone impressions. * * Generated from protobuf field optional int64 phone_impressions = 237; * * @param int|string $var * @return $this */ public function setPhoneImpressions($var) { GPBUtil::checkInt64($var); $this->phone_impressions = $var; return $this; } /** * Number of phone calls received (phone_calls) divided by the number of * times your phone number is shown (phone_impressions). * * Generated from protobuf field optional double phone_through_rate = 238; * * @return float */ public function getPhoneThroughRate() { return isset($this->phone_through_rate) ? $this->phone_through_rate : 0.0; } public function hasPhoneThroughRate() { return isset($this->phone_through_rate); } public function clearPhoneThroughRate() { unset($this->phone_through_rate); } /** * Number of phone calls received (phone_calls) divided by the number of * times your phone number is shown (phone_impressions). * * Generated from protobuf field optional double phone_through_rate = 238; * * @param float $var * @return $this */ public function setPhoneThroughRate($var) { GPBUtil::checkDouble($var); $this->phone_through_rate = $var; return $this; } /** * 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. * * Generated from protobuf field optional double relative_ctr = 239; * * @return float */ public function getRelativeCtr() { return isset($this->relative_ctr) ? $this->relative_ctr : 0.0; } public function hasRelativeCtr() { return isset($this->relative_ctr); } public function clearRelativeCtr() { unset($this->relative_ctr); } /** * 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. * * Generated from protobuf field optional double relative_ctr = 239; * * @param float $var * @return $this */ public function setRelativeCtr($var) { GPBUtil::checkDouble($var); $this->relative_ctr = $var; return $this; } /** * 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. * * Generated from protobuf field optional double search_absolute_top_impression_share = 136; * * @return float */ public function getSearchAbsoluteTopImpressionShare() { return isset($this->search_absolute_top_impression_share) ? $this->search_absolute_top_impression_share : 0.0; } public function hasSearchAbsoluteTopImpressionShare() { return isset($this->search_absolute_top_impression_share); } public function clearSearchAbsoluteTopImpressionShare() { unset($this->search_absolute_top_impression_share); } /** * 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. * * Generated from protobuf field optional double search_absolute_top_impression_share = 136; * * @param float $var * @return $this */ public function setSearchAbsoluteTopImpressionShare($var) { GPBUtil::checkDouble($var); $this->search_absolute_top_impression_share = $var; return $this; } /** * The number estimating how often your ad wasn't the very first ad among the * top ads in the search results due to a low budget. Note: Search * budget lost absolute top impression share is reported in the range of 0 to * 0.9. Any value above 0.9 is reported as 0.9001. * * Generated from protobuf field optional double search_budget_lost_absolute_top_impression_share = 137; * * @return float */ public function getSearchBudgetLostAbsoluteTopImpressionShare() { return isset($this->search_budget_lost_absolute_top_impression_share) ? $this->search_budget_lost_absolute_top_impression_share : 0.0; } public function hasSearchBudgetLostAbsoluteTopImpressionShare() { return isset($this->search_budget_lost_absolute_top_impression_share); } public function clearSearchBudgetLostAbsoluteTopImpressionShare() { unset($this->search_budget_lost_absolute_top_impression_share); } /** * The number estimating how often your ad wasn't the very first ad among the * top ads in the search results due to a low budget. Note: Search * budget lost absolute top impression share is reported in the range of 0 to * 0.9. Any value above 0.9 is reported as 0.9001. * * Generated from protobuf field optional double search_budget_lost_absolute_top_impression_share = 137; * * @param float $var * @return $this */ public function setSearchBudgetLostAbsoluteTopImpressionShare($var) { GPBUtil::checkDouble($var); $this->search_budget_lost_absolute_top_impression_share = $var; return $this; } /** * 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. * * Generated from protobuf field optional double search_budget_lost_impression_share = 138; * * @return float */ public function getSearchBudgetLostImpressionShare() { return isset($this->search_budget_lost_impression_share) ? $this->search_budget_lost_impression_share : 0.0; } public function hasSearchBudgetLostImpressionShare() { return isset($this->search_budget_lost_impression_share); } public function clearSearchBudgetLostImpressionShare() { unset($this->search_budget_lost_impression_share); } /** * 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. * * Generated from protobuf field optional double search_budget_lost_impression_share = 138; * * @param float $var * @return $this */ public function setSearchBudgetLostImpressionShare($var) { GPBUtil::checkDouble($var); $this->search_budget_lost_impression_share = $var; return $this; } /** * The number estimating how often your ad didn't show adjacent to the top * organic search results due to a low budget. Note: Search * budget lost top impression share is reported in the range of 0 to 0.9. Any * value above 0.9 is reported as 0.9001. * * Generated from protobuf field optional double search_budget_lost_top_impression_share = 139; * * @return float */ public function getSearchBudgetLostTopImpressionShare() { return isset($this->search_budget_lost_top_impression_share) ? $this->search_budget_lost_top_impression_share : 0.0; } public function hasSearchBudgetLostTopImpressionShare() { return isset($this->search_budget_lost_top_impression_share); } public function clearSearchBudgetLostTopImpressionShare() { unset($this->search_budget_lost_top_impression_share); } /** * The number estimating how often your ad didn't show adjacent to the top * organic search results due to a low budget. Note: Search * budget lost top impression share is reported in the range of 0 to 0.9. Any * value above 0.9 is reported as 0.9001. * * Generated from protobuf field optional double search_budget_lost_top_impression_share = 139; * * @param float $var * @return $this */ public function setSearchBudgetLostTopImpressionShare($var) { GPBUtil::checkDouble($var); $this->search_budget_lost_top_impression_share = $var; return $this; } /** * 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. * * Generated from protobuf field optional double search_click_share = 140; * * @return float */ public function getSearchClickShare() { return isset($this->search_click_share) ? $this->search_click_share : 0.0; } public function hasSearchClickShare() { return isset($this->search_click_share); } public function clearSearchClickShare() { unset($this->search_click_share); } /** * 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. * * Generated from protobuf field optional double search_click_share = 140; * * @param float $var * @return $this */ public function setSearchClickShare($var) { GPBUtil::checkDouble($var); $this->search_click_share = $var; return $this; } /** * 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. * * Generated from protobuf field optional double search_exact_match_impression_share = 141; * * @return float */ public function getSearchExactMatchImpressionShare() { return isset($this->search_exact_match_impression_share) ? $this->search_exact_match_impression_share : 0.0; } public function hasSearchExactMatchImpressionShare() { return isset($this->search_exact_match_impression_share); } public function clearSearchExactMatchImpressionShare() { unset($this->search_exact_match_impression_share); } /** * 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. * * Generated from protobuf field optional double search_exact_match_impression_share = 141; * * @param float $var * @return $this */ public function setSearchExactMatchImpressionShare($var) { GPBUtil::checkDouble($var); $this->search_exact_match_impression_share = $var; return $this; } /** * 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. * * Generated from protobuf field optional double search_impression_share = 142; * * @return float */ public function getSearchImpressionShare() { return isset($this->search_impression_share) ? $this->search_impression_share : 0.0; } public function hasSearchImpressionShare() { return isset($this->search_impression_share); } public function clearSearchImpressionShare() { unset($this->search_impression_share); } /** * 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. * * Generated from protobuf field optional double search_impression_share = 142; * * @param float $var * @return $this */ public function setSearchImpressionShare($var) { GPBUtil::checkDouble($var); $this->search_impression_share = $var; return $this; } /** * The number estimating how often your ad wasn't the very first ad among the * top ads in the search results due to poor Ad Rank. * Note: Search rank lost absolute top impression share is reported in the * range of 0 to 0.9. Any value above 0.9 is reported as 0.9001. * * Generated from protobuf field optional double search_rank_lost_absolute_top_impression_share = 143; * * @return float */ public function getSearchRankLostAbsoluteTopImpressionShare() { return isset($this->search_rank_lost_absolute_top_impression_share) ? $this->search_rank_lost_absolute_top_impression_share : 0.0; } public function hasSearchRankLostAbsoluteTopImpressionShare() { return isset($this->search_rank_lost_absolute_top_impression_share); } public function clearSearchRankLostAbsoluteTopImpressionShare() { unset($this->search_rank_lost_absolute_top_impression_share); } /** * The number estimating how often your ad wasn't the very first ad among the * top ads in the search results due to poor Ad Rank. * Note: Search rank lost absolute top impression share is reported in the * range of 0 to 0.9. Any value above 0.9 is reported as 0.9001. * * Generated from protobuf field optional double search_rank_lost_absolute_top_impression_share = 143; * * @param float $var * @return $this */ public function setSearchRankLostAbsoluteTopImpressionShare($var) { GPBUtil::checkDouble($var); $this->search_rank_lost_absolute_top_impression_share = $var; return $this; } /** * 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. * * Generated from protobuf field optional double search_rank_lost_impression_share = 144; * * @return float */ public function getSearchRankLostImpressionShare() { return isset($this->search_rank_lost_impression_share) ? $this->search_rank_lost_impression_share : 0.0; } public function hasSearchRankLostImpressionShare() { return isset($this->search_rank_lost_impression_share); } public function clearSearchRankLostImpressionShare() { unset($this->search_rank_lost_impression_share); } /** * 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. * * Generated from protobuf field optional double search_rank_lost_impression_share = 144; * * @param float $var * @return $this */ public function setSearchRankLostImpressionShare($var) { GPBUtil::checkDouble($var); $this->search_rank_lost_impression_share = $var; return $this; } /** * The number estimating how often your ad didn't show adjacent to the top * organic search results due to poor Ad Rank. * Note: Search rank lost top impression share is reported in the range of 0 * to 0.9. Any value above 0.9 is reported as 0.9001. * * Generated from protobuf field optional double search_rank_lost_top_impression_share = 145; * * @return float */ public function getSearchRankLostTopImpressionShare() { return isset($this->search_rank_lost_top_impression_share) ? $this->search_rank_lost_top_impression_share : 0.0; } public function hasSearchRankLostTopImpressionShare() { return isset($this->search_rank_lost_top_impression_share); } public function clearSearchRankLostTopImpressionShare() { unset($this->search_rank_lost_top_impression_share); } /** * The number estimating how often your ad didn't show adjacent to the top * organic search results due to poor Ad Rank. * Note: Search rank lost top impression share is reported in the range of 0 * to 0.9. Any value above 0.9 is reported as 0.9001. * * Generated from protobuf field optional double search_rank_lost_top_impression_share = 145; * * @param float $var * @return $this */ public function setSearchRankLostTopImpressionShare($var) { GPBUtil::checkDouble($var); $this->search_rank_lost_top_impression_share = $var; return $this; } /** * The impressions you've received among the top ads compared to the estimated * number of impressions you were eligible to receive among the top ads. * Note: Search top impression share is reported in the range of 0.1 to 1. Any * value below 0.1 is reported as 0.0999. * Top ads are generally above the top organic results, although they may show * below the top organic results on certain queries. * * Generated from protobuf field optional double search_top_impression_share = 146; * * @return float */ public function getSearchTopImpressionShare() { return isset($this->search_top_impression_share) ? $this->search_top_impression_share : 0.0; } public function hasSearchTopImpressionShare() { return isset($this->search_top_impression_share); } public function clearSearchTopImpressionShare() { unset($this->search_top_impression_share); } /** * The impressions you've received among the top ads compared to the estimated * number of impressions you were eligible to receive among the top ads. * Note: Search top impression share is reported in the range of 0.1 to 1. Any * value below 0.1 is reported as 0.0999. * Top ads are generally above the top organic results, although they may show * below the top organic results on certain queries. * * Generated from protobuf field optional double search_top_impression_share = 146; * * @param float $var * @return $this */ public function setSearchTopImpressionShare($var) { GPBUtil::checkDouble($var); $this->search_top_impression_share = $var; return $this; } /** * Search volume range for a search term insight category. * * Generated from protobuf field optional .google.ads.googleads.v23.common.SearchVolumeRange search_volume = 295; * * @return \Google\Ads\GoogleAds\V23\Common\SearchVolumeRange|null */ public function getSearchVolume() { return $this->search_volume; } public function hasSearchVolume() { return isset($this->search_volume); } public function clearSearchVolume() { unset($this->search_volume); } /** * Search volume range for a search term insight category. * * Generated from protobuf field optional .google.ads.googleads.v23.common.SearchVolumeRange search_volume = 295; * * @param \Google\Ads\GoogleAds\V23\Common\SearchVolumeRange $var * @return $this */ public function setSearchVolume($var) { GPBUtil::checkMessage($var, \Google\Ads\GoogleAds\V23\Common\SearchVolumeRange::class); $this->search_volume = $var; return $this; } /** * 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. * * Generated from protobuf field optional int64 speed_score = 147; * * @return int|string */ public function getSpeedScore() { return isset($this->speed_score) ? $this->speed_score : 0; } public function hasSpeedScore() { return isset($this->speed_score); } public function clearSpeedScore() { unset($this->speed_score); } /** * 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. * * Generated from protobuf field optional int64 speed_score = 147; * * @param int|string $var * @return $this */ public function setSpeedScore($var) { GPBUtil::checkInt64($var); $this->speed_score = $var; return $this; } /** * The average Target CPA, or unset if not available (for example, for * campaigns that had traffic from portfolio bidding strategies or non-tCPA). * * Generated from protobuf field optional int64 average_target_cpa_micros = 290; * * @return int|string */ public function getAverageTargetCpaMicros() { return isset($this->average_target_cpa_micros) ? $this->average_target_cpa_micros : 0; } public function hasAverageTargetCpaMicros() { return isset($this->average_target_cpa_micros); } public function clearAverageTargetCpaMicros() { unset($this->average_target_cpa_micros); } /** * The average Target CPA, or unset if not available (for example, for * campaigns that had traffic from portfolio bidding strategies or non-tCPA). * * Generated from protobuf field optional int64 average_target_cpa_micros = 290; * * @param int|string $var * @return $this */ public function setAverageTargetCpaMicros($var) { GPBUtil::checkInt64($var); $this->average_target_cpa_micros = $var; return $this; } /** * The average Target ROAS, or unset if not available (for example, for * campaigns that had traffic from portfolio bidding strategies or non-tROAS). * * Generated from protobuf field optional double average_target_roas = 250; * * @return float */ public function getAverageTargetRoas() { return isset($this->average_target_roas) ? $this->average_target_roas : 0.0; } public function hasAverageTargetRoas() { return isset($this->average_target_roas); } public function clearAverageTargetRoas() { unset($this->average_target_roas); } /** * The average Target ROAS, or unset if not available (for example, for * campaigns that had traffic from portfolio bidding strategies or non-tROAS). * * Generated from protobuf field optional double average_target_roas = 250; * * @param float $var * @return $this */ public function setAverageTargetRoas($var) { GPBUtil::checkDouble($var); $this->average_target_roas = $var; return $this; } /** * The percent of your ad impressions that are shown adjacent to the top * organic search results. * * Generated from protobuf field optional double top_impression_percentage = 148; * * @return float */ public function getTopImpressionPercentage() { return isset($this->top_impression_percentage) ? $this->top_impression_percentage : 0.0; } public function hasTopImpressionPercentage() { return isset($this->top_impression_percentage); } public function clearTopImpressionPercentage() { unset($this->top_impression_percentage); } /** * The percent of your ad impressions that are shown adjacent to the top * organic search results. * * Generated from protobuf field optional double top_impression_percentage = 148; * * @param float $var * @return $this */ public function setTopImpressionPercentage($var) { GPBUtil::checkDouble($var); $this->top_impression_percentage = $var; return $this; } /** * The percentage of ad clicks to Accelerated Mobile Pages (AMP) landing pages * that reach a valid AMP page. * * Generated from protobuf field optional double valid_accelerated_mobile_pages_clicks_percentage = 149; * * @return float */ public function getValidAcceleratedMobilePagesClicksPercentage() { return isset($this->valid_accelerated_mobile_pages_clicks_percentage) ? $this->valid_accelerated_mobile_pages_clicks_percentage : 0.0; } public function hasValidAcceleratedMobilePagesClicksPercentage() { return isset($this->valid_accelerated_mobile_pages_clicks_percentage); } public function clearValidAcceleratedMobilePagesClicksPercentage() { unset($this->valid_accelerated_mobile_pages_clicks_percentage); } /** * The percentage of ad clicks to Accelerated Mobile Pages (AMP) landing pages * that reach a valid AMP page. * * Generated from protobuf field optional double valid_accelerated_mobile_pages_clicks_percentage = 149; * * @param float $var * @return $this */ public function setValidAcceleratedMobilePagesClicksPercentage($var) { GPBUtil::checkDouble($var); $this->valid_accelerated_mobile_pages_clicks_percentage = $var; return $this; } /** * The value of all conversions divided by the number of all conversions. * * Generated from protobuf field optional double value_per_all_conversions = 150; * * @return float */ public function getValuePerAllConversions() { return isset($this->value_per_all_conversions) ? $this->value_per_all_conversions : 0.0; } public function hasValuePerAllConversions() { return isset($this->value_per_all_conversions); } public function clearValuePerAllConversions() { unset($this->value_per_all_conversions); } /** * The value of all conversions divided by the number of all conversions. * * Generated from protobuf field optional double value_per_all_conversions = 150; * * @param float $var * @return $this */ public function setValuePerAllConversions($var) { GPBUtil::checkDouble($var); $this->value_per_all_conversions = $var; return $this; } /** * 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. * * Generated from protobuf field optional double value_per_all_conversions_by_conversion_date = 244; * * @return float */ public function getValuePerAllConversionsByConversionDate() { return isset($this->value_per_all_conversions_by_conversion_date) ? $this->value_per_all_conversions_by_conversion_date : 0.0; } public function hasValuePerAllConversionsByConversionDate() { return isset($this->value_per_all_conversions_by_conversion_date); } public function clearValuePerAllConversionsByConversionDate() { unset($this->value_per_all_conversions_by_conversion_date); } /** * 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. * * Generated from protobuf field optional double value_per_all_conversions_by_conversion_date = 244; * * @param float $var * @return $this */ public function setValuePerAllConversionsByConversionDate($var) { GPBUtil::checkDouble($var); $this->value_per_all_conversions_by_conversion_date = $var; return $this; } /** * 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. * * Generated from protobuf field optional double value_per_conversion = 151; * * @return float */ public function getValuePerConversion() { return isset($this->value_per_conversion) ? $this->value_per_conversion : 0.0; } public function hasValuePerConversion() { return isset($this->value_per_conversion); } public function clearValuePerConversion() { unset($this->value_per_conversion); } /** * 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. * * Generated from protobuf field optional double value_per_conversion = 151; * * @param float $var * @return $this */ public function setValuePerConversion($var) { GPBUtil::checkDouble($var); $this->value_per_conversion = $var; return $this; } /** * 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. * * Generated from protobuf field optional double value_per_conversions_by_conversion_date = 245; * * @return float */ public function getValuePerConversionsByConversionDate() { return isset($this->value_per_conversions_by_conversion_date) ? $this->value_per_conversions_by_conversion_date : 0.0; } public function hasValuePerConversionsByConversionDate() { return isset($this->value_per_conversions_by_conversion_date); } public function clearValuePerConversionsByConversionDate() { unset($this->value_per_conversions_by_conversion_date); } /** * 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. * * Generated from protobuf field optional double value_per_conversions_by_conversion_date = 245; * * @param float $var * @return $this */ public function setValuePerConversionsByConversionDate($var) { GPBUtil::checkDouble($var); $this->value_per_conversions_by_conversion_date = $var; return $this; } /** * 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. * * Generated from protobuf field optional double value_per_current_model_attributed_conversion = 152; * * @return float */ public function getValuePerCurrentModelAttributedConversion() { return isset($this->value_per_current_model_attributed_conversion) ? $this->value_per_current_model_attributed_conversion : 0.0; } public function hasValuePerCurrentModelAttributedConversion() { return isset($this->value_per_current_model_attributed_conversion); } public function clearValuePerCurrentModelAttributedConversion() { unset($this->value_per_current_model_attributed_conversion); } /** * 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. * * Generated from protobuf field optional double value_per_current_model_attributed_conversion = 152; * * @param float $var * @return $this */ public function setValuePerCurrentModelAttributedConversion($var) { GPBUtil::checkDouble($var); $this->value_per_current_model_attributed_conversion = $var; return $this; } /** * Percentage of impressions where the viewer watched all of your video. * * Generated from protobuf field optional double video_quartile_p100_rate = 132; * * @return float */ public function getVideoQuartileP100Rate() { return isset($this->video_quartile_p100_rate) ? $this->video_quartile_p100_rate : 0.0; } public function hasVideoQuartileP100Rate() { return isset($this->video_quartile_p100_rate); } public function clearVideoQuartileP100Rate() { unset($this->video_quartile_p100_rate); } /** * Percentage of impressions where the viewer watched all of your video. * * Generated from protobuf field optional double video_quartile_p100_rate = 132; * * @param float $var * @return $this */ public function setVideoQuartileP100Rate($var) { GPBUtil::checkDouble($var); $this->video_quartile_p100_rate = $var; return $this; } /** * Percentage of impressions where the viewer watched 25% of your video. * * Generated from protobuf field optional double video_quartile_p25_rate = 133; * * @return float */ public function getVideoQuartileP25Rate() { return isset($this->video_quartile_p25_rate) ? $this->video_quartile_p25_rate : 0.0; } public function hasVideoQuartileP25Rate() { return isset($this->video_quartile_p25_rate); } public function clearVideoQuartileP25Rate() { unset($this->video_quartile_p25_rate); } /** * Percentage of impressions where the viewer watched 25% of your video. * * Generated from protobuf field optional double video_quartile_p25_rate = 133; * * @param float $var * @return $this */ public function setVideoQuartileP25Rate($var) { GPBUtil::checkDouble($var); $this->video_quartile_p25_rate = $var; return $this; } /** * Percentage of impressions where the viewer watched 50% of your video. * * Generated from protobuf field optional double video_quartile_p50_rate = 134; * * @return float */ public function getVideoQuartileP50Rate() { return isset($this->video_quartile_p50_rate) ? $this->video_quartile_p50_rate : 0.0; } public function hasVideoQuartileP50Rate() { return isset($this->video_quartile_p50_rate); } public function clearVideoQuartileP50Rate() { unset($this->video_quartile_p50_rate); } /** * Percentage of impressions where the viewer watched 50% of your video. * * Generated from protobuf field optional double video_quartile_p50_rate = 134; * * @param float $var * @return $this */ public function setVideoQuartileP50Rate($var) { GPBUtil::checkDouble($var); $this->video_quartile_p50_rate = $var; return $this; } /** * Percentage of impressions where the viewer watched 75% of your video. * * Generated from protobuf field optional double video_quartile_p75_rate = 135; * * @return float */ public function getVideoQuartileP75Rate() { return isset($this->video_quartile_p75_rate) ? $this->video_quartile_p75_rate : 0.0; } public function hasVideoQuartileP75Rate() { return isset($this->video_quartile_p75_rate); } public function clearVideoQuartileP75Rate() { unset($this->video_quartile_p75_rate); } /** * Percentage of impressions where the viewer watched 75% of your video. * * Generated from protobuf field optional double video_quartile_p75_rate = 135; * * @param float $var * @return $this */ public function setVideoQuartileP75Rate($var) { GPBUtil::checkDouble($var); $this->video_quartile_p75_rate = $var; return $this; } /** * The number of TrueView views your video ad receives divided by its number * of impressions, including thumbnail impressions for TrueView in-display * ads. * * Generated from protobuf field optional double video_trueview_view_rate = 406; * * @return float */ public function getVideoTrueviewViewRate() { return isset($this->video_trueview_view_rate) ? $this->video_trueview_view_rate : 0.0; } public function hasVideoTrueviewViewRate() { return isset($this->video_trueview_view_rate); } public function clearVideoTrueviewViewRate() { unset($this->video_trueview_view_rate); } /** * The number of TrueView views your video ad receives divided by its number * of impressions, including thumbnail impressions for TrueView in-display * ads. * * Generated from protobuf field optional double video_trueview_view_rate = 406; * * @param float $var * @return $this */ public function setVideoTrueviewViewRate($var) { GPBUtil::checkDouble($var); $this->video_trueview_view_rate = $var; return $this; } /** * The number of TrueView views your video ads received. * * Generated from protobuf field optional int64 video_trueview_views = 407; * * @return int|string */ public function getVideoTrueviewViews() { return isset($this->video_trueview_views) ? $this->video_trueview_views : 0; } public function hasVideoTrueviewViews() { return isset($this->video_trueview_views); } public function clearVideoTrueviewViews() { unset($this->video_trueview_views); } /** * The number of TrueView views your video ads received. * * Generated from protobuf field optional int64 video_trueview_views = 407; * * @param int|string $var * @return $this */ public function setVideoTrueviewViews($var) { GPBUtil::checkInt64($var); $this->video_trueview_views = $var; return $this; } /** * The total number of view-through conversions. * These happen when a customer sees an image or rich media ad, then later * completes a conversion on your site without interacting with (for example, * clicking on) another ad. * * Generated from protobuf field optional int64 view_through_conversions = 155; * * @return int|string */ public function getViewThroughConversions() { return isset($this->view_through_conversions) ? $this->view_through_conversions : 0; } public function hasViewThroughConversions() { return isset($this->view_through_conversions); } public function clearViewThroughConversions() { unset($this->view_through_conversions); } /** * The total number of view-through conversions. * These happen when a customer sees an image or rich media ad, then later * completes a conversion on your site without interacting with (for example, * clicking on) another ad. * * Generated from protobuf field optional int64 view_through_conversions = 155; * * @param int|string $var * @return $this */ public function setViewThroughConversions($var) { GPBUtil::checkInt64($var); $this->view_through_conversions = $var; return $this; } /** * The number of iOS Store Kit Ad Network conversions. * * Generated from protobuf field int64 sk_ad_network_installs = 246; * * @return int|string */ public function getSkAdNetworkInstalls() { return $this->sk_ad_network_installs; } /** * The number of iOS Store Kit Ad Network conversions. * * Generated from protobuf field int64 sk_ad_network_installs = 246; * * @param int|string $var * @return $this */ public function setSkAdNetworkInstalls($var) { GPBUtil::checkInt64($var); $this->sk_ad_network_installs = $var; return $this; } /** * The total number of iOS Store Kit Ad Network conversions. * * Generated from protobuf field int64 sk_ad_network_total_conversions = 292; * * @return int|string */ public function getSkAdNetworkTotalConversions() { return $this->sk_ad_network_total_conversions; } /** * The total number of iOS Store Kit Ad Network conversions. * * Generated from protobuf field int64 sk_ad_network_total_conversions = 292; * * @param int|string $var * @return $this */ public function setSkAdNetworkTotalConversions($var) { GPBUtil::checkInt64($var); $this->sk_ad_network_total_conversions = $var; return $this; } /** * Clicks from properties not owned by the publisher for which the traffic * the publisher has paid for or acquired through incentivized activity * * Generated from protobuf field int64 publisher_purchased_clicks = 264; * * @return int|string */ public function getPublisherPurchasedClicks() { return $this->publisher_purchased_clicks; } /** * Clicks from properties not owned by the publisher for which the traffic * the publisher has paid for or acquired through incentivized activity * * Generated from protobuf field int64 publisher_purchased_clicks = 264; * * @param int|string $var * @return $this */ public function setPublisherPurchasedClicks($var) { GPBUtil::checkInt64($var); $this->publisher_purchased_clicks = $var; return $this; } /** * Clicks from properties for which the traffic the publisher has not paid * for or acquired through incentivized activity * * Generated from protobuf field int64 publisher_organic_clicks = 265; * * @return int|string */ public function getPublisherOrganicClicks() { return $this->publisher_organic_clicks; } /** * Clicks from properties for which the traffic the publisher has not paid * for or acquired through incentivized activity * * Generated from protobuf field int64 publisher_organic_clicks = 265; * * @param int|string $var * @return $this */ public function setPublisherOrganicClicks($var) { GPBUtil::checkInt64($var); $this->publisher_organic_clicks = $var; return $this; } /** * Clicks from traffic which is not identified as "Publisher Purchased" or * "Publisher Organic" * * Generated from protobuf field int64 publisher_unknown_clicks = 266; * * @return int|string */ public function getPublisherUnknownClicks() { return $this->publisher_unknown_clicks; } /** * Clicks from traffic which is not identified as "Publisher Purchased" or * "Publisher Organic" * * Generated from protobuf field int64 publisher_unknown_clicks = 266; * * @param int|string $var * @return $this */ public function setPublisherUnknownClicks($var) { GPBUtil::checkInt64($var); $this->publisher_unknown_clicks = $var; return $this; } /** * 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. * * Generated from protobuf field optional double all_conversions_from_location_asset_click_to_call = 267; * * @return float */ public function getAllConversionsFromLocationAssetClickToCall() { return isset($this->all_conversions_from_location_asset_click_to_call) ? $this->all_conversions_from_location_asset_click_to_call : 0.0; } public function hasAllConversionsFromLocationAssetClickToCall() { return isset($this->all_conversions_from_location_asset_click_to_call); } public function clearAllConversionsFromLocationAssetClickToCall() { unset($this->all_conversions_from_location_asset_click_to_call); } /** * 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. * * Generated from protobuf field optional double all_conversions_from_location_asset_click_to_call = 267; * * @param float $var * @return $this */ public function setAllConversionsFromLocationAssetClickToCall($var) { GPBUtil::checkDouble($var); $this->all_conversions_from_location_asset_click_to_call = $var; return $this; } /** * 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. * * Generated from protobuf field optional double all_conversions_from_location_asset_directions = 268; * * @return float */ public function getAllConversionsFromLocationAssetDirections() { return isset($this->all_conversions_from_location_asset_directions) ? $this->all_conversions_from_location_asset_directions : 0.0; } public function hasAllConversionsFromLocationAssetDirections() { return isset($this->all_conversions_from_location_asset_directions); } public function clearAllConversionsFromLocationAssetDirections() { unset($this->all_conversions_from_location_asset_directions); } /** * 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. * * Generated from protobuf field optional double all_conversions_from_location_asset_directions = 268; * * @param float $var * @return $this */ public function setAllConversionsFromLocationAssetDirections($var) { GPBUtil::checkDouble($var); $this->all_conversions_from_location_asset_directions = $var; return $this; } /** * 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. * * Generated from protobuf field optional double all_conversions_from_location_asset_menu = 269; * * @return float */ public function getAllConversionsFromLocationAssetMenu() { return isset($this->all_conversions_from_location_asset_menu) ? $this->all_conversions_from_location_asset_menu : 0.0; } public function hasAllConversionsFromLocationAssetMenu() { return isset($this->all_conversions_from_location_asset_menu); } public function clearAllConversionsFromLocationAssetMenu() { unset($this->all_conversions_from_location_asset_menu); } /** * 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. * * Generated from protobuf field optional double all_conversions_from_location_asset_menu = 269; * * @param float $var * @return $this */ public function setAllConversionsFromLocationAssetMenu($var) { GPBUtil::checkDouble($var); $this->all_conversions_from_location_asset_menu = $var; return $this; } /** * Number of order clicks on any location surface after a chargeable ad event * (click or impression). This measure is coming from Asset based * location. * * Generated from protobuf field optional double all_conversions_from_location_asset_order = 270; * * @return float */ public function getAllConversionsFromLocationAssetOrder() { return isset($this->all_conversions_from_location_asset_order) ? $this->all_conversions_from_location_asset_order : 0.0; } public function hasAllConversionsFromLocationAssetOrder() { return isset($this->all_conversions_from_location_asset_order); } public function clearAllConversionsFromLocationAssetOrder() { unset($this->all_conversions_from_location_asset_order); } /** * Number of order clicks on any location surface after a chargeable ad event * (click or impression). This measure is coming from Asset based * location. * * Generated from protobuf field optional double all_conversions_from_location_asset_order = 270; * * @param float $var * @return $this */ public function setAllConversionsFromLocationAssetOrder($var) { GPBUtil::checkDouble($var); $this->all_conversions_from_location_asset_order = $var; return $this; } /** * 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. * * Generated from protobuf field optional double all_conversions_from_location_asset_other_engagement = 271; * * @return float */ public function getAllConversionsFromLocationAssetOtherEngagement() { return isset($this->all_conversions_from_location_asset_other_engagement) ? $this->all_conversions_from_location_asset_other_engagement : 0.0; } public function hasAllConversionsFromLocationAssetOtherEngagement() { return isset($this->all_conversions_from_location_asset_other_engagement); } public function clearAllConversionsFromLocationAssetOtherEngagement() { unset($this->all_conversions_from_location_asset_other_engagement); } /** * 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. * * Generated from protobuf field optional double all_conversions_from_location_asset_other_engagement = 271; * * @param float $var * @return $this */ public function setAllConversionsFromLocationAssetOtherEngagement($var) { GPBUtil::checkDouble($var); $this->all_conversions_from_location_asset_other_engagement = $var; return $this; } /** * Estimated number of visits to the business after a chargeable * ad event (click or impression). This measure is coming from Asset * based location. * * Generated from protobuf field optional double all_conversions_from_location_asset_store_visits = 272; * * @return float */ public function getAllConversionsFromLocationAssetStoreVisits() { return isset($this->all_conversions_from_location_asset_store_visits) ? $this->all_conversions_from_location_asset_store_visits : 0.0; } public function hasAllConversionsFromLocationAssetStoreVisits() { return isset($this->all_conversions_from_location_asset_store_visits); } public function clearAllConversionsFromLocationAssetStoreVisits() { unset($this->all_conversions_from_location_asset_store_visits); } /** * Estimated number of visits to the business after a chargeable * ad event (click or impression). This measure is coming from Asset * based location. * * Generated from protobuf field optional double all_conversions_from_location_asset_store_visits = 272; * * @param float $var * @return $this */ public function setAllConversionsFromLocationAssetStoreVisits($var) { GPBUtil::checkDouble($var); $this->all_conversions_from_location_asset_store_visits = $var; return $this; } /** * 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. * * Generated from protobuf field optional double all_conversions_from_location_asset_website = 273; * * @return float */ public function getAllConversionsFromLocationAssetWebsite() { return isset($this->all_conversions_from_location_asset_website) ? $this->all_conversions_from_location_asset_website : 0.0; } public function hasAllConversionsFromLocationAssetWebsite() { return isset($this->all_conversions_from_location_asset_website); } public function clearAllConversionsFromLocationAssetWebsite() { unset($this->all_conversions_from_location_asset_website); } /** * 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. * * Generated from protobuf field optional double all_conversions_from_location_asset_website = 273; * * @param float $var * @return $this */ public function setAllConversionsFromLocationAssetWebsite($var) { GPBUtil::checkDouble($var); $this->all_conversions_from_location_asset_website = $var; return $this; } /** * Number of impressions in which the business location was shown or the * location was used for targeting. This measure is coming from Asset based * location. * * Generated from protobuf field optional int64 eligible_impressions_from_location_asset_store_reach = 274; * * @return int|string */ public function getEligibleImpressionsFromLocationAssetStoreReach() { return isset($this->eligible_impressions_from_location_asset_store_reach) ? $this->eligible_impressions_from_location_asset_store_reach : 0; } public function hasEligibleImpressionsFromLocationAssetStoreReach() { return isset($this->eligible_impressions_from_location_asset_store_reach); } public function clearEligibleImpressionsFromLocationAssetStoreReach() { unset($this->eligible_impressions_from_location_asset_store_reach); } /** * Number of impressions in which the business location was shown or the * location was used for targeting. This measure is coming from Asset based * location. * * Generated from protobuf field optional int64 eligible_impressions_from_location_asset_store_reach = 274; * * @param int|string $var * @return $this */ public function setEligibleImpressionsFromLocationAssetStoreReach($var) { GPBUtil::checkInt64($var); $this->eligible_impressions_from_location_asset_store_reach = $var; return $this; } /** * Number of call button clicks on any location surface after an impression. * This measure is coming from Asset based location. * * Generated from protobuf field optional double view_through_conversions_from_location_asset_click_to_call = 275; * * @return float */ public function getViewThroughConversionsFromLocationAssetClickToCall() { return isset($this->view_through_conversions_from_location_asset_click_to_call) ? $this->view_through_conversions_from_location_asset_click_to_call : 0.0; } public function hasViewThroughConversionsFromLocationAssetClickToCall() { return isset($this->view_through_conversions_from_location_asset_click_to_call); } public function clearViewThroughConversionsFromLocationAssetClickToCall() { unset($this->view_through_conversions_from_location_asset_click_to_call); } /** * Number of call button clicks on any location surface after an impression. * This measure is coming from Asset based location. * * Generated from protobuf field optional double view_through_conversions_from_location_asset_click_to_call = 275; * * @param float $var * @return $this */ public function setViewThroughConversionsFromLocationAssetClickToCall($var) { GPBUtil::checkDouble($var); $this->view_through_conversions_from_location_asset_click_to_call = $var; return $this; } /** * Number of driving directions clicks on any location surface after an * impression. This measure is coming from Asset based location. * * Generated from protobuf field optional double view_through_conversions_from_location_asset_directions = 276; * * @return float */ public function getViewThroughConversionsFromLocationAssetDirections() { return isset($this->view_through_conversions_from_location_asset_directions) ? $this->view_through_conversions_from_location_asset_directions : 0.0; } public function hasViewThroughConversionsFromLocationAssetDirections() { return isset($this->view_through_conversions_from_location_asset_directions); } public function clearViewThroughConversionsFromLocationAssetDirections() { unset($this->view_through_conversions_from_location_asset_directions); } /** * Number of driving directions clicks on any location surface after an * impression. This measure is coming from Asset based location. * * Generated from protobuf field optional double view_through_conversions_from_location_asset_directions = 276; * * @param float $var * @return $this */ public function setViewThroughConversionsFromLocationAssetDirections($var) { GPBUtil::checkDouble($var); $this->view_through_conversions_from_location_asset_directions = $var; return $this; } /** * Number of menu link clicks on any location surface after an impression. * This measure is coming from Asset based location. * * Generated from protobuf field optional double view_through_conversions_from_location_asset_menu = 277; * * @return float */ public function getViewThroughConversionsFromLocationAssetMenu() { return isset($this->view_through_conversions_from_location_asset_menu) ? $this->view_through_conversions_from_location_asset_menu : 0.0; } public function hasViewThroughConversionsFromLocationAssetMenu() { return isset($this->view_through_conversions_from_location_asset_menu); } public function clearViewThroughConversionsFromLocationAssetMenu() { unset($this->view_through_conversions_from_location_asset_menu); } /** * Number of menu link clicks on any location surface after an impression. * This measure is coming from Asset based location. * * Generated from protobuf field optional double view_through_conversions_from_location_asset_menu = 277; * * @param float $var * @return $this */ public function setViewThroughConversionsFromLocationAssetMenu($var) { GPBUtil::checkDouble($var); $this->view_through_conversions_from_location_asset_menu = $var; return $this; } /** * Number of order clicks on any location surface after an impression. This * measure is coming from Asset based location. * * Generated from protobuf field optional double view_through_conversions_from_location_asset_order = 278; * * @return float */ public function getViewThroughConversionsFromLocationAssetOrder() { return isset($this->view_through_conversions_from_location_asset_order) ? $this->view_through_conversions_from_location_asset_order : 0.0; } public function hasViewThroughConversionsFromLocationAssetOrder() { return isset($this->view_through_conversions_from_location_asset_order); } public function clearViewThroughConversionsFromLocationAssetOrder() { unset($this->view_through_conversions_from_location_asset_order); } /** * Number of order clicks on any location surface after an impression. This * measure is coming from Asset based location. * * Generated from protobuf field optional double view_through_conversions_from_location_asset_order = 278; * * @param float $var * @return $this */ public function setViewThroughConversionsFromLocationAssetOrder($var) { GPBUtil::checkDouble($var); $this->view_through_conversions_from_location_asset_order = $var; return $this; } /** * Number of other types of local action clicks on any location surface after * an impression. This measure is coming from Asset based location. * * Generated from protobuf field optional double view_through_conversions_from_location_asset_other_engagement = 279; * * @return float */ public function getViewThroughConversionsFromLocationAssetOtherEngagement() { return isset($this->view_through_conversions_from_location_asset_other_engagement) ? $this->view_through_conversions_from_location_asset_other_engagement : 0.0; } public function hasViewThroughConversionsFromLocationAssetOtherEngagement() { return isset($this->view_through_conversions_from_location_asset_other_engagement); } public function clearViewThroughConversionsFromLocationAssetOtherEngagement() { unset($this->view_through_conversions_from_location_asset_other_engagement); } /** * Number of other types of local action clicks on any location surface after * an impression. This measure is coming from Asset based location. * * Generated from protobuf field optional double view_through_conversions_from_location_asset_other_engagement = 279; * * @param float $var * @return $this */ public function setViewThroughConversionsFromLocationAssetOtherEngagement($var) { GPBUtil::checkDouble($var); $this->view_through_conversions_from_location_asset_other_engagement = $var; return $this; } /** * Estimated number of visits to the business after an impression. * This measure is coming from Asset based location. * * Generated from protobuf field optional double view_through_conversions_from_location_asset_store_visits = 280; * * @return float */ public function getViewThroughConversionsFromLocationAssetStoreVisits() { return isset($this->view_through_conversions_from_location_asset_store_visits) ? $this->view_through_conversions_from_location_asset_store_visits : 0.0; } public function hasViewThroughConversionsFromLocationAssetStoreVisits() { return isset($this->view_through_conversions_from_location_asset_store_visits); } public function clearViewThroughConversionsFromLocationAssetStoreVisits() { unset($this->view_through_conversions_from_location_asset_store_visits); } /** * Estimated number of visits to the business after an impression. * This measure is coming from Asset based location. * * Generated from protobuf field optional double view_through_conversions_from_location_asset_store_visits = 280; * * @param float $var * @return $this */ public function setViewThroughConversionsFromLocationAssetStoreVisits($var) { GPBUtil::checkDouble($var); $this->view_through_conversions_from_location_asset_store_visits = $var; return $this; } /** * Number of website URL clicks on any location surface after an impression. * This measure is coming from Asset based location. * * Generated from protobuf field optional double view_through_conversions_from_location_asset_website = 281; * * @return float */ public function getViewThroughConversionsFromLocationAssetWebsite() { return isset($this->view_through_conversions_from_location_asset_website) ? $this->view_through_conversions_from_location_asset_website : 0.0; } public function hasViewThroughConversionsFromLocationAssetWebsite() { return isset($this->view_through_conversions_from_location_asset_website); } public function clearViewThroughConversionsFromLocationAssetWebsite() { unset($this->view_through_conversions_from_location_asset_website); } /** * Number of website URL clicks on any location surface after an impression. * This measure is coming from Asset based location. * * Generated from protobuf field optional double view_through_conversions_from_location_asset_website = 281; * * @param float $var * @return $this */ public function setViewThroughConversionsFromLocationAssetWebsite($var) { GPBUtil::checkDouble($var); $this->view_through_conversions_from_location_asset_website = $var; return $this; } /** * 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. * * Generated from protobuf field optional double orders = 296; * * @return float */ public function getOrders() { return isset($this->orders) ? $this->orders : 0.0; } public function hasOrders() { return isset($this->orders); } public function clearOrders() { unset($this->orders); } /** * 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. * * Generated from protobuf field optional double orders = 296; * * @param float $var * @return $this */ public function setOrders($var) { GPBUtil::checkDouble($var); $this->orders = $var; return $this; } /** * 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. * * Generated from protobuf field optional int64 average_order_value_micros = 297; * * @return int|string */ public function getAverageOrderValueMicros() { return isset($this->average_order_value_micros) ? $this->average_order_value_micros : 0; } public function hasAverageOrderValueMicros() { return isset($this->average_order_value_micros); } public function clearAverageOrderValueMicros() { unset($this->average_order_value_micros); } /** * 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. * * Generated from protobuf field optional int64 average_order_value_micros = 297; * * @param int|string $var * @return $this */ public function setAverageOrderValueMicros($var) { GPBUtil::checkInt64($var); $this->average_order_value_micros = $var; return $this; } /** * 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. * * Generated from protobuf field optional double average_cart_size = 298; * * @return float */ public function getAverageCartSize() { return isset($this->average_cart_size) ? $this->average_cart_size : 0.0; } public function hasAverageCartSize() { return isset($this->average_cart_size); } public function clearAverageCartSize() { unset($this->average_cart_size); } /** * 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. * * Generated from protobuf field optional double average_cart_size = 298; * * @param float $var * @return $this */ public function setAverageCartSize($var) { GPBUtil::checkDouble($var); $this->average_cart_size = $var; return $this; } /** * 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. * * Generated from protobuf field optional int64 cost_of_goods_sold_micros = 299; * * @return int|string */ public function getCostOfGoodsSoldMicros() { return isset($this->cost_of_goods_sold_micros) ? $this->cost_of_goods_sold_micros : 0; } public function hasCostOfGoodsSoldMicros() { return isset($this->cost_of_goods_sold_micros); } public function clearCostOfGoodsSoldMicros() { unset($this->cost_of_goods_sold_micros); } /** * 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. * * Generated from protobuf field optional int64 cost_of_goods_sold_micros = 299; * * @param int|string $var * @return $this */ public function setCostOfGoodsSoldMicros($var) { GPBUtil::checkInt64($var); $this->cost_of_goods_sold_micros = $var; return $this; } /** * 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. * * Generated from protobuf field optional int64 gross_profit_micros = 300; * * @return int|string */ public function getGrossProfitMicros() { return isset($this->gross_profit_micros) ? $this->gross_profit_micros : 0; } public function hasGrossProfitMicros() { return isset($this->gross_profit_micros); } public function clearGrossProfitMicros() { unset($this->gross_profit_micros); } /** * 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. * * Generated from protobuf field optional int64 gross_profit_micros = 300; * * @param int|string $var * @return $this */ public function setGrossProfitMicros($var) { GPBUtil::checkInt64($var); $this->gross_profit_micros = $var; return $this; } /** * 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. * * Generated from protobuf field optional double gross_profit_margin = 301; * * @return float */ public function getGrossProfitMargin() { return isset($this->gross_profit_margin) ? $this->gross_profit_margin : 0.0; } public function hasGrossProfitMargin() { return isset($this->gross_profit_margin); } public function clearGrossProfitMargin() { unset($this->gross_profit_margin); } /** * 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. * * Generated from protobuf field optional double gross_profit_margin = 301; * * @param float $var * @return $this */ public function setGrossProfitMargin($var) { GPBUtil::checkDouble($var); $this->gross_profit_margin = $var; return $this; } /** * 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. * * Generated from protobuf field optional int64 revenue_micros = 302; * * @return int|string */ public function getRevenueMicros() { return isset($this->revenue_micros) ? $this->revenue_micros : 0; } public function hasRevenueMicros() { return isset($this->revenue_micros); } public function clearRevenueMicros() { unset($this->revenue_micros); } /** * 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. * * Generated from protobuf field optional int64 revenue_micros = 302; * * @param int|string $var * @return $this */ public function setRevenueMicros($var) { GPBUtil::checkInt64($var); $this->revenue_micros = $var; return $this; } /** * 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. * * Generated from protobuf field optional double units_sold = 303; * * @return float */ public function getUnitsSold() { return isset($this->units_sold) ? $this->units_sold : 0.0; } public function hasUnitsSold() { return isset($this->units_sold); } public function clearUnitsSold() { unset($this->units_sold); } /** * 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. * * Generated from protobuf field optional double units_sold = 303; * * @param float $var * @return $this */ public function setUnitsSold($var) { GPBUtil::checkDouble($var); $this->units_sold = $var; return $this; } /** * 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. * * Generated from protobuf field optional int64 cross_sell_cost_of_goods_sold_micros = 304; * * @return int|string */ public function getCrossSellCostOfGoodsSoldMicros() { return isset($this->cross_sell_cost_of_goods_sold_micros) ? $this->cross_sell_cost_of_goods_sold_micros : 0; } public function hasCrossSellCostOfGoodsSoldMicros() { return isset($this->cross_sell_cost_of_goods_sold_micros); } public function clearCrossSellCostOfGoodsSoldMicros() { unset($this->cross_sell_cost_of_goods_sold_micros); } /** * 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. * * Generated from protobuf field optional int64 cross_sell_cost_of_goods_sold_micros = 304; * * @param int|string $var * @return $this */ public function setCrossSellCostOfGoodsSoldMicros($var) { GPBUtil::checkInt64($var); $this->cross_sell_cost_of_goods_sold_micros = $var; return $this; } /** * 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. * * Generated from protobuf field optional int64 cross_sell_gross_profit_micros = 305; * * @return int|string */ public function getCrossSellGrossProfitMicros() { return isset($this->cross_sell_gross_profit_micros) ? $this->cross_sell_gross_profit_micros : 0; } public function hasCrossSellGrossProfitMicros() { return isset($this->cross_sell_gross_profit_micros); } public function clearCrossSellGrossProfitMicros() { unset($this->cross_sell_gross_profit_micros); } /** * 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. * * Generated from protobuf field optional int64 cross_sell_gross_profit_micros = 305; * * @param int|string $var * @return $this */ public function setCrossSellGrossProfitMicros($var) { GPBUtil::checkInt64($var); $this->cross_sell_gross_profit_micros = $var; return $this; } /** * 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. * * Generated from protobuf field optional int64 cross_sell_revenue_micros = 306; * * @return int|string */ public function getCrossSellRevenueMicros() { return isset($this->cross_sell_revenue_micros) ? $this->cross_sell_revenue_micros : 0; } public function hasCrossSellRevenueMicros() { return isset($this->cross_sell_revenue_micros); } public function clearCrossSellRevenueMicros() { unset($this->cross_sell_revenue_micros); } /** * 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. * * Generated from protobuf field optional int64 cross_sell_revenue_micros = 306; * * @param int|string $var * @return $this */ public function setCrossSellRevenueMicros($var) { GPBUtil::checkInt64($var); $this->cross_sell_revenue_micros = $var; return $this; } /** * 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. * * Generated from protobuf field optional double cross_sell_units_sold = 307; * * @return float */ public function getCrossSellUnitsSold() { return isset($this->cross_sell_units_sold) ? $this->cross_sell_units_sold : 0.0; } public function hasCrossSellUnitsSold() { return isset($this->cross_sell_units_sold); } public function clearCrossSellUnitsSold() { unset($this->cross_sell_units_sold); } /** * 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. * * Generated from protobuf field optional double cross_sell_units_sold = 307; * * @param float $var * @return $this */ public function setCrossSellUnitsSold($var) { GPBUtil::checkDouble($var); $this->cross_sell_units_sold = $var; return $this; } /** * 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. * * Generated from protobuf field optional int64 lead_cost_of_goods_sold_micros = 308; * * @return int|string */ public function getLeadCostOfGoodsSoldMicros() { return isset($this->lead_cost_of_goods_sold_micros) ? $this->lead_cost_of_goods_sold_micros : 0; } public function hasLeadCostOfGoodsSoldMicros() { return isset($this->lead_cost_of_goods_sold_micros); } public function clearLeadCostOfGoodsSoldMicros() { unset($this->lead_cost_of_goods_sold_micros); } /** * 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. * * Generated from protobuf field optional int64 lead_cost_of_goods_sold_micros = 308; * * @param int|string $var * @return $this */ public function setLeadCostOfGoodsSoldMicros($var) { GPBUtil::checkInt64($var); $this->lead_cost_of_goods_sold_micros = $var; return $this; } /** * 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. * * Generated from protobuf field optional int64 lead_gross_profit_micros = 309; * * @return int|string */ public function getLeadGrossProfitMicros() { return isset($this->lead_gross_profit_micros) ? $this->lead_gross_profit_micros : 0; } public function hasLeadGrossProfitMicros() { return isset($this->lead_gross_profit_micros); } public function clearLeadGrossProfitMicros() { unset($this->lead_gross_profit_micros); } /** * 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. * * Generated from protobuf field optional int64 lead_gross_profit_micros = 309; * * @param int|string $var * @return $this */ public function setLeadGrossProfitMicros($var) { GPBUtil::checkInt64($var); $this->lead_gross_profit_micros = $var; return $this; } /** * 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. * * Generated from protobuf field optional int64 lead_revenue_micros = 310; * * @return int|string */ public function getLeadRevenueMicros() { return isset($this->lead_revenue_micros) ? $this->lead_revenue_micros : 0; } public function hasLeadRevenueMicros() { return isset($this->lead_revenue_micros); } public function clearLeadRevenueMicros() { unset($this->lead_revenue_micros); } /** * 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. * * Generated from protobuf field optional int64 lead_revenue_micros = 310; * * @param int|string $var * @return $this */ public function setLeadRevenueMicros($var) { GPBUtil::checkInt64($var); $this->lead_revenue_micros = $var; return $this; } /** * 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. * * Generated from protobuf field optional double lead_units_sold = 311; * * @return float */ public function getLeadUnitsSold() { return isset($this->lead_units_sold) ? $this->lead_units_sold : 0.0; } public function hasLeadUnitsSold() { return isset($this->lead_units_sold); } public function clearLeadUnitsSold() { unset($this->lead_units_sold); } /** * 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. * * Generated from protobuf field optional double lead_units_sold = 311; * * @param float $var * @return $this */ public function setLeadUnitsSold($var) { GPBUtil::checkDouble($var); $this->lead_units_sold = $var; return $this; } /** * 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. * * Generated from protobuf field optional int64 unique_users = 319; * * @return int|string */ public function getUniqueUsers() { return isset($this->unique_users) ? $this->unique_users : 0; } public function hasUniqueUsers() { return isset($this->unique_users); } public function clearUniqueUsers() { unset($this->unique_users); } /** * 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. * * Generated from protobuf field optional int64 unique_users = 319; * * @param int|string $var * @return $this */ public function setUniqueUsers($var) { GPBUtil::checkInt64($var); $this->unique_users = $var; return $this; } /** * 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. * * Generated from protobuf field optional double average_impression_frequency_per_user = 320; * * @return float */ public function getAverageImpressionFrequencyPerUser() { return isset($this->average_impression_frequency_per_user) ? $this->average_impression_frequency_per_user : 0.0; } public function hasAverageImpressionFrequencyPerUser() { return isset($this->average_impression_frequency_per_user); } public function clearAverageImpressionFrequencyPerUser() { unset($this->average_impression_frequency_per_user); } /** * 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. * * Generated from protobuf field optional double average_impression_frequency_per_user = 320; * * @param float $var * @return $this */ public function setAverageImpressionFrequencyPerUser($var) { GPBUtil::checkDouble($var); $this->average_impression_frequency_per_user = $var; return $this; } /** * Number of linked resources in which the asset is used. * This metric can only be selected with ChannelAggregateAssetView and * CampaignAggregateAssetView. * * Generated from protobuf field optional int64 linked_entities_count = 341; * * @return int|string */ public function getLinkedEntitiesCount() { return isset($this->linked_entities_count) ? $this->linked_entities_count : 0; } public function hasLinkedEntitiesCount() { return isset($this->linked_entities_count); } public function clearLinkedEntitiesCount() { unset($this->linked_entities_count); } /** * Number of linked resources in which the asset is used. * This metric can only be selected with ChannelAggregateAssetView and * CampaignAggregateAssetView. * * Generated from protobuf field optional int64 linked_entities_count = 341; * * @param int|string $var * @return $this */ public function setLinkedEntitiesCount($var) { GPBUtil::checkInt64($var); $this->linked_entities_count = $var; return $this; } /** * A list of up to 20 sample linked resources in which the asset is used. * This metric can only be selected with ChannelAggregateAssetView and * CampaignAggregateAssetView. * * Generated from protobuf field repeated string linked_sample_entities = 342; * * @return RepeatedField */ public function getLinkedSampleEntities() { return $this->linked_sample_entities; } /** * A list of up to 20 sample linked resources in which the asset is used. * This metric can only be selected with ChannelAggregateAssetView and * CampaignAggregateAssetView. * * Generated from protobuf field repeated string linked_sample_entities = 342; * * @param string[] $var * @return $this */ public function setLinkedSampleEntities($var) { $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); $this->linked_sample_entities = $arr; return $this; } /** * Number of total usages in which the asset is pinned. * This metric can only be selected with ChannelAggregateAssetView and * CampaignAggregateAssetView. * This metric is only supported in Search channel. * * Generated from protobuf field optional int64 asset_pinned_total_count = 348; * * @return int|string */ public function getAssetPinnedTotalCount() { return isset($this->asset_pinned_total_count) ? $this->asset_pinned_total_count : 0; } public function hasAssetPinnedTotalCount() { return isset($this->asset_pinned_total_count); } public function clearAssetPinnedTotalCount() { unset($this->asset_pinned_total_count); } /** * Number of total usages in which the asset is pinned. * This metric can only be selected with ChannelAggregateAssetView and * CampaignAggregateAssetView. * This metric is only supported in Search channel. * * Generated from protobuf field optional int64 asset_pinned_total_count = 348; * * @param int|string $var * @return $this */ public function setAssetPinnedTotalCount($var) { GPBUtil::checkInt64($var); $this->asset_pinned_total_count = $var; return $this; } /** * Number of entities in which the asset is pinned to headline 1. * This metric can only be selected with ChannelAggregateAssetView and * CampaignAggregateAssetView. * This metric is only supported in Search channel. * * Generated from protobuf field optional int64 asset_pinned_as_headline_position_one_count = 349; * * @return int|string */ public function getAssetPinnedAsHeadlinePositionOneCount() { return isset($this->asset_pinned_as_headline_position_one_count) ? $this->asset_pinned_as_headline_position_one_count : 0; } public function hasAssetPinnedAsHeadlinePositionOneCount() { return isset($this->asset_pinned_as_headline_position_one_count); } public function clearAssetPinnedAsHeadlinePositionOneCount() { unset($this->asset_pinned_as_headline_position_one_count); } /** * Number of entities in which the asset is pinned to headline 1. * This metric can only be selected with ChannelAggregateAssetView and * CampaignAggregateAssetView. * This metric is only supported in Search channel. * * Generated from protobuf field optional int64 asset_pinned_as_headline_position_one_count = 349; * * @param int|string $var * @return $this */ public function setAssetPinnedAsHeadlinePositionOneCount($var) { GPBUtil::checkInt64($var); $this->asset_pinned_as_headline_position_one_count = $var; return $this; } /** * Number of entities in which the asset is pinned to headline 2. * This metric can only be selected with ChannelAggregateAssetView and * CampaignAggregateAssetView. * This metric is only supported in Search channel. * * Generated from protobuf field optional int64 asset_pinned_as_headline_position_two_count = 350; * * @return int|string */ public function getAssetPinnedAsHeadlinePositionTwoCount() { return isset($this->asset_pinned_as_headline_position_two_count) ? $this->asset_pinned_as_headline_position_two_count : 0; } public function hasAssetPinnedAsHeadlinePositionTwoCount() { return isset($this->asset_pinned_as_headline_position_two_count); } public function clearAssetPinnedAsHeadlinePositionTwoCount() { unset($this->asset_pinned_as_headline_position_two_count); } /** * Number of entities in which the asset is pinned to headline 2. * This metric can only be selected with ChannelAggregateAssetView and * CampaignAggregateAssetView. * This metric is only supported in Search channel. * * Generated from protobuf field optional int64 asset_pinned_as_headline_position_two_count = 350; * * @param int|string $var * @return $this */ public function setAssetPinnedAsHeadlinePositionTwoCount($var) { GPBUtil::checkInt64($var); $this->asset_pinned_as_headline_position_two_count = $var; return $this; } /** * Number of entities in which the asset is pinned to headline 3. * This metric can only be selected with ChannelAggregateAssetView and * CampaignAggregateAssetView. * This metric is only supported in Search channel. * * Generated from protobuf field optional int64 asset_pinned_as_headline_position_three_count = 351; * * @return int|string */ public function getAssetPinnedAsHeadlinePositionThreeCount() { return isset($this->asset_pinned_as_headline_position_three_count) ? $this->asset_pinned_as_headline_position_three_count : 0; } public function hasAssetPinnedAsHeadlinePositionThreeCount() { return isset($this->asset_pinned_as_headline_position_three_count); } public function clearAssetPinnedAsHeadlinePositionThreeCount() { unset($this->asset_pinned_as_headline_position_three_count); } /** * Number of entities in which the asset is pinned to headline 3. * This metric can only be selected with ChannelAggregateAssetView and * CampaignAggregateAssetView. * This metric is only supported in Search channel. * * Generated from protobuf field optional int64 asset_pinned_as_headline_position_three_count = 351; * * @param int|string $var * @return $this */ public function setAssetPinnedAsHeadlinePositionThreeCount($var) { GPBUtil::checkInt64($var); $this->asset_pinned_as_headline_position_three_count = $var; return $this; } /** * Number of entities in which the asset is pinned to description 1. * This metric can only be selected with ChannelAggregateAssetView and * CampaignAggregateAssetView. * This metric is only supported in Search channel. * * Generated from protobuf field optional int64 asset_pinned_as_description_position_one_count = 352; * * @return int|string */ public function getAssetPinnedAsDescriptionPositionOneCount() { return isset($this->asset_pinned_as_description_position_one_count) ? $this->asset_pinned_as_description_position_one_count : 0; } public function hasAssetPinnedAsDescriptionPositionOneCount() { return isset($this->asset_pinned_as_description_position_one_count); } public function clearAssetPinnedAsDescriptionPositionOneCount() { unset($this->asset_pinned_as_description_position_one_count); } /** * Number of entities in which the asset is pinned to description 1. * This metric can only be selected with ChannelAggregateAssetView and * CampaignAggregateAssetView. * This metric is only supported in Search channel. * * Generated from protobuf field optional int64 asset_pinned_as_description_position_one_count = 352; * * @param int|string $var * @return $this */ public function setAssetPinnedAsDescriptionPositionOneCount($var) { GPBUtil::checkInt64($var); $this->asset_pinned_as_description_position_one_count = $var; return $this; } /** * Number of entities in which the asset is pinned to description 2. * This metric can only be selected with ChannelAggregateAssetView and * CampaignAggregateAssetView. * This metric is only supported in Search channel. * * Generated from protobuf field optional int64 asset_pinned_as_description_position_two_count = 353; * * @return int|string */ public function getAssetPinnedAsDescriptionPositionTwoCount() { return isset($this->asset_pinned_as_description_position_two_count) ? $this->asset_pinned_as_description_position_two_count : 0; } public function hasAssetPinnedAsDescriptionPositionTwoCount() { return isset($this->asset_pinned_as_description_position_two_count); } public function clearAssetPinnedAsDescriptionPositionTwoCount() { unset($this->asset_pinned_as_description_position_two_count); } /** * Number of entities in which the asset is pinned to description 2. * This metric can only be selected with ChannelAggregateAssetView and * CampaignAggregateAssetView. * This metric is only supported in Search channel. * * Generated from protobuf field optional int64 asset_pinned_as_description_position_two_count = 353; * * @param int|string $var * @return $this */ public function setAssetPinnedAsDescriptionPositionTwoCount($var) { GPBUtil::checkInt64($var); $this->asset_pinned_as_description_position_two_count = $var; return $this; } /** * The amount of business visits attributed by the last click model. * * Generated from protobuf field optional double store_visits_last_click_model_attributed_conversions = 365; * * @return float */ public function getStoreVisitsLastClickModelAttributedConversions() { return isset($this->store_visits_last_click_model_attributed_conversions) ? $this->store_visits_last_click_model_attributed_conversions : 0.0; } public function hasStoreVisitsLastClickModelAttributedConversions() { return isset($this->store_visits_last_click_model_attributed_conversions); } public function clearStoreVisitsLastClickModelAttributedConversions() { unset($this->store_visits_last_click_model_attributed_conversions); } /** * The amount of business visits attributed by the last click model. * * Generated from protobuf field optional double store_visits_last_click_model_attributed_conversions = 365; * * @param float $var * @return $this */ public function setStoreVisitsLastClickModelAttributedConversions($var) { GPBUtil::checkDouble($var); $this->store_visits_last_click_model_attributed_conversions = $var; return $this; } /** * The purchase conversion stats for the unified goals results. * * Generated from protobuf field optional double results_conversions_purchase = 366; * * @return float */ public function getResultsConversionsPurchase() { return isset($this->results_conversions_purchase) ? $this->results_conversions_purchase : 0.0; } public function hasResultsConversionsPurchase() { return isset($this->results_conversions_purchase); } public function clearResultsConversionsPurchase() { unset($this->results_conversions_purchase); } /** * The purchase conversion stats for the unified goals results. * * Generated from protobuf field optional double results_conversions_purchase = 366; * * @param float $var * @return $this */ public function setResultsConversionsPurchase($var) { GPBUtil::checkDouble($var); $this->results_conversions_purchase = $var; return $this; } /** * The number of TrueView views divided by number of impressions that can * potentially lead to TrueView views for in-feed formats. * * Generated from protobuf field optional double video_trueview_view_rate_in_feed = 408; * * @return float */ public function getVideoTrueviewViewRateInFeed() { return isset($this->video_trueview_view_rate_in_feed) ? $this->video_trueview_view_rate_in_feed : 0.0; } public function hasVideoTrueviewViewRateInFeed() { return isset($this->video_trueview_view_rate_in_feed); } public function clearVideoTrueviewViewRateInFeed() { unset($this->video_trueview_view_rate_in_feed); } /** * The number of TrueView views divided by number of impressions that can * potentially lead to TrueView views for in-feed formats. * * Generated from protobuf field optional double video_trueview_view_rate_in_feed = 408; * * @param float $var * @return $this */ public function setVideoTrueviewViewRateInFeed($var) { GPBUtil::checkDouble($var); $this->video_trueview_view_rate_in_feed = $var; return $this; } /** * The number of TrueView views divided by number of impressions that can * potentially lead to TrueView views for in-stream formats. * * Generated from protobuf field optional double video_trueview_view_rate_in_stream = 409; * * @return float */ public function getVideoTrueviewViewRateInStream() { return isset($this->video_trueview_view_rate_in_stream) ? $this->video_trueview_view_rate_in_stream : 0.0; } public function hasVideoTrueviewViewRateInStream() { return isset($this->video_trueview_view_rate_in_stream); } public function clearVideoTrueviewViewRateInStream() { unset($this->video_trueview_view_rate_in_stream); } /** * The number of TrueView views divided by number of impressions that can * potentially lead to TrueView views for in-stream formats. * * Generated from protobuf field optional double video_trueview_view_rate_in_stream = 409; * * @param float $var * @return $this */ public function setVideoTrueviewViewRateInStream($var) { GPBUtil::checkDouble($var); $this->video_trueview_view_rate_in_stream = $var; return $this; } /** * The number of TrueView views divided by number of impressions that can * potentially lead to TrueView views for Shorts ads. * * Generated from protobuf field optional double video_trueview_view_rate_shorts = 410; * * @return float */ public function getVideoTrueviewViewRateShorts() { return isset($this->video_trueview_view_rate_shorts) ? $this->video_trueview_view_rate_shorts : 0.0; } public function hasVideoTrueviewViewRateShorts() { return isset($this->video_trueview_view_rate_shorts); } public function clearVideoTrueviewViewRateShorts() { unset($this->video_trueview_view_rate_shorts); } /** * The number of TrueView views divided by number of impressions that can * potentially lead to TrueView views for Shorts ads. * * Generated from protobuf field optional double video_trueview_view_rate_shorts = 410; * * @param float $var * @return $this */ public function setVideoTrueviewViewRateShorts($var) { GPBUtil::checkDouble($var); $this->video_trueview_view_rate_shorts = $var; return $this; } /** * All co-viewed impressions represent the total number of people who saw your * ad. This includes people who are signed into their Google Account, as well * as other people who are watching the same ad on a connected TV. This metric * is only available for the Campaign resource with adjusted_age_range and * adjusted_gender segments. These segmentations are mandatory to get the * all coviewed impressions. * * Generated from protobuf field optional int64 coviewed_impressions = 380; * * @return int|string */ public function getCoviewedImpressions() { return isset($this->coviewed_impressions) ? $this->coviewed_impressions : 0; } public function hasCoviewedImpressions() { return isset($this->coviewed_impressions); } public function clearCoviewedImpressions() { unset($this->coviewed_impressions); } /** * All co-viewed impressions represent the total number of people who saw your * ad. This includes people who are signed into their Google Account, as well * as other people who are watching the same ad on a connected TV. This metric * is only available for the Campaign resource with adjusted_age_range and * adjusted_gender segments. These segmentations are mandatory to get the * all coviewed impressions. * * Generated from protobuf field optional int64 coviewed_impressions = 380; * * @param int|string $var * @return $this */ public function setCoviewedImpressions($var) { GPBUtil::checkInt64($var); $this->coviewed_impressions = $var; return $this; } /** * Primary impression is counted each time your ad is served. This metric is * only available for the Campaign resource with adjusted_age_range and * adjusted_gender segments. These segmentations are mandatory to get the * primary impressions. * * Generated from protobuf field optional int64 primary_impressions = 381; * * @return int|string */ public function getPrimaryImpressions() { return isset($this->primary_impressions) ? $this->primary_impressions : 0; } public function hasPrimaryImpressions() { return isset($this->primary_impressions); } public function clearPrimaryImpressions() { unset($this->primary_impressions); } /** * Primary impression is counted each time your ad is served. This metric is * only available for the Campaign resource with adjusted_age_range and * adjusted_gender segments. These segmentations are mandatory to get the * primary impressions. * * Generated from protobuf field optional int64 primary_impressions = 381; * * @param int|string $var * @return $this */ public function setPrimaryImpressions($var) { GPBUtil::checkInt64($var); $this->primary_impressions = $var; return $this; } /** * Platform comparable 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 for which include_in_conversions_metric * attribute is set to true. If you use conversion-based bidding, your bid * strategies will optimize for these conversions. * * Generated from protobuf field optional double platform_comparable_conversions_from_interactions_rate = 382; * * @return float */ public function getPlatformComparableConversionsFromInteractionsRate() { return isset($this->platform_comparable_conversions_from_interactions_rate) ? $this->platform_comparable_conversions_from_interactions_rate : 0.0; } public function hasPlatformComparableConversionsFromInteractionsRate() { return isset($this->platform_comparable_conversions_from_interactions_rate); } public function clearPlatformComparableConversionsFromInteractionsRate() { unset($this->platform_comparable_conversions_from_interactions_rate); } /** * Platform comparable 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 for which include_in_conversions_metric * attribute is set to true. If you use conversion-based bidding, your bid * strategies will optimize for these conversions. * * Generated from protobuf field optional double platform_comparable_conversions_from_interactions_rate = 382; * * @param float $var * @return $this */ public function setPlatformComparableConversionsFromInteractionsRate($var) { GPBUtil::checkDouble($var); $this->platform_comparable_conversions_from_interactions_rate = $var; return $this; } /** * The number of platform comparable conversions. This only includes * conversion actions for which include_in_conversions_metric attribute is set * to true. If you use conversion-based bidding, your bid strategies will * optimize for these conversions. * * Generated from protobuf field optional double platform_comparable_conversions = 383; * * @return float */ public function getPlatformComparableConversions() { return isset($this->platform_comparable_conversions) ? $this->platform_comparable_conversions : 0.0; } public function hasPlatformComparableConversions() { return isset($this->platform_comparable_conversions); } public function clearPlatformComparableConversions() { unset($this->platform_comparable_conversions); } /** * The number of platform comparable conversions. This only includes * conversion actions for which include_in_conversions_metric attribute is set * to true. If you use conversion-based bidding, your bid strategies will * optimize for these conversions. * * Generated from protobuf field optional double platform_comparable_conversions = 383; * * @param float $var * @return $this */ public function setPlatformComparableConversions($var) { GPBUtil::checkDouble($var); $this->platform_comparable_conversions = $var; return $this; } /** * The value of platform comparable 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. * * Generated from protobuf field optional double platform_comparable_conversions_value = 384; * * @return float */ public function getPlatformComparableConversionsValue() { return isset($this->platform_comparable_conversions_value) ? $this->platform_comparable_conversions_value : 0.0; } public function hasPlatformComparableConversionsValue() { return isset($this->platform_comparable_conversions_value); } public function clearPlatformComparableConversionsValue() { unset($this->platform_comparable_conversions_value); } /** * The value of platform comparable 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. * * Generated from protobuf field optional double platform_comparable_conversions_value = 384; * * @param float $var * @return $this */ public function setPlatformComparableConversionsValue($var) { GPBUtil::checkDouble($var); $this->platform_comparable_conversions_value = $var; return $this; } /** * The value of conversions divided by the cost of ad interactions. This only * includes conversion actions for which include_in_conversions_metric * attribute is set to true. If you use conversion-based bidding, your bid * strategies will optimize for these conversions. * * Generated from protobuf field optional double platform_comparable_conversions_value_per_cost = 385; * * @return float */ public function getPlatformComparableConversionsValuePerCost() { return isset($this->platform_comparable_conversions_value_per_cost) ? $this->platform_comparable_conversions_value_per_cost : 0.0; } public function hasPlatformComparableConversionsValuePerCost() { return isset($this->platform_comparable_conversions_value_per_cost); } public function clearPlatformComparableConversionsValuePerCost() { unset($this->platform_comparable_conversions_value_per_cost); } /** * The value of conversions divided by the cost of ad interactions. This only * includes conversion actions for which include_in_conversions_metric * attribute is set to true. If you use conversion-based bidding, your bid * strategies will optimize for these conversions. * * Generated from protobuf field optional double platform_comparable_conversions_value_per_cost = 385; * * @param float $var * @return $this */ public function setPlatformComparableConversionsValuePerCost($var) { GPBUtil::checkDouble($var); $this->platform_comparable_conversions_value_per_cost = $var; return $this; } /** * The number of platform comparable conversions. When this metric is * segmented by date, the values in the date segment represent the conversion * date. This only includes conversion actions for which * include_in_conversions_metric attribute is set to true. If you use * conversion-based bidding, your bid strategies will optimize for these * conversions. * * Generated from protobuf field optional double platform_comparable_conversions_by_conversion_date = 386; * * @return float */ public function getPlatformComparableConversionsByConversionDate() { return isset($this->platform_comparable_conversions_by_conversion_date) ? $this->platform_comparable_conversions_by_conversion_date : 0.0; } public function hasPlatformComparableConversionsByConversionDate() { return isset($this->platform_comparable_conversions_by_conversion_date); } public function clearPlatformComparableConversionsByConversionDate() { unset($this->platform_comparable_conversions_by_conversion_date); } /** * The number of platform comparable conversions. When this metric is * segmented by date, the values in the date segment represent the conversion * date. This only includes conversion actions for which * include_in_conversions_metric attribute is set to true. If you use * conversion-based bidding, your bid strategies will optimize for these * conversions. * * Generated from protobuf field optional double platform_comparable_conversions_by_conversion_date = 386; * * @param float $var * @return $this */ public function setPlatformComparableConversionsByConversionDate($var) { GPBUtil::checkDouble($var); $this->platform_comparable_conversions_by_conversion_date = $var; return $this; } /** * The value of platform comparable conversions. When this metric is segmented * by date, the values in the date segment represent the conversion date. This * only includes conversion actions for which include_in_conversions_metric * attribute is set to true. If you use conversion-based bidding, your bid * strategies will optimize for these conversions. * * Generated from protobuf field optional double platform_comparable_conversions_value_by_conversion_date = 387; * * @return float */ public function getPlatformComparableConversionsValueByConversionDate() { return isset($this->platform_comparable_conversions_value_by_conversion_date) ? $this->platform_comparable_conversions_value_by_conversion_date : 0.0; } public function hasPlatformComparableConversionsValueByConversionDate() { return isset($this->platform_comparable_conversions_value_by_conversion_date); } public function clearPlatformComparableConversionsValueByConversionDate() { unset($this->platform_comparable_conversions_value_by_conversion_date); } /** * The value of platform comparable conversions. When this metric is segmented * by date, the values in the date segment represent the conversion date. This * only includes conversion actions for which include_in_conversions_metric * attribute is set to true. If you use conversion-based bidding, your bid * strategies will optimize for these conversions. * * Generated from protobuf field optional double platform_comparable_conversions_value_by_conversion_date = 387; * * @param float $var * @return $this */ public function setPlatformComparableConversionsValueByConversionDate($var) { GPBUtil::checkDouble($var); $this->platform_comparable_conversions_value_by_conversion_date = $var; return $this; } /** * The value of platform comparable conversions from interactions divided by * the number of ad interactions. This only includes conversion actions for * which include_in_conversions_metric attribute is set to true. If you use * conversion-based bidding, your bid strategies will optimize for these * conversions. * * Generated from protobuf field optional double platform_comparable_conversions_from_interactions_value_per_interaction = 388; * * @return float */ public function getPlatformComparableConversionsFromInteractionsValuePerInteraction() { return isset($this->platform_comparable_conversions_from_interactions_value_per_interaction) ? $this->platform_comparable_conversions_from_interactions_value_per_interaction : 0.0; } public function hasPlatformComparableConversionsFromInteractionsValuePerInteraction() { return isset($this->platform_comparable_conversions_from_interactions_value_per_interaction); } public function clearPlatformComparableConversionsFromInteractionsValuePerInteraction() { unset($this->platform_comparable_conversions_from_interactions_value_per_interaction); } /** * The value of platform comparable conversions from interactions divided by * the number of ad interactions. This only includes conversion actions for * which include_in_conversions_metric attribute is set to true. If you use * conversion-based bidding, your bid strategies will optimize for these * conversions. * * Generated from protobuf field optional double platform_comparable_conversions_from_interactions_value_per_interaction = 388; * * @param float $var * @return $this */ public function setPlatformComparableConversionsFromInteractionsValuePerInteraction($var) { GPBUtil::checkDouble($var); $this->platform_comparable_conversions_from_interactions_value_per_interaction = $var; return $this; } /** * The cost of ad interactions divided by the number of platform comparable * conversions. This only includes conversion actions for which * include_in_conversions_metric attribute is set to true. If you use * conversion-based bidding, your bid strategies will optimize for these * conversions. * * Generated from protobuf field optional double cost_per_platform_comparable_conversion = 389; * * @return float */ public function getCostPerPlatformComparableConversion() { return isset($this->cost_per_platform_comparable_conversion) ? $this->cost_per_platform_comparable_conversion : 0.0; } public function hasCostPerPlatformComparableConversion() { return isset($this->cost_per_platform_comparable_conversion); } public function clearCostPerPlatformComparableConversion() { unset($this->cost_per_platform_comparable_conversion); } /** * The cost of ad interactions divided by the number of platform comparable * conversions. This only includes conversion actions for which * include_in_conversions_metric attribute is set to true. If you use * conversion-based bidding, your bid strategies will optimize for these * conversions. * * Generated from protobuf field optional double cost_per_platform_comparable_conversion = 389; * * @param float $var * @return $this */ public function setCostPerPlatformComparableConversion($var) { GPBUtil::checkDouble($var); $this->cost_per_platform_comparable_conversion = $var; return $this; } /** * The value of platform comparable conversions divided by the number of * platform comparable conversions. This only includes conversion actions for * which include_in_conversions_metric attribute is set to true. If you use * conversion-based bidding, your bid strategies will optimize for these * conversions. * * Generated from protobuf field optional double value_per_platform_comparable_conversion = 390; * * @return float */ public function getValuePerPlatformComparableConversion() { return isset($this->value_per_platform_comparable_conversion) ? $this->value_per_platform_comparable_conversion : 0.0; } public function hasValuePerPlatformComparableConversion() { return isset($this->value_per_platform_comparable_conversion); } public function clearValuePerPlatformComparableConversion() { unset($this->value_per_platform_comparable_conversion); } /** * The value of platform comparable conversions divided by the number of * platform comparable conversions. This only includes conversion actions for * which include_in_conversions_metric attribute is set to true. If you use * conversion-based bidding, your bid strategies will optimize for these * conversions. * * Generated from protobuf field optional double value_per_platform_comparable_conversion = 390; * * @param float $var * @return $this */ public function setValuePerPlatformComparableConversion($var) { GPBUtil::checkDouble($var); $this->value_per_platform_comparable_conversion = $var; return $this; } /** * The value of platform comparable conversions divided by the number of * platform comparable conversions. When this metric is segmented by date, the * values in the date segment represent the conversion date. This only * includes conversion actions for which include_in_conversions_metric * attribute is set to true. If you use conversion-based bidding, your bid * strategies will optimize for these conversions. * * Generated from protobuf field optional double value_per_platform_comparable_conversions_by_conversion_date = 391; * * @return float */ public function getValuePerPlatformComparableConversionsByConversionDate() { return isset($this->value_per_platform_comparable_conversions_by_conversion_date) ? $this->value_per_platform_comparable_conversions_by_conversion_date : 0.0; } public function hasValuePerPlatformComparableConversionsByConversionDate() { return isset($this->value_per_platform_comparable_conversions_by_conversion_date); } public function clearValuePerPlatformComparableConversionsByConversionDate() { unset($this->value_per_platform_comparable_conversions_by_conversion_date); } /** * The value of platform comparable conversions divided by the number of * platform comparable conversions. When this metric is segmented by date, the * values in the date segment represent the conversion date. This only * includes conversion actions for which include_in_conversions_metric * attribute is set to true. If you use conversion-based bidding, your bid * strategies will optimize for these conversions. * * Generated from protobuf field optional double value_per_platform_comparable_conversions_by_conversion_date = 391; * * @param float $var * @return $this */ public function setValuePerPlatformComparableConversionsByConversionDate($var) { GPBUtil::checkDouble($var); $this->value_per_platform_comparable_conversions_by_conversion_date = $var; return $this; } /** * The cost of the platform comparable conversion in the currency of the * authorized customer. * * Generated from protobuf field optional double cost_converted_currency_per_platform_comparable_conversion = 392; * * @return float */ public function getCostConvertedCurrencyPerPlatformComparableConversion() { return isset($this->cost_converted_currency_per_platform_comparable_conversion) ? $this->cost_converted_currency_per_platform_comparable_conversion : 0.0; } public function hasCostConvertedCurrencyPerPlatformComparableConversion() { return isset($this->cost_converted_currency_per_platform_comparable_conversion); } public function clearCostConvertedCurrencyPerPlatformComparableConversion() { unset($this->cost_converted_currency_per_platform_comparable_conversion); } /** * The cost of the platform comparable conversion in the currency of the * authorized customer. * * Generated from protobuf field optional double cost_converted_currency_per_platform_comparable_conversion = 392; * * @param float $var * @return $this */ public function setCostConvertedCurrencyPerPlatformComparableConversion($var) { GPBUtil::checkDouble($var); $this->cost_converted_currency_per_platform_comparable_conversion = $var; return $this; } /** * This metric counts the unique individuals who were shown your video ad two * or more times within the selected date range. This metric cannot be * aggregated, and can only be requested for date ranges of 31 days or less. * * Generated from protobuf field optional int64 unique_users_two_plus = 393; * * @return int|string */ public function getUniqueUsersTwoPlus() { return isset($this->unique_users_two_plus) ? $this->unique_users_two_plus : 0; } public function hasUniqueUsersTwoPlus() { return isset($this->unique_users_two_plus); } public function clearUniqueUsersTwoPlus() { unset($this->unique_users_two_plus); } /** * This metric counts the unique individuals who were shown your video ad two * or more times within the selected date range. This metric cannot be * aggregated, and can only be requested for date ranges of 31 days or less. * * Generated from protobuf field optional int64 unique_users_two_plus = 393; * * @param int|string $var * @return $this */ public function setUniqueUsersTwoPlus($var) { GPBUtil::checkInt64($var); $this->unique_users_two_plus = $var; return $this; } /** * This metric counts the unique individuals who were shown your video ad * three or more times within the selected date range. This metric cannot be * aggregated, and can only be requested for date ranges of 31 days or less. * * Generated from protobuf field optional int64 unique_users_three_plus = 394; * * @return int|string */ public function getUniqueUsersThreePlus() { return isset($this->unique_users_three_plus) ? $this->unique_users_three_plus : 0; } public function hasUniqueUsersThreePlus() { return isset($this->unique_users_three_plus); } public function clearUniqueUsersThreePlus() { unset($this->unique_users_three_plus); } /** * This metric counts the unique individuals who were shown your video ad * three or more times within the selected date range. This metric cannot be * aggregated, and can only be requested for date ranges of 31 days or less. * * Generated from protobuf field optional int64 unique_users_three_plus = 394; * * @param int|string $var * @return $this */ public function setUniqueUsersThreePlus($var) { GPBUtil::checkInt64($var); $this->unique_users_three_plus = $var; return $this; } /** * This metric counts the unique individuals who were shown your video ad four * or more times within the selected date range. This metric cannot be * aggregated, and can only be requested for date ranges of 31 days or less. * * Generated from protobuf field optional int64 unique_users_four_plus = 395; * * @return int|string */ public function getUniqueUsersFourPlus() { return isset($this->unique_users_four_plus) ? $this->unique_users_four_plus : 0; } public function hasUniqueUsersFourPlus() { return isset($this->unique_users_four_plus); } public function clearUniqueUsersFourPlus() { unset($this->unique_users_four_plus); } /** * This metric counts the unique individuals who were shown your video ad four * or more times within the selected date range. This metric cannot be * aggregated, and can only be requested for date ranges of 31 days or less. * * Generated from protobuf field optional int64 unique_users_four_plus = 395; * * @param int|string $var * @return $this */ public function setUniqueUsersFourPlus($var) { GPBUtil::checkInt64($var); $this->unique_users_four_plus = $var; return $this; } /** * This metric counts the unique individuals who were shown your video ad five * or more times within the selected date range. This metric cannot be * aggregated, and can only be requested for date ranges of 31 days or less. * * Generated from protobuf field optional int64 unique_users_five_plus = 396; * * @return int|string */ public function getUniqueUsersFivePlus() { return isset($this->unique_users_five_plus) ? $this->unique_users_five_plus : 0; } public function hasUniqueUsersFivePlus() { return isset($this->unique_users_five_plus); } public function clearUniqueUsersFivePlus() { unset($this->unique_users_five_plus); } /** * This metric counts the unique individuals who were shown your video ad five * or more times within the selected date range. This metric cannot be * aggregated, and can only be requested for date ranges of 31 days or less. * * Generated from protobuf field optional int64 unique_users_five_plus = 396; * * @param int|string $var * @return $this */ public function setUniqueUsersFivePlus($var) { GPBUtil::checkInt64($var); $this->unique_users_five_plus = $var; return $this; } /** * This metric counts the unique individuals who were shown your video ad ten * or more times within the selected date range. This metric cannot be * aggregated, and can only be requested for date ranges of 31 days or less. * * Generated from protobuf field optional int64 unique_users_ten_plus = 397; * * @return int|string */ public function getUniqueUsersTenPlus() { return isset($this->unique_users_ten_plus) ? $this->unique_users_ten_plus : 0; } public function hasUniqueUsersTenPlus() { return isset($this->unique_users_ten_plus); } public function clearUniqueUsersTenPlus() { unset($this->unique_users_ten_plus); } /** * This metric counts the unique individuals who were shown your video ad ten * or more times within the selected date range. This metric cannot be * aggregated, and can only be requested for date ranges of 31 days or less. * * Generated from protobuf field optional int64 unique_users_ten_plus = 397; * * @param int|string $var * @return $this */ public function setUniqueUsersTenPlus($var) { GPBUtil::checkInt64($var); $this->unique_users_ten_plus = $var; return $this; } /** * The conversion value rule adjustment from biddable conversions in all * conversion categories. * * Generated from protobuf field optional double value_adjustment = 398; * * @return float */ public function getValueAdjustment() { return isset($this->value_adjustment) ? $this->value_adjustment : 0.0; } public function hasValueAdjustment() { return isset($this->value_adjustment); } public function clearValueAdjustment() { unset($this->value_adjustment); } /** * The conversion value rule adjustment from biddable conversions in all * conversion categories. * * Generated from protobuf field optional double value_adjustment = 398; * * @param float $var * @return $this */ public function setValueAdjustment($var) { GPBUtil::checkDouble($var); $this->value_adjustment = $var; return $this; } /** * The conversion value rule adjustment from all conversions in all conversion * categories. * * Generated from protobuf field optional double all_value_adjustment = 399; * * @return float */ public function getAllValueAdjustment() { return isset($this->all_value_adjustment) ? $this->all_value_adjustment : 0.0; } public function hasAllValueAdjustment() { return isset($this->all_value_adjustment); } public function clearAllValueAdjustment() { unset($this->all_value_adjustment); } /** * The conversion value rule adjustment from all conversions in all conversion * categories. * * Generated from protobuf field optional double all_value_adjustment = 399; * * @param float $var * @return $this */ public function setAllValueAdjustment($var) { GPBUtil::checkDouble($var); $this->all_value_adjustment = $var; return $this; } /** * Unique query intent cluster count for clicks. * * Generated from protobuf field optional int64 clicks_unique_query_clusters = 400; * * @return int|string */ public function getClicksUniqueQueryClusters() { return isset($this->clicks_unique_query_clusters) ? $this->clicks_unique_query_clusters : 0; } public function hasClicksUniqueQueryClusters() { return isset($this->clicks_unique_query_clusters); } public function clearClicksUniqueQueryClusters() { unset($this->clicks_unique_query_clusters); } /** * Unique query intent cluster count for clicks. * * Generated from protobuf field optional int64 clicks_unique_query_clusters = 400; * * @param int|string $var * @return $this */ public function setClicksUniqueQueryClusters($var) { GPBUtil::checkInt64($var); $this->clicks_unique_query_clusters = $var; return $this; } /** * Unique query intent cluster count for conversions. * * Generated from protobuf field optional int64 conversions_unique_query_clusters = 401; * * @return int|string */ public function getConversionsUniqueQueryClusters() { return isset($this->conversions_unique_query_clusters) ? $this->conversions_unique_query_clusters : 0; } public function hasConversionsUniqueQueryClusters() { return isset($this->conversions_unique_query_clusters); } public function clearConversionsUniqueQueryClusters() { unset($this->conversions_unique_query_clusters); } /** * Unique query intent cluster count for conversions. * * Generated from protobuf field optional int64 conversions_unique_query_clusters = 401; * * @param int|string $var * @return $this */ public function setConversionsUniqueQueryClusters($var) { GPBUtil::checkInt64($var); $this->conversions_unique_query_clusters = $var; return $this; } /** * Unique query intent cluster count for impressions. * * Generated from protobuf field optional int64 impressions_unique_query_clusters = 402; * * @return int|string */ public function getImpressionsUniqueQueryClusters() { return isset($this->impressions_unique_query_clusters) ? $this->impressions_unique_query_clusters : 0; } public function hasImpressionsUniqueQueryClusters() { return isset($this->impressions_unique_query_clusters); } public function clearImpressionsUniqueQueryClusters() { unset($this->impressions_unique_query_clusters); } /** * Unique query intent cluster count for impressions. * * Generated from protobuf field optional int64 impressions_unique_query_clusters = 402; * * @param int|string $var * @return $this */ public function setImpressionsUniqueQueryClusters($var) { GPBUtil::checkInt64($var); $this->impressions_unique_query_clusters = $var; return $this; } /** * Total watch time duration in milliseconds for video impressions that * started playing. For a small percentage of impressions, we may not be able * to measure the watch time accurately. In such cases, we adjust the total * time to account for any unmeasured time by applying the average watch time * of impressions that were measured. * * Generated from protobuf field optional int64 video_watch_time_duration_millis = 403; * * @return int|string */ public function getVideoWatchTimeDurationMillis() { return isset($this->video_watch_time_duration_millis) ? $this->video_watch_time_duration_millis : 0; } public function hasVideoWatchTimeDurationMillis() { return isset($this->video_watch_time_duration_millis); } public function clearVideoWatchTimeDurationMillis() { unset($this->video_watch_time_duration_millis); } /** * Total watch time duration in milliseconds for video impressions that * started playing. For a small percentage of impressions, we may not be able * to measure the watch time accurately. In such cases, we adjust the total * time to account for any unmeasured time by applying the average watch time * of impressions that were measured. * * Generated from protobuf field optional int64 video_watch_time_duration_millis = 403; * * @param int|string $var * @return $this */ public function setVideoWatchTimeDurationMillis($var) { GPBUtil::checkInt64($var); $this->video_watch_time_duration_millis = $var; return $this; } /** * Average video watch time duration in milliseconds for video impressions * that started playing. * * Generated from protobuf field optional int64 average_video_watch_time_duration_millis = 404; * * @return int|string */ public function getAverageVideoWatchTimeDurationMillis() { return isset($this->average_video_watch_time_duration_millis) ? $this->average_video_watch_time_duration_millis : 0; } public function hasAverageVideoWatchTimeDurationMillis() { return isset($this->average_video_watch_time_duration_millis); } public function clearAverageVideoWatchTimeDurationMillis() { unset($this->average_video_watch_time_duration_millis); } /** * Average video watch time duration in milliseconds for video impressions * that started playing. * * Generated from protobuf field optional int64 average_video_watch_time_duration_millis = 404; * * @param int|string $var * @return $this */ public function setAverageVideoWatchTimeDurationMillis($var) { GPBUtil::checkInt64($var); $this->average_video_watch_time_duration_millis = $var; return $this; } /** * This feature is available to allowlisted accounts only. * * Generated from protobuf field optional int64 svr = 411; * * @return int|string */ public function getSvr() { return isset($this->svr) ? $this->svr : 0; } public function hasSvr() { return isset($this->svr); } public function clearSvr() { unset($this->svr); } /** * This feature is available to allowlisted accounts only. * * Generated from protobuf field optional int64 svr = 411; * * @param int|string $var * @return $this */ public function setSvr($var) { GPBUtil::checkInt64($var); $this->svr = $var; return $this; } /** * The number of impressions for which Active View could measure if the ad was * audible. * * Generated from protobuf field optional int64 active_view_audibility_measurable_impressions = 412; * * @return int|string */ public function getActiveViewAudibilityMeasurableImpressions() { return isset($this->active_view_audibility_measurable_impressions) ? $this->active_view_audibility_measurable_impressions : 0; } public function hasActiveViewAudibilityMeasurableImpressions() { return isset($this->active_view_audibility_measurable_impressions); } public function clearActiveViewAudibilityMeasurableImpressions() { unset($this->active_view_audibility_measurable_impressions); } /** * The number of impressions for which Active View could measure if the ad was * audible. * * Generated from protobuf field optional int64 active_view_audibility_measurable_impressions = 412; * * @param int|string $var * @return $this */ public function setActiveViewAudibilityMeasurableImpressions($var) { GPBUtil::checkInt64($var); $this->active_view_audibility_measurable_impressions = $var; return $this; } /** * The number of impressions for which Active View could measure if the ad was * audible, divided by the total number of impressions with Active View audio * enabled. * * Generated from protobuf field optional double active_view_audibility_measurable_impressions_rate = 413; * * @return float */ public function getActiveViewAudibilityMeasurableImpressionsRate() { return isset($this->active_view_audibility_measurable_impressions_rate) ? $this->active_view_audibility_measurable_impressions_rate : 0.0; } public function hasActiveViewAudibilityMeasurableImpressionsRate() { return isset($this->active_view_audibility_measurable_impressions_rate); } public function clearActiveViewAudibilityMeasurableImpressionsRate() { unset($this->active_view_audibility_measurable_impressions_rate); } /** * The number of impressions for which Active View could measure if the ad was * audible, divided by the total number of impressions with Active View audio * enabled. * * Generated from protobuf field optional double active_view_audibility_measurable_impressions_rate = 413; * * @param float $var * @return $this */ public function setActiveViewAudibilityMeasurableImpressionsRate($var) { GPBUtil::checkDouble($var); $this->active_view_audibility_measurable_impressions_rate = $var; return $this; } /** * The number of impressions for which Active View could measure audibility, * but that were filtered out by traffic quality filters, divided by the * total number of impressions measurable for audibility. * * Generated from protobuf field optional double active_view_audibility_invalid_measurable_impressions_rate = 414; * * @return float */ public function getActiveViewAudibilityInvalidMeasurableImpressionsRate() { return isset($this->active_view_audibility_invalid_measurable_impressions_rate) ? $this->active_view_audibility_invalid_measurable_impressions_rate : 0.0; } public function hasActiveViewAudibilityInvalidMeasurableImpressionsRate() { return isset($this->active_view_audibility_invalid_measurable_impressions_rate); } public function clearActiveViewAudibilityInvalidMeasurableImpressionsRate() { unset($this->active_view_audibility_invalid_measurable_impressions_rate); } /** * The number of impressions for which Active View could measure audibility, * but that were filtered out by traffic quality filters, divided by the * total number of impressions measurable for audibility. * * Generated from protobuf field optional double active_view_audibility_invalid_measurable_impressions_rate = 414; * * @param float $var * @return $this */ public function setActiveViewAudibilityInvalidMeasurableImpressionsRate($var) { GPBUtil::checkDouble($var); $this->active_view_audibility_invalid_measurable_impressions_rate = $var; return $this; } /** * The number of impressions for which Active View could measure audibility, * but that were filtered out by traffic quality filters, divided by the total * number of impressions measurable for audibility. Only includes GIVT * (general invalid traffic) impressions. * * Generated from protobuf field optional double active_view_audibility_invalid_givt_measurable_impressions_rate = 415; * * @return float */ public function getActiveViewAudibilityInvalidGivtMeasurableImpressionsRate() { return isset($this->active_view_audibility_invalid_givt_measurable_impressions_rate) ? $this->active_view_audibility_invalid_givt_measurable_impressions_rate : 0.0; } public function hasActiveViewAudibilityInvalidGivtMeasurableImpressionsRate() { return isset($this->active_view_audibility_invalid_givt_measurable_impressions_rate); } public function clearActiveViewAudibilityInvalidGivtMeasurableImpressionsRate() { unset($this->active_view_audibility_invalid_givt_measurable_impressions_rate); } /** * The number of impressions for which Active View could measure audibility, * but that were filtered out by traffic quality filters, divided by the total * number of impressions measurable for audibility. Only includes GIVT * (general invalid traffic) impressions. * * Generated from protobuf field optional double active_view_audibility_invalid_givt_measurable_impressions_rate = 415; * * @param float $var * @return $this */ public function setActiveViewAudibilityInvalidGivtMeasurableImpressionsRate($var) { GPBUtil::checkDouble($var); $this->active_view_audibility_invalid_givt_measurable_impressions_rate = $var; return $this; } /** * The number of impressions that were audible (volume > 0%) at any point * during the ad playback. * * Generated from protobuf field optional int64 active_view_audible_impressions = 416; * * @return int|string */ public function getActiveViewAudibleImpressions() { return isset($this->active_view_audible_impressions) ? $this->active_view_audible_impressions : 0; } public function hasActiveViewAudibleImpressions() { return isset($this->active_view_audible_impressions); } public function clearActiveViewAudibleImpressions() { unset($this->active_view_audible_impressions); } /** * The number of impressions that were audible (volume > 0%) at any point * during the ad playback. * * Generated from protobuf field optional int64 active_view_audible_impressions = 416; * * @param int|string $var * @return $this */ public function setActiveViewAudibleImpressions($var) { GPBUtil::checkInt64($var); $this->active_view_audible_impressions = $var; return $this; } /** * The number of impressions that were audible (volume > 0%) at any point * during the ad playback, divided by the total number of impressions * measurable for audibility. * * Generated from protobuf field optional double active_view_audible_impressions_rate = 417; * * @return float */ public function getActiveViewAudibleImpressionsRate() { return isset($this->active_view_audible_impressions_rate) ? $this->active_view_audible_impressions_rate : 0.0; } public function hasActiveViewAudibleImpressionsRate() { return isset($this->active_view_audible_impressions_rate); } public function clearActiveViewAudibleImpressionsRate() { unset($this->active_view_audible_impressions_rate); } /** * The number of impressions that were audible (volume > 0%) at any point * during the ad playback, divided by the total number of impressions * measurable for audibility. * * Generated from protobuf field optional double active_view_audible_impressions_rate = 417; * * @param float $var * @return $this */ public function setActiveViewAudibleImpressionsRate($var) { GPBUtil::checkDouble($var); $this->active_view_audible_impressions_rate = $var; return $this; } /** * The number of impressions that were audible for at least 2 seconds * (cumulative). * * Generated from protobuf field optional int64 active_view_audible_two_seconds_impressions = 418; * * @return int|string */ public function getActiveViewAudibleTwoSecondsImpressions() { return isset($this->active_view_audible_two_seconds_impressions) ? $this->active_view_audible_two_seconds_impressions : 0; } public function hasActiveViewAudibleTwoSecondsImpressions() { return isset($this->active_view_audible_two_seconds_impressions); } public function clearActiveViewAudibleTwoSecondsImpressions() { unset($this->active_view_audible_two_seconds_impressions); } /** * The number of impressions that were audible for at least 2 seconds * (cumulative). * * Generated from protobuf field optional int64 active_view_audible_two_seconds_impressions = 418; * * @param int|string $var * @return $this */ public function setActiveViewAudibleTwoSecondsImpressions($var) { GPBUtil::checkInt64($var); $this->active_view_audible_two_seconds_impressions = $var; return $this; } /** * The number of impressions that were audible for at least 2 seconds * (cumulative), divided by the total number of impressions measurable for * audibility. * * Generated from protobuf field optional double active_view_audible_two_seconds_impressions_rate = 419; * * @return float */ public function getActiveViewAudibleTwoSecondsImpressionsRate() { return isset($this->active_view_audible_two_seconds_impressions_rate) ? $this->active_view_audible_two_seconds_impressions_rate : 0.0; } public function hasActiveViewAudibleTwoSecondsImpressionsRate() { return isset($this->active_view_audible_two_seconds_impressions_rate); } public function clearActiveViewAudibleTwoSecondsImpressionsRate() { unset($this->active_view_audible_two_seconds_impressions_rate); } /** * The number of impressions that were audible for at least 2 seconds * (cumulative), divided by the total number of impressions measurable for * audibility. * * Generated from protobuf field optional double active_view_audible_two_seconds_impressions_rate = 419; * * @param float $var * @return $this */ public function setActiveViewAudibleTwoSecondsImpressionsRate($var) { GPBUtil::checkDouble($var); $this->active_view_audible_two_seconds_impressions_rate = $var; return $this; } /** * The number of impressions that were audible for at least 30 seconds * (cumulative). * * Generated from protobuf field optional int64 active_view_audible_thirty_seconds_impressions = 420; * * @return int|string */ public function getActiveViewAudibleThirtySecondsImpressions() { return isset($this->active_view_audible_thirty_seconds_impressions) ? $this->active_view_audible_thirty_seconds_impressions : 0; } public function hasActiveViewAudibleThirtySecondsImpressions() { return isset($this->active_view_audible_thirty_seconds_impressions); } public function clearActiveViewAudibleThirtySecondsImpressions() { unset($this->active_view_audible_thirty_seconds_impressions); } /** * The number of impressions that were audible for at least 30 seconds * (cumulative). * * Generated from protobuf field optional int64 active_view_audible_thirty_seconds_impressions = 420; * * @param int|string $var * @return $this */ public function setActiveViewAudibleThirtySecondsImpressions($var) { GPBUtil::checkInt64($var); $this->active_view_audible_thirty_seconds_impressions = $var; return $this; } /** * The number of impressions that were audible for at least 30 seconds * (cumulative), divided by the total number of impressions measurable for * audibility. * * Generated from protobuf field optional double active_view_audible_thirty_seconds_impressions_rate = 421; * * @return float */ public function getActiveViewAudibleThirtySecondsImpressionsRate() { return isset($this->active_view_audible_thirty_seconds_impressions_rate) ? $this->active_view_audible_thirty_seconds_impressions_rate : 0.0; } public function hasActiveViewAudibleThirtySecondsImpressionsRate() { return isset($this->active_view_audible_thirty_seconds_impressions_rate); } public function clearActiveViewAudibleThirtySecondsImpressionsRate() { unset($this->active_view_audible_thirty_seconds_impressions_rate); } /** * The number of impressions that were audible for at least 30 seconds * (cumulative), divided by the total number of impressions measurable for * audibility. * * Generated from protobuf field optional double active_view_audible_thirty_seconds_impressions_rate = 421; * * @param float $var * @return $this */ public function setActiveViewAudibleThirtySecondsImpressionsRate($var) { GPBUtil::checkDouble($var); $this->active_view_audible_thirty_seconds_impressions_rate = $var; return $this; } /** * The number of impressions that were audible at the first quartile of the * ad playback, divided by the total number of impressions measurable for * audibility. * * Generated from protobuf field optional double active_view_audible_quartile_p25_rate = 422; * * @return float */ public function getActiveViewAudibleQuartileP25Rate() { return isset($this->active_view_audible_quartile_p25_rate) ? $this->active_view_audible_quartile_p25_rate : 0.0; } public function hasActiveViewAudibleQuartileP25Rate() { return isset($this->active_view_audible_quartile_p25_rate); } public function clearActiveViewAudibleQuartileP25Rate() { unset($this->active_view_audible_quartile_p25_rate); } /** * The number of impressions that were audible at the first quartile of the * ad playback, divided by the total number of impressions measurable for * audibility. * * Generated from protobuf field optional double active_view_audible_quartile_p25_rate = 422; * * @param float $var * @return $this */ public function setActiveViewAudibleQuartileP25Rate($var) { GPBUtil::checkDouble($var); $this->active_view_audible_quartile_p25_rate = $var; return $this; } /** * The number of impressions that were audible at the second quartile of the * ad playback, divided by the total number of impressions measurable for * audibility. * * Generated from protobuf field optional double active_view_audible_quartile_p50_rate = 423; * * @return float */ public function getActiveViewAudibleQuartileP50Rate() { return isset($this->active_view_audible_quartile_p50_rate) ? $this->active_view_audible_quartile_p50_rate : 0.0; } public function hasActiveViewAudibleQuartileP50Rate() { return isset($this->active_view_audible_quartile_p50_rate); } public function clearActiveViewAudibleQuartileP50Rate() { unset($this->active_view_audible_quartile_p50_rate); } /** * The number of impressions that were audible at the second quartile of the * ad playback, divided by the total number of impressions measurable for * audibility. * * Generated from protobuf field optional double active_view_audible_quartile_p50_rate = 423; * * @param float $var * @return $this */ public function setActiveViewAudibleQuartileP50Rate($var) { GPBUtil::checkDouble($var); $this->active_view_audible_quartile_p50_rate = $var; return $this; } /** * The number of impressions that were audible at the third quartile of the * ad playback, divided by the total number of impressions measurable for * audibility. * * Generated from protobuf field optional double active_view_audible_quartile_p75_rate = 424; * * @return float */ public function getActiveViewAudibleQuartileP75Rate() { return isset($this->active_view_audible_quartile_p75_rate) ? $this->active_view_audible_quartile_p75_rate : 0.0; } public function hasActiveViewAudibleQuartileP75Rate() { return isset($this->active_view_audible_quartile_p75_rate); } public function clearActiveViewAudibleQuartileP75Rate() { unset($this->active_view_audible_quartile_p75_rate); } /** * The number of impressions that were audible at the third quartile of the * ad playback, divided by the total number of impressions measurable for * audibility. * * Generated from protobuf field optional double active_view_audible_quartile_p75_rate = 424; * * @param float $var * @return $this */ public function setActiveViewAudibleQuartileP75Rate($var) { GPBUtil::checkDouble($var); $this->active_view_audible_quartile_p75_rate = $var; return $this; } /** * The number of impressions that were audible at the fourth quartile of the * ad playback, divided by the total number of impressions measurable for * audibility. * * Generated from protobuf field optional double active_view_audible_quartile_p100_rate = 425; * * @return float */ public function getActiveViewAudibleQuartileP100Rate() { return isset($this->active_view_audible_quartile_p100_rate) ? $this->active_view_audible_quartile_p100_rate : 0.0; } public function hasActiveViewAudibleQuartileP100Rate() { return isset($this->active_view_audible_quartile_p100_rate); } public function clearActiveViewAudibleQuartileP100Rate() { unset($this->active_view_audible_quartile_p100_rate); } /** * The number of impressions that were audible at the fourth quartile of the * ad playback, divided by the total number of impressions measurable for * audibility. * * Generated from protobuf field optional double active_view_audible_quartile_p100_rate = 425; * * @param float $var * @return $this */ public function setActiveViewAudibleQuartileP100Rate($var) { GPBUtil::checkDouble($var); $this->active_view_audible_quartile_p100_rate = $var; return $this; } /** * The number of biddable first in app conversions where the app install was * driven by interaction with a web campaign. * * Generated from protobuf field optional int64 biddable_indirect_install_first_in_app_conversion_micros = 426; * * @return int|string */ public function getBiddableIndirectInstallFirstInAppConversionMicros() { return isset($this->biddable_indirect_install_first_in_app_conversion_micros) ? $this->biddable_indirect_install_first_in_app_conversion_micros : 0; } public function hasBiddableIndirectInstallFirstInAppConversionMicros() { return isset($this->biddable_indirect_install_first_in_app_conversion_micros); } public function clearBiddableIndirectInstallFirstInAppConversionMicros() { unset($this->biddable_indirect_install_first_in_app_conversion_micros); } /** * The number of biddable first in app conversions where the app install was * driven by interaction with a web campaign. * * Generated from protobuf field optional int64 biddable_indirect_install_first_in_app_conversion_micros = 426; * * @param int|string $var * @return $this */ public function setBiddableIndirectInstallFirstInAppConversionMicros($var) { GPBUtil::checkInt64($var); $this->biddable_indirect_install_first_in_app_conversion_micros = $var; return $this; } }