Ce document décrit les actions à effectuer avant de créer votre première application cliente.
Obtenir un compte Google
Vous devez disposer d'un compte Google pour utiliser cette API. Votre compte doit disposer de l'autorisation Search Console appropriée sur une propriété donnée pour pouvoir appeler cette méthode sur cette propriété. Par exemple, pour exécuter searchAnalytics.query, vous devez disposer d'autorisations de lecture sur cette propriété.
Essayer Google Search Console
Cette documentation de l'API suppose que vous avez utilisé la Google Search Console, et que vous connaissez les concepts de programmation Web et les formats de données Web.
Si vous n'avez jamais utilisé Google Search Console, essayez l'interface utilisateur avant de commencer à coder. Chaque API représente la fonctionnalité d'un rapport dans la Search Console. Avant d'utiliser une API, vous devez lire la documentation du rapport équivalent afin de comprendre les données que vous recevez.
Créer un projet et des identifiants pour votre client
Pour pouvoir envoyer des requêtes à la Google Search Console, vous devez indiquer à Google votre client et activer l'accès à l'API. Pour ce faire, utilisez la console Google APIs pour créer un projet, soit une collection nommée de paramètres et d'informations d'accès à l'API, puis enregistrez votre application.
À l'exception de l'API des outils de test, toutes les API Search Console nécessitent des identifiants OAuth2. Les guides de démarrage rapide pour Python et Java expliquent en détail comment créer un projet et obtenir des identifiants pour votre client.
Comprendre les principes de base de REST
Il existe deux façons d'appeler l'API :
- Envoi de requêtes HTTP et analyse des réponses
- Utilisation de bibliothèques clientes
Si vous décidez de ne pas utiliser de bibliothèques clientes, vous devez comprendre les bases de l'architecture REST.
Principes de base de REST
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 par un URI globalement 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 Google Search Console
Les opérations de l'API Google Search Console sont directement mappées aux verbes HTTP REST.
Le format de la plupart des URI de l'API Google Search Console se présente comme suit:
VERB https://www.googleapis.com/webmasters/v3/resourcePath?parameters
L'ensemble complet des URI et des verbes utilisés pour chaque méthode est disponible dans la documentation de référence de l'API Google Search Console.
Comprendre les principes de base du format JSON
L'API Google Search Console renvoie les données au format 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.