Nous vous conseillons d'utiliser le Centre d'aide des bibliothèques et des exemples pour votre mise en œuvre. Toutefois, si votre intégration avec l'API a des besoins spécifiques, comme l'utilisation d'une langue non prise en charge, vous pouvez envoyez des demandes directes comme décrit ci-dessous.
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 AdSense Management
Les opérations disponibles sont mappées directement à des verbes HTTP REST, comme décrit dans la section Opérations de l'API AdSense Management
Le format spécifique pour les URI de l'API AdSense Management est le suivant:
https://adsense.googleapis.com/v2/resourceID?parameters
où resourceID
est l'identifiant d'une annonce.
client, bloc d'annonces, critère d'URL, critère personnalisé ou collection de rapports, et
parameters
correspond aux paramètres à appliquer à
la requête.
Format des extensions de chemin resourceID
vous permet d'identifier la ressource sur laquelle vous travaillez, 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 figure dans la documentation de référence de l'API AdSense Management. document.
Voici quelques exemples de la façon dont cela fonctionne 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. doivent utiliser le flux d'application installée.
Chaque demande que votre application envoie à 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 OAuthVous 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 :
- Lorsque votre application requiert l'accès aux données utilisateur, elle demande à Google un champ d'application particulier.
- Google affiche alors un écran d'autorisation, dans lequel l'utilisateur est invité à autoriser votre application à demander certaines de ses données.
- Si l'utilisateur accepte, Google attribue à votre application un jeton d'accès temporaire.
- Votre application demande des données utilisateur en joignant le jeton d'accès à la requête.
- Dès lors que Google valide la requête et le jeton, les données demandées sont renvoyées.
Certains flux comportent des étapes supplémentaires, comme l'utilisation de jetons d'actualisation en vue de l'acquisition 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 concernant le niveau d'accès OAuth 2.0 pour l'API AdSense Management:
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. Consultez le documentation de référence pour obtenir des informations.