Method: customers.generateKeywordIdeas

Devuelve una lista de ideas para palabras clave.

Lista de errores arrojados: AuthenticationError AuthorizationError CollectionSizeError HeaderError InternalError KeywordPlanIdeaError QuotaError RequestError

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
customerId

string

El ID del cliente con la recomendación.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación 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

Los nombres de los recursos de la ubicación a la que se orientará El máximo es 10. PUEDE usar una lista vacía para especificar todas las ubicaciones geográficas para la segmentación.

includeAdultKeywords

boolean

Si es "true", se incluirán palabras clave para adultos en la respuesta. El valor predeterminado es falso.

pageToken

string

El token de la página que se recuperará. Si no se especifica, se mostrará la primera página de resultados. Para solicitar la página siguiente de resultados, usa el valor obtenido de nextPageToken en la respuesta anterior. Los campos de la solicitud deben coincidir en todas las páginas.

pageSize

integer

Cantidad de resultados que se recuperan en una sola página. Se pueden mostrar 10,000 resultados como máximo; si el pageSize excede este valor, se ignorará. Si no se especifica, se mostrarán 10,000 resultados como máximo. El servidor puede decidir limitar aún más la cantidad de recursos que se muestran. Si la respuesta contiene menos de 10,000 resultados, es posible que no se considere como la última página de resultados.

keywordPlanNetwork

enum (KeywordPlanNetwork)

Red de segmentación. Si no la estableces, se utilizará la Búsqueda de Google y la Red de socios.

keywordAnnotation[]

enum (KeywordPlanKeywordAnnotation)

Las anotaciones de palabras clave que se incluirán en la respuesta.

aggregateMetrics

object (KeywordPlanAggregateMetrics)

Los campos de agregación que se incluirán en la respuesta.

historicalMetricsOptions

object (HistoricalMetricsOptions)

Las opciones de los datos de métricas históricas.

language

string

El nombre del recurso del idioma de destino. Cada palabra clave pertenece a un conjunto de idiomas; una palabra clave se incluye si el idioma es uno de sus idiomas. Si no la estableces, se incluirán todas las palabras clave.

Campo de unión seed. El tipo de valor inicial para generar ideas para palabras clave. Las direcciones (seed) solo pueden ser una de las siguientes opciones:
keywordAndUrlSeed

object (KeywordAndUrlSeed)

Una palabra clave y una URL específica para generar ideas, por ejemplo, automóviles y www.example.com/autos.

keywordSeed

object (KeywordSeed)

Una palabra clave o frase para generar ideas, por ejemplo, automóviles.

urlSeed

object (UrlSeed)

Una URL específica a partir de la cual generar ideas, por ejemplo, www.example.com/automóviles.

siteSeed

object (SiteSeed)

Es el sitio a partir del cual se generarán ideas, por ejemplo, www.example.com.

Cuerpo de la respuesta

Mensaje de respuesta para KeywordPlanIdeaService.GenerateKeywordIdeas.

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Representación JSON
{
  "results": [
    {
      object (GenerateKeywordIdeaResult)
    }
  ],
  "aggregateMetricResults": {
    object (KeywordPlanAggregateMetricResults)
  },
  "nextPageToken": string,
  "totalSize": string
}
Campos
results[]

object (GenerateKeywordIdeaResult)

Resultados de la generación de ideas para palabras clave.

aggregateMetricResults

object (KeywordPlanAggregateMetricResults)

Las métricas totales de todas las ideas para palabras clave.

nextPageToken

string

Token de paginación que se usa para recuperar la siguiente página de resultados. Pasa el contenido de esta cadena como el atributo pageToken de la siguiente solicitud. No se muestra nextPageToken para la última página.

totalSize

string (int64 format)

Cantidad total de resultados disponibles.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la Descripción general de OAuth 2.0.

KeywordPlanKeywordAnnotation

Enumera las anotaciones del plan de palabras clave que se pueden solicitar.

