Method: customers.recommendations.generate

Gera recomendações com base nos recommendationTypes solicitados.

Lista de erros gerados: AuthenticationError AuthorizationError HeaderError InternalError QuotaError RecommendationError RequestError

Solicitação HTTP

POST https://googleads.googleapis.com/v16/customers/{customerId}/recommendations:generate

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
customerId

string

Obrigatório. O ID do cliente que está gerando recomendações.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{
  "recommendationTypes": [
    enum (RecommendationType)
  ],
  "advertisingChannelType": enum (AdvertisingChannelType),
  "adGroupInfo": [
    {
      object (AdGroupInfo)
    }
  ],
  "campaignSitelinkCount": integer,
  "conversionTrackingStatus": enum (ConversionTrackingStatus),
  "biddingInfo": {
    object (BiddingInfo)
  },
  "seedInfo": {
    object (SeedInfo)
  }
}
Campos
recommendationTypes[]

enum (RecommendationType)

Obrigatório. Lista de recommendationTypes qualificados para gerar. Se os critérios enviados não forem suficientes para fazer uma recomendação ou se a campanha já estiver no estado recomendado, nenhuma recomendação será retornada para esse tipo. Geralmente, uma recomendação é retornada se todos os campos obrigatórios para recommendationType forem enviados, mas há casos em que isso ainda não é suficiente.

Os seguintes recommendationTypes são compatíveis com a geração de recomendações: KEYWORD, MAXIMIZE_CLICKS_OPT_IN, MAXIMIZE_CONVERSIONS_OPT_IN, MAXIMIZE_CONVERSION_VALUE_OPT_IN, SET_TARGET_CPA, SET_TARGET_ROAS, SITELINK_ASSET, TARGET_CPA_OPT_IN, TARGET_ROAS_OPT_IN
advertisingChannelType

enum (AdvertisingChannelType)

Obrigatório. Tipo de canal de publicidade da campanha. Os seguintes tipos de advertisingChannelType são compatíveis com a geração de recomendações: PERFORMANCE_MAX e SEARCH
adGroupInfo[]

object (AdGroupInfo)

Opcional. Informações atuais do grupo de anúncios. Suporta informações de um único grupo de anúncios. Este campo é opcional para os seguintes recommendationTypes: KEYWORD
conversionTrackingStatus

enum (ConversionTrackingStatus)

Opcional. Status atual do acompanhamento de conversões. Esse campo é necessário para os seguintes recommendationTypes: MAXIMIZE_CLICKS_OPT_IN, MAXIMIZE_CONVERSIONS_OPT_IN, MAXIMIZE_CONVERSION_VALUE_OPT_IN, SET_TARGET_CPA, SET_TARGET_ROAS, TARGET_CPA_OPT_IN, TARGET_ROAS_OPT_IN
biddingInfo

object (BiddingInfo)

Opcional. Informações de lance atuais da campanha. Este campo é necessário para os seguintes recommendationTypes: MAXIMIZE_CLICKS_OPT_IN, MAXIMIZE_CONVERSIONS_OPT_IN, MAXIMIZE_CONVERSION_VALUE_OPT_IN, SET_TARGET_CPA, SET_TARGET_ROAS, TARGET_CPA_OPT_IN, TARGET_ROAS_OPT_IN
seedInfo

object (SeedInfo)

Opcional. Informações de sugestão para palavras-chave. Este campo é necessário para os seguintes recommendationTypes: KEYWORD

Corpo da resposta

Mensagem de resposta para RecommendationService.GenerateRecommendations.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "recommendations": [
    {
      object (Recommendation)
    }
  ]
}
Campos
recommendations[]

object (Recommendation)

Lista de recomendações geradas do conjunto de recommendationTypes solicitado. Se não houver dados suficientes para gerar uma recomendação para os recommendationTypes solicitados, o conjunto de resultados não vai conter uma recomendação para esse tipo.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte a Visão geral do OAuth 2.0.

BiddingInfo

Informações atuais sobre os lances da campanha. Fornece um wrapper para indicadores relacionados a lances que informam recomendações.

Representação JSON 
{
  "biddingStrategyType": enum (BiddingStrategyType),

  // Union field bidding_strategy_target_info can be only one of the following:
  "targetCpaMicros": string,
  "targetRoas": number
  // End of list of possible types for union field bidding_strategy_target_info.
}
Campos
biddingStrategyType

enum (BiddingStrategyType)

Estratégia de lances atual. Esse campo é necessário para os seguintes recommendationTypes: MAXIMIZE_CLICKS_OPT_IN, MAXIMIZE_CONVERSIONS_OPT_IN, MAXIMIZE_CONVERSION_VALUE_OPT_IN, SET_TARGET_CPA, SET_TARGET_ROAS, TARGET_CPA_OPT_IN, TARGET_ROAS_OPT_IN
Campo de união bidding_strategy_target_info. Detalhes opcionais relacionados ao bidding_strategy_type. bidding_strategy_target_info pode ser apenas de um dos tipos a seguir:
targetCpaMicros

string (int64 format)

Valor atual da meta de CPA em micros. Isso pode ser preenchido para campanhas com um tipo de estratégia de lances de TARGET_CPA ou MAXIMIZE_CONVERSIONS.
targetRoas

number

ROAS desejado atual. Isso pode ser preenchido para campanhas com um tipo de estratégia de lances de TARGET_ROAS ou MAXIMIZE_CONVERSION_VALUE.

AdGroupInfo

Informações atuais do grupo de anúncios da campanha.

Representação JSON 
{
  "keywords": [
    {
      object (KeywordInfo)
    }
  ],
  "adGroupType": enum (AdGroupType)
}
Campos
keywords[]

object (KeywordInfo)

Opcional. Palavras-chave atuais. Esse campo é opcional para os seguintes recommendationTypes se adGroupInfo estiver definido: KEYWORD
adGroupType

enum (AdGroupType)

Opcional. Tipo de grupo de anúncios do AdGroup. Esse campo é necessário para os seguintes recommendationTypes se adGroupInfo estiver definido: KEYWORD

SeedInfo

Uma palavra-chave inicial e um URL específico para gerar palavras-chave.

Representação JSON 
{
  "keywordSeeds": [
    string
  ],
  "urlSeed": string
}
Campos
keywordSeeds[]

string

Opcional. Palavras-chave ou frases para gerar ideias, por exemplo: carros ou "concessionária de carros perto de mim".
urlSeed

string

Um URL específico para gerar ideias, por exemplo: www.example.com/cars.