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/v16/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 gerar o histórico de métricas. Nem todas as entradas serão retornadas como resultado de uma eliminação de duplicação quase exata. Por exemplo, se as estatísticas para "carro" e "carros" forem solicitadas, somente "carro" será retornado. É possível usar até 10.000 palavras-chave.
includeAdultKeywords

boolean

Se verdadeiro, palavras-chave relacionadas a conteúdo adulto serão incluídas na resposta. O valor padrão é falso.
geoTargetConstants[]

string

Os nomes dos recursos do local a ser segmentado. O máximo é 10. Uma lista vazia PODE ser usada para especificar todas as áreas geográficas de segmentação.
keywordPlanNetwork

enum (KeywordPlanNetwork)

Rede segmentada. Se ela não for definida, a rede de parceiros e de pesquisa do Google será usada.
aggregateMetrics

object (KeywordPlanAggregateMetrics)

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

object (HistoricalMetricsOptions)

Opções dos dados históricos de métricas.
language

string

O nome do recurso do idioma a ser segmentado. Cada palavra-chave pertence a um conjunto de idiomas; uma palavra-chave é incluída se o idioma é um de seus idiomas. 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 o histórico de métricas delas.
aggregateMetricResults

object (KeywordPlanAggregateMetricResults)

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

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.

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

A lista de variantes aproximadas das palavras-chave solicitadas cujas estatísticas são combinadas neste GenerateKeywordHistoryMetricsResult.
keywordMetrics

object (KeywordPlanHistoricalMetrics)

Métricas históricas do texto e variantes aproximadas dele
text

string

O texto da consulta associado a uma ou mais palavras-chave. Eliminamos as duplicações da sua lista de palavras-chave, eliminando variantes aproximadas antes de retornar as palavras-chave como texto. Por exemplo, se sua solicitação originalmente continha as palavras-chave "carro" e "carros", a consulta de pesquisa retornada só conterá "carros". A lista de consultas duplicadas será incluída no campo closeVariants.