Contexte

Avant de commencer

  1. Demandez à votre responsable de compte de configurer les autorisations appropriées pour les comptes auxquels votre application accédera.
  2. Si vous ne connaissez pas les concepts associés, consultez le Centre d'aide Authorized Buyers et testez l'interface utilisateur. Si votre application doit définir des enchères en temps réel, consultez la documentation du protocole d'enchères en temps réel.
  3. Pour configurer un nouveau projet, accédez à la console des API. Connectez-vous à votre compte Google de développeur ou créez un compte. Vous serez ensuite invité à créer un projet et à approuver quelques conditions d'utilisation.

Comptes parent et enfant

Si vous utilisez une structure de compte contenant des comptes parents et enfants, vous pourrez peut-être travailler plus efficacement si vous comprenez la façon dont ils interagissent. Voici un bref résumé:

Comptes enfants

Un utilisateur disposant d'identifiants qui accordent l'accès à un compte enfant ne peut que consulter et modifier les ressources associées à son compte. Ils ne peuvent pas afficher ni 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 afficher et modifier les ressources du compte parent en plus de tous les comptes enfants associés. Pour les opérations répertoriant toutes une ressource donnée, cet utilisateur recevra une réponse incluant les données de son compte et de tous ses comptes enfants. Notez que pour les autres types de requêtes ciblant des ressources pour des sous-comptes, un compte parent doit spécifier un paramètre de chemin accountId pour le compte enfant plutôt que son propre accountId.

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

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

Une ressource Accounts inclut: un ID de compte, les informations utilisées dans 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 spécifiant le nombre maximal de requêtes par seconde que la place de marché peut envoyer.

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

Emplacement de l'enchérisseur

Les emplacements du système d'enchères sont des structures qui sont renvoyées avec les ressources "Accounts" pour fournir l'URL à laquelle Ad Exchange doit envoyer des demandes d'enchères et le nombre maximal de requêtes par seconde qu'Ad Exchange doit envoyer. Voici un exemple d'emplacement d'un système d'enchères, 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'éléments, exprimé en 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 l'API Ad Exchange pour acheteur, comme décrit dans le tableau suivant. Toutes les opérations nécessitent une autorisation.

Opération Description Mappages HTTP REST
liste Répertorie tous les comptes auxquels l'utilisateur actuellement authentifié peut accéder. 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 la ressource mise à jour.

Style d'appel

Il s'agit d'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'utilisation de verbes HTTP pour extraire et modifier des représentations de 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 tel que POST, GET, PUT ou DELETE. Il spécifie une ressource avec un URI global 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 de l'API.

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

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

resourceID est l'identifiant d'une ressource "Accounts" et parameters est les paramètres à appliquer à la requête. Pour en savoir plus, consultez les paramètres de requête standards et la documentation de référence.

Le format des extensions de chemin resourceID vous permet d'identifier la ressource en cours d'utilisation. 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 résumé dans la documentation de référence.

L'exemple ci-dessous illustre le fonctionnement 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.