API Reference

L'API Search Console propose les services suivants:

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

Rechercher dans Analytics

Pour en savoir plus sur la ressource "Analyse de la recherche", 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
query POST  /sites/siteUrl/searchAnalytics/query

interroger vos données de trafic de recherche à l'aide de filtres et de paramètres que vous définissez ; Cette méthode renvoie zéro ou plusieurs lignes regroupées en fonction des clés de ligne (dimensions) que vous définissez. Vous devez définir une plage de dates d'un ou plusieurs jours.

Lorsque "date" est l'une des dimensions, les jours sans données sont omis de la liste des résultats. Pour savoir quels jours comportent des données, lancez une requête sans filtres regroupés par date pour la plage de dates qui vous intéresse.

Les résultats sont triés par nombre de clics dans l'ordre décroissant. Si deux lignes ont 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 POST JSON : 
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 aux représentations de la ressource.

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.
get GET  /sites/siteUrl/sitemaps/feedpath Récupère des informations sur un sitemap spécifique.
liste GET  /sites/siteUrl/sitemaps Liste les entrées sitemaps-inputs 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 aux représentations de la ressource.

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.
get GET  /sites/siteUrl Récupère des informations sur un site spécifique.
liste GET  /sites Liste les sites Search Console de l'utilisateur.

Inspection de l'URL

Pour en savoir plus sur la ressource 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 POST JSON : 
POST https://searchconsole.googleapis.com/v1/urlInspection/index:inspect
{
  "inspectionUrl": "https://www.example.com/mypage",
  "siteUrl": "https://www.example.com/",
  "languageCode": "en-US"}