google-ads-api-client
Version:
A friendly and exhaustive client to the google-ads-api, code generated directly from google's published protobuf schema.
1,060 lines (1,059 loc) • 45.9 kB
TypeScript
import type { BinaryWriteOptions } from "@protobuf-ts/runtime";
import type { IBinaryWriter } from "@protobuf-ts/runtime";
import type { BinaryReadOptions } from "@protobuf-ts/runtime";
import type { IBinaryReader } from "@protobuf-ts/runtime";
import type { PartialMessage } from "@protobuf-ts/runtime";
import { MessageType } from "@protobuf-ts/runtime";
import { InteractionEventTypeEnum_InteractionEventType } from "../enums/interaction_event_type";
import { QualityScoreBucketEnum_QualityScoreBucket } from "../enums/quality_score_bucket";
/**
* Metrics data.
*
* @generated from protobuf message google.ads.googleads.v11.common.Metrics
*/
export interface Metrics {
/**
* The percent of your ad impressions that are shown as the very first ad
* above the organic search results.
*
* @generated from protobuf field: optional double absolute_top_impression_percentage = 183;
*/
absoluteTopImpressionPercentage?: number;
/**
* Average cost of viewable impressions (`active_view_impressions`).
*
* @generated from protobuf field: optional double active_view_cpm = 184;
*/
activeViewCpm?: number;
/**
* Active view measurable clicks divided by active view viewable impressions.
* This metric is reported only for display network.
*
* @generated from protobuf field: optional double active_view_ctr = 185;
*/
activeViewCtr?: number;
/**
* A measurement of how often your ad has become viewable on a Display
* Network site.
*
* @generated from protobuf field: optional int64 active_view_impressions = 186;
*/
activeViewImpressions?: bigint;
/**
* The ratio of impressions that could be measured by Active View over the
* number of served impressions.
*
* @generated from protobuf field: optional double active_view_measurability = 187;
*/
activeViewMeasurability?: number;
/**
* The cost of the impressions you received that were measurable by Active
* View.
*
* @generated from protobuf field: optional int64 active_view_measurable_cost_micros = 188;
*/
activeViewMeasurableCostMicros?: bigint;
/**
* The number of times your ads are appearing on placements in positions
* where they can be seen.
*
* @generated from protobuf field: optional int64 active_view_measurable_impressions = 189;
*/
activeViewMeasurableImpressions?: bigint;
/**
* The percentage of time when your ad appeared on an Active View enabled site
* (measurable impressions) and was viewable (viewable impressions).
*
* @generated from protobuf field: optional double active_view_viewability = 190;
*/
activeViewViewability?: number;
/**
* All conversions from interactions (as oppose to view through conversions)
* divided by the number of ad interactions.
*
* @generated from protobuf field: optional double all_conversions_from_interactions_rate = 191;
*/
allConversionsFromInteractionsRate?: number;
/**
* The value of all conversions.
*
* @generated from protobuf field: optional double all_conversions_value = 192;
*/
allConversionsValue?: number;
/**
* The value of all conversions. When this column is selected with date, the
* values in date column means the conversion date. Details for the
* by_conversion_date columns are available at
* https://support.google.com/google-ads/answer/9549009.
*
* @generated from protobuf field: double all_conversions_value_by_conversion_date = 240;
*/
allConversionsValueByConversionDate: number;
/**
* The total number of conversions. This includes all conversions regardless
* of the value of include_in_conversions_metric.
*
* @generated from protobuf field: optional double all_conversions = 193;
*/
allConversions?: number;
/**
* The total number of conversions. This includes all conversions regardless
* of the value of include_in_conversions_metric. When this column is selected
* with date, the values in date column means the conversion date. Details for
* the by_conversion_date columns are available at
* https://support.google.com/google-ads/answer/9549009.
*
* @generated from protobuf field: double all_conversions_by_conversion_date = 241;
*/
allConversionsByConversionDate: number;
/**
* The value of all conversions divided by the total cost of ad interactions
* (such as clicks for text ads or views for video ads).
*
* @generated from protobuf field: optional double all_conversions_value_per_cost = 194;
*/
allConversionsValuePerCost?: number;
/**
* 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.
*
* @generated from protobuf field: optional double all_conversions_from_click_to_call = 195;
*/
allConversionsFromClickToCall?: number;
/**
* 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.
*
* @generated from protobuf field: optional double all_conversions_from_directions = 196;
*/
allConversionsFromDirections?: number;
/**
* The value of all conversions from interactions divided by the total number
* of interactions.
*
* @generated from protobuf field: optional double all_conversions_from_interactions_value_per_interaction = 197;
*/
allConversionsFromInteractionsValuePerInteraction?: number;
/**
* 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.
*
* @generated from protobuf field: optional double all_conversions_from_menu = 198;
*/
allConversionsFromMenu?: number;
/**
* The number of times people placed an order at a store after clicking an ad.
* This metric applies to feed items only.
*
* @generated from protobuf field: optional double all_conversions_from_order = 199;
*/
allConversionsFromOrder?: number;
/**
* 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.
*
* @generated from protobuf field: optional double all_conversions_from_other_engagement = 200;
*/
allConversionsFromOtherEngagement?: number;
/**
* Estimated number of times people visited a store after clicking an ad.
* This metric applies to feed items only.
*
* @generated from protobuf field: optional double all_conversions_from_store_visit = 201;
*/
allConversionsFromStoreVisit?: number;
/**
* The number of times that people were taken to a store's URL after clicking
* an ad.
* This metric applies to feed items only.
*
* @generated from protobuf field: optional double all_conversions_from_store_website = 202;
*/
allConversionsFromStoreWebsite?: number;
/**
* This metric is part of the Auction Insights report, and tells how often
* the ads of another participant showed as the very first ad above the
* organic search results.
* This percentage is computed only over the auctions that you appeared in
* the page.
* This metric is not publicly available.
*
* @generated from protobuf field: optional double auction_insight_search_absolute_top_impression_percentage = 258;
*/
auctionInsightSearchAbsoluteTopImpressionPercentage?: number;
/**
* This metric is part of the Auction Insights report, and tells the
* percentage of impressions that another participant obtained, over the total
* number of impressions that your ads were eligible for.
* Any value below 0.1 is reported as 0.0999.
* This metric is not publicly available.
*
* @generated from protobuf field: optional double auction_insight_search_impression_share = 259;
*/
auctionInsightSearchImpressionShare?: number;
/**
* This metric is part of the Auction Insights report, and tells the
* percentage of impressions that your ads outranked (showed above)
* another participant in the auction, compared to the total number of
* impressions that your ads were eligible for.
* Any value below 0.1 is reported as 0.0999.
* This metric is not publicly available.
*
* @generated from protobuf field: optional double auction_insight_search_outranking_share = 260;
*/
auctionInsightSearchOutrankingShare?: number;
/**
* This metric is part of the Auction Insights report, and tells how often
* another participant's ad received an impression when your ad also received
* an impression.
* This metric is not publicly available.
*
* @generated from protobuf field: optional double auction_insight_search_overlap_rate = 261;
*/
auctionInsightSearchOverlapRate?: number;
/**
* This metric is part of the Auction Insights report, and tells how often
* another participant's ad was shown in a higher position than yours, when
* both of your ads were shown at the same page.
* This metric is not publicly available.
*
* @generated from protobuf field: optional double auction_insight_search_position_above_rate = 262;
*/
auctionInsightSearchPositionAboveRate?: number;
/**
* This metric is part of the Auction Insights report, and tells how often
* the ads of another participant showed above the organic search results.
* This percentage is computed only over the auctions that you appeared in
* the page.
* This metric is not publicly available.
*
* @generated from protobuf field: optional double auction_insight_search_top_impression_percentage = 263;
*/
auctionInsightSearchTopImpressionPercentage?: number;
/**
* The average amount you pay per interaction. This amount is the total cost
* of your ads divided by the total number of interactions.
*
* @generated from protobuf field: optional double average_cost = 203;
*/
averageCost?: number;
/**
* The total cost of all clicks divided by the total number of clicks
* received.
*
* @generated from protobuf field: optional double average_cpc = 204;
*/
averageCpc?: number;
/**
* The average amount that you've been charged for an ad engagement. This
* amount is the total cost of all ad engagements divided by the total number
* of ad engagements.
*
* @generated from protobuf field: optional double average_cpe = 205;
*/
averageCpe?: number;
/**
* Average cost-per-thousand impressions (CPM).
*
* @generated from protobuf field: optional double average_cpm = 206;
*/
averageCpm?: number;
/**
* 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.
*
* @generated from protobuf field: optional double average_cpv = 207;
*/
averageCpv?: number;
/**
* Average number of pages viewed per session.
*
* @generated from protobuf field: optional double average_page_views = 208;
*/
averagePageViews?: number;
/**
* Total duration of all sessions (in seconds) / number of sessions. Imported
* from Google Analytics.
*
* @generated from protobuf field: optional double average_time_on_site = 209;
*/
averageTimeOnSite?: number;
/**
* An indication of how other advertisers are bidding on similar products.
*
* @generated from protobuf field: optional double benchmark_average_max_cpc = 210;
*/
benchmarkAverageMaxCpc?: number;
/**
* Number of app installs.
*
* @generated from protobuf field: optional double biddable_app_install_conversions = 254;
*/
biddableAppInstallConversions?: number;
/**
* Number of in-app actions.
*
* @generated from protobuf field: optional double biddable_app_post_install_conversions = 255;
*/
biddableAppPostInstallConversions?: number;
/**
* An indication on how other advertisers' Shopping ads for similar products
* are performing based on how often people who see their ad click on it.
*
* @generated from protobuf field: optional double benchmark_ctr = 211;
*/
benchmarkCtr?: number;
/**
* Percentage of clicks where the user only visited a single page on your
* site. Imported from Google Analytics.
*
* @generated from protobuf field: optional double bounce_rate = 212;
*/
bounceRate?: number;
/**
* The number of clicks.
*
* @generated from protobuf field: optional int64 clicks = 131;
*/
clicks?: bigint;
/**
* The number of times your ad or your site's listing in the unpaid
* results was clicked. See the help page at
* https://support.google.com/google-ads/answer/3097241 for details.
*
* @generated from protobuf field: optional int64 combined_clicks = 156;
*/
combinedClicks?: bigint;
/**
* The number of times your ad or your site's listing in the unpaid
* results was clicked (combined_clicks) divided by combined_queries. See the
* help page at https://support.google.com/google-ads/answer/3097241 for
* details.
*
* @generated from protobuf field: optional double combined_clicks_per_query = 157;
*/
combinedClicksPerQuery?: number;
/**
* The number of searches that returned pages from your site in the unpaid
* results or showed one of your text ads. See the help page at
* https://support.google.com/google-ads/answer/3097241 for details.
*
* @generated from protobuf field: optional int64 combined_queries = 158;
*/
combinedQueries?: bigint;
/**
* The estimated percent of times that your ad was eligible to show
* on the Display Network but didn't because your budget was too low.
* Note: Content budget lost impression share is reported in the range of 0
* to 0.9. Any value above 0.9 is reported as 0.9001.
*
* @generated from protobuf field: optional double content_budget_lost_impression_share = 159;
*/
contentBudgetLostImpressionShare?: number;
/**
* The impressions you've received on the Display Network divided
* by the estimated number of impressions you were eligible to receive.
* Note: Content impression share is reported in the range of 0.1 to 1. Any
* value below 0.1 is reported as 0.0999.
*
* @generated from protobuf field: optional double content_impression_share = 160;
*/
contentImpressionShare?: number;
/**
* The last date/time a conversion tag for this conversion action successfully
* fired and was seen by Google Ads. This firing event may not have been the
* result of an attributable conversion (for example, because the tag was
* fired from a browser that did not previously click an ad from an
* appropriate advertiser). The date/time is in the customer's time zone.
*
* @generated from protobuf field: optional string conversion_last_received_request_date_time = 161;
*/
conversionLastReceivedRequestDateTime?: string;
/**
* The date of the most recent conversion for this conversion action. The date
* is in the customer's time zone.
*
* @generated from protobuf field: optional string conversion_last_conversion_date = 162;
*/
conversionLastConversionDate?: string;
/**
* The estimated percentage of impressions on the Display Network
* that your ads didn't receive due to poor Ad Rank.
* Note: Content rank lost impression share is reported in the range of 0
* to 0.9. Any value above 0.9 is reported as 0.9001.
*
* @generated from protobuf field: optional double content_rank_lost_impression_share = 163;
*/
contentRankLostImpressionShare?: number;
/**
* Conversions from interactions divided by the number of ad interactions
* (such as clicks for text ads or views for video ads). This only includes
* conversion actions which include_in_conversions_metric attribute is set to
* true. If you use conversion-based bidding, your bid strategies will
* optimize for these conversions.
*
* @generated from protobuf field: optional double conversions_from_interactions_rate = 164;
*/
conversionsFromInteractionsRate?: number;
/**
* The value of conversions. This only includes conversion actions which
* include_in_conversions_metric attribute is set to true. If you use
* conversion-based bidding, your bid strategies will optimize for these
* conversions.
*
* @generated from protobuf field: optional double conversions_value = 165;
*/
conversionsValue?: number;
/**
* The value of conversions. This only includes conversion actions which
* include_in_conversions_metric attribute is set to true. If you use
* conversion-based bidding, your bid strategies will optimize for these
* conversions. When this column is selected with date, the values in date
* column means the conversion date. Details for the by_conversion_date
* columns are available at
* https://support.google.com/google-ads/answer/9549009.
*
* @generated from protobuf field: double conversions_value_by_conversion_date = 242;
*/
conversionsValueByConversionDate: number;
/**
* The value of conversions divided by the cost of ad interactions. This only
* includes conversion actions which include_in_conversions_metric attribute
* is set to true. If you use conversion-based bidding, your bid strategies
* will optimize for these conversions.
*
* @generated from protobuf field: optional double conversions_value_per_cost = 166;
*/
conversionsValuePerCost?: number;
/**
* The value of conversions from interactions divided by the number of ad
* interactions. This only includes conversion actions which
* include_in_conversions_metric attribute is set to true. If you use
* conversion-based bidding, your bid strategies will optimize for these
* conversions.
*
* @generated from protobuf field: optional double conversions_from_interactions_value_per_interaction = 167;
*/
conversionsFromInteractionsValuePerInteraction?: number;
/**
* The number of conversions. This only includes conversion actions which
* include_in_conversions_metric attribute is set to true. If you use
* conversion-based bidding, your bid strategies will optimize for these
* conversions.
*
* @generated from protobuf field: optional double conversions = 168;
*/
conversions?: number;
/**
* The number of conversions. This only includes conversion actions which
* include_in_conversions_metric attribute is set to true. If you use
* conversion-based bidding, your bid strategies will optimize for these
* conversions. When this column is selected with date, the values in date
* column means the conversion date. Details for the by_conversion_date
* columns are available at
* https://support.google.com/google-ads/answer/9549009.
*
* @generated from protobuf field: double conversions_by_conversion_date = 243;
*/
conversionsByConversionDate: number;
/**
* The sum of your cost-per-click (CPC) and cost-per-thousand impressions
* (CPM) costs during this period.
*
* @generated from protobuf field: optional int64 cost_micros = 169;
*/
costMicros?: bigint;
/**
* The cost of ad interactions divided by all conversions.
*
* @generated from protobuf field: optional double cost_per_all_conversions = 170;
*/
costPerAllConversions?: number;
/**
* The cost of ad interactions divided by conversions. This only includes
* conversion actions which include_in_conversions_metric attribute is set to
* true. If you use conversion-based bidding, your bid strategies will
* optimize for these conversions.
*
* @generated from protobuf field: optional double cost_per_conversion = 171;
*/
costPerConversion?: number;
/**
* The cost of ad interactions divided by current model attributed
* conversions. This only includes conversion actions which
* include_in_conversions_metric attribute is set to true. If you use
* conversion-based bidding, your bid strategies will optimize for these
* conversions.
*
* @generated from protobuf field: optional double cost_per_current_model_attributed_conversion = 172;
*/
costPerCurrentModelAttributedConversion?: number;
/**
* Conversions from when a customer clicks on a Google Ads ad on one device,
* then converts on a different device or browser.
* Cross-device conversions are already included in all_conversions.
*
* @generated from protobuf field: optional double cross_device_conversions = 173;
*/
crossDeviceConversions?: number;
/**
* The number of clicks your ad receives (Clicks) divided by the number
* of times your ad is shown (Impressions).
*
* @generated from protobuf field: optional double ctr = 174;
*/
ctr?: number;
/**
* Shows how your historic conversions data would look under the attribution
* model you've currently selected. This only includes conversion actions
* which include_in_conversions_metric attribute is set to true. If you use
* conversion-based bidding, your bid strategies will optimize for these
* conversions.
*
* @generated from protobuf field: optional double current_model_attributed_conversions = 175;
*/
currentModelAttributedConversions?: number;
/**
* Current model attributed conversions from interactions divided by the
* number of ad interactions (such as clicks for text ads or views for video
* ads). This only includes conversion actions which
* include_in_conversions_metric attribute is set to true. If you use
* conversion-based bidding, your bid strategies will optimize for these
* conversions.
*
* @generated from protobuf field: optional double current_model_attributed_conversions_from_interactions_rate = 176;
*/
currentModelAttributedConversionsFromInteractionsRate?: number;
/**
* The value of current model attributed conversions from interactions divided
* by the number of ad interactions. This only includes conversion actions
* which include_in_conversions_metric attribute is set to true. If you use
* conversion-based bidding, your bid strategies will optimize for these
* conversions.
*
* @generated from protobuf field: optional double current_model_attributed_conversions_from_interactions_value_per_interaction = 177;
*/
currentModelAttributedConversionsFromInteractionsValuePerInteraction?: number;
/**
* The value of current model attributed conversions. This only includes
* conversion actions which include_in_conversions_metric attribute is set to
* true. If you use conversion-based bidding, your bid strategies will
* optimize for these conversions.
*
* @generated from protobuf field: optional double current_model_attributed_conversions_value = 178;
*/
currentModelAttributedConversionsValue?: number;
/**
* The value of current model attributed conversions divided by the cost of ad
* interactions. This only includes conversion actions which
* include_in_conversions_metric attribute is set to true. If you use
* conversion-based bidding, your bid strategies will optimize for these
* conversions.
*
* @generated from protobuf field: optional double current_model_attributed_conversions_value_per_cost = 179;
*/
currentModelAttributedConversionsValuePerCost?: number;
/**
* How often people engage with your ad after it's shown to them. This is the
* number of ad expansions divided by the number of times your ad is shown.
*
* @generated from protobuf field: optional double engagement_rate = 180;
*/
engagementRate?: number;
/**
* The number of engagements.
* An engagement occurs when a viewer expands your Lightbox ad. Also, in the
* future, other ad types may support engagement metrics.
*
* @generated from protobuf field: optional int64 engagements = 181;
*/
engagements?: bigint;
/**
* Average lead value based on clicks.
*
* @generated from protobuf field: optional double hotel_average_lead_value_micros = 213;
*/
hotelAverageLeadValueMicros?: number;
/**
* Commission bid rate in micros. A 20% commission is represented as
* 200,000.
*
* @generated from protobuf field: optional int64 hotel_commission_rate_micros = 256;
*/
hotelCommissionRateMicros?: bigint;
/**
* Expected commission cost. The result of multiplying the commission value
* times the hotel_commission_rate in advertiser currency.
*
* @generated from protobuf field: optional double hotel_expected_commission_cost = 257;
*/
hotelExpectedCommissionCost?: number;
/**
* The average price difference between the price offered by reporting hotel
* advertiser and the cheapest price offered by the competing advertiser.
*
* @generated from protobuf field: optional double hotel_price_difference_percentage = 214;
*/
hotelPriceDifferencePercentage?: number;
/**
* The number of impressions that hotel partners could have had given their
* feed performance.
*
* @generated from protobuf field: optional int64 hotel_eligible_impressions = 215;
*/
hotelEligibleImpressions?: bigint;
/**
* The creative historical quality score.
*
* @generated from protobuf field: google.ads.googleads.v11.enums.QualityScoreBucketEnum.QualityScoreBucket historical_creative_quality_score = 80;
*/
historicalCreativeQualityScore: QualityScoreBucketEnum_QualityScoreBucket;
/**
* The quality of historical landing page experience.
*
* @generated from protobuf field: google.ads.googleads.v11.enums.QualityScoreBucketEnum.QualityScoreBucket historical_landing_page_quality_score = 81;
*/
historicalLandingPageQualityScore: QualityScoreBucketEnum_QualityScoreBucket;
/**
* The historical quality score.
*
* @generated from protobuf field: optional int64 historical_quality_score = 216;
*/
historicalQualityScore?: bigint;
/**
* The historical search predicted click through rate (CTR).
*
* @generated from protobuf field: google.ads.googleads.v11.enums.QualityScoreBucketEnum.QualityScoreBucket historical_search_predicted_ctr = 83;
*/
historicalSearchPredictedCtr: QualityScoreBucketEnum_QualityScoreBucket;
/**
* The number of times the ad was forwarded to someone else as a message.
*
* @generated from protobuf field: optional int64 gmail_forwards = 217;
*/
gmailForwards?: bigint;
/**
* The number of times someone has saved your Gmail ad to their inbox as a
* message.
*
* @generated from protobuf field: optional int64 gmail_saves = 218;
*/
gmailSaves?: bigint;
/**
* The number of clicks to the landing page on the expanded state of Gmail
* ads.
*
* @generated from protobuf field: optional int64 gmail_secondary_clicks = 219;
*/
gmailSecondaryClicks?: bigint;
/**
* The number of times a store's location-based ad was shown.
* This metric applies to feed items only.
*
* @generated from protobuf field: optional int64 impressions_from_store_reach = 220;
*/
impressionsFromStoreReach?: bigint;
/**
* Count of how often your ad has appeared on a search results page or
* website on the Google Network.
*
* @generated from protobuf field: optional int64 impressions = 221;
*/
impressions?: bigint;
/**
* How often people interact with your ad after it is shown to them.
* This is the number of interactions divided by the number of times your ad
* is shown.
*
* @generated from protobuf field: optional double interaction_rate = 222;
*/
interactionRate?: number;
/**
* The number of interactions.
* An interaction is the main user action associated with an ad format-clicks
* for text and shopping ads, views for video ads, and so on.
*
* @generated from protobuf field: optional int64 interactions = 223;
*/
interactions?: bigint;
/**
* The types of payable and free interactions.
*
* @generated from protobuf field: repeated google.ads.googleads.v11.enums.InteractionEventTypeEnum.InteractionEventType interaction_event_types = 100;
*/
interactionEventTypes: InteractionEventTypeEnum_InteractionEventType[];
/**
* The percentage of clicks filtered out of your total number of clicks
* (filtered + non-filtered clicks) during the reporting period.
*
* @generated from protobuf field: optional double invalid_click_rate = 224;
*/
invalidClickRate?: number;
/**
* Number of clicks Google considers illegitimate and doesn't charge you for.
*
* @generated from protobuf field: optional int64 invalid_clicks = 225;
*/
invalidClicks?: bigint;
/**
* Number of message chats initiated for Click To Message impressions that
* were message tracking eligible.
*
* @generated from protobuf field: optional int64 message_chats = 226;
*/
messageChats?: bigint;
/**
* Number of Click To Message impressions that were message tracking eligible.
*
* @generated from protobuf field: optional int64 message_impressions = 227;
*/
messageImpressions?: bigint;
/**
* Number of message chats initiated (message_chats) divided by the number
* of message impressions (message_impressions).
* Rate at which a user initiates a message chat from an ad impression with
* a messaging option and message tracking enabled.
* Note that this rate can be more than 1.0 for a given message impression.
*
* @generated from protobuf field: optional double message_chat_rate = 228;
*/
messageChatRate?: number;
/**
* The percentage of mobile clicks that go to a mobile-friendly page.
*
* @generated from protobuf field: optional double mobile_friendly_clicks_percentage = 229;
*/
mobileFriendlyClicksPercentage?: number;
/**
* Total optimization score uplift of all recommendations.
*
* @generated from protobuf field: optional double optimization_score_uplift = 247;
*/
optimizationScoreUplift?: number;
/**
* URL for the optimization score page in the Google Ads web interface.
* This metric can be selected from `customer` or `campaign`, and can be
* segmented by `segments.recommendation_type`. For example, `SELECT
* metrics.optimization_score_url, segments.recommendation_type FROM
* customer` will return a URL for each unique (customer, recommendation_type)
* combination.
*
* @generated from protobuf field: optional string optimization_score_url = 248;
*/
optimizationScoreUrl?: string;
/**
* The number of times someone clicked your site's listing in the unpaid
* results for a particular query. See the help page at
* https://support.google.com/google-ads/answer/3097241 for details.
*
* @generated from protobuf field: optional int64 organic_clicks = 230;
*/
organicClicks?: bigint;
/**
* The number of times someone clicked your site's listing in the unpaid
* results (organic_clicks) divided by the total number of searches that
* returned pages from your site (organic_queries). See the help page at
* https://support.google.com/google-ads/answer/3097241 for details.
*
* @generated from protobuf field: optional double organic_clicks_per_query = 231;
*/
organicClicksPerQuery?: number;
/**
* The number of listings for your site in the unpaid search results. See the
* help page at https://support.google.com/google-ads/answer/3097241 for
* details.
*
* @generated from protobuf field: optional int64 organic_impressions = 232;
*/
organicImpressions?: bigint;
/**
* The number of times a page from your site was listed in the unpaid search
* results (organic_impressions) divided by the number of searches returning
* your site's listing in the unpaid results (organic_queries). See the help
* page at https://support.google.com/google-ads/answer/3097241 for details.
*
* @generated from protobuf field: optional double organic_impressions_per_query = 233;
*/
organicImpressionsPerQuery?: number;
/**
* The total number of searches that returned your site's listing in the
* unpaid results. See the help page at
* https://support.google.com/google-ads/answer/3097241 for details.
*
* @generated from protobuf field: optional int64 organic_queries = 234;
*/
organicQueries?: bigint;
/**
* Percentage of first-time sessions (from people who had never visited your
* site before). Imported from Google Analytics.
*
* @generated from protobuf field: optional double percent_new_visitors = 235;
*/
percentNewVisitors?: number;
/**
* Number of offline phone calls.
*
* @generated from protobuf field: optional int64 phone_calls = 236;
*/
phoneCalls?: bigint;
/**
* Number of offline phone impressions.
*
* @generated from protobuf field: optional int64 phone_impressions = 237;
*/
phoneImpressions?: bigint;
/**
* Number of phone calls received (phone_calls) divided by the number of
* times your phone number is shown (phone_impressions).
*
* @generated from protobuf field: optional double phone_through_rate = 238;
*/
phoneThroughRate?: number;
/**
* Your clickthrough rate (Ctr) divided by the average clickthrough rate of
* all advertisers on the websites that show your ads. Measures how your ads
* perform on Display Network sites compared to other ads on the same sites.
*
* @generated from protobuf field: optional double relative_ctr = 239;
*/
relativeCtr?: number;
/**
* The percentage of the customer's Shopping or Search ad impressions that are
* shown in the most prominent Shopping position. See
* https://support.google.com/google-ads/answer/7501826
* for details. Any value below 0.1 is reported as 0.0999.
*
* @generated from protobuf field: optional double search_absolute_top_impression_share = 136;
*/
searchAbsoluteTopImpressionShare?: number;
/**
* The number estimating how often your ad wasn't the very first ad above the
* organic search results due to a low budget. Note: Search
* budget lost absolute top impression share is reported in the range of 0 to
* 0.9. Any value above 0.9 is reported as 0.9001.
*
* @generated from protobuf field: optional double search_budget_lost_absolute_top_impression_share = 137;
*/
searchBudgetLostAbsoluteTopImpressionShare?: number;
/**
* The estimated percent of times that your ad was eligible to show on the
* Search Network but didn't because your budget was too low. Note: Search
* budget lost impression share is reported in the range of 0 to 0.9. Any
* value above 0.9 is reported as 0.9001.
*
* @generated from protobuf field: optional double search_budget_lost_impression_share = 138;
*/
searchBudgetLostImpressionShare?: number;
/**
* The number estimating how often your ad didn't show anywhere above the
* organic search results due to a low budget. Note: Search
* budget lost top impression share is reported in the range of 0 to 0.9. Any
* value above 0.9 is reported as 0.9001.
*
* @generated from protobuf field: optional double search_budget_lost_top_impression_share = 139;
*/
searchBudgetLostTopImpressionShare?: number;
/**
* The number of clicks you've received on the Search Network
* divided by the estimated number of clicks you were eligible to receive.
* Note: Search click share is reported in the range of 0.1 to 1. Any value
* below 0.1 is reported as 0.0999.
*
* @generated from protobuf field: optional double search_click_share = 140;
*/
searchClickShare?: number;
/**
* The impressions you've received divided by the estimated number of
* impressions you were eligible to receive on the Search Network for search
* terms that matched your keywords exactly (or were close variants of your
* keyword), regardless of your keyword match types. Note: Search exact match
* impression share is reported in the range of 0.1 to 1. Any value below 0.1
* is reported as 0.0999.
*
* @generated from protobuf field: optional double search_exact_match_impression_share = 141;
*/
searchExactMatchImpressionShare?: number;
/**
* The impressions you've received on the Search Network divided
* by the estimated number of impressions you were eligible to receive.
* Note: Search impression share is reported in the range of 0.1 to 1. Any
* value below 0.1 is reported as 0.0999.
*
* @generated from protobuf field: optional double search_impression_share = 142;
*/
searchImpressionShare?: number;
/**
* The number estimating how often your ad wasn't the very first ad above the
* organic search results due to poor Ad Rank.
* Note: Search rank lost absolute top impression share is reported in the
* range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.
*
* @generated from protobuf field: optional double search_rank_lost_absolute_top_impression_share = 143;
*/
searchRankLostAbsoluteTopImpressionShare?: number;
/**
* The estimated percentage of impressions on the Search Network
* that your ads didn't receive due to poor Ad Rank.
* Note: Search rank lost impression share is reported in the range of 0 to
* 0.9. Any value above 0.9 is reported as 0.9001.
*
* @generated from protobuf field: optional double search_rank_lost_impression_share = 144;
*/
searchRankLostImpressionShare?: number;
/**
* The number estimating how often your ad didn't show anywhere above the
* organic search results due to poor Ad Rank.
* Note: Search rank lost top impression share is reported in the range of 0
* to 0.9. Any value above 0.9 is reported as 0.9001.
*
* @generated from protobuf field: optional double search_rank_lost_top_impression_share = 145;
*/
searchRankLostTopImpressionShare?: number;
/**
* The impressions you've received in the top location (anywhere above the
* organic search results) compared to the estimated number of impressions you
* were eligible to receive in the top location.
* Note: Search top impression share is reported in the range of 0.1 to 1. Any
* value below 0.1 is reported as 0.0999.
*
* @generated from protobuf field: optional double search_top_impression_share = 146;
*/
searchTopImpressionShare?: number;
/**
* A measure of how quickly your page loads after clicks on your mobile ads.
* The score is a range from 1 to 10, 10 being the fastest.
*
* @generated from protobuf field: optional int64 speed_score = 147;
*/
speedScore?: bigint;
/**
* The percent of your ad impressions that are shown anywhere above the
* organic search results.
*
* @generated from protobuf field: optional double top_impression_percentage = 148;
*/
topImpressionPercentage?: number;
/**
* The percentage of ad clicks to Accelerated Mobile Pages (AMP) landing pages
* that reach a valid AMP page.
*
* @generated from protobuf field: optional double valid_accelerated_mobile_pages_clicks_percentage = 149;
*/
validAcceleratedMobilePagesClicksPercentage?: number;
/**
* The value of all conversions divided by the number of all conversions.
*
* @generated from protobuf field: optional double value_per_all_conversions = 150;
*/
valuePerAllConversions?: number;
/**
* The value of all conversions divided by the number of all conversions. When
* this column is selected with date, the values in date column means the
* conversion date. Details for the by_conversion_date columns are available
* at https://support.google.com/google-ads/answer/9549009.
*
* @generated from protobuf field: optional double value_per_all_conversions_by_conversion_date = 244;
*/
valuePerAllConversionsByConversionDate?: number;
/**
* The value of conversions divided by the number of conversions. This only
* includes conversion actions which include_in_conversions_metric attribute
* is set to true. If you use conversion-based bidding, your bid strategies
* will optimize for these conversions.
*
* @generated from protobuf field: optional double value_per_conversion = 151;
*/
valuePerConversion?: number;
/**
* The value of conversions divided by the number of conversions. This only
* includes conversion actions which include_in_conversions_metric attribute
* is set to true. If you use conversion-based bidding, your bid strategies
* will optimize for these conversions. When this column is selected with
* date, the values in date column means the conversion date. Details for the
* by_conversion_date columns are available at
* https://support.google.com/google-ads/answer/9549009.
*
* @generated from protobuf field: optional double value_per_conversions_by_conversion_date = 245;
*/
valuePerConversionsByConversionDate?: number;
/**
* The value of current model attributed conversions divided by the number of
* the conversions. This only includes conversion actions which
* include_in_conversions_metric attribute is set to true. If you use
* conversion-based bidding, your bid strategies will optimize for these
* conversions.
*
* @generated from protobuf field: optional double value_per_current_model_attributed_conversion = 152;
*/
valuePerCurrentModelAttributedConversion?: number;
/**
* Percentage of impressions where the viewer watched all of your video.
*
* @generated from protobuf field: optional double video_quartile_p100_rate = 132;
*/
videoQuartileP100Rate?: number;
/**
* Percentage of impressions where the viewer watched 25% of your video.
*
* @generated from protobuf field: optional double video_quartile_p25_rate = 133;
*/
videoQuartileP25Rate?: number;
/**
* Percentage of impressions where the viewer watched 50% of your video.
*
* @generated from protobuf field: optional double video_quartile_p50_rate = 134;
*/
videoQuartileP50Rate?: number;
/**
* Percentage of impressions where the viewer watched 75% of your video.
*
* @generated from protobuf field: optional double video_quartile_p75_rate = 135;
*/
videoQuartileP75Rate?: number;
/**
* The number of views your TrueView video ad receives divided by its number
* of impressions, including thumbnail impressions for TrueView in-display
* ads.
*
* @generated from protobuf field: optional double video_view_rate = 153;
*/
videoViewRate?: number;
/**
* The number of times your video ads were viewed.
*
* @generated from protobuf field: optional int64 video_views = 154;
*/
videoViews?: bigint;
/**
* The total number of view-through conversions.
* These happen when a customer sees an image or rich media ad, then later
* completes a conversion on your site without interacting with (for example,
* clicking on) another ad.
*
* @generated from protobuf field: optional int64 view_through_conversions = 155;
*/
viewThroughConversions?: bigint;
/**
* The number of iOS Store Kit Ad Network conversions.
*
* @generated from protobuf field: int64 sk_ad_network_conversions = 246;
*/
skAdNetworkConversions: bigint;
}
declare class Metrics$Type extends MessageType<Metrics> {
constructor();
create(value?: PartialMessage<Metrics>): Metrics;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: Metrics): Metrics;
internalBinaryWrite(message: Metrics, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.common.Metrics
*/
export declare const Metrics: Metrics$Type;
export {};