Method: customers.recommendations.apply

Applique les recommandations données avec les paramètres apply correspondants.

Liste des erreurs générées: AuthenticationError AuthorizationError DatabaseError FieldError HeaderError InternalError MutateError QuotaError RecommendationError RequestError UrlFieldError

Requête HTTP

POST https://googleads.googleapis.com/v14/customers/{customerId}/recommendations:apply

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
customerId

string

Obligatoire. 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 
{
  "operations": [
    {
      object (ApplyRecommendationOperation)
    }
  ],
  "partialFailure": boolean
}
Champs
operations[]

object (ApplyRecommendationOperation)

Obligatoire. Liste des opérations auxquelles appliquer les recommandations. Si partialFailure=false, toutes les recommandations doivent être du même type. La limite est de 100 opérations par requête.
partialFailure

boolean

Si la valeur est "true", les opérations réussies sont effectuées et les opérations non valides renvoient des erreurs. Si la valeur est "false", les opérations seront effectuées en tant que transaction si et seulement si elles sont toutes valides. La valeur par défaut est "false".

Corps de la réponse

Message de réponse pour RecommendationService.ApplyRecommendation.

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 (ApplyRecommendationResult)
    }
  ],
  "partialFailureError": {
    object (Status)
  }
}
Champs
results[]

object (ApplyRecommendationResult)

Résultats des opérations pour appliquer les recommandations.
partialFailureError

object (Status)

