Method: customers.generateKeywordForecastMetrics

Renvoie les métriques (impressions, clics, coût total, etc.) d'une prévision de mot clé pour la campagne donnée.

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

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
customerId

string

ID du client.

Corps de la requête

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

Représentation JSON 
{
  "forecastPeriod": {
    object (DateRange)
  },
  "campaign": {
    object (CampaignToForecast)
  },
  "currencyCode": string
}
Champs
forecastPeriod

object (DateRange)

Plage de dates de la prévision. La date de début doit être postérieure à la date du jour et la date de fin doit se situer dans l'année à venir. Le fuseau horaire de référence utilisé correspond à celui du compte Google Ads appartenant au client. Si cette règle n'est pas configurée, une période par défaut allant du dimanche prochain au samedi suivant sera utilisée.
campaign

object (CampaignToForecast)

Obligatoire. Campagne utilisée dans la prévision.
currencyCode

string

Devise utilisée pour la conversion du taux de change. Par défaut, la devise du compte du client est utilisée. Ne définissez ce champ que si la devise est différente de celle du compte. La liste des codes de devise valides est disponible à l'adresse https://developers.google.com/google-ads/api/data/codes-formats#currency-codes.

Corps de la réponse

Message de réponse pour [KeywordPlanIdeaService.GenerateKeywordForecastMetrics].

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

Représentation JSON 
{
  "campaignForecastMetrics": {
    object (KeywordForecastMetrics)
  }
}
Champs
campaignForecastMetrics

object (KeywordForecastMetrics)

Résultats de la prévision de la campagne.

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.

CampaignToForecast

Une campagne pour effectuer une prévision de mots clés.

Représentation JSON 
{
  "languageConstants": [
    string
  ],
  "geoModifiers": [
    {
      object (CriterionBidModifier)
    }
  ],
  "keywordPlanNetwork": enum (KeywordPlanNetwork),
  "negativeKeywords": [
    {
      object (KeywordInfo)
    }
  ],
  "biddingStrategy": {
    object (CampaignBiddingStrategy)
  },
  "adGroups": [
    {
      object (ForecastAdGroup)
    }
  ],
  "conversionRate": number
}
Champs
languageConstants[]

string

Liste des noms de ressources des langues à cibler. Le nom de la ressource est au format "languageConstants/{criterionId}". Consultez https://developers.google.com/google-ads/api/data/codes-formats#languages pour obtenir la liste des codes des critères de langue.
geoModifiers[]

object (CriterionBidModifier)

Zones géographiques à cibler. Les établissements doivent être uniques.
keywordPlanNetwork

enum (KeywordPlanNetwork)

Obligatoire. Réseau utilisé pour le ciblage.
negativeKeywords[]

object (KeywordInfo)

Liste des mots clés à exclure à utiliser dans la campagne lors de la prévision.
biddingStrategy

object (CampaignBiddingStrategy)

Obligatoire. Stratégie d'enchères de la campagne.
adGroups[]

object (ForecastAdGroup)

Groupes d'annonces de la nouvelle campagne à prévoir.
conversionRate

number

Le taux de conversion attendu (nombre de conversions divisé par le nombre total de clics) tel que défini par l'utilisateur. Cette valeur étant exprimée sous forme de valeur décimale, vous devez saisir un taux de conversion attendu de 2 %, sous la forme 0,02. Si vous ne renseignez pas ce champ, un taux de conversion estimé sera utilisé.

CriterionBidModifier

Modificateur d'enchères du critère géographique.

Représentation JSON 
{
  "geoTargetConstant": string,
  "bidModifier": number
}
Champs
geoTargetConstant

string

Nom de ressource de la zone géographique à cibler. Le nom de la ressource est au format "geoTargetConstants/{criterionId}".
bidModifier

number

Multiplicateur associé au paramètre "criteriaId". Si cette valeur est définie, elle ne peut pas être égale à 0.

CampaignBiddingStrategy

Stratégies d'enchères compatibles avec les nouvelles prévisions de campagne

Représentation JSON 
{

  // Union field bidding_strategy can be only one of the following:
  "manualCpcBiddingStrategy": {
    object (ManualCpcBiddingStrategy)
  },
  "maximizeClicksBiddingStrategy": {
    object (MaximizeClicksBiddingStrategy)
  },
  "maximizeConversionsBiddingStrategy": {
    object (MaximizeConversionsBiddingStrategy)
  }
  // End of list of possible types for union field bidding_strategy.
}
Champs
Champ d'union bidding_strategy. Stratégies d'enchères bidding_strategy ne peut être qu'un des éléments suivants :
manualCpcBiddingStrategy

object (ManualCpcBiddingStrategy)

Utilisez la stratégie d'enchères au CPC manuelles pour effectuer des prévisions.
maximizeClicksBiddingStrategy

