Modifier des objets

Objectif : Découvrez comment modifier des objets à l'aide de l'API Google Ads.

Comme indiqué dans le guide sur la structure de l'API, chaque ressource de premier niveau de l'API Google Ads dispose d'un service spécifique au type de ressource correspondant, qui permet de modifier les instances de la ressource.

Ce guide utilise CampaignService pour montrer comment modifier les objets Campaign, mais les mêmes concepts s'appliquent à tous les autres services spécifiques aux types de ressources.

Terme clé : une ressource de premier niveau est une ressource dont le nom n'inclut pas de point (.). Par exemple, Campaign est une ressource de premier niveau, mais Campaign.NetworkSettings ne l'est pas.

Modifier des objets

Chaque service spécifique à un type de ressource disposera d'une méthode mutate qui accepte une requête de mutation. Cette demande se compose des éléments suivants :

• customerId
• Ensemble d'opérations
• Paramètre de type de contenu de la réponse qui détermine si la ressource modifiable ou uniquement le nom de la ressource doivent être renvoyés après la modification.

Par exemple, la méthode MutateCampaigns de CampaignService accepte un MutateCampaignsRequest qui se compose des éléments suivants :

• customerId
• Collection d'objets CampaignOperation
• Champ response_content_type indiquant le type de réponse préféré.

Opérations

Un objet d'opération tel qu'un CampaignOperation vous permet de spécifier l'action que vous souhaitez effectuer sur une seule ressource en définissant son champ operation. Ce champ est un champ "oneof" composé des attributs suivants dont le type est le type de ressource :

create

Crée une instance de la ressource.

update

Met à jour la ressource pour qu'elle corresponde aux attributs de la ressource update. Lorsque ce champ est défini, vous devez également définir le update_mask de l'opération, qui indique à l'API Google Ads les attributs à modifier lors de l'opération de mise à jour. Chaque bibliothèque cliente dispose d'une méthode utilitaire ou d'assistance qui génère le update_mask pour vous, comme indiqué dans nos bibliothèques clientes.

remove

Supprime la ressource.

Étant donné que le champ operation est un champ oneof, vous ne pouvez pas utiliser une seule opération pour modifier plusieurs objets. Par exemple, si vous souhaitez créer une campagne et en supprimer une autre, ajoutez deux instances de CampaignOperation à votre requête : une avec create défini et une autre avec remove défini.

Opérations par lot

Bien qu'une seule opération ne puisse créer, mettre à jour ou supprimer qu'une seule ressource, une seule requête de mutation peut contenir plusieurs opérations. Vous devez combiner vos opérations en une seule requête mutate au lieu d'envoyer plusieurs requêtes mutate contenant chacune une seule opération.

Par exemple, si vous souhaitez créer dix campagnes, vous devez envoyer un MutateCampaignsRequest unique contenant dix objets CampaignOperation.

Modifier les réponses

Le contenu de la réponse dépend de ce qui a été envoyé dans le response_content_type de la requête mutate. Par exemple, si MUTABLE_RESOURCE a été spécifié, la réponse ne contiendra que les champs modifiables de la campagne. Vous pouvez ensuite effectuer des mutations de suivi sur cet objet de ressource sans avoir à le reconstruire.

Erreurs de mutation

Les opérations d'une requête de mutation donnée ne seront appliquées à votre compte Google Ads que si chaque opération de la requête réussit. Consultez le guide des erreurs courantes pour obtenir la liste des erreurs courantes et savoir comment les résoudre.