Method: customers.generateKeywordIdeas

Affiche 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/v16/customers/{customerId}:generateKeywordIdeas

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
customerId

string

Identifiant 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 de ressources de la zone géographique à cibler. La valeur maximale est 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 seront inclus dans la réponse. La valeur par défaut est "false".
pageToken

string

Jeton de la page à récupérer. Si aucune valeur n'est spécifiée, la première page de résultats est affiché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 la demande doivent être identiques sur toutes 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 taille de la page dépasse cette limite, elle est ignorée. Si aucune valeur n'est spécifiée, 10 000 résultats au maximum seront 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,elle ne peut pas être considérée comme la dernière page de résultats.
keywordPlanNetwork

enum (KeywordPlanNetwork)

Ciblage du réseau. Si cette règle n'est pas configurée, nous utilisons le Réseau de Recherche de Google et le réseau des partenaires.
keywordAnnotation[]

enum (KeywordPlanKeywordAnnotation)

Annotations de mot clé à 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 de métriques historiques.
language

string

Nom de ressource de la langue à cibler. Chaque mot clé est associé à un ensemble de langues. Un mot clé est inclus si la langue fait partie des langues qui lui sont associées. Si cette règle n'est pas configurée, tous les mots clés sont inclus.
Champ d'union seed. Type de valeur source 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 pour générer des idées à partir, par exemple, de voitures ou de www.example.com/voitures.
keywordSeed

object (KeywordSeed)

Mot clé ou expression permettant de générer des idées à partir, par exemple, de voitures.
urlSeed

object (UrlSeed)

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

object (SiteSeed)

Site à partir duquel vous souhaitez générer 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)

Statistiques cumulé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 la présentation d'OAuth 2.0.

KeywordPlanKeywordAnnotation

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

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

KeywordAndUrlSeed

Source de mot clé et d'URL

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

string

Nécessite au moins un mot clé.
url

string

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

KeywordSeed

Source de mot clé

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

string

Nécessite au moins un mot clé.

UrlSeed

Source d'URL

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

string

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

SiteSeed

Source de données de site

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

string

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

GenerateKeywordIdeaResult

Résultat obtenu en générant des idées de mots clés

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

object (KeywordPlanHistoricalMetrics)

Historique des statistiques du mot clé.
keywordAnnotations

object (KeywordAnnotations)

Annotations pour le mot clé Les données d'annotation ne sont fournies que sur demande.
closeVariants[]

string

Liste de variantes proches des mots clés demandés combinées dans ce GenerateKeywordIdeaResult. Pour connaître la définition des "variantes proches", consultez la page 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 KeywordPlanKeywordHistoryMetrics dans KeywordPlanService.

KeywordAnnotations

Annotations pour les mots clés du plan de mots clés.

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

object (KeywordConcept)

Liste des concepts associés au mot clé.

KeywordConcept

Le concept associé au mot clé.

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

string

Nom du concept pour le mot clé dans le conceptGroup.
conceptGroup

object (ConceptGroup)

Groupe de concepts dans les détails du concept.

ConceptGroup

Groupe de concepts pour le 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 du plan de mots clés.

Enums
UNSPECIFIED La classification du groupe de concepts est différente de celle par marque. Il s'agit d'un bucket collecteur pour toutes les classifications qui n'appartiennent à aucune des catégories ci-dessous.
UNKNOWN La valeur est inconnue dans cette version.
BRAND La classification du groupe de concepts est basée sur BRAND.
OTHER_BRANDS Classification du groupe de concepts basé sur BRAND, qui ne correspondait pas bien à la classification BRAND. Il s'agit généralement de valeurs aberrantes et pouvant être associées à 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 BRAND. Cet état est renvoyé pour les mots clés génériques qui ne sont associés à aucune marque.