--- v19/services/reach_plan_service.proto 2025-04-14 05:29:57.000000000 +0000 +++ v19-1/services/reach_plan_service.proto 2025-04-14 05:30:02.000000000 +0000 @@ -47,6 +48,25 @@ option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; + // Returns a collection of conversion rate suggestions for supported plannable + // products. + // + // List of thrown errors: + // [AuthenticationError]() + // [AuthorizationError]() + // [HeaderError]() + // [InternalError]() + // [QuotaError]() + // [RequestError]() + rpc GenerateConversionRates(GenerateConversionRatesRequest) + returns (GenerateConversionRatesResponse) { + option (google.api.http) = { + post: "/v19:generateConversionRates" + body: "*" + }; + option (google.api.method_signature) = "customer_id"; + } + // Returns the list of plannable locations (for example, countries). // // List of thrown errors: @@ -107,6 +127,42 @@ } // Request message for +// [ReachPlanService.GenerateConversionRates][google.ads.googleads.v19.services.ReachPlanService.GenerateConversionRates]. +message GenerateConversionRatesRequest { + // Required. The ID of the customer. A conversion rate based on the historical + // data of this customer may be suggested. + string customer_id = 1 [(google.api.field_behavior) = REQUIRED]; + + // The name of the customer being planned for. This is a user-defined value. + optional string customer_reach_group = 2; +} + +// Response message for +// [ReachPlanService.GenerateConversionRates][google.ads.googleads.v19.services.ReachPlanService.GenerateConversionRates], +// containing conversion rate suggestions for supported plannable products. +message GenerateConversionRatesResponse { + // A list containing conversion rate suggestions. Each repeated element will + // have an associated product code. Multiple suggestions may share the same + // product code. + repeated ConversionRateSuggestion conversion_rate_suggestions = 1; +} + +// A conversion rate suggestion. +message ConversionRateSuggestion { + // Model type used to calculate the suggested conversion rate. + google.ads.googleads.v19.enums.ReachPlanConversionRateModelEnum + .ReachPlanConversionRateModel conversion_rate_model = 1; + + // The code associated with the plannable product (for example: DEMAND_GEN). + // To list all plannable product codes, use + // [ReachPlanService.ListPlannableProducts][google.ads.googleads.v19.services.ReachPlanService.ListPlannableProducts]. + string plannable_product_code = 2; + + // The suggested conversion rate. The value is between 0 and 1 (exclusive). + double conversion_rate = 3; +} + +// Request message for // [ReachPlanService.ListPlannableLocations][google.ads.googleads.v19.services.ReachPlanService.ListPlannableLocations]. message ListPlannableLocationsRequest {} @@ -372,6 +428,13 @@ // For example: 1 000 000$ = 1 000 000 000 000 micros. optional int64 budget_micros = 4 [(google.api.field_behavior) = REQUIRED]; + // Conversion rate as a decimal between 0 and 1, exclusive. + // For example: if 2% of ad interactions are expected to lead to conversions, + // conversion_rate should be 0.02. + // This field is required for DEMAND_GEN plannable products. It is not + // supported for other plannable products. + optional double conversion_rate = 6; + // Targeting settings for the selected product. // To list the available targeting for each product use // [ReachPlanService.ListPlannableProducts][google.ads.googleads.v19.services.ReachPlanService.ListPlannableProducts]. @@ -472,6 +535,13 @@ // See https://support.google.com/google-ads/answer/2375431 for // more information on views. optional int64 views = 15; + + // The number of conversions. + // This metric is only available for DEMAND_GEN plannable products. + // + // See https://support.google.com/google-ads/answer/2375431 for + // more information on conversions. + optional double conversions = 16; } // The forecasted allocation and traffic metrics for a specific product @@ -554,6 +624,13 @@ // See https://support.google.com/google-ads/answer/2375431 for // more information on views. optional int64 views = 11; + + // The number of conversions. + // This metric is only available for DEMAND_GEN plannable products. + // + // See https://support.google.com/google-ads/answer/2375431 for + // more information on conversions. + optional double conversions = 12; } // Audience metrics for the planned products.
/services/reach_plan_service.proto
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-04-14 UTC.