object (MaximizeClicksBiddingStrategy)

Utilisez la stratégie d'enchères "Maximiser les clics" pour effectuer des prévisions.
maximizeConversionsBiddingStrategy

object (MaximizeConversionsBiddingStrategy)

Utilisez la stratégie d'enchères "Maximiser les conversions" pour effectuer des prévisions.

ManualCpcBiddingStrategy

Stratégie d'enchères au CPC manuelles.

Représentation JSON 
{
  "maxCpcBidMicros": string,
  "dailyBudgetMicros": string
}
Champs
maxCpcBidMicros

string (int64 format)

Obligatoire. Enchère en micros à appliquer aux groupes d'annonces de la campagne pour une stratégie d'enchères au CPC manuelles.
dailyBudgetMicros

string (int64 format)

Budget au niveau de la campagne en micros. Si cette valeur est définie, une valeur minimale est appliquée dans la devise locale utilisée dans la campagne. Si la valeur de ce champ est trop basse, une erreur s'affiche.

MaximizeClicksBiddingStrategy

"Maximiser les clics".

Représentation JSON 
{
  "dailyTargetSpendMicros": string,
  "maxCpcBidCeilingMicros": string
}
Champs
dailyTargetSpendMicros

string (int64 format)

Obligatoire. Objectif de dépenses quotidiennes (en microsecondes) à utiliser pour l'estimation. Une valeur minimale est appliquée pour la devise locale utilisée dans la campagne. Si la valeur de ce champ est trop basse, une erreur s'affiche.
maxCpcBidCeilingMicros

string (int64 format)

Plafond des enchères au CPC max. (en micros).

MaximizeConversionsBiddingStrategy

la stratégie d'enchères "Maximiser les conversions".

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

string (int64 format)

Obligatoire. Objectif de dépenses quotidiennes (en microsecondes) à utiliser pour l'estimation. Cette valeur doit être supérieure à zéro.

ForecastAdGroup

Groupe d'annonces faisant partie d'une campagne pour laquelle effectuer des prévisions.

Représentation JSON 
{
  "biddableKeywords": [
    {
      object (BiddableKeyword)
    }
  ],
  "negativeKeywords": [
    {
      object (KeywordInfo)
    }
  ],
  "maxCpcBidMicros": string
}
Champs
biddableKeywords[]

object (BiddableKeyword)

Obligatoire. Liste des mots clés enchérissables à utiliser dans le groupe d'annonces lors de la prévision. Nécessite au moins un mot clé.
negativeKeywords[]

object (KeywordInfo)

Détails du mot clé. Vous devez spécifier le texte du mot clé et le type de correspondance.
maxCpcBidMicros

string (int64 format)

CPC max. à utiliser pour le groupe d'annonces lors de la génération de trafic prévu. Cette valeur remplacera la valeur du CPC max. définie dans la stratégie d'enchères. Ne spécifiez ce champ que pour les stratégies d'enchères qui maximisent les valeurs au CPC.

BiddableKeyword

Partie de mot clé d'un groupe d'annonces pour laquelle une enchère peut être définie.

Représentation JSON 
{
  "keyword": {
    object (KeywordInfo)
  },
  "maxCpcBidMicros": string
}
Champs
keyword

object (KeywordInfo)

Obligatoire. Mot clé. Vous devez indiquer du texte et un type de correspondance.
maxCpcBidMicros

string (int64 format)

Enchère au CPC max. (en micros) qui remplace l'enchère au CPC max. au niveau du groupe d'annonces dans la simulation de prévisions. Cette valeur remplacera la valeur du CPC max. définie dans la stratégie d'enchères et le groupe d'annonces. Ne spécifiez ce champ que pour les stratégies d'enchères qui acceptent les valeurs de CPC max.

KeywordForecastMetrics

Métriques de prévision pour la campagne de mots clés sans plan.

Représentation JSON 
{
  "impressions": number,
  "clickThroughRate": number,
  "averageCpcMicros": string,
  "clicks": number,
  "costMicros": string,
  "conversions": number,
  "conversionRate": number,
  "averageCpaMicros": string
}
Champs
impressions

number

Nombre total d'impressions.
clickThroughRate

number

Taux de clics moyen. Disponible uniquement si le nombre d'impressions est supérieur à 0.
averageCpcMicros

string (int64 format)

CPC moyen Disponible uniquement si le nombre de clics est supérieur à 0.
clicks

number

Nombre total de clics.
costMicros

string (int64 format)

Coût total.
conversions

number

Nombre de conversions prévu: clics * taux de conversion.
conversionRate

number

Taux de conversion prévu.
averageCpaMicros

string (int64 format)

Coût par acquisition moyen, calculé comme suit : costMicros / conversions.