Mercredi 9 décembre 2020
Il y a quelques mois, nous avions annoncé une mise à niveau de l'infrastructure API qui permettait d'améliorer les performances de l'API Search Console et de répondre aux besoins croissants des utilisateurs. Aujourd'hui, nous sommes heureux de vous annoncer quelques nouveautés supplémentaires :
- Ajout d'un filtre pour les données récentes et les actualités dans l'API Search Console
- Compatibilité avec les propriétés de domaine dans l'API Sitemaps
- Ajout d'instructions sur la façon de migrer le document de découverte
Si vous effectuez vos propres appels d'API, poursuivez la lecture.
Filtre pour les données récentes et les actualités dans l'API Search Console
Le rapport sur les performances accepte déjà les données récentes qui remontent à moins d'un jour. Vous pouvez désormais accéder à ces données via l'API en transmettant le paramètre de requête dataState avec la valeur all. Les données obtenues pour cette valeur incluent également des données récentes qui ne sont pas encore définitives. Si vous ne souhaitez obtenir que des données finales, vous pouvez transmettre ce paramètre avec une valeur définie sur final, ou ne pas le transmettre du tout. Dans ce cas, vous n'obtiendrez que des données finales par défaut.
Il y a quelques mois, nous avons ajouté un onglet "Actualités" dans le filtre de recherche du rapport sur les performances. Ces informations sont désormais également disponibles dans l'API. Vous pouvez y accéder en définissant la valeur du paramètre searchType de la requête sur news.
Compatibilité avec les propriétés de domaine dans l'API Sitemaps
L'API Sitemaps est désormais compatible avec les propriétés de domaine, comme toutes les autres API de la Search Console. Vous pouvez interroger, ajouter et supprimer vos sitemaps sur les propriétés de domaine, par exemple :
GET https://www.googleapis.com/webmasters/v3/sites/sc-domain:example.com/sitemaps
Migration du document de découverte
Nous allons supprimer cette compatibilité dans le document de découverte Webmasters API. Si vous interrogez l'API Search Console à l'aide d'une bibliothèque d'API externe ou interrogez directement le document de découverte Webmasters API, vous devez mettre à jour vos appels d'API pour inclure les modifications suivantes.
Modifications apportées à la bibliothèque d'API
Pour en savoir plus sur les modifications apportées à la bibliothèque d'API, reportez-vous aux guides de démarrage rapide de Java et Python afin d'obtenir les toutes dernières informations concernant l'utilisation des API.
Java
Pour toutes les importations liées aux services pour les webmasters, remplacez le package webmasters par searchconsole.v1 et le nom du service, Webmasters, par SearchConsole. Exemples :
- Pour importer le service d'API :
import com.google.api.services.webmasters.Webmasters;import com.google.api.services.searchconsole.v1.SearchConsole; - Pour importer un objet de réponse :
import com.google.api.services.webmasters.model.WmxSite;import com.google.api.services.searchconsole.v1.model.WmxSite;
Notez qu'en plus de l'objet de service, les autres objets d'API sont exactement les mêmes qu'auparavant. Seul le package change.
Python
Lors de la création de l'objet de service Webmasters, effectuez la modification suivante :
webmasters_service = build('webmasters', 'v3', http=http)
webmasters_service = build('searchconsole', 'v1', http=http)
Une fois encore, le comportement des objets ne change pas.
Requête directe sur le document de découverte
L'interrogation du document de découverte fait l'objet des modifications suivantes :
- Modification des URL
https://www.googleapis.com/discovery/v1/apis/webmasters/v3/resthttps://searchconsole.googleapis.com/$discovery/rest - Modification du contenu
- Le champ
namepasse dewebmastersàsearchconsole. - Le champ
versionpasse dev3àv1.
- Le champ
Si vous avez des questions, posez-les dans la communauté Search Central ou sur Twitter.