Enumeradores
UNSPECIFIED No se especifica.
UNKNOWN El valor es desconocido en esta versión.
KEYWORD_CONCEPT Muestra los datos del grupo de conceptos y el concepto de palabras clave.

KeywordAndUrlSeed

Origen de la URL y la palabra clave

Representación JSON
{
  "keywords": [
    string
  ],
  "url": string
}
Campos
keywords[]

string

Se requiere al menos una palabra clave.

url

string

La URL que se rastreará para generar ideas para palabras clave.

KeywordSeed

Palabra clave inicial

Representación JSON
{
  "keywords": [
    string
  ]
}
Campos
keywords[]

string

Se requiere al menos una palabra clave.

UrlSeed

Origen de la URL

Representación JSON
{
  "url": string
}
Campos
url

string

La URL que se rastreará para generar ideas para palabras clave.

SiteSeed

Origen del sitio

Representación JSON
{
  "site": string
}
Campos
site

string

Es el nombre de dominio del sitio. Si el cliente que solicita las ideas no es propietario del sitio proporcionado, solo se devolverá la información pública.

GenerateKeywordIdeaResult

Es el resultado de generar ideas para palabras clave.

Representación JSON
{
  "keywordIdeaMetrics": {
    object (KeywordPlanHistoricalMetrics)
  },
  "keywordAnnotations": {
    object (KeywordAnnotations)
  },
  "closeVariants": [
    string
  ],
  "text": string
}
Campos
keywordIdeaMetrics

object (KeywordPlanHistoricalMetrics)

Las métricas históricas de la palabra clave.

keywordAnnotations

object (KeywordAnnotations)

Las anotaciones de la palabra clave. Los datos de anotación solo se proporcionan si se solicitan.

closeVariants[]

string

Es la lista de variantes cercanas de las palabras clave solicitadas que se combinan en GenerateKeywordIdeaResult. Para ver la definición de "variantes cercanas", consulta https://support.google.com/google-ads/answer/9342105.

text

string

Texto de la idea para palabras clave Al igual que en las métricas históricas del plan de palabras clave, es posible que este texto no sea una palabra clave real, sino el formato canónica de varias palabras clave. Consultar el mensaje KeywordPlanKeywordHistoricalMetrics en KeywordPlanService

KeywordAnnotations

Las anotaciones de las palabras clave del plan de palabras clave.

Representación JSON
{
  "concepts": [
    {
      object (KeywordConcept)
    }
  ]
}
Campos
concepts[]

object (KeywordConcept)

La lista de conceptos para la palabra clave.

KeywordConcept

El concepto de la palabra clave.

Representación JSON
{
  "name": string,
  "conceptGroup": {
    object (ConceptGroup)
  }
}
Campos
name

string

El nombre del concepto de la palabra clave en conceptGroup.

conceptGroup

object (ConceptGroup)

El grupo de conceptos que contiene los detalles del concepto.

ConceptGroup

El grupo de conceptos para el concepto de palabra clave.

Representación JSON
{
  "name": string,
  "type": enum (KeywordPlanConceptGroupType)
}
Campos
name

string

El nombre del grupo de conceptos.

type

enum (KeywordPlanConceptGroupType)

El tipo de grupo de conceptos.

KeywordPlanConceptGroupType

Enumera los tipos de grupos de conceptos de planes de palabras clave.

Enumeradores
UNSPECIFIED La clasificación del grupo de conceptos es diferente de “marca” o “sin marca”. Este es un bucket de todos los tipos para todas las clasificaciones que no son de las siguientes opciones.
UNKNOWN El valor es desconocido en esta versión.
BRAND La clasificación del grupo de conceptos se basa en BRAND.
OTHER_BRANDS Es la clasificación de grupos de conceptos basada en MARCA, que no encajaba bien con las clasificaciones de MARCA. Por lo general, estos son valores atípicos y pueden tener muy pocas palabras clave en este tipo de clasificación.
NON_BRAND Esta clasificación de grupos de conceptos no se basa en BRAND. Se devuelve para las palabras clave genéricas que no tienen una asociación de marca.