Guide d'utilisation

Cette page explique comment effectuer des tâches courantes à l'aide de l'API.

Création d'utilisateurs

Le service UserService permet à un utilisateur disposant de droits d'administrateur de créer un utilisateur directement sur son réseau. Tout développeur peut le faire sans que le nouvel utilisateur ne s'inscrive au préalable. Par exemple, si vous testez l'API pour la première fois, au lieu d'effectuer tous les appels d'API en tant qu'administrateur (paramètre par défaut de votre adresse e-mail), vous pouvez créer quelques utilisateurs avec des rôles tels que Commercial, Trafficker ou Annonceur, afin de tester des flux de travail concrets.

  1. Créez des adresses Gmail telles que my.name.dfp.salesperson@gmail.com. Vous pouvez également enregistrer une adresse autre que Gmail en tant que nouveau compte Google.
  2. Appelez createUsers avec cette nouvelle adresse et le Role choisi.
  3. Vous pouvez vous authentifier en tant que nouvel utilisateur et générer le jeton d'accès à l'aide du protocole OAuth 2.0.

Obtenir le bloc d'annonces racine

Le AdUnit supérieur auquel vous pouvez ajouter des nœuds enfants, ainsi que la profondeur autorisée de votre hiérarchie dépendent de votre type de compte (Small Business ou Premium). La AdUnit racine qui prend en charge la modification de ses nœuds enfants est appelée AdUnit racine effective.

Pour récupérer la racine effective, appelez NetworkService.getCurrentNetwork() et examinez le champ effectiveRootAdUnitId de l'objet Network renvoyé.

Remarque:Les modèles de hiérarchie diffèrent selon le type de compte.

Interroger un objet

Pour rechercher des objets en fonction de critères de recherche, vous devez utiliser la méthode getObjectsByStatement() fournie par de nombreux services, où Objet correspond à un type d'objet spécifique. Cette méthode utilise une requête PQL, semblable à une requête SQL en ce sens qu'elle vous permet de spécifier les champs à rechercher (où les noms de champ sont mappés à des propriétés sur l'objet), de trier, de limiter et de décaler les résultats de votre recherche. Consultez le guide PQL pour en savoir plus sur PQL et pour découvrir les champs d'objet pouvant être filtrés.

Créer une commande

Pour créer une campagne, il vous suffit de créer un objet Order, de définir les ID d'annonceur, de commercial et de trafficker sur les utilisateurs appropriés, de leur attribuer un nom unique, puis d'appeler createOrders(). Le résultat inclura le Order nouvellement créé ou une erreur.

Exemple

Consultez l'exemple de code Java pour créer une campagne.

Créer un élément de campagne

Pour créer un élément de campagne, procédez comme suit:

  1. Créez un objet Order ou utilisez un objet existant.
  2. Créez un objet LineItem, puis définissez le type de rotation, le tableau des tailles de créations, les dates de début et de fin, ainsi que d'autres propriétés.
  3. Créez un objet InventoryTargeting, puis spécifiez les objets Placement ou AdUnit à cibler ou à exclure.
  4. Encapsulez votre objet InventoryTargeting dans un nouvel objet Targeting, puis attribuez-le à la propriété de ciblage de votre LineItem.
  5. Appelez la méthode de service d'éléments de ligne createLineItems() avec votre nouvel objet, puis examinez le résultat pour voir si votre objet a été créé.

Exemple

Consultez l'exemple de code Java pour créer un élément de campagne.

Concevoir une création

Les différents types de créations sont compatibles avec différents composants. Par exemple, une création illustrée n'accepte qu'un seul fichier source pour l'image, tandis qu'une création Flash accepte deux fichiers d'éléments sous-jacents (un fichier Flash et un fichier image de back-up) si le fichier Flash ne peut pas être diffusé. Pour les créations hébergées sur des sites tiers, vous ne devez importer qu'un extrait de code HTML faisant référence au fichier sur le serveur tiers. Consultez votre sous-classe Creative spécifique pour savoir quels éléments vous devez importer pour concevoir votre création.

Exemple

Consultez l'exemple de code Java pour concevoir une création illustrée.

Modification d'un objet existant

Pour modifier un objet existant, interrogez votre objet en appelant getObjectsByStatement(), mettez à jour les valeurs dans les objets renvoyés, puis appelez updateObjects().

Remarque:Les objets mis à jour remplaceront complètement les objets existants. Par conséquent, si vous négligez de définir une valeur de propriété dans l'objet que vous envoyez, l'objet enregistré recevra la valeur par défaut de cette propriété, et non la valeur précédente.

Modifier l'état d'un objet

L'état d'un objet est modifié en appelant la méthode performObjectAction() exposée par votre service. Cette méthode nécessite deux paramètres:

  • Instance de l'objet action qui décrit ce que vous souhaitez faire. Par exemple, le service de commande expose plusieurs actions, y compris ApproveOrders, PauseOrders et ArchiveOrders. Les objets Action proviennent tous d'une classe d'action de base adaptée à votre service.
  • Requête PQL décrivant les objets à modifier. Vous pouvez modifier l'état d'un ou de plusieurs objets à la fois en spécifiant une instruction PQL appropriée.

Générer des tags d'emplacement publicitaire

Vous ne pouvez pas générer de tags d'emplacement publicitaire via l'API. Vous devez utiliser le site Web Google Ad Manager à la place. Pour en savoir plus, consultez la section Ajouter des tags dans le centre d'aide.

Autres exemples

Vous trouverez de nombreux autres exemples dans l'exemple de code de notre bibliothèque cliente, dans différents langages de programmation. Consultez la page Bibliothèques clientes et exemples de code pour obtenir un lien vers des exemples dans votre langage de programmation.