Method: customers.generateKeywordForecastMetrics

Retorna métricas (como impressões, cliques, custo total) de uma previsão de palavra-chave para uma determinada campanha.

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

Solicitação HTTP

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

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

Parâmetros de caminho

Parâmetros
customerId

string

O ID do cliente.

Corpo da solicitação

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

Representação JSON 
{
  "forecastPeriod": {
    object (DateRange)
  },
  "campaign": {
    object (CampaignToForecast)
  },
  "currencyCode": string
}
Campos
forecastPeriod

object (DateRange)

Período da previsão. A data de início precisa estar no futuro, e a data de término precisa estar dentro de um ano a partir de hoje. O fuso horário de referência usado é o da conta do Google Ads que pertence ao cliente. Se não for definido, será usado um período padrão do próximo domingo ao sábado seguinte.
campaign

object (CampaignToForecast)

Obrigatório. A campanha usada na previsão.
currencyCode

string

A moeda usada para a conversão de taxa de câmbio. Por padrão, a moeda da conta do cliente é usada. Defina este campo somente se a moeda for diferente da moeda da conta. Consulte a lista de códigos de moeda válidos em https://developers.google.com/google-ads/api/data/codes-formats#currency-codes.

Corpo da resposta

Mensagem de resposta para [KeywordPlanIdeaService.GenerateKeyword pipelineMetrics].

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

Representação JSON 
{
  "campaignForecastMetrics": {
    object (KeywordForecastMetrics)
  }
}
Campos
campaignForecastMetrics

object (KeywordForecastMetrics)

Resultados da previsão da campanha.

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.

CampaignToForecast

Uma campanha para fazer uma previsão de campanha por palavra-chave.

Representação JSON 
{
  "languageConstants": [
    string
  ],
  "geoModifiers": [
    {
      object (CriterionBidModifier)
    }
  ],
  "keywordPlanNetwork": enum (KeywordPlanNetwork),
  "negativeKeywords": [
    {
      object (KeywordInfo)
    }
  ],
  "biddingStrategy": {
    object (CampaignBiddingStrategy)
  },
  "adGroups": [
    {
      object (ForecastAdGroup)
    }
  ],
  "conversionRate": number
}
Campos
languageConstants[]

string

A lista de nomes de recursos dos idiomas a serem segmentados. O nome do recurso tem o formato "languageConstants/{criterionId}". Consulte https://developers.google.com/google-ads/api/data/codes-formats#languages para ver a lista de códigos de critério de idioma.
geoModifiers[]

object (CriterionBidModifier)

Locais a serem segmentados. Os locais precisam ser exclusivos.
keywordPlanNetwork

enum (KeywordPlanNetwork)

Obrigatório. A rede usada para segmentação.
negativeKeywords[]

object (KeywordInfo)

A lista de palavras-chave negativas que serão usadas na campanha durante a previsão.
biddingStrategy

object (CampaignBiddingStrategy)

Obrigatório. Estratégia de lances da campanha.
adGroups[]

object (ForecastAdGroup)

Os grupos de anúncios na nova campanha a ser prevista.
conversionRate

number

A taxa de conversão esperada (número de conversões dividido pelo número de cliques totais), conforme definido pelo usuário. Esse valor é expresso como um valor decimal.Assim, uma taxa de conversão esperada de 2% deve ser inserida como 0,02. Se deixado em branco, uma taxa de conversão estimada será usada.

CriterionBidModifier

Modificador de lance do critério de local.

Representação JSON 
{
  "geoTargetConstant": string,
  "bidModifier": number
}
Campos
geoTargetConstant

string

O nome do recurso da localização geográfica a ser segmentada. O nome do recurso tem o formato "geoTargetConstants/{criterionId}".
bidModifier

number

O multiplicador associado para o criterionId. Se definido, esse valor não pode ser 0.

CampaignBiddingStrategy

Estratégias de lances compatíveis com as previsões de novas campanhas.

Representação JSON 
{

  // Union field bidding_strategy can be only one of the following:
  "manualCpcBiddingStrategy": {
    object (ManualCpcBiddingStrategy)
  },
  "maximizeClicksBiddingStrategy": {
    object (MaximizeClicksBiddingStrategy)
  },
  "maximizeConversionsBiddingStrategy": {
    object (MaximizeConversionsBiddingStrategy)
  }
  // End of list of possible types for union field bidding_strategy.
}
Campos
Campo de união bidding_strategy. Estratégias de lances: bidding_strategy pode ser apenas de um dos tipos a seguir:
manualCpcBiddingStrategy

object (ManualCpcBiddingStrategy)