Erreurs liées à des échecs d'opération en mode échec partiel. Est renvoyé uniquement lorsque partialFailure = true et que toutes les erreurs se produisent à l'intérieur des opérations. Si des erreurs se produisent en dehors des opérations (erreurs d'authentification, par exemple), nous renvoyons l'erreur au niveau du RPC.

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.

ApplyRecommendationOperation

Informations sur l'opération permettant d'appliquer une recommandation et sur les paramètres permettant de la personnaliser.

Représentation JSON 
{
  "resourceName": string,

  // Union field apply_parameters can be only one of the following:
  "campaignBudget": {
    object (CampaignBudgetParameters)
  },
  "textAd": {
    object (TextAdParameters)
  },
  "keyword": {
    object (KeywordParameters)
  },
  "targetCpaOptIn": {
    object (TargetCpaOptInParameters)
  },
  "targetRoasOptIn": {
    object (TargetRoasOptInParameters)
  },
  "calloutExtension": {
    object (CalloutExtensionParameters)
  },
  "callExtension": {
    object (CallExtensionParameters)
  },
  "sitelinkExtension": {
    object (SitelinkExtensionParameters)
  },
  "moveUnusedBudget": {
    object (MoveUnusedBudgetParameters)
  },
  "responsiveSearchAd": {
    object (ResponsiveSearchAdParameters)
  },
  "useBroadMatchKeyword": {
    object (UseBroadMatchKeywordParameters)
  },
  "responsiveSearchAdAsset": {
    object (ResponsiveSearchAdAssetParameters)
  },
  "responsiveSearchAdImproveAdStrength": {
    object (ResponsiveSearchAdImproveAdStrengthParameters)
  },
  "raiseTargetCpaBidTooLow": {
    object (RaiseTargetCpaBidTooLowParameters)
  },
  "forecastingSetTargetRoas": {
    object (ForecastingSetTargetRoasParameters)
  },
  "calloutAsset": {
    object (CalloutAssetParameters)
  },
  "callAsset": {
    object (CallAssetParameters)
  },
  "sitelinkAsset": {
    object (SitelinkAssetParameters)
  },
  "raiseTargetCpa": {
    object (RaiseTargetCpaParameters)
  },
  "lowerTargetRoas": {
    object (LowerTargetRoasParameters)
  }
  // End of list of possible types for union field apply_parameters.
}
Champs
resourceName

string

Nom de ressource de la recommandation à appliquer.
Champ d'union apply_parameters. Paramètres à utiliser lors de l'application de la recommandation. apply_parameters ne peut être qu'un des éléments suivants :
campaignBudget

object (CampaignBudgetParameters)

Paramètres facultatifs à utiliser lorsque vous appliquez une recommandation de budget de campagne.
textAd

object (TextAdParameters)

Paramètres facultatifs à utiliser lors de l'application d'une recommandation d'annonce textuelle.
keyword

object (KeywordParameters)

Paramètres facultatifs à utiliser lors de l'application de la recommandation de mot clé.
targetCpaOptIn

object (TargetCpaOptInParameters)

Paramètres facultatifs à utiliser lors de l'application de la recommandation d'activation du CPA cible.
targetRoasOptIn

object (TargetRoasOptInParameters)

Paramètres facultatifs à utiliser lors de l'application de la recommandation d'activation du ROAS cible.
calloutExtension

object (CalloutExtensionParameters)

Paramètres à utiliser lors de l'application d'une recommandation d'extension d'accroche.
callExtension

object (CallExtensionParameters)

Paramètres à utiliser lors de l'application d'une recommandation d'extension d'appel.
moveUnusedBudget

object (MoveUnusedBudgetParameters)

Paramètres à utiliser lors de l'application de la recommandation de déplacement de budget inutilisé.
responsiveSearchAd

object (ResponsiveSearchAdParameters)

Paramètres à utiliser lorsque vous appliquez une recommandation concernant une annonce responsive sur le Réseau de Recherche.
useBroadMatchKeyword

object (UseBroadMatchKeywordParameters)

Paramètres à utiliser lors de l'application d'une recommandation d'utilisation de mot clé en requête large.
responsiveSearchAdAsset

object (ResponsiveSearchAdAssetParameters)

Paramètres à utiliser lors de l'application d'une recommandation de composant d'annonce responsive sur le Réseau de Recherche.
responsiveSearchAdImproveAdStrength

object (ResponsiveSearchAdImproveAdStrengthParameters)

Les paramètres à utiliser lorsque vous appliquez une annonce responsive sur le Réseau de Recherche améliorent la recommandation concernant l'efficacité de l'annonce.
raiseTargetCpaBidTooLow

object (RaiseTargetCpaBidTooLowParameters)

Paramètres à utiliser lors de l'application d'une recommandation d'augmentation de l'enchère au CPA cible trop faible. L'application est asynchrone et peut prendre quelques minutes selon le nombre de groupes d'annonces dans la campagne associée.
forecastingSetTargetRoas

object (ForecastingSetTargetRoasParameters)

Paramètres à utiliser lorsque vous appliquez une recommandation de ROAS cible pour les prévisions.
calloutAsset

object (CalloutAssetParameters)

Paramètres à utiliser lors de l'application d'une recommandation de composant Accroche.
callAsset

object (CallAssetParameters)

Paramètres à utiliser lors de l'application d'une recommandation de composant Appel.
raiseTargetCpa

object (RaiseTargetCpaParameters)

Paramètres à utiliser lorsque vous appliquez la recommandation "Augmenter le CPA cible".
lowerTargetRoas

object (LowerTargetRoasParameters)

Paramètres à utiliser lorsque vous appliquez une recommandation de ROAS cible moins élevé.

CampaignBudgetParameters

Paramètres à utiliser lorsque vous appliquez une recommandation de budget de campagne.

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

string (int64 format)

Nouveau montant à définir pour la ressource de budget cible. Champ obligatoire.

TextAdParameters

Paramètres à utiliser lors de l'application d'une recommandation d'annonce textuelle.

Représentation JSON 
{
  "ad": {
    object (Ad)
  }
}
Champs
ad

object (Ad)

Nouvelle annonce à ajouter au groupe d'annonces recommandé. Tous les champs nécessaires doivent être définis dans ce message. Champ obligatoire.

KeywordParameters

Paramètres à utiliser lors de l'application d'une recommandation de mot clé.

Représentation JSON 
{
  "matchType": enum (KeywordMatchType),
  "adGroup": string,
  "cpcBidMicros": string
}
Champs
matchType

enum (KeywordMatchType)

Type de correspondance du mot clé. Champ obligatoire.
adGroup

string

Ressource du groupe d'annonces à laquelle ajouter le mot clé. Champ obligatoire.
cpcBidMicros

string (int64 format)

(Facultatif) Enchère au CPC à définir pour le mot clé. Si cette règle n'est pas configurée, le mot clé utilisera l'enchère en fonction de la stratégie d'enchères utilisée par le groupe d'annonces cible.

TargetCpaOptInParameters

Paramètres à utiliser lors de l'application de la recommandation "CPA cible".

Représentation JSON 
{
  "targetCpaMicros": string,
  "newCampaignBudgetAmountMicros": string
}
Champs
targetCpaMicros

string (int64 format)

CPA moyen à utiliser pour la stratégie d'enchères au CPA cible. Champ obligatoire.
newCampaignBudgetAmountMicros

string (int64 format)

Facultatif : montant du budget à définir pour la campagne.

TargetRoasOptInParameters

Paramètres à utiliser lorsque vous appliquez une recommandation d'activation du ROAS cible.

Représentation JSON 
{
  "targetRoas": number,
  "newCampaignBudgetAmountMicros": string
}
Champs
targetRoas

number

ROAS moyen (revenu par unité de dépense) à utiliser pour la stratégie d'enchères au ROAS cible. La valeur est comprise entre 0,01 et 1 000,0 inclus. Ce champ est obligatoire, sauf si newCampaignBudgetAmountMicros est défini.
newCampaignBudgetAmountMicros

string (int64 format)

Facultatif : montant du budget à définir pour la campagne.

CalloutExtensionParameters

Paramètres à utiliser lors de l'application d'une recommandation d'extension d'accroche.

Représentation JSON 
{
  "calloutExtensions": [
    {
      object (CalloutFeedItem)
    }
  ]
}
Champs
calloutExtensions[]

object (CalloutFeedItem)

Extensions d'accroche à ajouter. Champ obligatoire.

CallExtensionParameters

Paramètres à utiliser lors de l'application d'une recommandation d'extension d'appel.

Représentation JSON 
{
  "callExtensions": [
    {
      object (CallFeedItem)
    }
  ]
}
Champs
callExtensions[]

object (CallFeedItem)

Extensions d'appel à ajouter. Champ obligatoire.

SitelinkExtensionParameters

Paramètres à utiliser lors de l'application d'une recommandation de lien annexe.

Représentation JSON 
{
  "sitelinkExtensions": [
    {
      object (SitelinkFeedItem)
    }
  ]
}
Champs

MoveUnusedBudgetParameters

Paramètres à utiliser lors de l'application de la recommandation de déplacement de budget inutilisé.

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

string (int64 format)

Montant du budget permettant de passer d'un budget excédentaire à un budget limité. Champ obligatoire.

ResponsiveSearchAdParameters

Paramètres à utiliser lorsque vous appliquez une recommandation concernant une annonce responsive sur le Réseau de Recherche.

Représentation JSON 
{
  "ad": {
    object (Ad)
  }
}
Champs
ad

object (Ad)

Obligatoire. Nouvelle annonce à ajouter au groupe d'annonces recommandé.

UseBroadMatchKeywordParameters

Paramètres à utiliser lors de l'application d'une recommandation d'utilisation de mot clé en requête large.

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

string (int64 format)

Nouveau montant à définir pour la ressource de budget cible.

ResponsiveSearchAdAssetParameters

Paramètres à utiliser lors de l'application d'une recommandation de composant d'annonce responsive sur le Réseau de Recherche.

Représentation JSON 
{
  "updatedAd": {
    object (Ad)
  }
}
Champs
updatedAd

object (Ad)

Annonce mise à jour. Le contenu de l'annonce actuelle sera remplacé.

ResponsiveSearchAdImproveAdStrengthParameters

Les paramètres à utiliser lorsque vous appliquez une annonce responsive sur le Réseau de Recherche améliorent la recommandation concernant l'efficacité de l'annonce.

Représentation JSON 
{
  "updatedAd": {
    object (Ad)
  }
}
Champs
updatedAd

object (Ad)

Annonce mise à jour. Le contenu de l'annonce actuelle sera remplacé.

RaiseTargetCpaBidTooLowParameters

Paramètres à utiliser lors de l'application d'une recommandation d'augmentation de l'enchère au CPA cible trop faible. L'application est asynchrone et peut prendre quelques minutes selon le nombre de groupes d'annonces dans la campagne associée.

Représentation JSON 
{
  "targetMultiplier": number
}
Champs
targetMultiplier

number

Obligatoire. Nombre supérieur à 1,0 indiquant le facteur d'augmentation du CPA cible. Champ obligatoire.

ForecastingSetTargetRoasParameters

Paramètres à utiliser lors de l'application d'une recommandation de ROAS cible pour la prévision.

Représentation JSON 
{
  "targetRoas": number,
  "campaignBudgetAmountMicros": string
}
Champs
targetRoas

number

Nouveau ROAS cible (revenu par unité de dépense) à définir pour une ressource de campagne. La valeur est comprise entre 0,01 et 1 000,0 inclus.
campaignBudgetAmountMicros

string (int64 format)

Nouveau montant de budget de campagne à définir pour une ressource de campagne.

CalloutAssetParameters

Paramètres à utiliser lors de l'application des recommandations de composants Accroche.

Représentation JSON 
{
  "adAssetApplyParameters": {
    object (AdAssetApplyParameters)
  }
}
Champs
adAssetApplyParameters

object (AdAssetApplyParameters)

Obligatoire. Composants Accroche à ajouter. Champ obligatoire.

AdAssetApplyParameters

Paramètres courants utilisés lors de l'application des recommandations sur les composants d'annonce.

Représentation JSON 
{
  "newAssets": [
    {
      object (Asset)
    }
  ],
  "existingAssets": [
    string
  ],
  "scope": enum (ApplyScope)
}
Champs
newAssets[]

object (Asset)

Assets à créer et à associer à un champ d'application. Vous pouvez l'associer à existingAssets dans le même appel.
existingAssets[]

string

Noms de ressources des éléments existants à associer à un champ d'application. Vous pouvez l'associer à newAssets dans le même appel.
scope

enum (ApplyScope)

Obligatoire. Champ d'application auquel appliquer les éléments. Les composants au niveau de la campagne seront appliqués à la campagne associée à la recommandation. Les composants au niveau du client s'appliquent à l'ensemble du compte. Les composants au niveau de la campagne remplacent ceux associés au niveau du client.

ApplyScope

Portée à laquelle appliquer les éléments.

Enums
UNSPECIFIED Le champ d'application "apply" n'a pas été spécifié.
UNKNOWN Inconnu.
CUSTOMER Appliquer au niveau du client.
CAMPAIGN Appliquer au niveau de la campagne

CallAssetParameters

Paramètres à utiliser lors de l'application des recommandations sur les composants Appel.

Représentation JSON 
{
  "adAssetApplyParameters": {
    object (AdAssetApplyParameters)
  }
}
Champs
adAssetApplyParameters

object (AdAssetApplyParameters)

Obligatoire. Composants Appel à ajouter. Champ obligatoire.

SitelinkAssetParameters

Paramètres à utiliser lors de l'application des recommandations de composants Lien annexe.

Représentation JSON 
{
  "adAssetApplyParameters": {
    object (AdAssetApplyParameters)
  }
}
Champs
adAssetApplyParameters

object (AdAssetApplyParameters)

Obligatoire. Composants Lien annexe à ajouter. Champ obligatoire.

RaiseTargetCpaParameters

Paramètres à utiliser lorsque vous appliquez des recommandations d'augmentation du CPA cible.

Représentation JSON 
{
  "targetCpaMultiplier": number
}
Champs
targetCpaMultiplier

number

Obligatoire. Cible sur laquelle définir le multiplicateur de CPA. Champ obligatoire.

LowerTargetRoasParameters

Paramètres à utiliser lorsque vous appliquez des recommandations pour un ROAS cible plus faible.

Représentation JSON 
{
  "targetRoasMultiplier": number
}
Champs
targetRoasMultiplier

number

Obligatoire. Cible sur laquelle définir le multiplicateur de ROAS. Champ obligatoire.

ApplyRecommendationResult

Résultat de l'application d'une recommandation.

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

string

Retourné pour les candidatures validées.