Envoyer des demandes directes

Nous vous encourageons à utiliser les exemples de code et bibliothèques clientes pour votre mise en œuvre. Toutefois, si votre intégration à l'API présente des besoins particuliers, tels que l'utilisation d'une langue non compatible, vous pouvez effectuer des requêtes directes comme décrit ci-dessous.

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 AdSense Management

Les opérations disponibles sont mappées directement à des verbes HTTP REST, comme expliqué dans la section Opérations de l'API AdSense Management.

Le format spécifique des URI de l'API AdSense Management est le suivant:

https://adsense.googleapis.com/v2/resourceID?parameters

où resourceID est l'identifiant d'un client publicitaire, d'un bloc d'annonces, d'un critère d'URL, d'un critère personnalisé ou d'une collection de rapports, et parameters représente les paramètres à appliquer à la requête.

Le format des extensions de chemin resourceID vous permet d'identifier la ressource sur laquelle vous travaillez actuellement. Par exemple:

https://adsense.googleapis.com/v2/accounts/account_id/adclients
https://adsense.googleapis.com/v2/accounts/account_id/adclients/adClientId
https://adsense.googleapis.com/v2/accounts/account_id/adclients/adClientId/adunits
https://adsense.googleapis.com/v2/accounts/account_id/adclients/adClientId/adunits/adUnitId
https://adsense.googleapis.com/v2/accounts/account_id/adclients/adClientId/urlchannels
...

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 de l'API AdSense Management.

Voici quelques exemples de ce fonctionnement dans l'API AdSense Management.

Lister les clients publicitaires:

GET https://adsense.googleapis.com/v2/accounts/account_id/adclients/

Répertorier les blocs d'annonces dans le client publicitaire ca-pub-1234567890123456:

GET https://adsense.googleapis.com/v2/accounts/account_id/adclients/ca-pub-1234567890123456/adunits

Format des données

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.

Autoriser les requêtes

Notez qu'AdSense n'est pas compatible avec les comptes de service. Vous devez utiliser le flux de l'application installée.

Chaque demande envoyée par votre application à l'API AdSense Management doit inclure un jeton d'autorisation. Celui-ci permet également d'identifier votre application auprès de Google.

À propos des protocoles d'autorisation

Votre application doit autoriser les requêtes via le protocole OAuth 2.0. Les autres protocoles d'autorisation ne sont pas acceptés. Si votre application utilise la fonctionnalité Se connecter avec Google, certains aspects de l'autorisation sont traités pour vous.

Autoriser des requêtes avec OAuth 2.0

Toutes les demandes envoyées à l'API AdSense Management doivent être autorisées par un utilisateur authentifié.

Ce processus est facilité par l'utilisation d'un ID client OAuth.

Obtenir un ID client OAuth

Vous pouvez également en créer un sur la page Identifiants.

Les détails de la procédure d'autorisation (ou "flux") concernant OAuth 2.0 varient légèrement selon le type d'application que vous développez. La procédure générale suivante s'applique à tous les types d'applications :

  1. Lorsque votre application requiert l'accès aux données utilisateur, elle demande à Google un champ d'application particulier.
  2. Google affiche alors un écran d'autorisation, dans lequel l'utilisateur est invité à autoriser votre application à demander certaines de ses données.
  3. Si l'utilisateur accepte, Google attribue à votre application un jeton d'accès temporaire.
  4. Votre application demande des données utilisateur en joignant le jeton d'accès à la requête.
  5. Dès lors que Google valide la requête et le jeton, les données demandées sont renvoyées.

Certains flux comportent d'autres étapes, comme l'utilisation de jetons d'actualisation afin d'obtenir de nouveaux jetons d'accès. Pour en savoir plus sur les flux concernant divers types d'applications, consultez la documentation OAuth 2.0 de Google.

Voici les informations sur le niveau d'accès d'OAuth 2.0 pour l'API AdSense Management:

Définition du champ d'application Signification
https://www.googleapis.com/auth/adsense Accès en lecture/écriture aux données AdSense.
https://www.googleapis.com/auth/adsense.readonly Accès en lecture seule aux données AdSense.

Pour demander l'accès via OAuth 2.0, vous avez besoin du champ d'application ainsi que des informations fournies par Google lors de l'enregistrement de l'application (l'ID client et le code secret du client, par exemple).

Conseil : Les bibliothèques clientes des API Google peuvent gérer une partie de la procédure d'autorisation à votre place. Elles sont proposées pour une grande variété de langages de programmation. Pour en savoir plus, explorez les bibliothèques clientes et les exemples de code présentés sur la page Installer les bibliothèques clientes.

Envoyer une demande

La dernière étape consiste à envoyer la requête API. Pour en savoir plus, consultez la documentation de référence.