Method: customers.generateKeywordHistoricalMetrics

Retorna uma lista de métricas históricas de palavras-chave.

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

Solicitação HTTP

POST https://googleads.googleapis.com/v18/customers/{customerId}:generateKeywordHistoricalMetrics

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

Parâmetros de caminho

Parâmetros
customerId

string

O ID do cliente com a recomendação.

Corpo da solicitação

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

Representação JSON 
{
  "keywords": [
    string
  ],
  "includeAdultKeywords": boolean,
  "geoTargetConstants": [
    string
  ],
  "keywordPlanNetwork": enum (KeywordPlanNetwork),
  "aggregateMetrics": {
    object (KeywordPlanAggregateMetrics)
  },
  "historicalMetricsOptions": {
    object (HistoricalMetricsOptions)
  },
  "language": string
}
Campos
keywords[]

string

Uma lista de palavras-chave para receber métricas históricas. Nem todas as entradas serão retornadas como resultado da eliminação de duplicação quase exata. Por exemplo, se as estatísticas de "car" e "cars" forem solicitadas, apenas "car" será retornado. É possível usar até 10.000 palavras-chave.
includeAdultKeywords

boolean

Se verdadeiro, as palavras-chave para adultos serão incluídas na resposta. O valor padrão é falso.
geoTargetConstants[]

string

Os nomes dos recursos do local de destino. O máximo é 10. Uma lista vazia PODE ser usada para especificar todas as regiões de segmentação.
keywordPlanNetwork

enum (KeywordPlanNetwork)

Rede de segmentação. Se não for definido, a rede de parceiros e pesquisa do Google será usada.
aggregateMetrics

object (KeywordPlanAggregateMetrics)

Os campos agregados a serem incluídos na resposta.
historicalMetricsOptions

object (HistoricalMetricsOptions)

As opções para dados de métricas históricas.
language

string

O nome do recurso do idioma de destino. Cada palavra-chave pertence a um conjunto de idiomas. Uma palavra-chave é incluída se o idioma for um deles. Se não for definido, todas as palavras-chave serão incluídas.

Corpo da resposta

Mensagem de resposta para KeywordPlanIdeaService.GenerateKeywordHistoricalMetrics.

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

Representação JSON 
{
  "results": [
    {
      object (GenerateKeywordHistoricalMetricsResult)
    }
  ],
  "aggregateMetricResults": {
    object (KeywordPlanAggregateMetricResults)
  }
}
Campos
results[]

object (GenerateKeywordHistoricalMetricsResult)

Lista de palavras-chave e métricas históricas.
aggregateMetricResults

object (KeywordPlanAggregateMetricResults)

As métricas agregadas de todas as palavras-chave.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte OAuth 2.0 Overview.

GenerateKeywordHistoricalMetricsResult

O resultado da geração de métricas históricas de palavras-chave.

Representação JSON 
{
  "closeVariants": [
    string
  ],
  "keywordMetrics": {
    object (KeywordPlanHistoricalMetrics)
  },
  "text": string
}
Campos
closeVariants[]

string

Lista de variantes aproximadas das palavras-chave solicitadas, cujas estatísticas são combinadas no resultado "GenerateKeywordHistoricalMetricsResult".
keywordMetrics

object (KeywordPlanHistoricalMetrics)

As métricas históricas do texto e das variantes próximas
text

string

O texto da consulta associada a uma ou mais palavras-chave. Removemos as duplicatas da sua lista de palavras-chave, eliminando as variantes aproximadas antes de retornar as palavras-chave como texto. Por exemplo, se a solicitação original continha as palavras-chave "carro" e "carros", a consulta de pesquisa retornada vai conter apenas "carros". A lista de consultas sem duplicações será incluída no campo closeVariants.