Method: customers.generateKeywordIdeas

Retorna uma lista de ideias de palavras-chave.

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

Solicitação HTTP

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

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 
{
  "geoTargetConstants": [
    string
  ],
  "includeAdultKeywords": boolean,
  "pageToken": string,
  "pageSize": integer,
  "keywordPlanNetwork": enum (KeywordPlanNetwork),
  "keywordAnnotation": [
    enum (KeywordPlanKeywordAnnotation)
  ],
  "aggregateMetrics": {
    object (KeywordPlanAggregateMetrics)
  },
  "historicalMetricsOptions": {
    object (HistoricalMetricsOptions)
  },
  "language": string,

  // Union field seed can be only one of the following:
  "keywordAndUrlSeed": {
    object (KeywordAndUrlSeed)
  },
  "keywordSeed": {
    object (KeywordSeed)
  },
  "urlSeed": {
    object (UrlSeed)
  },
  "siteSeed": {
    object (SiteSeed)
  }
  // End of list of possible types for union field seed.
}
Campos
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.
includeAdultKeywords

boolean

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

string

Token da página a ser recuperada. Se não for especificado, a primeira página de resultados será retornada. Para solicitar a próxima página de resultados, use o valor recebido de nextPageToken na resposta anterior. Os campos de solicitação precisam ser iguais em todas as páginas.
pageSize

integer

Número de resultados a serem recuperados em uma única página. Um máximo de 10.000 resultados pode ser retornado. Se o pageSize exceder esse valor, ele será ignorado. Se não for especificado, no máximo 10.000 resultados serão retornados. O servidor pode decidir limitar ainda mais o número de recursos retornados. Se a resposta tiver menos de 10.000 resultados,ela não será considerada a última página de resultados.
keywordPlanNetwork

enum (KeywordPlanNetwork)

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

enum (KeywordPlanKeywordAnnotation)

As anotações de palavras-chave a serem incluídas na resposta.
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.
Campo de união seed. O tipo de semente para gerar ideias de palavras-chave. seed pode ser apenas de um dos tipos a seguir:
keywordAndUrlSeed

object (KeywordAndUrlSeed)

Uma palavra-chave e um URL específico para gerar ideias, por exemplo, carros, www.example.com/cars.
keywordSeed

object (KeywordSeed)

Uma palavra-chave ou frase para gerar ideias, por exemplo, carros.
urlSeed

object (UrlSeed)

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

object (SiteSeed)

O site para gerar ideias, por exemplo, www.example.com.

Corpo da resposta

Mensagem de resposta para KeywordPlanIdeaService.GenerateKeywordIdeas.

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

Representação JSON 
{
  "results": [
    {
      object (GenerateKeywordIdeaResult)
    }
  ],
  "aggregateMetricResults": {
    object (KeywordPlanAggregateMetricResults)
  },
  "nextPageToken": string,
  "totalSize": string
}
Campos
results[]

object (GenerateKeywordIdeaResult)

Resultados da geração de ideias de palavras-chave.
aggregateMetricResults

object (KeywordPlanAggregateMetricResults)

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

string

Token de paginação usado para recuperar a próxima página de resultados. Transmita o conteúdo dessa string como o atributo pageToken da próxima solicitação. nextPageToken não é retornado para a última página.
totalSize

string (int64 format)

Número total de resultados disponíveis.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

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

KeywordPlanKeywordAnnotation

Enumera as anotações do plano de palavras-chave que podem ser solicitadas.

Enums
UNSPECIFIED Não especificado.
UNKNOWN O valor é desconhecido nessa versão.
KEYWORD_CONCEPT Retorna o conceito de palavra-chave e os dados do grupo de conceitos.

KeywordAndUrlSeed

Semente de palavras-chave e URL

Representação JSON 
{
  "keywords": [
    string
  ],
  "url": string
}
Campos
keywords[]

string

É necessário incluir pelo menos uma e no máximo 20 palavras-chave.
url

string

O URL a ser rastreado para gerar ideias de palavras-chave.

KeywordSeed

Semente de palavras-chave

Representação JSON 
{
  "keywords": [
    string
  ]
}
Campos
keywords[]

string

É necessário incluir pelo menos uma e no máximo 20 palavras-chave.

UrlSeed

Semente de URL

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

string

O URL a ser rastreado para gerar ideias de palavras-chave.

SiteSeed

Site Seed

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

string

O nome de domínio do site. Se o cliente que solicitar as ideias não for proprietário do site fornecido, apenas informações públicas serão retornadas.

GenerateKeywordIdeaResult

O resultado da geração de ideias de palavras-chave.

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

object (KeywordPlanHistoricalMetrics)

As métricas históricas da palavra-chave.
keywordAnnotations

object (KeywordAnnotations)

As anotações da palavra-chave. Os dados de anotação só são fornecidos se solicitados.
closeVariants[]

string

A lista de variantes aproximadas das palavras-chave solicitadas que são combinadas neste GenerateKeywordIdeaResult. Consulte https://support.google.com/google-ads/answer/9342105 para ver a definição de "variantes próximas".
text

string

Texto da ideia de palavra-chave. Assim como nas métricas históricas do Planejador de palavras-chave, esse texto pode não ser uma palavra-chave real, mas a forma canônica de várias palavras-chave. Consulte a mensagem "KeywordPlanKeywordHistoricalMetrics" no KeywordPlanService.

KeywordAnnotations

As anotações das palavras-chave do plano de palavras-chave.

Representação JSON 
{
  "concepts": [
    {
      object (KeywordConcept)
    }
  ]
}
Campos
concepts[]

object (KeywordConcept)

A lista de conceitos da palavra-chave.

KeywordConcept

O conceito da palavra-chave.

Representação JSON 
{
  "name": string,
  "conceptGroup": {
    object (ConceptGroup)
  }
}
Campos
name

string

O nome do conceito da palavra-chave no conceptGroup.
conceptGroup

object (ConceptGroup)

O grupo de conceito dos detalhes do conceito.

ConceptGroup

O grupo de conceito da palavra-chave.

Representação JSON 
{
  "name": string,
  "type": enum (KeywordPlanConceptGroupType)
}
Campos
name

string

O nome do grupo de conceitos.
type

enum (KeywordPlanConceptGroupType)

O tipo de grupo de conceito.

KeywordPlanConceptGroupType

Enumera os tipos de grupo de conceito do plano de palavras-chave.

Enums
UNSPECIFIED A classificação do grupo de conceito é diferente de marca/não marca. Este é um bucket para todas as classificações que não se enquadram nas opções abaixo.
UNKNOWN O valor é desconhecido nessa versão.
BRAND A classificação do grupo de conceito é baseada na MARCA.
OTHER_BRANDS A classificação do grupo de conceitos com base em MARCA, que não se encaixava bem nas classificações de MARCA. Geralmente, esses são valores fora da curva e podem ter poucas palavras-chave nesse tipo de classificação.
NON_BRAND A classificação do grupo de conceito não é baseada na MARCA. Isso é retornado para palavras-chave genéricas que não têm uma associação de marca.