Method: generateConversionRates

Returns a collection of conversion rate suggestions for supported plannable products.

List of thrown errors: AuthenticationError AuthorizationError HeaderError InternalError QuotaError RequestError

HTTP request

POST https://googleads.googleapis.com/v19:generateConversionRates

The URL uses gRPC Transcoding syntax.

Request body

The request body contains data with the following structure:

JSON representation
{
  "customerId": string,
  "customerReachGroup": string
}
Fields
customerId

string

Required. The ID of the customer. A conversion rate based on the historical data of this customer may be suggested.

customerReachGroup

string

The name of the customer being planned for. This is a user-defined value.

Response body

Response message for ReachPlanService.GenerateConversionRates, containing conversion rate suggestions for supported plannable products.

If successful, the response body contains data with the following structure:

JSON representation
{
  "conversionRateSuggestions": [
    {
      object (ConversionRateSuggestion)
    }
  ]
}
Fields
conversionRateSuggestions[]

object (ConversionRateSuggestion)

A list containing conversion rate suggestions. Each repeated element will have an associated product code. Multiple suggestions may share the same product code.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

ConversionRateSuggestion

A conversion rate suggestion.

JSON representation
{
  "conversionRateModel": enum (ReachPlanConversionRateModel),
  "plannableProductCode": string,
  "conversionRate": number
}
Fields
conversionRateModel

enum (ReachPlanConversionRateModel)

Model type used to calculate the suggested conversion rate.

plannableProductCode

string

The code associated with the plannable product (for example: DEMAND_GEN). To list all plannable product codes, use ReachPlanService.ListPlannableProducts.

conversionRate

number

The suggested conversion rate. The value is between 0 and 1 (exclusive).

ReachPlanConversionRateModel

Types of models used to create conversion rate suggestions.

Enums
UNSPECIFIED Not specified.
UNKNOWN The value is unknown in this version.
CUSTOMER_HISTORY Suggested conversion rate for the authenticated customer based on the previous 70 days.
INVENTORY_AGGRESSIVE Suggested conversion rate based on an aggressive rate for the entire inventory.
INVENTORY_CONSERVATIVE Suggested conversion rate based on a conservative rate for the entire inventory.
INVENTORY_MEDIAN Suggested conversion rate based on the median rate for the entire inventory.