Method: customers.generateKeywordIdeas

Renvoie une liste d'idées de mots clés.

Liste des erreurs générées: AuthenticationError AuthorizationError CollectionSizeError HeaderError InternalError KeywordPlanIdeaError QuotaError RequestError

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
customerId

string

ID du client associé à la recommandation.

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation 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.
}
Champs
geoTargetConstants[]

string

Noms des ressources de l'établissement à cibler. Le maximum est de 10. Une liste vide peut être utilisée pour spécifier toutes les zones géographiques de ciblage.

includeAdultKeywords

boolean

Si la valeur est "true", les mots clés réservés aux adultes sont inclus dans la réponse. La valeur par défaut est false.

pageToken

string

Jeton de la page à récupérer. Si cette valeur n'est pas spécifiée, la première page de résultats est renvoyée. Pour demander la page de résultats suivante, utilisez la valeur obtenue à partir de nextPageToken dans la réponse précédente. Les champs de requête doivent correspondre entre les pages.

pageSize

integer

Nombre de résultats à récupérer sur une seule page. Un maximum de 10 000 résultats peut être renvoyé. Si la valeur de "pageSize" est supérieure, elle est ignorée. Si aucune valeur n'est spécifiée, 10 000 résultats au maximum sont renvoyés. Le serveur peut décider de limiter davantage le nombre de ressources renvoyées. Si la réponse contient moins de 10 000 résultats,il n'est pas possible de considérer qu'il s'agit de la dernière page de résultats.

keywordPlanNetwork

enum (KeywordPlanNetwork)

Réseau de ciblage. Si ce paramètre n'est pas défini, le Réseau de Recherche et les sites partenaires de Google est utilisé.

keywordAnnotation[]

enum (KeywordPlanKeywordAnnotation)

Les annotations de mots clés à inclure dans la réponse.

aggregateMetrics

object (KeywordPlanAggregateMetrics)

Champs agrégés à inclure dans la réponse.

historicalMetricsOptions

object (HistoricalMetricsOptions)

Options pour les données historiques des métriques.

language

string

Nom de la ressource de la langue à cibler. Chaque mot clé appartient à un ensemble de langues. Un mot clé est inclus si la langue est l'une de celles de l'ensemble. Si ce paramètre n'est pas défini, tous les mots clés sont inclus.

Champ d'union seed. Type de graine à utiliser pour générer des idées de mots clés. seed ne peut être qu'un des éléments suivants :
keywordAndUrlSeed

object (KeywordAndUrlSeed)

Un mot clé et une URL spécifique à partir desquels générer des idées (par exemple, "voitures", www.example.com/voitures).

keywordSeed

object (KeywordSeed)

Mot clé ou expression à partir duquel générer des idées (par exemple, "voitures").

urlSeed

object (UrlSeed)

URL spécifique à partir de laquelle générer des idées (par exemple, www.example.com/cars)

siteSeed

object (SiteSeed)

Site à partir duquel vous générez des idées (par exemple, www.example.com).

Corps de la réponse

Message de réponse pour KeywordPlanIdeaService.GenerateKeywordIdeas.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON
{
  "results": [
    {
      object (GenerateKeywordIdeaResult)
    }
  ],
  "aggregateMetricResults": {
    object (KeywordPlanAggregateMetricResults)
  },
  "nextPageToken": string,
  "totalSize": string
}
Champs
results[]

object (GenerateKeywordIdeaResult)

Résultats de la génération d'idées de mots clés.

aggregateMetricResults

object (KeywordPlanAggregateMetricResults)

Métriques agrégées pour toutes les idées de mots clés.

nextPageToken

string

Jeton de pagination utilisé pour récupérer la page de résultats suivante. Transmettez le contenu de cette chaîne en tant qu'attribut pageToken de la requête suivante. nextPageToken n'est pas renvoyé pour la dernière page.

totalSize

string (int64 format)

Nombre total de résultats disponibles.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour en savoir plus, consultez OAuth 2.0 Overview.

KeywordPlanKeywordAnnotation

Énumère les annotations de plan de mots clés pouvant être demandées.