Use a estratégia de lances manuais de CPC para fazer previsões.
maximizeClicksBiddingStrategy

object (MaximizeClicksBiddingStrategy)

Use a estratégia de lances "Maximizar cliques" para fazer estimativas.
maximizeConversionsBiddingStrategy

object (MaximizeConversionsBiddingStrategy)

Usar a estratégia de lances "Maximizar conversões" para fazer estimativas.

ManualCpcBiddingStrategy

Estratégia de lances manuais de CPC.

Representação JSON 
{
  "maxCpcBidMicros": string,
  "dailyBudgetMicros": string
}
Campos
maxCpcBidMicros

string (int64 format)

Obrigatório. Um lance em micros a ser aplicado aos grupos de anúncios da campanha para uma estratégia de lances manuais de CPC.
dailyBudgetMicros

string (int64 format)

Orçamento no nível da campanha em micros. Se definido, um valor mínimo será aplicado à moeda local usada na campanha. Se o campo for definido muito baixo, ocorrerá um erro mostrando o valor mínimo.

MaximizeClicksBiddingStrategy

a estratégia de lances "Maximizar cliques".

Representação JSON 
{
  "dailyTargetSpendMicros": string,
  "maxCpcBidCeilingMicros": string
}
Campos
dailyTargetSpendMicros

string (int64 format)

Obrigatório. É o gasto desejado diário em micros a ser usado na estimativa. Um valor mínimo é aplicado à moeda local usada na campanha. Se o campo for definido muito baixo, ocorrerá um erro mostrando o valor mínimo.
maxCpcBidCeilingMicros

string (int64 format)

Lances máximos de CPC máximo, em micros.

MaximizeConversionsBiddingStrategy

estratégia de lances "Maximizar conversões".

Representação JSON 
{
  "dailyTargetSpendMicros": string
}
Campos
dailyTargetSpendMicros

string (int64 format)

Obrigatório. É o gasto desejado diário em micros a ser usado na estimativa. Esse valor deve ser maior do que zero.

ForecastAdGroup

Um grupo de anúncios que faz parte de uma campanha a ser prevista.

Representação JSON 
{
  "biddableKeywords": [
    {
      object (BiddableKeyword)
    }
  ],
  "negativeKeywords": [
    {
      object (KeywordInfo)
    }
  ],
  "maxCpcBidMicros": string
}
Campos
biddableKeywords[]

object (BiddableKeyword)

Obrigatório. A lista de palavras-chave que recebem lances a serem usadas no grupo de anúncios durante a previsão. Requer pelo menos uma palavra-chave.
negativeKeywords[]

object (KeywordInfo)

Os detalhes da palavra-chave. Você deve especificar o texto da palavra-chave e o tipo de correspondência.
maxCpcBidMicros

string (int64 format)

O CPC máximo a ser usado no grupo de anúncios ao gerar o tráfego previsto. Esse valor substituirá o CPC máx. definido na estratégia de lances. Somente especifique este campo para estratégias de lances que valores máximos de CPC.

BiddableKeyword

Uma parte de palavra-chave que recebe lances de um grupo de anúncios.

Representação JSON 
{
  "keyword": {
    object (KeywordInfo)
  },
  "maxCpcBidMicros": string
}
Campos
keyword

object (KeywordInfo)

Obrigatório. Palavra-chave. Precisa ter texto e tipo de correspondência.
maxCpcBidMicros

string (int64 format)

Um lance de CPC máx. em micros que substitui o lance de CPC máx. no nível do grupo de anúncios na simulação da previsão. Esse valor substituirá o CPC máx. definido na estratégia de lances e no grupo de anúncios. Especifique este campo somente para estratégias de lances compatíveis com valores máximos de CPC.

KeywordForecastMetrics

Métricas de estimativa para a campanha de palavras-chave sem plano.

Representação JSON 
{
  "impressions": number,
  "clickThroughRate": number,
  "averageCpcMicros": string,
  "clicks": number,
  "costMicros": string,
  "conversions": number,
  "conversionRate": number,
  "averageCpaMicros": string
}
Campos
impressions

number

O número total de impressões.
clickThroughRate

number

A taxa média de cliques. Disponível somente se as impressões forem maiores que zero.
averageCpcMicros

string (int64 format)

O CPC médio. Disponível somente se os cliques forem maiores que zero.
clicks

number

O número total de cliques.
costMicros

string (int64 format)

Custo total.
conversions

number

Número estimado de conversões: cliques * conversionRate.
conversionRate

number

Taxa de conversão estimada.
averageCpaMicros

string (int64 format)

Custo médio por aquisição calculado como costMicros / conversões.