Interface MetricsOrBuilder
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
Metrics,Metrics.Builder
public interface MetricsOrBuilder
extends com.google.protobuf.MessageOrBuilder
-
Method Summary
Modifier and TypeMethodDescriptiondoubleSearch absolute top impression share is the percentage of your Search ad impressions that are shown in the most prominent Search position.doubleAverage cost of viewable impressions (`active_view_impressions`).doubleActive view measurable clicks divided by active view viewable impressions.longA measurement of how often your ad has become viewable on a Display Network site.doubleThe ratio of impressions that could be measured by Active View over the number of served impressions.longThe cost of the impressions you received that were measurable by Active View.longThe number of times your ads are appearing on placements in positions where they can be seen.doubleThe percentage of time when your ad appeared on an Active View enabled site (measurable impressions) and was viewable (viewable impressions).doubleThe total number of conversions.doubleThe total number of conversions.doubleThe number of times people clicked the "Call" button to call a store during or after clicking an ad.doubleThe number of times people clicked a "Get directions" button to navigate to a store after clicking an ad.doubleAll conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions.doubleThe value of all conversions from interactions divided by the total number of interactions.doubleNumber of call button clicks on any location surface after a chargeable ad event (click or impression).doubleNumber of driving directions clicks on any location surface after a chargeable ad event (click or impression).doubleNumber of menu link clicks on any location surface after a chargeable ad event (click or impression).doubleNumber of order clicks on any location surface after a chargeable ad event (click or impression).doubleNumber of other types of local action clicks on any location surface after a chargeable ad event (click or impression).doubleEstimated number of visits to the store after a chargeable ad event (click or impression).doubleNumber of website URL clicks on any location surface after a chargeable ad event (click or impression).doubleThe number of times people clicked a link to view a store's menu after clicking an ad.doubleThe number of times people placed an order at a store after clicking an ad.doubleThe number of other conversions (for example, posting a review or saving a location for a store) that occurred after people clicked an ad.doubleEstimated number of times people visited a store after clicking an ad.doubleThe number of times that people were taken to a store's URL after clicking an ad.doubleThe value of all conversions.doubleThe value of all conversions.doubleThe value of all conversions divided by the total cost of ad interactions (such as clicks for text ads or views for video ads).doubleAll of new customers' lifetime conversion value.doublePercentage of cost the asset received in ads with AssetPerformanceLabel.BEST.doublePercentage of impressions the asset received in ads with AssetPerformanceLabel.BEST.doublePercentage of cost the asset received in ads with AssetPerformanceLabel.GOOD.doublePercentage of impressions the asset received in ads with AssetPerformanceLabel.GOOD.doublePercentage of cost the asset received in ads with AssetPerformanceLabel.LEARNING.doublePercentage of impressions the asset received in ads with AssetPerformanceLabel.LEARNING.doublePercentage of cost the asset received in ads with AssetPerformanceLabel.LOW.doublePercentage of impressions the asset received in ads with AssetPerformanceLabel.LOW.longNumber of entities in which the asset is pinned to description 1.longNumber of entities in which the asset is pinned to description 2.longNumber of entities in which the asset is pinned to headline 1.longNumber of entities in which the asset is pinned to headline 3.longNumber of entities in which the asset is pinned to headline 2.longNumber of total usages in which the asset is pinned.doublePercentage of cost the asset received in ads with AssetPerformanceLabel other than BEST, GOOD, LOW, and LEARNING.doublePercentage of impressions the asset received in ads with AssetPerformanceLabel other than BEST, GOOD, LOW, and LEARNING.doubleThis 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.doubleThis 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.doubleThis 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.doubleThis 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.doubleThis 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.doubleThis 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.doubleAverage cart size is the average number of products in each order attributed to your ads.doubleThe average amount you pay per interaction.doubleThe total cost of all clicks divided by the total number of clicks received.doubleThe average amount that you've been charged for an ad engagement.doubleAverage cost-per-thousand impressions (CPM).doubleThe average amount you pay each time someone views your ad.doubleThe average number of times a unique user saw your ad during the requested time period.longAverage order value is the average revenue you made per order attributed to your ads.doubleAverage number of pages viewed per session.longThe average Target CPA, or unset if not available (for example, for campaigns that had traffic from portfolio bidding strategies or non-tCPA).doubleThe average Target ROAS, or unset if not available (for example, for campaigns that had traffic from portfolio bidding strategies or non-tROAS).doubleTotal duration of all sessions (in seconds) / number of sessions.doubleAn indication of how other advertisers are bidding on similar products.doubleAn indication on how other advertisers' Shopping ads for similar products are performing based on how often people who see their ad click on it.doubleNumber of app installs.doubleNumber of in-app actions.doublePercentage of clicks where the user only visited a single page on your site.longThe number of clicks.longThe number of times your ad or your site's listing in the unpaid results was clicked.doubleThe number of times your ad or your site's listing in the unpaid results was clicked (combined_clicks) divided by combined_queries.longThe number of searches that returned pages from your site in the unpaid results or showed one of your text ads.doubleThe estimated percent of times that your ad was eligible to show on the Display Network but didn't because your budget was too low.doubleThe impressions you've received on the Display Network divided by the estimated number of impressions you were eligible to receive.doubleThe estimated percentage of impressions on the Display Network that your ads didn't receive due to poor Ad Rank.The date of the most recent conversion for this conversion action.com.google.protobuf.ByteStringThe date of the most recent conversion for this conversion action.The last date/time a conversion tag for this conversion action successfully fired and was seen by Google Ads.com.google.protobuf.ByteStringThe last date/time a conversion tag for this conversion action successfully fired and was seen by Google Ads.doubleThe number of conversions.doubleThe number of conversions.doubleConversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads).doubleThe value of conversions from interactions divided by the number of ad interactions.doubleThe value of conversions.doubleThe value of conversions.doubleThe value of conversions divided by the cost of ad interactions.longThe sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period.longCost of goods sold (COGS) is the total cost of the products you sold in orders attributed to your ads.doubleThe cost of ad interactions divided by all conversions.doubleThe cost of ad interactions divided by conversions.doubleThe cost of ad interactions divided by current model attributed conversions.doubleConversions from when a customer clicks on a Google Ads ad on one device, then converts on a different device or browser.longThe sum of the value of cross-device conversions, in micros.longCross-sell cost of goods sold (COGS) is the total cost of products sold as a result of advertising a different product.longCross-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).longCross-sell revenue is the total amount you made from products sold as a result of advertising a different product.doubleCross-sell units sold is the total number of products sold as a result of advertising a different product.doublegetCtr()The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions).doubleShows how your historic conversions data would look under the attribution model you've currently selected.doubleCurrent model attributed conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads).doubleThe value of current model attributed conversions from interactions divided by the number of ad interactions.doubleThe value of current model attributed conversions.doubleThe value of current model attributed conversions divided by the cost of ad interactions.longNumber of impressions in which the store location was shown or the location was used for targeting.doubleHow often people engage with your ad after it's shown to them.longThe number of engagements.doubleThe percentage of clicks that have been filtered out of your total number of clicks (filtered + non-filtered clicks) due to being general invalid clicks.longNumber of general invalid clicks.longThe number of times the ad was forwarded to someone else as a message.longThe number of times someone has saved your Gmail ad to their inbox as a message.longThe number of clicks to the landing page on the expanded state of Gmail ads.doubleGross profit margin is the percentage gross profit you made from orders attributed to your ads, after taking out the cost of goods sold (COGS).longGross profit is the profit you made from orders attributed to your ads minus the cost of goods sold (COGS).The creative historical quality score.intThe creative historical quality score.The quality of historical landing page experience.intThe quality of historical landing page experience.longThe historical quality score.The historical search predicted click through rate (CTR).intThe historical search predicted click through rate (CTR).doubleAverage lead value based on clicks.longCommission bid rate in micros.longThe number of impressions that hotel partners could have had given their feed performance.doubleExpected commission cost.doubleThe average price difference between the price offered by reporting hotel advertiser and the cheapest price offered by the competing advertiser.longCount of how often your ad has appeared on a search results page or website on the Google Network.longThe number of times a store's location-based ad was shown.getInteractionEventTypes(int index) The types of payable and free interactions.intThe types of payable and free interactions.The types of payable and free interactions.intgetInteractionEventTypesValue(int index) The types of payable and free interactions.The types of payable and free interactions.doubleHow often people interact with your ad after it is shown to them.longThe number of interactions.doubleThe percentage of clicks filtered out of your total number of clicks (filtered + non-filtered clicks) during the reporting period.longNumber of clicks Google considers illegitimate and doesn't charge you for.longLead cost of goods sold (COGS) is the total cost of products sold as a result of advertising the same product.longLead gross profit is the profit you made from products sold as a result of advertising the same product, minus cost of goods sold (COGS).longLead revenue is the total amount you made from products sold as a result of advertising the same product.doubleLead units sold is the total number of products sold as a result of advertising the same product.longNumber of linked resources in which the asset is used.getLinkedSampleEntities(int index) A list of up to 20 sample linked resources in which the asset is used.com.google.protobuf.ByteStringgetLinkedSampleEntitiesBytes(int index) A list of up to 20 sample linked resources in which the asset is used.intA list of up to 20 sample linked resources in which the asset is used.A list of up to 20 sample linked resources in which the asset is used.doubleNumber of message chats initiated (message_chats) divided by the number of message impressions (message_impressions).longNumber of message chats initiated for Click To Message impressions that were message tracking eligible.longNumber of Click To Message impressions that were message tracking eligible.doubleThe percentage of mobile clicks that go to a mobile-friendly page.doubleNew customers' lifetime conversion value.doubleTotal optimization score uplift of all recommendations.URL for the optimization score page in the Google Ads web interface.com.google.protobuf.ByteStringURL for the optimization score page in the Google Ads web interface.doubleOrders is the total number of purchase conversions you received attributed to your ads.longThe number of times someone clicked your site's listing in the unpaid results for a particular query.doubleThe 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).longThe number of listings for your site in the unpaid search results.doubleThe 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).longThe total number of searches that returned your site's listing in the unpaid results.doublePercentage of first-time sessions (from people who had never visited your site before).longNumber of offline phone calls.longNumber of offline phone impressions.doubleNumber of phone calls received (phone_calls) divided by the number of times your phone number is shown (phone_impressions).longClicks from properties for which the traffic the publisher has not paid for or acquired through incentivized activitylongClicks from properties not owned by the publisher for which the traffic the publisher has paid for or acquired through incentivized activitylongClicks from traffic which is not identified as "Publisher Purchased" or "Publisher Organic"doubleYour clickthrough rate (Ctr) divided by the average clickthrough rate of all advertisers on the websites that show your ads.doubleThe purchase conversion stats for the unified goals results.longRevenue is the total amount you made from orders attributed to your ads.getSampleBestPerformanceEntities(int index) A list of up to 20 sample linked resources with impressions in the last 30 days where the asset had the AssetPerformanceLabel.BEST performance label.com.google.protobuf.ByteStringgetSampleBestPerformanceEntitiesBytes(int index) A list of up to 20 sample linked resources with impressions in the last 30 days where the asset had the AssetPerformanceLabel.BEST performance label.intA list of up to 20 sample linked resources with impressions in the last 30 days where the asset had the AssetPerformanceLabel.BEST performance label.A list of up to 20 sample linked resources with impressions in the last 30 days where the asset had the AssetPerformanceLabel.BEST performance label.getSampleGoodPerformanceEntities(int index) A list of up to 20 sample linked resources with impressions in the last 30 days where the asset had the AssetPerformanceLabel.GOOD performance label.com.google.protobuf.ByteStringgetSampleGoodPerformanceEntitiesBytes(int index) A list of up to 20 sample linked resources with impressions in the last 30 days where the asset had the AssetPerformanceLabel.GOOD performance label.intA list of up to 20 sample linked resources with impressions in the last 30 days where the asset had the AssetPerformanceLabel.GOOD performance label.A list of up to 20 sample linked resources with impressions in the last 30 days where the asset had the AssetPerformanceLabel.GOOD performance label.getSampleLearningPerformanceEntities(int index) A list of up to 20 sample linked resources with impressions in the last 30 days where the asset had the AssetPerformanceLabel.LEARNING performance label.com.google.protobuf.ByteStringgetSampleLearningPerformanceEntitiesBytes(int index) A list of up to 20 sample linked resources with impressions in the last 30 days where the asset had the AssetPerformanceLabel.LEARNING performance label.intA list of up to 20 sample linked resources with impressions in the last 30 days where the asset had the AssetPerformanceLabel.LEARNING performance label.A list of up to 20 sample linked resources with impressions in the last 30 days where the asset had the AssetPerformanceLabel.LEARNING performance label.getSampleLowPerformanceEntities(int index) A list of up to 20 sample linked resources with impressions in the last 30 days where the asset had the AssetPerformanceLabel.LOW performance label.com.google.protobuf.ByteStringgetSampleLowPerformanceEntitiesBytes(int index) A list of up to 20 sample linked resources with impressions in the last 30 days where the asset had the AssetPerformanceLabel.LOW performance label.intA list of up to 20 sample linked resources with impressions in the last 30 days where the asset had the AssetPerformanceLabel.LOW performance label.A list of up to 20 sample linked resources with impressions in the last 30 days where the asset had the AssetPerformanceLabel.LOW performance label.getSampleUnratedPerformanceEntities(int index) A list of up to 20 sample linked resources with impressions in the last 30 days where the assets had AssetPerformanceLabel performance label other than BEST, GOOD, LOW, and LEARNING.com.google.protobuf.ByteStringgetSampleUnratedPerformanceEntitiesBytes(int index) A list of up to 20 sample linked resources with impressions in the last 30 days where the assets had AssetPerformanceLabel performance label other than BEST, GOOD, LOW, and LEARNING.intA list of up to 20 sample linked resources with impressions in the last 30 days where the assets had AssetPerformanceLabel performance label other than BEST, GOOD, LOW, and LEARNING.A list of up to 20 sample linked resources with impressions in the last 30 days where the assets had AssetPerformanceLabel performance label other than BEST, GOOD, LOW, and LEARNING.doubleThe percentage of the customer's Shopping or Search ad impressions that are shown in the most prominent Shopping position.doubleThe 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.doubleThe estimated percent of times that your ad was eligible to show on the Search Network but didn't because your budget was too low.doubleThe number estimating how often your ad didn't show adjacent to the top organic search results due to a low budget.doubleThe number of clicks you've received on the Search Network divided by the estimated number of clicks you were eligible to receive.doubleThe 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.doubleThe impressions you've received on the Search Network divided by the estimated number of impressions you were eligible to receive.doubleThe 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.doubleThe estimated percentage of impressions on the Search Network that your ads didn't receive due to poor Ad Rank.doubleThe number estimating how often your ad didn't show adjacent to the top organic search results due to poor Ad Rank.doubleThe impressions you've received among the top ads compared to the estimated number of impressions you were eligible to receive among the top ads.Search volume range for a search term insight category.Search volume range for a search term insight category.longThe number of iOS Store Kit Ad Network conversions.longThe total number of iOS Store Kit Ad Network conversions.longA measure of how quickly your page loads after clicks on your mobile ads.doubleThe amount of store visits attributed by the last click model.doubleThe percent of your ad impressions that are shown adjacent to the top organic search results.longThe number of unique users who saw your ad during the requested time period.doubleUnits sold is the total number of products sold from orders attributed to your ads.doubleThe percentage of ad clicks to Accelerated Mobile Pages (AMP) landing pages that reach a valid AMP page.doubleThe value of all conversions divided by the number of all conversions.doubleThe value of all conversions divided by the number of all conversions.doubleThe value of conversions divided by the number of conversions.doubleThe value of conversions divided by the number of conversions.doubleThe value of current model attributed conversions divided by the number of the conversions.doublePercentage of impressions where the viewer watched all of your video.doublePercentage of impressions where the viewer watched 25% of your video.doublePercentage of impressions where the viewer watched 50% of your video.doublePercentage of impressions where the viewer watched 75% of your video.doubleThe number of views your TrueView video ad receives divided by its number of impressions, including thumbnail impressions for TrueView in-display ads.doubleThe number of video views divided by number of impressions that can potentially lead to video views for in-feed formats.doubleThe number of video views divided by number of impressions that can potentially lead to video views for in-stream formats.doubleThe number of video views divided by number of impressions that can potentially lead to video views for in shorts formats.longThe number of times your video ads were viewed.longThe total number of view-through conversions.doubleNumber of call button clicks on any location surface after an impression.doubleNumber of driving directions clicks on any location surface after an impression.doubleNumber of menu link clicks on any location surface after an impression.doubleNumber of order clicks on any location surface after an impression.doubleNumber of other types of local action clicks on any location surface after an impression.doubleEstimated number of visits to the store after an impression.doubleNumber of website URL clicks on any location surface after an impression.booleanSearch absolute top impression share is the percentage of your Search ad impressions that are shown in the most prominent Search position.booleanAverage cost of viewable impressions (`active_view_impressions`).booleanActive view measurable clicks divided by active view viewable impressions.booleanA measurement of how often your ad has become viewable on a Display Network site.booleanThe ratio of impressions that could be measured by Active View over the number of served impressions.booleanThe cost of the impressions you received that were measurable by Active View.booleanThe number of times your ads are appearing on placements in positions where they can be seen.booleanThe percentage of time when your ad appeared on an Active View enabled site (measurable impressions) and was viewable (viewable impressions).booleanThe total number of conversions.booleanThe total number of conversions.booleanThe number of times people clicked the "Call" button to call a store during or after clicking an ad.booleanThe number of times people clicked a "Get directions" button to navigate to a store after clicking an ad.booleanAll conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions.booleanThe value of all conversions from interactions divided by the total number of interactions.booleanNumber of call button clicks on any location surface after a chargeable ad event (click or impression).booleanNumber of driving directions clicks on any location surface after a chargeable ad event (click or impression).booleanNumber of menu link clicks on any location surface after a chargeable ad event (click or impression).booleanNumber of order clicks on any location surface after a chargeable ad event (click or impression).booleanNumber of other types of local action clicks on any location surface after a chargeable ad event (click or impression).booleanEstimated number of visits to the store after a chargeable ad event (click or impression).booleanNumber of website URL clicks on any location surface after a chargeable ad event (click or impression).booleanThe number of times people clicked a link to view a store's menu after clicking an ad.booleanThe number of times people placed an order at a store after clicking an ad.booleanThe number of other conversions (for example, posting a review or saving a location for a store) that occurred after people clicked an ad.booleanEstimated number of times people visited a store after clicking an ad.booleanThe number of times that people were taken to a store's URL after clicking an ad.booleanThe value of all conversions.booleanThe value of all conversions.booleanThe value of all conversions divided by the total cost of ad interactions (such as clicks for text ads or views for video ads).booleanAll of new customers' lifetime conversion value.booleanPercentage of cost the asset received in ads with AssetPerformanceLabel.BEST.booleanPercentage of impressions the asset received in ads with AssetPerformanceLabel.BEST.booleanPercentage of cost the asset received in ads with AssetPerformanceLabel.GOOD.booleanPercentage of impressions the asset received in ads with AssetPerformanceLabel.GOOD.booleanPercentage of cost the asset received in ads with AssetPerformanceLabel.LEARNING.booleanPercentage of impressions the asset received in ads with AssetPerformanceLabel.LEARNING.booleanPercentage of cost the asset received in ads with AssetPerformanceLabel.LOW.booleanPercentage of impressions the asset received in ads with AssetPerformanceLabel.LOW.booleanNumber of entities in which the asset is pinned to description 1.booleanNumber of entities in which the asset is pinned to description 2.booleanNumber of entities in which the asset is pinned to headline 1.booleanNumber of entities in which the asset is pinned to headline 3.booleanNumber of entities in which the asset is pinned to headline 2.booleanNumber of total usages in which the asset is pinned.booleanPercentage of cost the asset received in ads with AssetPerformanceLabel other than BEST, GOOD, LOW, and LEARNING.booleanPercentage of impressions the asset received in ads with AssetPerformanceLabel other than BEST, GOOD, LOW, and LEARNING.booleanThis 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.booleanThis 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.booleanThis 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.booleanThis 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.booleanThis 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.booleanThis 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.booleanAverage cart size is the average number of products in each order attributed to your ads.booleanThe average amount you pay per interaction.booleanThe total cost of all clicks divided by the total number of clicks received.booleanThe average amount that you've been charged for an ad engagement.booleanAverage cost-per-thousand impressions (CPM).booleanThe average amount you pay each time someone views your ad.booleanThe average number of times a unique user saw your ad during the requested time period.booleanAverage order value is the average revenue you made per order attributed to your ads.booleanAverage number of pages viewed per session.booleanThe average Target CPA, or unset if not available (for example, for campaigns that had traffic from portfolio bidding strategies or non-tCPA).booleanThe average Target ROAS, or unset if not available (for example, for campaigns that had traffic from portfolio bidding strategies or non-tROAS).booleanTotal duration of all sessions (in seconds) / number of sessions.booleanAn indication of how other advertisers are bidding on similar products.booleanAn indication on how other advertisers' Shopping ads for similar products are performing based on how often people who see their ad click on it.booleanNumber of app installs.booleanNumber of in-app actions.booleanPercentage of clicks where the user only visited a single page on your site.booleanThe number of clicks.booleanThe number of times your ad or your site's listing in the unpaid results was clicked.booleanThe number of times your ad or your site's listing in the unpaid results was clicked (combined_clicks) divided by combined_queries.booleanThe number of searches that returned pages from your site in the unpaid results or showed one of your text ads.booleanThe estimated percent of times that your ad was eligible to show on the Display Network but didn't because your budget was too low.booleanThe impressions you've received on the Display Network divided by the estimated number of impressions you were eligible to receive.booleanThe estimated percentage of impressions on the Display Network that your ads didn't receive due to poor Ad Rank.booleanThe date of the most recent conversion for this conversion action.booleanThe last date/time a conversion tag for this conversion action successfully fired and was seen by Google Ads.booleanThe number of conversions.booleanThe number of conversions.booleanConversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads).booleanThe value of conversions from interactions divided by the number of ad interactions.booleanThe value of conversions.booleanThe value of conversions.booleanThe value of conversions divided by the cost of ad interactions.booleanThe sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period.booleanCost of goods sold (COGS) is the total cost of the products you sold in orders attributed to your ads.booleanThe cost of ad interactions divided by all conversions.booleanThe cost of ad interactions divided by conversions.booleanThe cost of ad interactions divided by current model attributed conversions.booleanConversions from when a customer clicks on a Google Ads ad on one device, then converts on a different device or browser.booleanThe sum of the value of cross-device conversions, in micros.booleanCross-sell cost of goods sold (COGS) is the total cost of products sold as a result of advertising a different product.booleanCross-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).booleanCross-sell revenue is the total amount you made from products sold as a result of advertising a different product.booleanCross-sell units sold is the total number of products sold as a result of advertising a different product.booleanhasCtr()The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions).booleanShows how your historic conversions data would look under the attribution model you've currently selected.booleanCurrent model attributed conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads).booleanThe value of current model attributed conversions from interactions divided by the number of ad interactions.booleanThe value of current model attributed conversions.booleanThe value of current model attributed conversions divided by the cost of ad interactions.booleanNumber of impressions in which the store location was shown or the location was used for targeting.booleanHow often people engage with your ad after it's shown to them.booleanThe number of engagements.booleanThe percentage of clicks that have been filtered out of your total number of clicks (filtered + non-filtered clicks) due to being general invalid clicks.booleanNumber of general invalid clicks.booleanThe number of times the ad was forwarded to someone else as a message.booleanThe number of times someone has saved your Gmail ad to their inbox as a message.booleanThe number of clicks to the landing page on the expanded state of Gmail ads.booleanGross profit margin is the percentage gross profit you made from orders attributed to your ads, after taking out the cost of goods sold (COGS).booleanGross profit is the profit you made from orders attributed to your ads minus the cost of goods sold (COGS).booleanThe historical quality score.booleanAverage lead value based on clicks.booleanCommission bid rate in micros.booleanThe number of impressions that hotel partners could have had given their feed performance.booleanExpected commission cost.booleanThe average price difference between the price offered by reporting hotel advertiser and the cheapest price offered by the competing advertiser.booleanCount of how often your ad has appeared on a search results page or website on the Google Network.booleanThe number of times a store's location-based ad was shown.booleanHow often people interact with your ad after it is shown to them.booleanThe number of interactions.booleanThe percentage of clicks filtered out of your total number of clicks (filtered + non-filtered clicks) during the reporting period.booleanNumber of clicks Google considers illegitimate and doesn't charge you for.booleanLead cost of goods sold (COGS) is the total cost of products sold as a result of advertising the same product.booleanLead gross profit is the profit you made from products sold as a result of advertising the same product, minus cost of goods sold (COGS).booleanLead revenue is the total amount you made from products sold as a result of advertising the same product.booleanLead units sold is the total number of products sold as a result of advertising the same product.booleanNumber of linked resources in which the asset is used.booleanNumber of message chats initiated (message_chats) divided by the number of message impressions (message_impressions).booleanNumber of message chats initiated for Click To Message impressions that were message tracking eligible.booleanNumber of Click To Message impressions that were message tracking eligible.booleanThe percentage of mobile clicks that go to a mobile-friendly page.booleanNew customers' lifetime conversion value.booleanTotal optimization score uplift of all recommendations.booleanURL for the optimization score page in the Google Ads web interface.booleanOrders is the total number of purchase conversions you received attributed to your ads.booleanThe number of times someone clicked your site's listing in the unpaid results for a particular query.booleanThe 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).booleanThe number of listings for your site in the unpaid search results.booleanThe 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).booleanThe total number of searches that returned your site's listing in the unpaid results.booleanPercentage of first-time sessions (from people who had never visited your site before).booleanNumber of offline phone calls.booleanNumber of offline phone impressions.booleanNumber of phone calls received (phone_calls) divided by the number of times your phone number is shown (phone_impressions).booleanYour clickthrough rate (Ctr) divided by the average clickthrough rate of all advertisers on the websites that show your ads.booleanThe purchase conversion stats for the unified goals results.booleanRevenue is the total amount you made from orders attributed to your ads.booleanThe percentage of the customer's Shopping or Search ad impressions that are shown in the most prominent Shopping position.booleanThe 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.booleanThe estimated percent of times that your ad was eligible to show on the Search Network but didn't because your budget was too low.booleanThe number estimating how often your ad didn't show adjacent to the top organic search results due to a low budget.booleanThe number of clicks you've received on the Search Network divided by the estimated number of clicks you were eligible to receive.booleanThe 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.booleanThe impressions you've received on the Search Network divided by the estimated number of impressions you were eligible to receive.booleanThe 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.booleanThe estimated percentage of impressions on the Search Network that your ads didn't receive due to poor Ad Rank.booleanThe number estimating how often your ad didn't show adjacent to the top organic search results due to poor Ad Rank.booleanThe impressions you've received among the top ads compared to the estimated number of impressions you were eligible to receive among the top ads.booleanSearch volume range for a search term insight category.booleanA measure of how quickly your page loads after clicks on your mobile ads.booleanThe amount of store visits attributed by the last click model.booleanThe percent of your ad impressions that are shown adjacent to the top organic search results.booleanThe number of unique users who saw your ad during the requested time period.booleanUnits sold is the total number of products sold from orders attributed to your ads.booleanThe percentage of ad clicks to Accelerated Mobile Pages (AMP) landing pages that reach a valid AMP page.booleanThe value of all conversions divided by the number of all conversions.booleanThe value of all conversions divided by the number of all conversions.booleanThe value of conversions divided by the number of conversions.booleanThe value of conversions divided by the number of conversions.booleanThe value of current model attributed conversions divided by the number of the conversions.booleanPercentage of impressions where the viewer watched all of your video.booleanPercentage of impressions where the viewer watched 25% of your video.booleanPercentage of impressions where the viewer watched 50% of your video.booleanPercentage of impressions where the viewer watched 75% of your video.booleanThe number of views your TrueView video ad receives divided by its number of impressions, including thumbnail impressions for TrueView in-display ads.booleanThe number of video views divided by number of impressions that can potentially lead to video views for in-feed formats.booleanThe number of video views divided by number of impressions that can potentially lead to video views for in-stream formats.booleanThe number of video views divided by number of impressions that can potentially lead to video views for in shorts formats.booleanThe number of times your video ads were viewed.booleanThe total number of view-through conversions.booleanNumber of call button clicks on any location surface after an impression.booleanNumber of driving directions clicks on any location surface after an impression.booleanNumber of menu link clicks on any location surface after an impression.booleanNumber of order clicks on any location surface after an impression.booleanNumber of other types of local action clicks on any location surface after an impression.booleanEstimated number of visits to the store after an impression.booleanNumber of website URL clicks on any location surface after an impression.Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitializedMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
hasAbsoluteTopImpressionPercentage
boolean hasAbsoluteTopImpressionPercentage()Search absolute top impression share is the percentage of your Search ad impressions that are shown in the most prominent Search position.
optional double absolute_top_impression_percentage = 183;- Returns:
- Whether the absoluteTopImpressionPercentage field is set.
-
getAbsoluteTopImpressionPercentage
double getAbsoluteTopImpressionPercentage()Search absolute top impression share is the percentage of your Search ad impressions that are shown in the most prominent Search position.
optional double absolute_top_impression_percentage = 183;- Returns:
- The absoluteTopImpressionPercentage.
-
hasActiveViewCpm
boolean hasActiveViewCpm()Average cost of viewable impressions (`active_view_impressions`).
optional double active_view_cpm = 184;- Returns:
- Whether the activeViewCpm field is set.
-
getActiveViewCpm
double getActiveViewCpm()Average cost of viewable impressions (`active_view_impressions`).
optional double active_view_cpm = 184;- Returns:
- The activeViewCpm.
-
hasActiveViewCtr
boolean hasActiveViewCtr()Active view measurable clicks divided by active view viewable impressions. This metric is reported only for the Display Network.
optional double active_view_ctr = 185;- Returns:
- Whether the activeViewCtr field is set.
-
getActiveViewCtr
double getActiveViewCtr()Active view measurable clicks divided by active view viewable impressions. This metric is reported only for the Display Network.
optional double active_view_ctr = 185;- Returns:
- The activeViewCtr.
-
hasActiveViewImpressions
boolean hasActiveViewImpressions()A measurement of how often your ad has become viewable on a Display Network site.
optional int64 active_view_impressions = 186;- Returns:
- Whether the activeViewImpressions field is set.
-
getActiveViewImpressions
long getActiveViewImpressions()A measurement of how often your ad has become viewable on a Display Network site.
optional int64 active_view_impressions = 186;- Returns:
- The activeViewImpressions.
-
hasActiveViewMeasurability
boolean hasActiveViewMeasurability()The ratio of impressions that could be measured by Active View over the number of served impressions.
optional double active_view_measurability = 187;- Returns:
- Whether the activeViewMeasurability field is set.
-
getActiveViewMeasurability
double getActiveViewMeasurability()The ratio of impressions that could be measured by Active View over the number of served impressions.
optional double active_view_measurability = 187;- Returns:
- The activeViewMeasurability.
-
hasActiveViewMeasurableCostMicros
boolean hasActiveViewMeasurableCostMicros()The cost of the impressions you received that were measurable by Active View.
optional int64 active_view_measurable_cost_micros = 188;- Returns:
- Whether the activeViewMeasurableCostMicros field is set.
-
getActiveViewMeasurableCostMicros
long getActiveViewMeasurableCostMicros()The cost of the impressions you received that were measurable by Active View.
optional int64 active_view_measurable_cost_micros = 188;- Returns:
- The activeViewMeasurableCostMicros.
-
hasActiveViewMeasurableImpressions
boolean hasActiveViewMeasurableImpressions()The number of times your ads are appearing on placements in positions where they can be seen.
optional int64 active_view_measurable_impressions = 189;- Returns:
- Whether the activeViewMeasurableImpressions field is set.
-
getActiveViewMeasurableImpressions
long getActiveViewMeasurableImpressions()The number of times your ads are appearing on placements in positions where they can be seen.
optional int64 active_view_measurable_impressions = 189;- Returns:
- The activeViewMeasurableImpressions.
-
hasActiveViewViewability
boolean hasActiveViewViewability()The percentage of time when your ad appeared on an Active View enabled site (measurable impressions) and was viewable (viewable impressions).
optional double active_view_viewability = 190;- Returns:
- Whether the activeViewViewability field is set.
-
getActiveViewViewability
double getActiveViewViewability()The percentage of time when your ad appeared on an Active View enabled site (measurable impressions) and was viewable (viewable impressions).
optional double active_view_viewability = 190;- Returns:
- The activeViewViewability.
-
hasAllConversionsFromInteractionsRate
boolean hasAllConversionsFromInteractionsRate()All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions.
optional double all_conversions_from_interactions_rate = 191;- Returns:
- Whether the allConversionsFromInteractionsRate field is set.
-
getAllConversionsFromInteractionsRate
double getAllConversionsFromInteractionsRate()All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions.
optional double all_conversions_from_interactions_rate = 191;- Returns:
- The allConversionsFromInteractionsRate.
-
hasAllConversionsValue
boolean hasAllConversionsValue()The value of all conversions.
optional double all_conversions_value = 192;- Returns:
- Whether the allConversionsValue field is set.
-
getAllConversionsValue
double getAllConversionsValue()The value of all conversions.
optional double all_conversions_value = 192;- Returns:
- The allConversionsValue.
-
hasAllConversionsValueByConversionDate
boolean hasAllConversionsValueByConversionDate()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.
optional double all_conversions_value_by_conversion_date = 240;- Returns:
- Whether the allConversionsValueByConversionDate field is set.
-
getAllConversionsValueByConversionDate
double getAllConversionsValueByConversionDate()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.
optional double all_conversions_value_by_conversion_date = 240;- Returns:
- The allConversionsValueByConversionDate.
-
hasAllNewCustomerLifetimeValue
boolean hasAllNewCustomerLifetimeValue()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.
optional double all_new_customer_lifetime_value = 294;- Returns:
- Whether the allNewCustomerLifetimeValue field is set.
-
getAllNewCustomerLifetimeValue
double getAllNewCustomerLifetimeValue()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.
optional double all_new_customer_lifetime_value = 294;- Returns:
- The allNewCustomerLifetimeValue.
-
hasAllConversions
boolean hasAllConversions()The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric.
optional double all_conversions = 193;- Returns:
- Whether the allConversions field is set.
-
getAllConversions
double getAllConversions()The total number of conversions. This includes all conversions regardless of the value of include_in_conversions_metric.
optional double all_conversions = 193;- Returns:
- The allConversions.
-
hasAllConversionsByConversionDate
boolean hasAllConversionsByConversionDate()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.
optional double all_conversions_by_conversion_date = 241;- Returns:
- Whether the allConversionsByConversionDate field is set.
-
getAllConversionsByConversionDate
double getAllConversionsByConversionDate()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.
optional double all_conversions_by_conversion_date = 241;- Returns:
- The allConversionsByConversionDate.
-
hasAllConversionsValuePerCost
boolean hasAllConversionsValuePerCost()The value of all conversions divided by the total cost of ad interactions (such as clicks for text ads or views for video ads).
optional double all_conversions_value_per_cost = 194;- Returns:
- Whether the allConversionsValuePerCost field is set.
-
getAllConversionsValuePerCost
double getAllConversionsValuePerCost()The value of all conversions divided by the total cost of ad interactions (such as clicks for text ads or views for video ads).
optional double all_conversions_value_per_cost = 194;- Returns:
- The allConversionsValuePerCost.
-
hasAllConversionsFromClickToCall
boolean hasAllConversionsFromClickToCall()The number of times people clicked the "Call" button to call a store during or after clicking an ad. This number doesn't include whether or not calls were connected, or the duration of any calls. This metric applies to feed items only.
optional double all_conversions_from_click_to_call = 195;- Returns:
- Whether the allConversionsFromClickToCall field is set.
-
getAllConversionsFromClickToCall
double getAllConversionsFromClickToCall()The number of times people clicked the "Call" button to call a store during or after clicking an ad. This number doesn't include whether or not calls were connected, or the duration of any calls. This metric applies to feed items only.
optional double all_conversions_from_click_to_call = 195;- Returns:
- The allConversionsFromClickToCall.
-
hasAllConversionsFromDirections
boolean hasAllConversionsFromDirections()The number of times people clicked a "Get directions" button to navigate to a store after clicking an ad. This metric applies to feed items only.
optional double all_conversions_from_directions = 196;- Returns:
- Whether the allConversionsFromDirections field is set.
-
getAllConversionsFromDirections
double getAllConversionsFromDirections()The number of times people clicked a "Get directions" button to navigate to a store after clicking an ad. This metric applies to feed items only.
optional double all_conversions_from_directions = 196;- Returns:
- The allConversionsFromDirections.
-
hasAllConversionsFromInteractionsValuePerInteraction
boolean hasAllConversionsFromInteractionsValuePerInteraction()The value of all conversions from interactions divided by the total number of interactions.
optional double all_conversions_from_interactions_value_per_interaction = 197;- Returns:
- Whether the allConversionsFromInteractionsValuePerInteraction field is set.
-
getAllConversionsFromInteractionsValuePerInteraction
double getAllConversionsFromInteractionsValuePerInteraction()The value of all conversions from interactions divided by the total number of interactions.
optional double all_conversions_from_interactions_value_per_interaction = 197;- Returns:
- The allConversionsFromInteractionsValuePerInteraction.
-
hasAllConversionsFromMenu
boolean hasAllConversionsFromMenu()The number of times people clicked a link to view a store's menu after clicking an ad. This metric applies to feed items only.
optional double all_conversions_from_menu = 198;- Returns:
- Whether the allConversionsFromMenu field is set.
-
getAllConversionsFromMenu
double getAllConversionsFromMenu()The number of times people clicked a link to view a store's menu after clicking an ad. This metric applies to feed items only.
optional double all_conversions_from_menu = 198;- Returns:
- The allConversionsFromMenu.
-
hasAllConversionsFromOrder
boolean hasAllConversionsFromOrder()The number of times people placed an order at a store after clicking an ad. This metric applies to feed items only.
optional double all_conversions_from_order = 199;- Returns:
- Whether the allConversionsFromOrder field is set.
-
getAllConversionsFromOrder
double getAllConversionsFromOrder()The number of times people placed an order at a store after clicking an ad. This metric applies to feed items only.
optional double all_conversions_from_order = 199;- Returns:
- The allConversionsFromOrder.
-
hasAllConversionsFromOtherEngagement
boolean hasAllConversionsFromOtherEngagement()The number of other conversions (for example, posting a review or saving a location for a store) that occurred after people clicked an ad. This metric applies to feed items only.
optional double all_conversions_from_other_engagement = 200;- Returns:
- Whether the allConversionsFromOtherEngagement field is set.
-
getAllConversionsFromOtherEngagement
double getAllConversionsFromOtherEngagement()The number of other conversions (for example, posting a review or saving a location for a store) that occurred after people clicked an ad. This metric applies to feed items only.
optional double all_conversions_from_other_engagement = 200;- Returns:
- The allConversionsFromOtherEngagement.
-
hasAllConversionsFromStoreVisit
boolean hasAllConversionsFromStoreVisit()Estimated number of times people visited a store after clicking an ad. This metric applies to feed items only.
optional double all_conversions_from_store_visit = 201;- Returns:
- Whether the allConversionsFromStoreVisit field is set.
-
getAllConversionsFromStoreVisit
double getAllConversionsFromStoreVisit()Estimated number of times people visited a store after clicking an ad. This metric applies to feed items only.
optional double all_conversions_from_store_visit = 201;- Returns:
- The allConversionsFromStoreVisit.
-
hasAllConversionsFromStoreWebsite
boolean hasAllConversionsFromStoreWebsite()The number of times that people were taken to a store's URL after clicking an ad. This metric applies to feed items only.
optional double all_conversions_from_store_website = 202;- Returns:
- Whether the allConversionsFromStoreWebsite field is set.
-
getAllConversionsFromStoreWebsite
double getAllConversionsFromStoreWebsite()The number of times that people were taken to a store's URL after clicking an ad. This metric applies to feed items only.
optional double all_conversions_from_store_website = 202;- Returns:
- The allConversionsFromStoreWebsite.
-
hasAuctionInsightSearchAbsoluteTopImpressionPercentage
boolean hasAuctionInsightSearchAbsoluteTopImpressionPercentage()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.
optional double auction_insight_search_absolute_top_impression_percentage = 258;- Returns:
- Whether the auctionInsightSearchAbsoluteTopImpressionPercentage field is set.
-
getAuctionInsightSearchAbsoluteTopImpressionPercentage
double getAuctionInsightSearchAbsoluteTopImpressionPercentage()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.
optional double auction_insight_search_absolute_top_impression_percentage = 258;- Returns:
- The auctionInsightSearchAbsoluteTopImpressionPercentage.
-
hasAuctionInsightSearchOverlapRate
boolean hasAuctionInsightSearchOverlapRate()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.
optional double auction_insight_search_overlap_rate = 261;- Returns:
- Whether the auctionInsightSearchOverlapRate field is set.
-
getAuctionInsightSearchOverlapRate
double getAuctionInsightSearchOverlapRate()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.
optional double auction_insight_search_overlap_rate = 261;- Returns:
- The auctionInsightSearchOverlapRate.
-
hasAuctionInsightSearchPositionAboveRate
boolean hasAuctionInsightSearchPositionAboveRate()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.
optional double auction_insight_search_position_above_rate = 262;- Returns:
- Whether the auctionInsightSearchPositionAboveRate field is set.
-
getAuctionInsightSearchPositionAboveRate
double getAuctionInsightSearchPositionAboveRate()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.
optional double auction_insight_search_position_above_rate = 262;- Returns:
- The auctionInsightSearchPositionAboveRate.
-
hasAuctionInsightSearchTopImpressionPercentage
boolean hasAuctionInsightSearchTopImpressionPercentage()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.
optional double auction_insight_search_top_impression_percentage = 263;- Returns:
- Whether the auctionInsightSearchTopImpressionPercentage field is set.
-
getAuctionInsightSearchTopImpressionPercentage
double getAuctionInsightSearchTopImpressionPercentage()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.
optional double auction_insight_search_top_impression_percentage = 263;- Returns:
- The auctionInsightSearchTopImpressionPercentage.
-
hasAverageCost
boolean hasAverageCost()The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions.
optional double average_cost = 203;- Returns:
- Whether the averageCost field is set.
-
getAverageCost
double getAverageCost()The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions.
optional double average_cost = 203;- Returns:
- The averageCost.
-
hasAverageCpc
boolean hasAverageCpc()The total cost of all clicks divided by the total number of clicks received.
optional double average_cpc = 204;- Returns:
- Whether the averageCpc field is set.
-
getAverageCpc
double getAverageCpc()The total cost of all clicks divided by the total number of clicks received.
optional double average_cpc = 204;- Returns:
- The averageCpc.
-
hasAverageCpe
boolean hasAverageCpe()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.
optional double average_cpe = 205;- Returns:
- Whether the averageCpe field is set.
-
getAverageCpe
double getAverageCpe()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.
optional double average_cpe = 205;- Returns:
- The averageCpe.
-
hasAverageCpm
boolean hasAverageCpm()Average cost-per-thousand impressions (CPM).
optional double average_cpm = 206;- Returns:
- Whether the averageCpm field is set.
-
getAverageCpm
double getAverageCpm()Average cost-per-thousand impressions (CPM).
optional double average_cpm = 206;- Returns:
- The averageCpm.
-
hasAverageCpv
boolean hasAverageCpv()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 views.
optional double average_cpv = 207;- Returns:
- Whether the averageCpv field is set.
-
getAverageCpv
double getAverageCpv()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 views.
optional double average_cpv = 207;- Returns:
- The averageCpv.
-
hasAveragePageViews
boolean hasAveragePageViews()Average number of pages viewed per session.
optional double average_page_views = 208;- Returns:
- Whether the averagePageViews field is set.
-
getAveragePageViews
double getAveragePageViews()Average number of pages viewed per session.
optional double average_page_views = 208;- Returns:
- The averagePageViews.
-
hasAverageTimeOnSite
boolean hasAverageTimeOnSite()Total duration of all sessions (in seconds) / number of sessions. Imported from Google Analytics.
optional double average_time_on_site = 209;- Returns:
- Whether the averageTimeOnSite field is set.
-
getAverageTimeOnSite
double getAverageTimeOnSite()Total duration of all sessions (in seconds) / number of sessions. Imported from Google Analytics.
optional double average_time_on_site = 209;- Returns:
- The averageTimeOnSite.
-
hasBenchmarkAverageMaxCpc
boolean hasBenchmarkAverageMaxCpc()An indication of how other advertisers are bidding on similar products.
optional double benchmark_average_max_cpc = 210;- Returns:
- Whether the benchmarkAverageMaxCpc field is set.
-
getBenchmarkAverageMaxCpc
double getBenchmarkAverageMaxCpc()An indication of how other advertisers are bidding on similar products.
optional double benchmark_average_max_cpc = 210;- Returns:
- The benchmarkAverageMaxCpc.
-
hasBiddableAppInstallConversions
boolean hasBiddableAppInstallConversions()Number of app installs.
optional double biddable_app_install_conversions = 254;- Returns:
- Whether the biddableAppInstallConversions field is set.
-
getBiddableAppInstallConversions
double getBiddableAppInstallConversions()Number of app installs.
optional double biddable_app_install_conversions = 254;- Returns:
- The biddableAppInstallConversions.
-
hasBiddableAppPostInstallConversions
boolean hasBiddableAppPostInstallConversions()Number of in-app actions.
optional double biddable_app_post_install_conversions = 255;- Returns:
- Whether the biddableAppPostInstallConversions field is set.
-
getBiddableAppPostInstallConversions
double getBiddableAppPostInstallConversions()Number of in-app actions.
optional double biddable_app_post_install_conversions = 255;- Returns:
- The biddableAppPostInstallConversions.
-
hasBenchmarkCtr
boolean hasBenchmarkCtr()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.
optional double benchmark_ctr = 211;- Returns:
- Whether the benchmarkCtr field is set.
-
getBenchmarkCtr
double getBenchmarkCtr()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.
optional double benchmark_ctr = 211;- Returns:
- The benchmarkCtr.
-
hasBounceRate
boolean hasBounceRate()Percentage of clicks where the user only visited a single page on your site. Imported from Google Analytics.
optional double bounce_rate = 212;- Returns:
- Whether the bounceRate field is set.
-
getBounceRate
double getBounceRate()Percentage of clicks where the user only visited a single page on your site. Imported from Google Analytics.
optional double bounce_rate = 212;- Returns:
- The bounceRate.
-
hasClicks
boolean hasClicks()The number of clicks.
optional int64 clicks = 131;- Returns:
- Whether the clicks field is set.
-
getClicks
long getClicks()The number of clicks.
optional int64 clicks = 131;- Returns:
- The clicks.
-
hasCombinedClicks
boolean hasCombinedClicks()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.
optional int64 combined_clicks = 156;- Returns:
- Whether the combinedClicks field is set.
-
getCombinedClicks
long getCombinedClicks()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.
optional int64 combined_clicks = 156;- Returns:
- The combinedClicks.
-
hasCombinedClicksPerQuery
boolean hasCombinedClicksPerQuery()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.
optional double combined_clicks_per_query = 157;- Returns:
- Whether the combinedClicksPerQuery field is set.
-
getCombinedClicksPerQuery
double getCombinedClicksPerQuery()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.
optional double combined_clicks_per_query = 157;- Returns:
- The combinedClicksPerQuery.
-
hasCombinedQueries
boolean hasCombinedQueries()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.
optional int64 combined_queries = 158;- Returns:
- Whether the combinedQueries field is set.
-
getCombinedQueries
long getCombinedQueries()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.
optional int64 combined_queries = 158;- Returns:
- The combinedQueries.
-
hasConversionLastReceivedRequestDateTime
boolean hasConversionLastReceivedRequestDateTime()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.
optional string conversion_last_received_request_date_time = 161;- Returns:
- Whether the conversionLastReceivedRequestDateTime field is set.
-
getConversionLastReceivedRequestDateTime
String getConversionLastReceivedRequestDateTime()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.
optional string conversion_last_received_request_date_time = 161;- Returns:
- The conversionLastReceivedRequestDateTime.
-
getConversionLastReceivedRequestDateTimeBytes
com.google.protobuf.ByteString getConversionLastReceivedRequestDateTimeBytes()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.
optional string conversion_last_received_request_date_time = 161;- Returns:
- The bytes for conversionLastReceivedRequestDateTime.
-
hasConversionLastConversionDate
boolean hasConversionLastConversionDate()The date of the most recent conversion for this conversion action. The date is in the customer's time zone.
optional string conversion_last_conversion_date = 162;- Returns:
- Whether the conversionLastConversionDate field is set.
-
getConversionLastConversionDate
String getConversionLastConversionDate()The date of the most recent conversion for this conversion action. The date is in the customer's time zone.
optional string conversion_last_conversion_date = 162;- Returns:
- The conversionLastConversionDate.
-
getConversionLastConversionDateBytes
com.google.protobuf.ByteString getConversionLastConversionDateBytes()The date of the most recent conversion for this conversion action. The date is in the customer's time zone.
optional string conversion_last_conversion_date = 162;- Returns:
- The bytes for conversionLastConversionDate.
-
hasConversionsFromInteractionsRate
boolean hasConversionsFromInteractionsRate()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.
optional double conversions_from_interactions_rate = 164;- Returns:
- Whether the conversionsFromInteractionsRate field is set.
-
getConversionsFromInteractionsRate
double getConversionsFromInteractionsRate()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.
optional double conversions_from_interactions_rate = 164;- Returns:
- The conversionsFromInteractionsRate.
-
hasConversionsValue
boolean hasConversionsValue()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.
optional double conversions_value = 165;- Returns:
- Whether the conversionsValue field is set.
-
getConversionsValue
double getConversionsValue()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.
optional double conversions_value = 165;- Returns:
- The conversionsValue.
-
hasConversionsValueByConversionDate
boolean hasConversionsValueByConversionDate()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.
optional double conversions_value_by_conversion_date = 242;- Returns:
- Whether the conversionsValueByConversionDate field is set.
-
getConversionsValueByConversionDate
double getConversionsValueByConversionDate()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.
optional double conversions_value_by_conversion_date = 242;- Returns:
- The conversionsValueByConversionDate.
-
hasNewCustomerLifetimeValue
boolean hasNewCustomerLifetimeValue()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.
optional double new_customer_lifetime_value = 293;- Returns:
- Whether the newCustomerLifetimeValue field is set.
-
getNewCustomerLifetimeValue
double getNewCustomerLifetimeValue()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.
optional double new_customer_lifetime_value = 293;- Returns:
- The newCustomerLifetimeValue.
-
hasConversionsValuePerCost
boolean hasConversionsValuePerCost()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.
optional double conversions_value_per_cost = 166;- Returns:
- Whether the conversionsValuePerCost field is set.
-
getConversionsValuePerCost
double getConversionsValuePerCost()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.
optional double conversions_value_per_cost = 166;- Returns:
- The conversionsValuePerCost.
-
hasConversionsFromInteractionsValuePerInteraction
boolean hasConversionsFromInteractionsValuePerInteraction()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.
optional double conversions_from_interactions_value_per_interaction = 167;- Returns:
- Whether the conversionsFromInteractionsValuePerInteraction field is set.
-
getConversionsFromInteractionsValuePerInteraction
double getConversionsFromInteractionsValuePerInteraction()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.
optional double conversions_from_interactions_value_per_interaction = 167;- Returns:
- The conversionsFromInteractionsValuePerInteraction.
-
hasConversions
boolean hasConversions()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.
optional double conversions = 168;- Returns:
- Whether the conversions field is set.
-
getConversions
double getConversions()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.
optional double conversions = 168;- Returns:
- The conversions.
-
hasConversionsByConversionDate
boolean hasConversionsByConversionDate()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.
optional double conversions_by_conversion_date = 243;- Returns:
- Whether the conversionsByConversionDate field is set.
-
getConversionsByConversionDate
double getConversionsByConversionDate()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.
optional double conversions_by_conversion_date = 243;- Returns:
- The conversionsByConversionDate.
-
hasCostMicros
boolean hasCostMicros()The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period.
optional int64 cost_micros = 169;- Returns:
- Whether the costMicros field is set.
-
getCostMicros
long getCostMicros()The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period.
optional int64 cost_micros = 169;- Returns:
- The costMicros.
-
hasCostPerAllConversions
boolean hasCostPerAllConversions()The cost of ad interactions divided by all conversions.
optional double cost_per_all_conversions = 170;- Returns:
- Whether the costPerAllConversions field is set.
-
getCostPerAllConversions
double getCostPerAllConversions()The cost of ad interactions divided by all conversions.
optional double cost_per_all_conversions = 170;- Returns:
- The costPerAllConversions.
-
hasCostPerConversion
boolean hasCostPerConversion()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.
optional double cost_per_conversion = 171;- Returns:
- Whether the costPerConversion field is set.
-
getCostPerConversion
double getCostPerConversion()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.
optional double cost_per_conversion = 171;- Returns:
- The costPerConversion.
-
hasCostPerCurrentModelAttributedConversion
boolean hasCostPerCurrentModelAttributedConversion()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.
optional double cost_per_current_model_attributed_conversion = 172;- Returns:
- Whether the costPerCurrentModelAttributedConversion field is set.
-
getCostPerCurrentModelAttributedConversion
double getCostPerCurrentModelAttributedConversion()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.
optional double cost_per_current_model_attributed_conversion = 172;- Returns:
- The costPerCurrentModelAttributedConversion.
-
hasCrossDeviceConversions
boolean hasCrossDeviceConversions()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.
optional double cross_device_conversions = 173;- Returns:
- Whether the crossDeviceConversions field is set.
-
getCrossDeviceConversions
double getCrossDeviceConversions()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.
optional double cross_device_conversions = 173;- Returns:
- The crossDeviceConversions.
-
hasCrossDeviceConversionsValueMicros
boolean hasCrossDeviceConversionsValueMicros()The sum of the value of cross-device conversions, in micros.
optional int64 cross_device_conversions_value_micros = 312;- Returns:
- Whether the crossDeviceConversionsValueMicros field is set.
-
getCrossDeviceConversionsValueMicros
long getCrossDeviceConversionsValueMicros()The sum of the value of cross-device conversions, in micros.
optional int64 cross_device_conversions_value_micros = 312;- Returns:
- The crossDeviceConversionsValueMicros.
-
hasCtr
boolean hasCtr()The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions).
optional double ctr = 174;- Returns:
- Whether the ctr field is set.
-
getCtr
double getCtr()The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions).
optional double ctr = 174;- Returns:
- The ctr.
-
hasCurrentModelAttributedConversions
boolean hasCurrentModelAttributedConversions()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.
optional double current_model_attributed_conversions = 175;- Returns:
- Whether the currentModelAttributedConversions field is set.
-
getCurrentModelAttributedConversions
double getCurrentModelAttributedConversions()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.
optional double current_model_attributed_conversions = 175;- Returns:
- The currentModelAttributedConversions.
-
hasCurrentModelAttributedConversionsFromInteractionsRate
boolean hasCurrentModelAttributedConversionsFromInteractionsRate()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.
optional double current_model_attributed_conversions_from_interactions_rate = 176;- Returns:
- Whether the currentModelAttributedConversionsFromInteractionsRate field is set.
-
getCurrentModelAttributedConversionsFromInteractionsRate
double getCurrentModelAttributedConversionsFromInteractionsRate()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.
optional double current_model_attributed_conversions_from_interactions_rate = 176;- Returns:
- The currentModelAttributedConversionsFromInteractionsRate.
-
hasCurrentModelAttributedConversionsFromInteractionsValuePerInteraction
boolean hasCurrentModelAttributedConversionsFromInteractionsValuePerInteraction()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.
optional double current_model_attributed_conversions_from_interactions_value_per_interaction = 177;- Returns:
- Whether the currentModelAttributedConversionsFromInteractionsValuePerInteraction field is set.
-
getCurrentModelAttributedConversionsFromInteractionsValuePerInteraction
double getCurrentModelAttributedConversionsFromInteractionsValuePerInteraction()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.
optional double current_model_attributed_conversions_from_interactions_value_per_interaction = 177;- Returns:
- The currentModelAttributedConversionsFromInteractionsValuePerInteraction.
-
hasCurrentModelAttributedConversionsValue
boolean hasCurrentModelAttributedConversionsValue()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.
optional double current_model_attributed_conversions_value = 178;- Returns:
- Whether the currentModelAttributedConversionsValue field is set.
-
getCurrentModelAttributedConversionsValue
double getCurrentModelAttributedConversionsValue()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.
optional double current_model_attributed_conversions_value = 178;- Returns:
- The currentModelAttributedConversionsValue.
-
hasCurrentModelAttributedConversionsValuePerCost
boolean hasCurrentModelAttributedConversionsValuePerCost()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.
optional double current_model_attributed_conversions_value_per_cost = 179;- Returns:
- Whether the currentModelAttributedConversionsValuePerCost field is set.
-
getCurrentModelAttributedConversionsValuePerCost
double getCurrentModelAttributedConversionsValuePerCost()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.
optional double current_model_attributed_conversions_value_per_cost = 179;- Returns:
- The currentModelAttributedConversionsValuePerCost.
-
hasEngagementRate
boolean hasEngagementRate()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.
optional double engagement_rate = 180;- Returns:
- Whether the engagementRate field is set.
-
getEngagementRate
double getEngagementRate()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.
optional double engagement_rate = 180;- Returns:
- The engagementRate.
-
hasEngagements
boolean hasEngagements()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.
optional int64 engagements = 181;- Returns:
- Whether the engagements field is set.
-
getEngagements
long getEngagements()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.
optional int64 engagements = 181;- Returns:
- The engagements.
-
hasHotelAverageLeadValueMicros
boolean hasHotelAverageLeadValueMicros()Average lead value based on clicks.
optional double hotel_average_lead_value_micros = 213;- Returns:
- Whether the hotelAverageLeadValueMicros field is set.
-
getHotelAverageLeadValueMicros
double getHotelAverageLeadValueMicros()Average lead value based on clicks.
optional double hotel_average_lead_value_micros = 213;- Returns:
- The hotelAverageLeadValueMicros.
-
hasHotelCommissionRateMicros
boolean hasHotelCommissionRateMicros()Commission bid rate in micros. A 20% commission is represented as 200,000.
optional int64 hotel_commission_rate_micros = 256;- Returns:
- Whether the hotelCommissionRateMicros field is set.
-
getHotelCommissionRateMicros
long getHotelCommissionRateMicros()Commission bid rate in micros. A 20% commission is represented as 200,000.
optional int64 hotel_commission_rate_micros = 256;- Returns:
- The hotelCommissionRateMicros.
-
hasHotelExpectedCommissionCost
boolean hasHotelExpectedCommissionCost()Expected commission cost. The result of multiplying the commission value times the hotel_commission_rate in advertiser currency.
optional double hotel_expected_commission_cost = 257;- Returns:
- Whether the hotelExpectedCommissionCost field is set.
-
getHotelExpectedCommissionCost
double getHotelExpectedCommissionCost()Expected commission cost. The result of multiplying the commission value times the hotel_commission_rate in advertiser currency.
optional double hotel_expected_commission_cost = 257;- Returns:
- The hotelExpectedCommissionCost.
-
hasHotelPriceDifferencePercentage
boolean hasHotelPriceDifferencePercentage()The average price difference between the price offered by reporting hotel advertiser and the cheapest price offered by the competing advertiser.
optional double hotel_price_difference_percentage = 214;- Returns:
- Whether the hotelPriceDifferencePercentage field is set.
-
getHotelPriceDifferencePercentage
double getHotelPriceDifferencePercentage()The average price difference between the price offered by reporting hotel advertiser and the cheapest price offered by the competing advertiser.
optional double hotel_price_difference_percentage = 214;- Returns:
- The hotelPriceDifferencePercentage.
-
hasHotelEligibleImpressions
boolean hasHotelEligibleImpressions()The number of impressions that hotel partners could have had given their feed performance.
optional int64 hotel_eligible_impressions = 215;- Returns:
- Whether the hotelEligibleImpressions field is set.
-
getHotelEligibleImpressions
long getHotelEligibleImpressions()The number of impressions that hotel partners could have had given their feed performance.
optional int64 hotel_eligible_impressions = 215;- Returns:
- The hotelEligibleImpressions.
-
getHistoricalCreativeQualityScoreValue
int getHistoricalCreativeQualityScoreValue()The creative historical quality score.
.google.ads.googleads.v18.enums.QualityScoreBucketEnum.QualityScoreBucket historical_creative_quality_score = 80;- Returns:
- The enum numeric value on the wire for historicalCreativeQualityScore.
-
getHistoricalCreativeQualityScore
QualityScoreBucketEnum.QualityScoreBucket getHistoricalCreativeQualityScore()The creative historical quality score.
.google.ads.googleads.v18.enums.QualityScoreBucketEnum.QualityScoreBucket historical_creative_quality_score = 80;- Returns:
- The historicalCreativeQualityScore.
-
getHistoricalLandingPageQualityScoreValue
int getHistoricalLandingPageQualityScoreValue()The quality of historical landing page experience.
.google.ads.googleads.v18.enums.QualityScoreBucketEnum.QualityScoreBucket historical_landing_page_quality_score = 81;- Returns:
- The enum numeric value on the wire for historicalLandingPageQualityScore.
-
getHistoricalLandingPageQualityScore
QualityScoreBucketEnum.QualityScoreBucket getHistoricalLandingPageQualityScore()The quality of historical landing page experience.
.google.ads.googleads.v18.enums.QualityScoreBucketEnum.QualityScoreBucket historical_landing_page_quality_score = 81;- Returns:
- The historicalLandingPageQualityScore.
-
hasHistoricalQualityScore
boolean hasHistoricalQualityScore()The historical quality score.
optional int64 historical_quality_score = 216;- Returns:
- Whether the historicalQualityScore field is set.
-
getHistoricalQualityScore
long getHistoricalQualityScore()The historical quality score.
optional int64 historical_quality_score = 216;- Returns:
- The historicalQualityScore.
-
getHistoricalSearchPredictedCtrValue
int getHistoricalSearchPredictedCtrValue()The historical search predicted click through rate (CTR).
.google.ads.googleads.v18.enums.QualityScoreBucketEnum.QualityScoreBucket historical_search_predicted_ctr = 83;- Returns:
- The enum numeric value on the wire for historicalSearchPredictedCtr.
-
getHistoricalSearchPredictedCtr
QualityScoreBucketEnum.QualityScoreBucket getHistoricalSearchPredictedCtr()The historical search predicted click through rate (CTR).
.google.ads.googleads.v18.enums.QualityScoreBucketEnum.QualityScoreBucket historical_search_predicted_ctr = 83;- Returns:
- The historicalSearchPredictedCtr.
-
hasGmailForwards
boolean hasGmailForwards()The number of times the ad was forwarded to someone else as a message.
optional int64 gmail_forwards = 217;- Returns:
- Whether the gmailForwards field is set.
-
getGmailForwards
long getGmailForwards()The number of times the ad was forwarded to someone else as a message.
optional int64 gmail_forwards = 217;- Returns:
- The gmailForwards.
-
hasGmailSaves
boolean hasGmailSaves()The number of times someone has saved your Gmail ad to their inbox as a message.
optional int64 gmail_saves = 218;- Returns:
- Whether the gmailSaves field is set.
-
getGmailSaves
long getGmailSaves()The number of times someone has saved your Gmail ad to their inbox as a message.
optional int64 gmail_saves = 218;- Returns:
- The gmailSaves.
-
hasGmailSecondaryClicks
boolean hasGmailSecondaryClicks()The number of clicks to the landing page on the expanded state of Gmail ads.
optional int64 gmail_secondary_clicks = 219;- Returns:
- Whether the gmailSecondaryClicks field is set.
-
getGmailSecondaryClicks
long getGmailSecondaryClicks()The number of clicks to the landing page on the expanded state of Gmail ads.
optional int64 gmail_secondary_clicks = 219;- Returns:
- The gmailSecondaryClicks.
-
hasImpressionsFromStoreReach
boolean hasImpressionsFromStoreReach()The number of times a store's location-based ad was shown. This metric applies to feed items only.
optional int64 impressions_from_store_reach = 220;- Returns:
- Whether the impressionsFromStoreReach field is set.
-
getImpressionsFromStoreReach
long getImpressionsFromStoreReach()The number of times a store's location-based ad was shown. This metric applies to feed items only.
optional int64 impressions_from_store_reach = 220;- Returns:
- The impressionsFromStoreReach.
-
hasImpressions
boolean hasImpressions()Count of how often your ad has appeared on a search results page or website on the Google Network.
optional int64 impressions = 221;- Returns:
- Whether the impressions field is set.
-
getImpressions
long getImpressions()Count of how often your ad has appeared on a search results page or website on the Google Network.
optional int64 impressions = 221;- Returns:
- The impressions.
-
hasInteractionRate
boolean hasInteractionRate()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.
optional double interaction_rate = 222;- Returns:
- Whether the interactionRate field is set.
-
getInteractionRate
double getInteractionRate()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.
optional double interaction_rate = 222;- Returns:
- The interactionRate.
-
hasInteractions
boolean hasInteractions()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.
optional int64 interactions = 223;- Returns:
- Whether the interactions field is set.
-
getInteractions
long getInteractions()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.
optional int64 interactions = 223;- Returns:
- The interactions.
-
getInteractionEventTypesList
List<InteractionEventTypeEnum.InteractionEventType> getInteractionEventTypesList()The types of payable and free interactions.
repeated .google.ads.googleads.v18.enums.InteractionEventTypeEnum.InteractionEventType interaction_event_types = 100;- Returns:
- A list containing the interactionEventTypes.
-
getInteractionEventTypesCount
int getInteractionEventTypesCount()The types of payable and free interactions.
repeated .google.ads.googleads.v18.enums.InteractionEventTypeEnum.InteractionEventType interaction_event_types = 100;- Returns:
- The count of interactionEventTypes.
-
getInteractionEventTypes
The types of payable and free interactions.
repeated .google.ads.googleads.v18.enums.InteractionEventTypeEnum.InteractionEventType interaction_event_types = 100;- Parameters:
index- The index of the element to return.- Returns:
- The interactionEventTypes at the given index.
-
getInteractionEventTypesValueList
The types of payable and free interactions.
repeated .google.ads.googleads.v18.enums.InteractionEventTypeEnum.InteractionEventType interaction_event_types = 100;- Returns:
- A list containing the enum numeric values on the wire for interactionEventTypes.
-
getInteractionEventTypesValue
int getInteractionEventTypesValue(int index) The types of payable and free interactions.
repeated .google.ads.googleads.v18.enums.InteractionEventTypeEnum.InteractionEventType interaction_event_types = 100;- Parameters:
index- The index of the value to return.- Returns:
- The enum numeric value on the wire of interactionEventTypes at the given index.
-
hasInvalidClickRate
boolean hasInvalidClickRate()The percentage of clicks filtered out of your total number of clicks (filtered + non-filtered clicks) during the reporting period.
optional double invalid_click_rate = 224;- Returns:
- Whether the invalidClickRate field is set.
-
getInvalidClickRate
double getInvalidClickRate()The percentage of clicks filtered out of your total number of clicks (filtered + non-filtered clicks) during the reporting period.
optional double invalid_click_rate = 224;- Returns:
- The invalidClickRate.
-
hasInvalidClicks
boolean hasInvalidClicks()Number of clicks Google considers illegitimate and doesn't charge you for.
optional int64 invalid_clicks = 225;- Returns:
- Whether the invalidClicks field is set.
-
getInvalidClicks
long getInvalidClicks()Number of clicks Google considers illegitimate and doesn't charge you for.
optional int64 invalid_clicks = 225;- Returns:
- The invalidClicks.
-
hasGeneralInvalidClickRate
boolean hasGeneralInvalidClickRate()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.
optional double general_invalid_click_rate = 370;- Returns:
- Whether the generalInvalidClickRate field is set.
-
getGeneralInvalidClickRate
double getGeneralInvalidClickRate()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.
optional double general_invalid_click_rate = 370;- Returns:
- The generalInvalidClickRate.
-
hasGeneralInvalidClicks
boolean hasGeneralInvalidClicks()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.
optional int64 general_invalid_clicks = 371;- Returns:
- Whether the generalInvalidClicks field is set.
-
getGeneralInvalidClicks
long getGeneralInvalidClicks()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.
optional int64 general_invalid_clicks = 371;- Returns:
- The generalInvalidClicks.
-
hasMessageChats
boolean hasMessageChats()Number of message chats initiated for Click To Message impressions that were message tracking eligible.
optional int64 message_chats = 226;- Returns:
- Whether the messageChats field is set.
-
getMessageChats
long getMessageChats()Number of message chats initiated for Click To Message impressions that were message tracking eligible.
optional int64 message_chats = 226;- Returns:
- The messageChats.
-
hasMessageImpressions
boolean hasMessageImpressions()Number of Click To Message impressions that were message tracking eligible.
optional int64 message_impressions = 227;- Returns:
- Whether the messageImpressions field is set.
-
getMessageImpressions
long getMessageImpressions()Number of Click To Message impressions that were message tracking eligible.
optional int64 message_impressions = 227;- Returns:
- The messageImpressions.
-
hasMessageChatRate
boolean hasMessageChatRate()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.
optional double message_chat_rate = 228;- Returns:
- Whether the messageChatRate field is set.
-
getMessageChatRate
double getMessageChatRate()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.
optional double message_chat_rate = 228;- Returns:
- The messageChatRate.
-
hasMobileFriendlyClicksPercentage
boolean hasMobileFriendlyClicksPercentage()The percentage of mobile clicks that go to a mobile-friendly page.
optional double mobile_friendly_clicks_percentage = 229;- Returns:
- Whether the mobileFriendlyClicksPercentage field is set.
-
getMobileFriendlyClicksPercentage
double getMobileFriendlyClicksPercentage()The percentage of mobile clicks that go to a mobile-friendly page.
optional double mobile_friendly_clicks_percentage = 229;- Returns:
- The mobileFriendlyClicksPercentage.
-
hasOptimizationScoreUplift
boolean hasOptimizationScoreUplift()Total optimization score uplift of all recommendations.
optional double optimization_score_uplift = 247;- Returns:
- Whether the optimizationScoreUplift field is set.
-
getOptimizationScoreUplift
double getOptimizationScoreUplift()Total optimization score uplift of all recommendations.
optional double optimization_score_uplift = 247;- Returns:
- The optimizationScoreUplift.
-
hasOptimizationScoreUrl
boolean hasOptimizationScoreUrl()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.
optional string optimization_score_url = 248;- Returns:
- Whether the optimizationScoreUrl field is set.
-
getOptimizationScoreUrl
String getOptimizationScoreUrl()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.
optional string optimization_score_url = 248;- Returns:
- The optimizationScoreUrl.
-
getOptimizationScoreUrlBytes
com.google.protobuf.ByteString getOptimizationScoreUrlBytes()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.
optional string optimization_score_url = 248;- Returns:
- The bytes for optimizationScoreUrl.
-
hasOrganicClicks
boolean hasOrganicClicks()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.
optional int64 organic_clicks = 230;- Returns:
- Whether the organicClicks field is set.
-
getOrganicClicks
long getOrganicClicks()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.
optional int64 organic_clicks = 230;- Returns:
- The organicClicks.
-
hasOrganicClicksPerQuery
boolean hasOrganicClicksPerQuery()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.
optional double organic_clicks_per_query = 231;- Returns:
- Whether the organicClicksPerQuery field is set.
-
getOrganicClicksPerQuery
double getOrganicClicksPerQuery()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.
optional double organic_clicks_per_query = 231;- Returns:
- The organicClicksPerQuery.
-
hasOrganicImpressions
boolean hasOrganicImpressions()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.
optional int64 organic_impressions = 232;- Returns:
- Whether the organicImpressions field is set.
-
getOrganicImpressions
long getOrganicImpressions()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.
optional int64 organic_impressions = 232;- Returns:
- The organicImpressions.
-
hasOrganicImpressionsPerQuery
boolean hasOrganicImpressionsPerQuery()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.
optional double organic_impressions_per_query = 233;- Returns:
- Whether the organicImpressionsPerQuery field is set.
-
getOrganicImpressionsPerQuery
double getOrganicImpressionsPerQuery()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.
optional double organic_impressions_per_query = 233;- Returns:
- The organicImpressionsPerQuery.
-
hasOrganicQueries
boolean hasOrganicQueries()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.
optional int64 organic_queries = 234;- Returns:
- Whether the organicQueries field is set.
-
getOrganicQueries
long getOrganicQueries()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.
optional int64 organic_queries = 234;- Returns:
- The organicQueries.
-
hasPercentNewVisitors
boolean hasPercentNewVisitors()Percentage of first-time sessions (from people who had never visited your site before). Imported from Google Analytics.
optional double percent_new_visitors = 235;- Returns:
- Whether the percentNewVisitors field is set.
-
getPercentNewVisitors
double getPercentNewVisitors()Percentage of first-time sessions (from people who had never visited your site before). Imported from Google Analytics.
optional double percent_new_visitors = 235;- Returns:
- The percentNewVisitors.
-
hasPhoneCalls
boolean hasPhoneCalls()Number of offline phone calls.
optional int64 phone_calls = 236;- Returns:
- Whether the phoneCalls field is set.
-
getPhoneCalls
long getPhoneCalls()Number of offline phone calls.
optional int64 phone_calls = 236;- Returns:
- The phoneCalls.
-
hasPhoneImpressions
boolean hasPhoneImpressions()Number of offline phone impressions.
optional int64 phone_impressions = 237;- Returns:
- Whether the phoneImpressions field is set.
-
getPhoneImpressions
long getPhoneImpressions()Number of offline phone impressions.
optional int64 phone_impressions = 237;- Returns:
- The phoneImpressions.
-
hasPhoneThroughRate
boolean hasPhoneThroughRate()Number of phone calls received (phone_calls) divided by the number of times your phone number is shown (phone_impressions).
optional double phone_through_rate = 238;- Returns:
- Whether the phoneThroughRate field is set.
-
getPhoneThroughRate
double getPhoneThroughRate()Number of phone calls received (phone_calls) divided by the number of times your phone number is shown (phone_impressions).
optional double phone_through_rate = 238;- Returns:
- The phoneThroughRate.
-
hasRelativeCtr
boolean hasRelativeCtr()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.
optional double relative_ctr = 239;- Returns:
- Whether the relativeCtr field is set.
-
getRelativeCtr
double getRelativeCtr()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.
optional double relative_ctr = 239;- Returns:
- The relativeCtr.
-
hasSearchVolume
boolean hasSearchVolume()Search volume range for a search term insight category.
optional .google.ads.googleads.v18.common.SearchVolumeRange search_volume = 295;- Returns:
- Whether the searchVolume field is set.
-
getSearchVolume
SearchVolumeRange getSearchVolume()Search volume range for a search term insight category.
optional .google.ads.googleads.v18.common.SearchVolumeRange search_volume = 295;- Returns:
- The searchVolume.
-
getSearchVolumeOrBuilder
SearchVolumeRangeOrBuilder getSearchVolumeOrBuilder()Search volume range for a search term insight category.
optional .google.ads.googleads.v18.common.SearchVolumeRange search_volume = 295; -
hasSpeedScore
boolean hasSpeedScore()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.
optional int64 speed_score = 147;- Returns:
- Whether the speedScore field is set.
-
getSpeedScore
long getSpeedScore()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.
optional int64 speed_score = 147;- Returns:
- The speedScore.
-
hasAverageTargetCpaMicros
boolean hasAverageTargetCpaMicros()The average Target CPA, or unset if not available (for example, for campaigns that had traffic from portfolio bidding strategies or non-tCPA).
optional int64 average_target_cpa_micros = 290;- Returns:
- Whether the averageTargetCpaMicros field is set.
-
getAverageTargetCpaMicros
long getAverageTargetCpaMicros()The average Target CPA, or unset if not available (for example, for campaigns that had traffic from portfolio bidding strategies or non-tCPA).
optional int64 average_target_cpa_micros = 290;- Returns:
- The averageTargetCpaMicros.
-
hasAverageTargetRoas
boolean hasAverageTargetRoas()The average Target ROAS, or unset if not available (for example, for campaigns that had traffic from portfolio bidding strategies or non-tROAS).
optional double average_target_roas = 250;- Returns:
- Whether the averageTargetRoas field is set.
-
getAverageTargetRoas
double getAverageTargetRoas()The average Target ROAS, or unset if not available (for example, for campaigns that had traffic from portfolio bidding strategies or non-tROAS).
optional double average_target_roas = 250;- Returns:
- The averageTargetRoas.
-
hasTopImpressionPercentage
boolean hasTopImpressionPercentage()The percent of your ad impressions that are shown adjacent to the top organic search results.
optional double top_impression_percentage = 148;- Returns:
- Whether the topImpressionPercentage field is set.
-
getTopImpressionPercentage
double getTopImpressionPercentage()The percent of your ad impressions that are shown adjacent to the top organic search results.
optional double top_impression_percentage = 148;- Returns:
- The topImpressionPercentage.
-
hasValidAcceleratedMobilePagesClicksPercentage
boolean hasValidAcceleratedMobilePagesClicksPercentage()The percentage of ad clicks to Accelerated Mobile Pages (AMP) landing pages that reach a valid AMP page.
optional double valid_accelerated_mobile_pages_clicks_percentage = 149;- Returns:
- Whether the validAcceleratedMobilePagesClicksPercentage field is set.
-
getValidAcceleratedMobilePagesClicksPercentage
double getValidAcceleratedMobilePagesClicksPercentage()The percentage of ad clicks to Accelerated Mobile Pages (AMP) landing pages that reach a valid AMP page.
optional double valid_accelerated_mobile_pages_clicks_percentage = 149;- Returns:
- The validAcceleratedMobilePagesClicksPercentage.
-
hasValuePerAllConversions
boolean hasValuePerAllConversions()The value of all conversions divided by the number of all conversions.
optional double value_per_all_conversions = 150;- Returns:
- Whether the valuePerAllConversions field is set.
-
getValuePerAllConversions
double getValuePerAllConversions()The value of all conversions divided by the number of all conversions.
optional double value_per_all_conversions = 150;- Returns:
- The valuePerAllConversions.
-
hasValuePerAllConversionsByConversionDate
boolean hasValuePerAllConversionsByConversionDate()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.
optional double value_per_all_conversions_by_conversion_date = 244;- Returns:
- Whether the valuePerAllConversionsByConversionDate field is set.
-
getValuePerAllConversionsByConversionDate
double getValuePerAllConversionsByConversionDate()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.
optional double value_per_all_conversions_by_conversion_date = 244;- Returns:
- The valuePerAllConversionsByConversionDate.
-
hasValuePerConversion
boolean hasValuePerConversion()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.
optional double value_per_conversion = 151;- Returns:
- Whether the valuePerConversion field is set.
-
getValuePerConversion
double getValuePerConversion()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.
optional double value_per_conversion = 151;- Returns:
- The valuePerConversion.
-
hasValuePerConversionsByConversionDate
boolean hasValuePerConversionsByConversionDate()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.
optional double value_per_conversions_by_conversion_date = 245;- Returns:
- Whether the valuePerConversionsByConversionDate field is set.
-
getValuePerConversionsByConversionDate
double getValuePerConversionsByConversionDate()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.
optional double value_per_conversions_by_conversion_date = 245;- Returns:
- The valuePerConversionsByConversionDate.
-
hasValuePerCurrentModelAttributedConversion
boolean hasValuePerCurrentModelAttributedConversion()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.
optional double value_per_current_model_attributed_conversion = 152;- Returns:
- Whether the valuePerCurrentModelAttributedConversion field is set.
-
getValuePerCurrentModelAttributedConversion
double getValuePerCurrentModelAttributedConversion()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.
optional double value_per_current_model_attributed_conversion = 152;- Returns:
- The valuePerCurrentModelAttributedConversion.
-
hasVideoQuartileP100Rate
boolean hasVideoQuartileP100Rate()Percentage of impressions where the viewer watched all of your video.
optional double video_quartile_p100_rate = 132;- Returns:
- Whether the videoQuartileP100Rate field is set.
-
getVideoQuartileP100Rate
double getVideoQuartileP100Rate()Percentage of impressions where the viewer watched all of your video.
optional double video_quartile_p100_rate = 132;- Returns:
- The videoQuartileP100Rate.
-
hasVideoQuartileP25Rate
boolean hasVideoQuartileP25Rate()Percentage of impressions where the viewer watched 25% of your video.
optional double video_quartile_p25_rate = 133;- Returns:
- Whether the videoQuartileP25Rate field is set.
-
getVideoQuartileP25Rate
double getVideoQuartileP25Rate()Percentage of impressions where the viewer watched 25% of your video.
optional double video_quartile_p25_rate = 133;- Returns:
- The videoQuartileP25Rate.
-
hasVideoQuartileP50Rate
boolean hasVideoQuartileP50Rate()Percentage of impressions where the viewer watched 50% of your video.
optional double video_quartile_p50_rate = 134;- Returns:
- Whether the videoQuartileP50Rate field is set.
-
getVideoQuartileP50Rate
double getVideoQuartileP50Rate()Percentage of impressions where the viewer watched 50% of your video.
optional double video_quartile_p50_rate = 134;- Returns:
- The videoQuartileP50Rate.
-
hasVideoQuartileP75Rate
boolean hasVideoQuartileP75Rate()Percentage of impressions where the viewer watched 75% of your video.
optional double video_quartile_p75_rate = 135;- Returns:
- Whether the videoQuartileP75Rate field is set.
-
getVideoQuartileP75Rate
double getVideoQuartileP75Rate()Percentage of impressions where the viewer watched 75% of your video.
optional double video_quartile_p75_rate = 135;- Returns:
- The videoQuartileP75Rate.
-
hasVideoViewRate
boolean hasVideoViewRate()The number of views your TrueView video ad receives divided by its number of impressions, including thumbnail impressions for TrueView in-display ads.
optional double video_view_rate = 153;- Returns:
- Whether the videoViewRate field is set.
-
getVideoViewRate
double getVideoViewRate()The number of views your TrueView video ad receives divided by its number of impressions, including thumbnail impressions for TrueView in-display ads.
optional double video_view_rate = 153;- Returns:
- The videoViewRate.
-
hasVideoViews
boolean hasVideoViews()The number of times your video ads were viewed.
optional int64 video_views = 154;- Returns:
- Whether the videoViews field is set.
-
getVideoViews
long getVideoViews()The number of times your video ads were viewed.
optional int64 video_views = 154;- Returns:
- The videoViews.
-
hasViewThroughConversions
boolean hasViewThroughConversions()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.
optional int64 view_through_conversions = 155;- Returns:
- Whether the viewThroughConversions field is set.
-
getViewThroughConversions
long getViewThroughConversions()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.
optional int64 view_through_conversions = 155;- Returns:
- The viewThroughConversions.
-
getSkAdNetworkInstalls
long getSkAdNetworkInstalls()The number of iOS Store Kit Ad Network conversions.
int64 sk_ad_network_installs = 246;- Returns:
- The skAdNetworkInstalls.
-
getSkAdNetworkTotalConversions
long getSkAdNetworkTotalConversions()The total number of iOS Store Kit Ad Network conversions.
int64 sk_ad_network_total_conversions = 292;- Returns:
- The skAdNetworkTotalConversions.
-
getPublisherPurchasedClicks
long getPublisherPurchasedClicks()Clicks from properties not owned by the publisher for which the traffic the publisher has paid for or acquired through incentivized activity
int64 publisher_purchased_clicks = 264;- Returns:
- The publisherPurchasedClicks.
-
getPublisherOrganicClicks
long getPublisherOrganicClicks()Clicks from properties for which the traffic the publisher has not paid for or acquired through incentivized activity
int64 publisher_organic_clicks = 265;- Returns:
- The publisherOrganicClicks.
-
getPublisherUnknownClicks
long getPublisherUnknownClicks()Clicks from traffic which is not identified as "Publisher Purchased" or "Publisher Organic"
int64 publisher_unknown_clicks = 266;- Returns:
- The publisherUnknownClicks.
-
hasAllConversionsFromLocationAssetClickToCall
boolean hasAllConversionsFromLocationAssetClickToCall()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.
optional double all_conversions_from_location_asset_click_to_call = 267;- Returns:
- Whether the allConversionsFromLocationAssetClickToCall field is set.
-
getAllConversionsFromLocationAssetClickToCall
double getAllConversionsFromLocationAssetClickToCall()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.
optional double all_conversions_from_location_asset_click_to_call = 267;- Returns:
- The allConversionsFromLocationAssetClickToCall.
-
hasAllConversionsFromLocationAssetDirections
boolean hasAllConversionsFromLocationAssetDirections()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.
optional double all_conversions_from_location_asset_directions = 268;- Returns:
- Whether the allConversionsFromLocationAssetDirections field is set.
-
getAllConversionsFromLocationAssetDirections
double getAllConversionsFromLocationAssetDirections()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.
optional double all_conversions_from_location_asset_directions = 268;- Returns:
- The allConversionsFromLocationAssetDirections.
-
hasAllConversionsFromLocationAssetMenu
boolean hasAllConversionsFromLocationAssetMenu()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.
optional double all_conversions_from_location_asset_menu = 269;- Returns:
- Whether the allConversionsFromLocationAssetMenu field is set.
-
getAllConversionsFromLocationAssetMenu
double getAllConversionsFromLocationAssetMenu()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.
optional double all_conversions_from_location_asset_menu = 269;- Returns:
- The allConversionsFromLocationAssetMenu.
-
hasAllConversionsFromLocationAssetOrder
boolean hasAllConversionsFromLocationAssetOrder()Number of order clicks on any location surface after a chargeable ad event (click or impression). This measure is coming from Asset based location.
optional double all_conversions_from_location_asset_order = 270;- Returns:
- Whether the allConversionsFromLocationAssetOrder field is set.
-
getAllConversionsFromLocationAssetOrder
double getAllConversionsFromLocationAssetOrder()Number of order clicks on any location surface after a chargeable ad event (click or impression). This measure is coming from Asset based location.
optional double all_conversions_from_location_asset_order = 270;- Returns:
- The allConversionsFromLocationAssetOrder.
-
hasAllConversionsFromLocationAssetOtherEngagement
boolean hasAllConversionsFromLocationAssetOtherEngagement()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.
optional double all_conversions_from_location_asset_other_engagement = 271;- Returns:
- Whether the allConversionsFromLocationAssetOtherEngagement field is set.
-
getAllConversionsFromLocationAssetOtherEngagement
double getAllConversionsFromLocationAssetOtherEngagement()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.
optional double all_conversions_from_location_asset_other_engagement = 271;- Returns:
- The allConversionsFromLocationAssetOtherEngagement.
-
hasAllConversionsFromLocationAssetStoreVisits
boolean hasAllConversionsFromLocationAssetStoreVisits()Estimated number of visits to the store after a chargeable ad event (click or impression). This measure is coming from Asset based location.
optional double all_conversions_from_location_asset_store_visits = 272;- Returns:
- Whether the allConversionsFromLocationAssetStoreVisits field is set.
-
getAllConversionsFromLocationAssetStoreVisits
double getAllConversionsFromLocationAssetStoreVisits()Estimated number of visits to the store after a chargeable ad event (click or impression). This measure is coming from Asset based location.
optional double all_conversions_from_location_asset_store_visits = 272;- Returns:
- The allConversionsFromLocationAssetStoreVisits.
-
hasAllConversionsFromLocationAssetWebsite
boolean hasAllConversionsFromLocationAssetWebsite()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.
optional double all_conversions_from_location_asset_website = 273;- Returns:
- Whether the allConversionsFromLocationAssetWebsite field is set.
-
getAllConversionsFromLocationAssetWebsite
double getAllConversionsFromLocationAssetWebsite()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.
optional double all_conversions_from_location_asset_website = 273;- Returns:
- The allConversionsFromLocationAssetWebsite.
-
hasEligibleImpressionsFromLocationAssetStoreReach
boolean hasEligibleImpressionsFromLocationAssetStoreReach()Number of impressions in which the store location was shown or the location was used for targeting. This measure is coming from Asset based location.
optional int64 eligible_impressions_from_location_asset_store_reach = 274;- Returns:
- Whether the eligibleImpressionsFromLocationAssetStoreReach field is set.
-
getEligibleImpressionsFromLocationAssetStoreReach
long getEligibleImpressionsFromLocationAssetStoreReach()Number of impressions in which the store location was shown or the location was used for targeting. This measure is coming from Asset based location.
optional int64 eligible_impressions_from_location_asset_store_reach = 274;- Returns:
- The eligibleImpressionsFromLocationAssetStoreReach.
-
hasViewThroughConversionsFromLocationAssetClickToCall
boolean hasViewThroughConversionsFromLocationAssetClickToCall()Number of call button clicks on any location surface after an impression. This measure is coming from Asset based location.
optional double view_through_conversions_from_location_asset_click_to_call = 275;- Returns:
- Whether the viewThroughConversionsFromLocationAssetClickToCall field is set.
-
getViewThroughConversionsFromLocationAssetClickToCall
double getViewThroughConversionsFromLocationAssetClickToCall()Number of call button clicks on any location surface after an impression. This measure is coming from Asset based location.
optional double view_through_conversions_from_location_asset_click_to_call = 275;- Returns:
- The viewThroughConversionsFromLocationAssetClickToCall.
-
hasViewThroughConversionsFromLocationAssetDirections
boolean hasViewThroughConversionsFromLocationAssetDirections()Number of driving directions clicks on any location surface after an impression. This measure is coming from Asset based location.
optional double view_through_conversions_from_location_asset_directions = 276;- Returns:
- Whether the viewThroughConversionsFromLocationAssetDirections field is set.
-
getViewThroughConversionsFromLocationAssetDirections
double getViewThroughConversionsFromLocationAssetDirections()Number of driving directions clicks on any location surface after an impression. This measure is coming from Asset based location.
optional double view_through_conversions_from_location_asset_directions = 276;- Returns:
- The viewThroughConversionsFromLocationAssetDirections.
-
hasViewThroughConversionsFromLocationAssetMenu
boolean hasViewThroughConversionsFromLocationAssetMenu()Number of menu link clicks on any location surface after an impression. This measure is coming from Asset based location.
optional double view_through_conversions_from_location_asset_menu = 277;- Returns:
- Whether the viewThroughConversionsFromLocationAssetMenu field is set.
-
getViewThroughConversionsFromLocationAssetMenu
double getViewThroughConversionsFromLocationAssetMenu()Number of menu link clicks on any location surface after an impression. This measure is coming from Asset based location.
optional double view_through_conversions_from_location_asset_menu = 277;- Returns:
- The viewThroughConversionsFromLocationAssetMenu.
-
hasViewThroughConversionsFromLocationAssetOrder
boolean hasViewThroughConversionsFromLocationAssetOrder()Number of order clicks on any location surface after an impression. This measure is coming from Asset based location.
optional double view_through_conversions_from_location_asset_order = 278;- Returns:
- Whether the viewThroughConversionsFromLocationAssetOrder field is set.
-
getViewThroughConversionsFromLocationAssetOrder
double getViewThroughConversionsFromLocationAssetOrder()Number of order clicks on any location surface after an impression. This measure is coming from Asset based location.
optional double view_through_conversions_from_location_asset_order = 278;- Returns:
- The viewThroughConversionsFromLocationAssetOrder.
-
hasViewThroughConversionsFromLocationAssetOtherEngagement
boolean hasViewThroughConversionsFromLocationAssetOtherEngagement()Number of other types of local action clicks on any location surface after an impression. This measure is coming from Asset based location.
optional double view_through_conversions_from_location_asset_other_engagement = 279;- Returns:
- Whether the viewThroughConversionsFromLocationAssetOtherEngagement field is set.
-
getViewThroughConversionsFromLocationAssetOtherEngagement
double getViewThroughConversionsFromLocationAssetOtherEngagement()Number of other types of local action clicks on any location surface after an impression. This measure is coming from Asset based location.
optional double view_through_conversions_from_location_asset_other_engagement = 279;- Returns:
- The viewThroughConversionsFromLocationAssetOtherEngagement.
-
hasViewThroughConversionsFromLocationAssetStoreVisits
boolean hasViewThroughConversionsFromLocationAssetStoreVisits()Estimated number of visits to the store after an impression. This measure is coming from Asset based location.
optional double view_through_conversions_from_location_asset_store_visits = 280;- Returns:
- Whether the viewThroughConversionsFromLocationAssetStoreVisits field is set.
-
getViewThroughConversionsFromLocationAssetStoreVisits
double getViewThroughConversionsFromLocationAssetStoreVisits()Estimated number of visits to the store after an impression. This measure is coming from Asset based location.
optional double view_through_conversions_from_location_asset_store_visits = 280;- Returns:
- The viewThroughConversionsFromLocationAssetStoreVisits.
-
hasViewThroughConversionsFromLocationAssetWebsite
boolean hasViewThroughConversionsFromLocationAssetWebsite()Number of website URL clicks on any location surface after an impression. This measure is coming from Asset based location.
optional double view_through_conversions_from_location_asset_website = 281;- Returns:
- Whether the viewThroughConversionsFromLocationAssetWebsite field is set.
-
getViewThroughConversionsFromLocationAssetWebsite
double getViewThroughConversionsFromLocationAssetWebsite()Number of website URL clicks on any location surface after an impression. This measure is coming from Asset based location.
optional double view_through_conversions_from_location_asset_website = 281;- Returns:
- The viewThroughConversionsFromLocationAssetWebsite.
-
hasOrders
boolean hasOrders()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.
optional double orders = 296;- Returns:
- Whether the orders field is set.
-
getOrders
double getOrders()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.
optional double orders = 296;- Returns:
- The orders.
-
hasAverageOrderValueMicros
boolean hasAverageOrderValueMicros()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.
optional int64 average_order_value_micros = 297;- Returns:
- Whether the averageOrderValueMicros field is set.
-
getAverageOrderValueMicros
long getAverageOrderValueMicros()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.
optional int64 average_order_value_micros = 297;- Returns:
- The averageOrderValueMicros.
-
hasAverageCartSize
boolean hasAverageCartSize()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.
optional double average_cart_size = 298;- Returns:
- Whether the averageCartSize field is set.
-
getAverageCartSize
double getAverageCartSize()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.
optional double average_cart_size = 298;- Returns:
- The averageCartSize.
-
hasCostOfGoodsSoldMicros
boolean hasCostOfGoodsSoldMicros()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.
optional int64 cost_of_goods_sold_micros = 299;- Returns:
- Whether the costOfGoodsSoldMicros field is set.
-
getCostOfGoodsSoldMicros
long getCostOfGoodsSoldMicros()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.
optional int64 cost_of_goods_sold_micros = 299;- Returns:
- The costOfGoodsSoldMicros.
-
hasGrossProfitMicros
boolean hasGrossProfitMicros()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.
optional int64 gross_profit_micros = 300;- Returns:
- Whether the grossProfitMicros field is set.
-
getGrossProfitMicros
long getGrossProfitMicros()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.
optional int64 gross_profit_micros = 300;- Returns:
- The grossProfitMicros.
-
hasGrossProfitMargin
boolean hasGrossProfitMargin()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.
optional double gross_profit_margin = 301;- Returns:
- Whether the grossProfitMargin field is set.
-
getGrossProfitMargin
double getGrossProfitMargin()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.
optional double gross_profit_margin = 301;- Returns:
- The grossProfitMargin.
-
hasRevenueMicros
boolean hasRevenueMicros()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.
optional int64 revenue_micros = 302;- Returns:
- Whether the revenueMicros field is set.
-
getRevenueMicros
long getRevenueMicros()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.
optional int64 revenue_micros = 302;- Returns:
- The revenueMicros.
-
hasUnitsSold
boolean hasUnitsSold()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.
optional double units_sold = 303;- Returns:
- Whether the unitsSold field is set.
-
getUnitsSold
double getUnitsSold()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.
optional double units_sold = 303;- Returns:
- The unitsSold.
-
hasCrossSellCostOfGoodsSoldMicros
boolean hasCrossSellCostOfGoodsSoldMicros()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.
optional int64 cross_sell_cost_of_goods_sold_micros = 304;- Returns:
- Whether the crossSellCostOfGoodsSoldMicros field is set.
-
getCrossSellCostOfGoodsSoldMicros
long getCrossSellCostOfGoodsSoldMicros()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.
optional int64 cross_sell_cost_of_goods_sold_micros = 304;- Returns:
- The crossSellCostOfGoodsSoldMicros.
-
hasCrossSellGrossProfitMicros
boolean hasCrossSellGrossProfitMicros()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.
optional int64 cross_sell_gross_profit_micros = 305;- Returns:
- Whether the crossSellGrossProfitMicros field is set.
-
getCrossSellGrossProfitMicros
long getCrossSellGrossProfitMicros()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.
optional int64 cross_sell_gross_profit_micros = 305;- Returns:
- The crossSellGrossProfitMicros.
-
hasCrossSellRevenueMicros
boolean hasCrossSellRevenueMicros()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.
optional int64 cross_sell_revenue_micros = 306;- Returns:
- Whether the crossSellRevenueMicros field is set.
-
getCrossSellRevenueMicros
long getCrossSellRevenueMicros()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.
optional int64 cross_sell_revenue_micros = 306;- Returns:
- The crossSellRevenueMicros.
-
hasCrossSellUnitsSold
boolean hasCrossSellUnitsSold()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.
optional double cross_sell_units_sold = 307;- Returns:
- Whether the crossSellUnitsSold field is set.
-
getCrossSellUnitsSold
double getCrossSellUnitsSold()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.
optional double cross_sell_units_sold = 307;- Returns:
- The crossSellUnitsSold.
-
hasLeadCostOfGoodsSoldMicros
boolean hasLeadCostOfGoodsSoldMicros()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.
optional int64 lead_cost_of_goods_sold_micros = 308;- Returns:
- Whether the leadCostOfGoodsSoldMicros field is set.
-
getLeadCostOfGoodsSoldMicros
long getLeadCostOfGoodsSoldMicros()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.
optional int64 lead_cost_of_goods_sold_micros = 308;- Returns:
- The leadCostOfGoodsSoldMicros.
-
hasLeadGrossProfitMicros
boolean hasLeadGrossProfitMicros()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.
optional int64 lead_gross_profit_micros = 309;- Returns:
- Whether the leadGrossProfitMicros field is set.
-
getLeadGrossProfitMicros
long getLeadGrossProfitMicros()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.
optional int64 lead_gross_profit_micros = 309;- Returns:
- The leadGrossProfitMicros.
-
hasLeadRevenueMicros
boolean hasLeadRevenueMicros()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.
optional int64 lead_revenue_micros = 310;- Returns:
- Whether the leadRevenueMicros field is set.
-
getLeadRevenueMicros
long getLeadRevenueMicros()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.
optional int64 lead_revenue_micros = 310;- Returns:
- The leadRevenueMicros.
-
hasLeadUnitsSold
boolean hasLeadUnitsSold()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.
optional double lead_units_sold = 311;- Returns:
- Whether the leadUnitsSold field is set.
-
getLeadUnitsSold
double getLeadUnitsSold()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.
optional double lead_units_sold = 311;- Returns:
- The leadUnitsSold.
-
hasUniqueUsers
boolean hasUniqueUsers()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.
optional int64 unique_users = 319;- Returns:
- Whether the uniqueUsers field is set.
-
getUniqueUsers
long getUniqueUsers()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.
optional int64 unique_users = 319;- Returns:
- The uniqueUsers.
-
hasAverageImpressionFrequencyPerUser
boolean hasAverageImpressionFrequencyPerUser()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.
optional double average_impression_frequency_per_user = 320;- Returns:
- Whether the averageImpressionFrequencyPerUser field is set.
-
getAverageImpressionFrequencyPerUser
double getAverageImpressionFrequencyPerUser()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.
optional double average_impression_frequency_per_user = 320;- Returns:
- The averageImpressionFrequencyPerUser.
-
hasLinkedEntitiesCount
boolean hasLinkedEntitiesCount()Number of linked resources in which the asset is used. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView.
optional int64 linked_entities_count = 341;- Returns:
- Whether the linkedEntitiesCount field is set.
-
getLinkedEntitiesCount
long getLinkedEntitiesCount()Number of linked resources in which the asset is used. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView.
optional int64 linked_entities_count = 341;- Returns:
- The linkedEntitiesCount.
-
getLinkedSampleEntitiesList
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.
repeated string linked_sample_entities = 342;- Returns:
- A list containing the linkedSampleEntities.
-
getLinkedSampleEntitiesCount
int getLinkedSampleEntitiesCount()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.
repeated string linked_sample_entities = 342;- Returns:
- The count of linkedSampleEntities.
-
getLinkedSampleEntities
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.
repeated string linked_sample_entities = 342;- Parameters:
index- The index of the element to return.- Returns:
- The linkedSampleEntities at the given index.
-
getLinkedSampleEntitiesBytes
com.google.protobuf.ByteString getLinkedSampleEntitiesBytes(int index) 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.
repeated string linked_sample_entities = 342;- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the linkedSampleEntities at the given index.
-
getSampleBestPerformanceEntitiesList
A list of up to 20 sample linked resources with impressions in the last 30 days where the asset had the AssetPerformanceLabel.BEST performance label. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView.
repeated string sample_best_performance_entities = 343;- Returns:
- A list containing the sampleBestPerformanceEntities.
-
getSampleBestPerformanceEntitiesCount
int getSampleBestPerformanceEntitiesCount()A list of up to 20 sample linked resources with impressions in the last 30 days where the asset had the AssetPerformanceLabel.BEST performance label. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView.
repeated string sample_best_performance_entities = 343;- Returns:
- The count of sampleBestPerformanceEntities.
-
getSampleBestPerformanceEntities
A list of up to 20 sample linked resources with impressions in the last 30 days where the asset had the AssetPerformanceLabel.BEST performance label. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView.
repeated string sample_best_performance_entities = 343;- Parameters:
index- The index of the element to return.- Returns:
- The sampleBestPerformanceEntities at the given index.
-
getSampleBestPerformanceEntitiesBytes
com.google.protobuf.ByteString getSampleBestPerformanceEntitiesBytes(int index) A list of up to 20 sample linked resources with impressions in the last 30 days where the asset had the AssetPerformanceLabel.BEST performance label. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView.
repeated string sample_best_performance_entities = 343;- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the sampleBestPerformanceEntities at the given index.
-
getSampleGoodPerformanceEntitiesList
A list of up to 20 sample linked resources with impressions in the last 30 days where the asset had the AssetPerformanceLabel.GOOD performance label. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView.
repeated string sample_good_performance_entities = 344;- Returns:
- A list containing the sampleGoodPerformanceEntities.
-
getSampleGoodPerformanceEntitiesCount
int getSampleGoodPerformanceEntitiesCount()A list of up to 20 sample linked resources with impressions in the last 30 days where the asset had the AssetPerformanceLabel.GOOD performance label. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView.
repeated string sample_good_performance_entities = 344;- Returns:
- The count of sampleGoodPerformanceEntities.
-
getSampleGoodPerformanceEntities
A list of up to 20 sample linked resources with impressions in the last 30 days where the asset had the AssetPerformanceLabel.GOOD performance label. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView.
repeated string sample_good_performance_entities = 344;- Parameters:
index- The index of the element to return.- Returns:
- The sampleGoodPerformanceEntities at the given index.
-
getSampleGoodPerformanceEntitiesBytes
com.google.protobuf.ByteString getSampleGoodPerformanceEntitiesBytes(int index) A list of up to 20 sample linked resources with impressions in the last 30 days where the asset had the AssetPerformanceLabel.GOOD performance label. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView.
repeated string sample_good_performance_entities = 344;- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the sampleGoodPerformanceEntities at the given index.
-
getSampleLowPerformanceEntitiesList
A list of up to 20 sample linked resources with impressions in the last 30 days where the asset had the AssetPerformanceLabel.LOW performance label. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView.
repeated string sample_low_performance_entities = 345;- Returns:
- A list containing the sampleLowPerformanceEntities.
-
getSampleLowPerformanceEntitiesCount
int getSampleLowPerformanceEntitiesCount()A list of up to 20 sample linked resources with impressions in the last 30 days where the asset had the AssetPerformanceLabel.LOW performance label. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView.
repeated string sample_low_performance_entities = 345;- Returns:
- The count of sampleLowPerformanceEntities.
-
getSampleLowPerformanceEntities
A list of up to 20 sample linked resources with impressions in the last 30 days where the asset had the AssetPerformanceLabel.LOW performance label. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView.
repeated string sample_low_performance_entities = 345;- Parameters:
index- The index of the element to return.- Returns:
- The sampleLowPerformanceEntities at the given index.
-
getSampleLowPerformanceEntitiesBytes
com.google.protobuf.ByteString getSampleLowPerformanceEntitiesBytes(int index) A list of up to 20 sample linked resources with impressions in the last 30 days where the asset had the AssetPerformanceLabel.LOW performance label. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView.
repeated string sample_low_performance_entities = 345;- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the sampleLowPerformanceEntities at the given index.
-
getSampleLearningPerformanceEntitiesList
A list of up to 20 sample linked resources with impressions in the last 30 days where the asset had the AssetPerformanceLabel.LEARNING performance label. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView.
repeated string sample_learning_performance_entities = 346;- Returns:
- A list containing the sampleLearningPerformanceEntities.
-
getSampleLearningPerformanceEntitiesCount
int getSampleLearningPerformanceEntitiesCount()A list of up to 20 sample linked resources with impressions in the last 30 days where the asset had the AssetPerformanceLabel.LEARNING performance label. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView.
repeated string sample_learning_performance_entities = 346;- Returns:
- The count of sampleLearningPerformanceEntities.
-
getSampleLearningPerformanceEntities
A list of up to 20 sample linked resources with impressions in the last 30 days where the asset had the AssetPerformanceLabel.LEARNING performance label. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView.
repeated string sample_learning_performance_entities = 346;- Parameters:
index- The index of the element to return.- Returns:
- The sampleLearningPerformanceEntities at the given index.
-
getSampleLearningPerformanceEntitiesBytes
com.google.protobuf.ByteString getSampleLearningPerformanceEntitiesBytes(int index) A list of up to 20 sample linked resources with impressions in the last 30 days where the asset had the AssetPerformanceLabel.LEARNING performance label. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView.
repeated string sample_learning_performance_entities = 346;- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the sampleLearningPerformanceEntities at the given index.
-
getSampleUnratedPerformanceEntitiesList
A list of up to 20 sample linked resources with impressions in the last 30 days where the assets had AssetPerformanceLabel performance label other than BEST, GOOD, LOW, and LEARNING. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView.
repeated string sample_unrated_performance_entities = 347;- Returns:
- A list containing the sampleUnratedPerformanceEntities.
-
getSampleUnratedPerformanceEntitiesCount
int getSampleUnratedPerformanceEntitiesCount()A list of up to 20 sample linked resources with impressions in the last 30 days where the assets had AssetPerformanceLabel performance label other than BEST, GOOD, LOW, and LEARNING. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView.
repeated string sample_unrated_performance_entities = 347;- Returns:
- The count of sampleUnratedPerformanceEntities.
-
getSampleUnratedPerformanceEntities
A list of up to 20 sample linked resources with impressions in the last 30 days where the assets had AssetPerformanceLabel performance label other than BEST, GOOD, LOW, and LEARNING. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView.
repeated string sample_unrated_performance_entities = 347;- Parameters:
index- The index of the element to return.- Returns:
- The sampleUnratedPerformanceEntities at the given index.
-
getSampleUnratedPerformanceEntitiesBytes
com.google.protobuf.ByteString getSampleUnratedPerformanceEntitiesBytes(int index) A list of up to 20 sample linked resources with impressions in the last 30 days where the assets had AssetPerformanceLabel performance label other than BEST, GOOD, LOW, and LEARNING. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView.
repeated string sample_unrated_performance_entities = 347;- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the sampleUnratedPerformanceEntities at the given index.
-
hasAssetPinnedTotalCount
boolean hasAssetPinnedTotalCount()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.
optional int64 asset_pinned_total_count = 348;- Returns:
- Whether the assetPinnedTotalCount field is set.
-
getAssetPinnedTotalCount
long getAssetPinnedTotalCount()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.
optional int64 asset_pinned_total_count = 348;- Returns:
- The assetPinnedTotalCount.
-
hasAssetPinnedAsHeadlinePositionOneCount
boolean hasAssetPinnedAsHeadlinePositionOneCount()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.
optional int64 asset_pinned_as_headline_position_one_count = 349;- Returns:
- Whether the assetPinnedAsHeadlinePositionOneCount field is set.
-
getAssetPinnedAsHeadlinePositionOneCount
long getAssetPinnedAsHeadlinePositionOneCount()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.
optional int64 asset_pinned_as_headline_position_one_count = 349;- Returns:
- The assetPinnedAsHeadlinePositionOneCount.
-
hasAssetPinnedAsHeadlinePositionTwoCount
boolean hasAssetPinnedAsHeadlinePositionTwoCount()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.
optional int64 asset_pinned_as_headline_position_two_count = 350;- Returns:
- Whether the assetPinnedAsHeadlinePositionTwoCount field is set.
-
getAssetPinnedAsHeadlinePositionTwoCount
long getAssetPinnedAsHeadlinePositionTwoCount()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.
optional int64 asset_pinned_as_headline_position_two_count = 350;- Returns:
- The assetPinnedAsHeadlinePositionTwoCount.
-
hasAssetPinnedAsHeadlinePositionThreeCount
boolean hasAssetPinnedAsHeadlinePositionThreeCount()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.
optional int64 asset_pinned_as_headline_position_three_count = 351;- Returns:
- Whether the assetPinnedAsHeadlinePositionThreeCount field is set.
-
getAssetPinnedAsHeadlinePositionThreeCount
long getAssetPinnedAsHeadlinePositionThreeCount()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.
optional int64 asset_pinned_as_headline_position_three_count = 351;- Returns:
- The assetPinnedAsHeadlinePositionThreeCount.
-
hasAssetPinnedAsDescriptionPositionOneCount
boolean hasAssetPinnedAsDescriptionPositionOneCount()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.
optional int64 asset_pinned_as_description_position_one_count = 352;- Returns:
- Whether the assetPinnedAsDescriptionPositionOneCount field is set.
-
getAssetPinnedAsDescriptionPositionOneCount
long getAssetPinnedAsDescriptionPositionOneCount()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.
optional int64 asset_pinned_as_description_position_one_count = 352;- Returns:
- The assetPinnedAsDescriptionPositionOneCount.
-
hasAssetPinnedAsDescriptionPositionTwoCount
boolean hasAssetPinnedAsDescriptionPositionTwoCount()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.
optional int64 asset_pinned_as_description_position_two_count = 353;- Returns:
- Whether the assetPinnedAsDescriptionPositionTwoCount field is set.
-
getAssetPinnedAsDescriptionPositionTwoCount
long getAssetPinnedAsDescriptionPositionTwoCount()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.
optional int64 asset_pinned_as_description_position_two_count = 353;- Returns:
- The assetPinnedAsDescriptionPositionTwoCount.
-
hasAssetBestPerformanceImpressionPercentage
boolean hasAssetBestPerformanceImpressionPercentage()Percentage of impressions the asset received in ads with AssetPerformanceLabel.BEST. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView. This metric is only supported in Search channel.
optional double asset_best_performance_impression_percentage = 354;- Returns:
- Whether the assetBestPerformanceImpressionPercentage field is set.
-
getAssetBestPerformanceImpressionPercentage
double getAssetBestPerformanceImpressionPercentage()Percentage of impressions the asset received in ads with AssetPerformanceLabel.BEST. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView. This metric is only supported in Search channel.
optional double asset_best_performance_impression_percentage = 354;- Returns:
- The assetBestPerformanceImpressionPercentage.
-
hasAssetGoodPerformanceImpressionPercentage
boolean hasAssetGoodPerformanceImpressionPercentage()Percentage of impressions the asset received in ads with AssetPerformanceLabel.GOOD. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView. This metric is only supported in Search channel.
optional double asset_good_performance_impression_percentage = 355;- Returns:
- Whether the assetGoodPerformanceImpressionPercentage field is set.
-
getAssetGoodPerformanceImpressionPercentage
double getAssetGoodPerformanceImpressionPercentage()Percentage of impressions the asset received in ads with AssetPerformanceLabel.GOOD. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView. This metric is only supported in Search channel.
optional double asset_good_performance_impression_percentage = 355;- Returns:
- The assetGoodPerformanceImpressionPercentage.
-
hasAssetLowPerformanceImpressionPercentage
boolean hasAssetLowPerformanceImpressionPercentage()Percentage of impressions the asset received in ads with AssetPerformanceLabel.LOW. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView. This metric is only supported in Search channel.
optional double asset_low_performance_impression_percentage = 356;- Returns:
- Whether the assetLowPerformanceImpressionPercentage field is set.
-
getAssetLowPerformanceImpressionPercentage
double getAssetLowPerformanceImpressionPercentage()Percentage of impressions the asset received in ads with AssetPerformanceLabel.LOW. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView. This metric is only supported in Search channel.
optional double asset_low_performance_impression_percentage = 356;- Returns:
- The assetLowPerformanceImpressionPercentage.
-
hasAssetLearningPerformanceImpressionPercentage
boolean hasAssetLearningPerformanceImpressionPercentage()Percentage of impressions the asset received in ads with AssetPerformanceLabel.LEARNING. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView. This metric is only supported in Search channel.
optional double asset_learning_performance_impression_percentage = 357;- Returns:
- Whether the assetLearningPerformanceImpressionPercentage field is set.
-
getAssetLearningPerformanceImpressionPercentage
double getAssetLearningPerformanceImpressionPercentage()Percentage of impressions the asset received in ads with AssetPerformanceLabel.LEARNING. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView. This metric is only supported in Search channel.
optional double asset_learning_performance_impression_percentage = 357;- Returns:
- The assetLearningPerformanceImpressionPercentage.
-
hasAssetUnratedPerformanceImpressionPercentage
boolean hasAssetUnratedPerformanceImpressionPercentage()Percentage of impressions the asset received in ads with AssetPerformanceLabel other than BEST, GOOD, LOW, and LEARNING. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView. This metric is only supported in Search channel.
optional double asset_unrated_performance_impression_percentage = 358;- Returns:
- Whether the assetUnratedPerformanceImpressionPercentage field is set.
-
getAssetUnratedPerformanceImpressionPercentage
double getAssetUnratedPerformanceImpressionPercentage()Percentage of impressions the asset received in ads with AssetPerformanceLabel other than BEST, GOOD, LOW, and LEARNING. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView. This metric is only supported in Search channel.
optional double asset_unrated_performance_impression_percentage = 358;- Returns:
- The assetUnratedPerformanceImpressionPercentage.
-
hasAssetBestPerformanceCostPercentage
boolean hasAssetBestPerformanceCostPercentage()Percentage of cost the asset received in ads with AssetPerformanceLabel.BEST. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView. This metric is only supported in Performance Max channel.
optional double asset_best_performance_cost_percentage = 359;- Returns:
- Whether the assetBestPerformanceCostPercentage field is set.
-
getAssetBestPerformanceCostPercentage
double getAssetBestPerformanceCostPercentage()Percentage of cost the asset received in ads with AssetPerformanceLabel.BEST. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView. This metric is only supported in Performance Max channel.
optional double asset_best_performance_cost_percentage = 359;- Returns:
- The assetBestPerformanceCostPercentage.
-
hasAssetGoodPerformanceCostPercentage
boolean hasAssetGoodPerformanceCostPercentage()Percentage of cost the asset received in ads with AssetPerformanceLabel.GOOD. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView. This metric is only supported in Performance Max channel.
optional double asset_good_performance_cost_percentage = 360;- Returns:
- Whether the assetGoodPerformanceCostPercentage field is set.
-
getAssetGoodPerformanceCostPercentage
double getAssetGoodPerformanceCostPercentage()Percentage of cost the asset received in ads with AssetPerformanceLabel.GOOD. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView. This metric is only supported in Performance Max channel.
optional double asset_good_performance_cost_percentage = 360;- Returns:
- The assetGoodPerformanceCostPercentage.
-
hasAssetLowPerformanceCostPercentage
boolean hasAssetLowPerformanceCostPercentage()Percentage of cost the asset received in ads with AssetPerformanceLabel.LOW. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView. This metric is only supported in Performance Max channel.
optional double asset_low_performance_cost_percentage = 361;- Returns:
- Whether the assetLowPerformanceCostPercentage field is set.
-
getAssetLowPerformanceCostPercentage
double getAssetLowPerformanceCostPercentage()Percentage of cost the asset received in ads with AssetPerformanceLabel.LOW. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView. This metric is only supported in Performance Max channel.
optional double asset_low_performance_cost_percentage = 361;- Returns:
- The assetLowPerformanceCostPercentage.
-
hasAssetLearningPerformanceCostPercentage
boolean hasAssetLearningPerformanceCostPercentage()Percentage of cost the asset received in ads with AssetPerformanceLabel.LEARNING. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView. This metric is only supported in Performance Max channel.
optional double asset_learning_performance_cost_percentage = 362;- Returns:
- Whether the assetLearningPerformanceCostPercentage field is set.
-
getAssetLearningPerformanceCostPercentage
double getAssetLearningPerformanceCostPercentage()Percentage of cost the asset received in ads with AssetPerformanceLabel.LEARNING. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView. This metric is only supported in Performance Max channel.
optional double asset_learning_performance_cost_percentage = 362;- Returns:
- The assetLearningPerformanceCostPercentage.
-
hasAssetUnratedPerformanceCostPercentage
boolean hasAssetUnratedPerformanceCostPercentage()Percentage of cost the asset received in ads with AssetPerformanceLabel other than BEST, GOOD, LOW, and LEARNING. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView. This metric is only supported in Performance Max channel.
optional double asset_unrated_performance_cost_percentage = 363;- Returns:
- Whether the assetUnratedPerformanceCostPercentage field is set.
-
getAssetUnratedPerformanceCostPercentage
double getAssetUnratedPerformanceCostPercentage()Percentage of cost the asset received in ads with AssetPerformanceLabel other than BEST, GOOD, LOW, and LEARNING. This metric can only be selected with ChannelAggregateAssetView and CampaignAggregateAssetView. This metric is only supported in Performance Max channel.
optional double asset_unrated_performance_cost_percentage = 363;- Returns:
- The assetUnratedPerformanceCostPercentage.
-
hasStoreVisitsLastClickModelAttributedConversions
boolean hasStoreVisitsLastClickModelAttributedConversions()The amount of store visits attributed by the last click model.
optional double store_visits_last_click_model_attributed_conversions = 365;- Returns:
- Whether the storeVisitsLastClickModelAttributedConversions field is set.
-
getStoreVisitsLastClickModelAttributedConversions
double getStoreVisitsLastClickModelAttributedConversions()The amount of store visits attributed by the last click model.
optional double store_visits_last_click_model_attributed_conversions = 365;- Returns:
- The storeVisitsLastClickModelAttributedConversions.
-
hasResultsConversionsPurchase
boolean hasResultsConversionsPurchase()The purchase conversion stats for the unified goals results.
optional double results_conversions_purchase = 366;- Returns:
- Whether the resultsConversionsPurchase field is set.
-
getResultsConversionsPurchase
double getResultsConversionsPurchase()The purchase conversion stats for the unified goals results.
optional double results_conversions_purchase = 366;- Returns:
- The resultsConversionsPurchase.
-
hasVideoViewRateInFeed
boolean hasVideoViewRateInFeed()The number of video views divided by number of impressions that can potentially lead to video views for in-feed formats.
optional double video_view_rate_in_feed = 367;- Returns:
- Whether the videoViewRateInFeed field is set.
-
getVideoViewRateInFeed
double getVideoViewRateInFeed()The number of video views divided by number of impressions that can potentially lead to video views for in-feed formats.
optional double video_view_rate_in_feed = 367;- Returns:
- The videoViewRateInFeed.
-
hasVideoViewRateInStream
boolean hasVideoViewRateInStream()The number of video views divided by number of impressions that can potentially lead to video views for in-stream formats.
optional double video_view_rate_in_stream = 368;- Returns:
- Whether the videoViewRateInStream field is set.
-
getVideoViewRateInStream
double getVideoViewRateInStream()The number of video views divided by number of impressions that can potentially lead to video views for in-stream formats.
optional double video_view_rate_in_stream = 368;- Returns:
- The videoViewRateInStream.
-
hasVideoViewRateShorts
boolean hasVideoViewRateShorts()The number of video views divided by number of impressions that can potentially lead to video views for in shorts formats.
optional double video_view_rate_shorts = 369;- Returns:
- Whether the videoViewRateShorts field is set.
-
getVideoViewRateShorts
double getVideoViewRateShorts()The number of video views divided by number of impressions that can potentially lead to video views for in shorts formats.
optional double video_view_rate_shorts = 369;- Returns:
- The videoViewRateShorts.
-