Contexte

Avant de commencer

  1. Demandez à votre responsable de compte de configurer les autorisations appropriées pour les comptes. auxquelles votre application accédera.
  2. Si vous ne connaissez pas les concepts Authorized Buyers, consultez la le Centre d'aide Authorized Buyers et tester l'interface utilisateur. Si votre application est censée définir des enchères en temps réel, consultez les documentation sur le protocole d'enchères en temps réel.
  3. Consultez le Console des API pour configurer un nouveau projet. Connectez-vous à votre compte Google de développeur ou créer un compte. Vous serez ensuite invité à créer un projet et à valider sur quelques conditions d'utilisation.

Comptes parent et enfant

Si vous travaillez dans une structure de compte contenant un parent et un enfant vous serez peut-être en mesure de travailler plus efficacement si vous comprenez comment ils d'interagir. Voici un bref résumé:

Comptes enfants

Un utilisateur disposant d'identifiants qui lui accordent l'accès à un compte enfant ne peut d'afficher et de modifier les ressources associées à leur compte. Les comptes enfant ne peuvent pas afficher ou modifier les ressources appartenant à d'autres comptes enfants ou parents.

Comptes parents

Un utilisateur disposant d'identifiants qui accordent l'accès à un compte parent peut consulter et modifier les ressources du compte parent, en plus comptes enfants. Pour les opérations listant l'ensemble d'une ressource donnée, cet utilisateur reçoivent une réponse incluant des données pour leur compte et l'ensemble de leurs comptes enfants. Notez que pour les autres types de requêtes ciblant des ressources pour des sous-comptes, un le compte parent doit spécifier un paramètre de chemin accountId pour l'élément enfant au lieu de son propre accountId.

Modèle de données de l'API REST

Une ressource est une entité de données individuelle disposant d'un identifiant unique. La La ressource "Accounts" représente une entrée de compte Authorized Buyers. Il s'agit de la ressource pour l'API Ad Exchange pour acheteur. Les méthodes de l'API agissent sur des données des ressources Accounts et sur des collections de ressources Accounts.

Un compte la ressource inclut un ID de compte, les informations utilisées pour la mise en correspondance des cookies, les emplacements des enchérisseurs, l'URL à laquelle les demandes d'enchères sont envoyées et une demande pour spécifier le nombre maximal de requêtes par seconde pouvant être envoyées par la place de marché.

Outre la ressource et la collection "Accounts", l'API Ad Exchange pour acheteur définit les structures de données suivantes:

Emplacement de l'enchérisseur

Les emplacements de l'enchérisseur sont des structures renvoyées avec les ressources "Accounts" pour fournir l'URL à laquelle Ad Exchange doit envoyer les demandes d'enchères. le nombre maximal de requêtes par seconde que la place de marché doit envoyer. Voici une exemple d'emplacement d'enchérisseur, exprimé au format JSON: 

"bidderLocation": [
    {
      "url": "http://bid.url.com/bidder",
      "maximumQps": 1500
    }
  ],

Éléments

Les éléments fournissent une liste de comptes. Voici un exemple d'articles, exprimé au format JSON: 

{
  "kind": "adexchangebuyer#accountsList",
  "items": [
    accounts Resource
  ]
}

Opérations compatibles

Vous pouvez appeler trois méthodes différentes sur les collections et les ressources dans le API Ad Exchange pour acheteur, comme indiqué dans le tableau suivant. Toutes les opérations nécessitent autorisation.

Opération Description Mappages HTTP REST
liste Liste tous les comptes auxquels le compte actuellement authentifié peut accéder utilisateur. GET sur un URI de collection.
get Récupère une ressource "Accounts" spécifique. GET sur un URI de ressource
mise à jour Met à jour une ressource "Accounts" spécifique. PUT sur un URI de ressource, où vous transmettez des données pour le ressource mise à jour.

Style d'appel

REST est un style d'architecture logicielle qui permet de demander et modifier des données de manière pratique et cohérente.

Le terme REST est l'acronyme de REpresentational State Transfer. Dans le contexte des API Google, il désigne l'architecture utilisant des verbes HTTP pour récupérer et modifier les représentations des données stockées par Google.

Dans un système RESTful, les ressources sont stockées dans un datastore. Un client envoie une requête pour que le serveur exécute une action spécifique (par exemple la création, l'extraction, la mise à jour ou la suppression d'une ressource), et le serveur exécute l'action et envoie une réponse, souvent sous la forme d'une représentation de la ressource spécifiée.

Dans les API RESTful de Google, le client spécifie une action à l'aide d'un verbe HTTP comme POST, GET, PUT ou DELETE. La ressource est désignée par un URI unique au format suivant :

https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters

Étant donné que toutes les ressources d'API possèdent des URI uniques accessibles via HTTP, REST permet la mise en cache des données, et son fonctionnement est optimisé pour l'infrastructure distribuée du Web.

Les définitions de méthode figurant dans la documentation du standard HTTP 1.1 peuvent s'avérer utiles, car elles incluent les spécifications pour GET, POST, PUT, et DELETE.

REST dans l'API Ad Exchange pour acheteur

Les opérations disponibles sont mappées directement à des verbes HTTP REST, comme décrit dans la section Opérations d'API

Le format spécifique des URI d'API est le suivant:

https://www.googleapis.com/adexchangebuyer/v1.4/resourceID?parameters

où resourceID est l'identifiant la ressource "Accounts" et parameters sont paramètres à appliquer à la requête. Voir Paramètres de requête standards et documentation de référence pour en savoir plus.

Format des extensions de chemin resourceID vous permet d'identifier la ressource sur laquelle vous travaillez, par exemple:

https://www.googleapis.com/adexchangebuyer/v1.4/accounts
https://www.googleapis.com/adexchangebuyer/v1.4/accounts/id

L'ensemble complet des URI utilisés pour chaque opération disponible dans l'API est est résumé dans le documentation de référence.

Voici un exemple dans l'API Ad Exchange pour acheteur.

Obtenez la liste des comptes de l'utilisateur authentifié:

GET https://www.googleapis.com/adexchangebuyer/v1.4/accounts

Format des données

JSON

JSON (JavaScript Object Notation) est un format de données qui ne dépend pas d'un langage et qui fournit une représentation textuelle simple de structures de données arbitraires. Pour en savoir plus, accédez à json.org.