API Reference

L'API Search Console offre les services suivants:

  • Analyse de la recherche : interrogez les données de trafic de votre site.
  • Sitemaps : répertoriez tous vos sitemaps, demandez des informations sur un sitemap spécifique et envoyez-nous un sitemap.
  • Sites : permet de répertorier, ajouter ou supprimer des propriétés dans votre compte Search Console.
  • Inspection de l'URL : inspectez l'état d'une page dans l'index Google (équivalent de l'inspection d'URL dans la Search Console).

Analyse de la recherche

Pour en savoir plus sur la ressource "Analyse de la recherche", consultez la page relative aux représentations de la ressource.

Méthode Requête HTTP : Description
URI relatifs à https://www.googleapis.com/webmasters/v3, sauf indication contraire
query POST  /sites/siteUrl/searchAnalytics/query

Interrogez les données sur le trafic de recherche grâce aux filtres et aux paramètres que vous définissez. La méthode renvoie zéro ou plusieurs lignes regroupées par les clés (dimensions) de ligne que vous définissez. Vous devez définir une plage de dates d'un ou plusieurs jours.

Lorsque la date fait partie de l'attribut, les jours sans données sont omis de la liste des résultats. Pour savoir quels jours contiennent des données, lancez une requête sans filtres regroupés par date, pour la plage de dates d'intérêt.

Les résultats sont triés par ordre décroissant du nombre de clics. Si deux lignes présentent le même nombre de clics, elles sont triées de manière arbitraire.

Consultez l'exemple Python pour appeler cette méthode.

Exemple de requête JSON POST :
POST https://www.googleapis.com/webmasters/v3/sites/https%3A%2F%2Fwww.example.com%2F/searchAnalytics/query
{
  "startDate": "2015-04-01",
  "endDate": "2015-05-01",
  "dimensions": ["country","device"]
}

Sitemaps

Pour en savoir plus sur la ressource "Sitemaps", consultez la page relative à la représentation des ressources.

Méthode Requête HTTP : Description
URI relatifs à https://www.googleapis.com/webmasters/v3, sauf indication contraire
supprimer DELETE  /sites/siteUrl/sitemaps/feedpath Supprime un sitemap de ce site.
obtenir GET  /sites/siteUrl/sitemaps/feedpath Récupère des informations sur un sitemap spécifique.
list GET  /sites/siteUrl/sitemaps Répertorie les sitemaps-entries envoyées pour ce site ou incluses dans le fichier d'index de sitemaps (si sitemapIndex est spécifié dans la requête).
envoyer PUT  /sites/siteUrl/sitemaps/feedpath Envoie un sitemap pour un site.

Sites

Pour en savoir plus sur la ressource "Sites", consultez la page relative à la représentation des ressources.

Méthode Requête HTTP : Description
URI relatifs à https://www.googleapis.com/webmasters/v3, sauf indication contraire
ajouter PUT  /sites/siteUrl Ajoute un site à l'ensemble des sites de l'utilisateur dans la Search Console.
supprimer DELETE  /sites/siteUrl Supprime un site de l'ensemble des sites Search Console de l'utilisateur.
obtenir GET  /sites/siteUrl Récupère des informations sur un site spécifique.
list GET  /sites Répertorie les sites Search Console de l'utilisateur.

Inspection de l'URL

Pour en savoir plus sur les ressources d'inspection d'URL, consultez la page relative à la représentation des ressources.

Méthode Requête HTTP : Description
URI relatif à https://searchconsole.googleapis.com/v1
index.inspect. POST /urlInspection/index:inspect

Informations sur l'URL fournie dans l'index Google.

Exemple de requête JSON POST :
POST https://searchconsole.googleapis.com/v1/urlInspection/index:inspect
{
  "inspectionUrl": "https://www.example.com/mypage",
  "siteUrl": "https://www.example.com/",
  "languageCode": "en-US"}