Guide d'utilisation

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

Création d'utilisateurs

L'objet UserService permet un utilisateur disposant de droits d'administrateur pour créer un utilisateur directement dans son réseau. Tout développeur peut le faire sans le nouvel utilisateur s’inscrit en premier. Par exemple, si vous testez l'API au lieu d'effectuer chaque appel d'API en tant qu'administrateur pour votre adresse e-mail), vous pouvez créer quelques utilisateurs avec des rôles Commercial, Trafficker ou Annonceur pour tester des flux de travail réels.

  1. Créez des adresses Gmail, telles que my.name.salesperson@gmail.com. Par ailleurs, enregistrer une adresse autre que Gmail en tant que nouvelle compte Google.
  2. Appelez createUsers avec cette nouvelle adresse et le Role choisi.
  3. Vous pouvez vous authentifier en tant que nouvel utilisateur en utilisant OAuth 2.0 pour générer votre jeton d'accès.

Obtenir le bloc d'annonces racine

Le AdUnit supérieur auquel vous pouvez ajouter des nœuds enfants et la profondeur autorisée de votre hiérarchie dépendent de votre type de compte (Small Business ou Premium). Le AdUnit racine qui prend en charge la modification de ses nœuds enfants est appelé 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 hiérarchiques varient en fonction du type de compte.

Interroger un objet

Vous pouvez rechercher des objets par critère de recherche à l'aide de la méthode getObjectsByStatement(). exposés par de nombreux services, où Object est un type d'objet spécifique. Ce utilise une requête PQL. Elle est semblable à une requête SQL, car elle vous permet de spécifier les champs sur lesquels effectuer la recherche (où les noms des champs correspondent aux propriétés de l'objet), trier, et décaler vos résultats de recherche. Reportez-vous à la page PQL pour en savoir plus sur PQL, ainsi que pour connaître les champs d'objet que vous pouvez filtrer par.

Créer une commande

Pour créer un ordre, il vous suffit de créer un objet Order et de définir l'annonceur, les numéros de vendeur et de trafficker aux utilisateurs appropriés, attribuez un nom unique, et appelez createOrders(). Le résultat inclut le nouveau Order, ou une erreur.

Exemple

Voir un exemple de code Java pour la création d'une commande.

Créer un élément de campagne

Voici les étapes à suivre pour créer un élément de campagne:

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

Exemple

Consultez un exemple de code Java pour la création d'un élément de campagne.

Concevoir une création

Les composants (par exemple, une image) varient en fonction du type de création la création n'accepte qu'un seul fichier source pour l'image. qu'une création Flash deux fichiers de contenu sous-jacents: un fichier Flash et un fichier d'image de back-up, au cas où le fichier Flash ne peut pas être diffusé. Pour les créations hébergées sur des sites tiers, vous importez qu'un extrait de code HTML qui référence le fichier sur le serveur tiers. Consultez votre une sous-classe Creative spécifique pour savoir quels éléments vous devez importer pour concevoir votre création.

Exemple

Consultez un exemple de code Java permettant de concevoir une création illustrée.

Modifier un objet existant

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

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

Modifier l'état d'un objet

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

  • Instance de l'objet d'action qui décrit l'action à effectuer. Pour le service des commandes expose plusieurs actions, y compris ApproveOrders, PauseOrders, et ArchiveOrders. Les objets d'action sont tous dérivés d'une action de base adaptée à votre service.
  • Requête PQL décrivant les objets à modifier. Vous pouvez modifier le statut d'un ou de plusieurs objets à la fois en spécifiant .

Générer des tags d'emplacement publicitaire

Vous ne pouvez pas générer de tags d'emplacement publicitaire à l'aide de l'API. vous devez utiliser le site Web Google Ad Manager. Consultez la section Ajout de tags dans le centre d'aide plus d'informations.

Autres exemples

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