Enums
UNSPECIFIED Non spécifié.
UNKNOWN La valeur est inconnue dans cette version.
KEYWORD_CONCEPT Renvoie les données du concept de mot clé et du groupe de concepts.

KeywordAndUrlSeed

Mot clé et URL de base

Représentation JSON
{
  "keywords": [
    string
  ],
  "url": string
}
Champs
keywords[]

string

Vous devez indiquer au moins un mot clé et pas plus de 20 mots clés.

url

string

URL à explorer pour générer des idées de mots clés.

KeywordSeed

Mot clé de base

Représentation JSON
{
  "keywords": [
    string
  ]
}
Champs
keywords[]

string

Vous devez indiquer au moins un mot clé et pas plus de 20 mots clés.

UrlSeed

Graine d'URL

Représentation JSON
{
  "url": string
}
Champs
url

string

URL à explorer pour générer des idées de mots clés.

SiteSeed

Graine de site

Représentation JSON
{
  "site": string
}
Champs
site

string

Nom de domaine du site. Si le client qui demande des idées n'est pas le propriétaire du site fourni, seules les informations publiques sont renvoyées.

GenerateKeywordIdeaResult

Résultat de la génération d'idées de mots clés.

Représentation JSON
{
  "keywordIdeaMetrics": {
    object (KeywordPlanHistoricalMetrics)
  },
  "keywordAnnotations": {
    object (KeywordAnnotations)
  },
  "closeVariants": [
    string
  ],
  "text": string
}
Champs
keywordIdeaMetrics

object (KeywordPlanHistoricalMetrics)

Métriques historiques du mot clé.

keywordAnnotations

object (KeywordAnnotations)

Annotations du mot clé. Les données d'annotation ne sont fournies que si elles sont demandées.

closeVariants[]

string

Liste des variantes proches des mots clés demandés qui sont combinées dans GenerateKeywordIdeaResult. Pour en savoir plus sur les variantes proches, consultez https://support.google.com/google-ads/answer/9342105.

text

string

Texte de l'idée de mot clé. Comme dans les métriques historiques du plan de mots clés, ce texte peut ne pas être un mot clé réel, mais la forme canonique de plusieurs mots clés. Voir le message KeywordPlanKeywordHistoricalMetrics dans KeywordPlanService

KeywordAnnotations

Les annotations des mots clés du plan de mots clés.

Représentation JSON
{
  "concepts": [
    {
      object (KeywordConcept)
    }
  ]
}
Champs
concepts[]

object (KeywordConcept)

Liste des concepts du mot clé.

KeywordConcept

Concept du mot clé.

Représentation JSON
{
  "name": string,
  "conceptGroup": {
    object (ConceptGroup)
  }
}
Champs
name

string

Nom du concept du mot clé dans le conceptGroup.

conceptGroup

object (ConceptGroup)

Groupe de concepts des détails du concept.

ConceptGroup

Groupe de concepts du concept de mot clé.

Représentation JSON
{
  "name": string,
  "type": enum (KeywordPlanConceptGroupType)
}
Champs
name

string

Nom du groupe de concepts.

type

enum (KeywordPlanConceptGroupType)

Type de groupe de concepts.

KeywordPlanConceptGroupType

Énumère les types de groupes de concepts de plan de mots clés.

Enums
UNSPECIFIED La classification du groupe de concepts est différente de celle de la marque/non-marque. Il s'agit d'un bucket générique pour toutes les classifications qui ne correspondent à aucune des classifications ci-dessous.
UNKNOWN La valeur est inconnue dans cette version.
BRAND La classification des groupes de concepts est basée sur BRAND.
OTHER_BRANDS La classification des groupes de concepts basée sur la MARQUE, qui ne correspondait pas bien aux classifications de la MARQUE. Il s'agit généralement d'éléments aberrants qui peuvent comporter très peu de mots clés dans ce type de classification.
NON_BRAND La classification de ces groupes de concepts n'est pas basée sur la MARQUE. Cette valeur est renvoyée pour les mots clés génériques qui ne sont pas associés à une marque.