La ressource REST urlNotifications de l’API d’indexation
Découvrez la ressource UrlNotification, ses champs, ses types d'événements et ses méthodes pour piloter l'API d'indexation de Google.
La ressource UrlNotification est l’objet central de l’API d’indexation : elle est utilisée dans tous les appels. Elle décrit un événement dans le cycle de vie d’un document web, c’est-à-dire le fait qu’une URL ait été mise à jour ou supprimée. Comprendre sa structure est la base pour construire correctement vos requêtes vers Google.
Pour le SEO, cette ressource est le langage commun de l’API. Que vous notifiiez une page ou interrogiez son état, vous manipulez toujours une UrlNotification. En maîtriser les champs évite les requêtes mal formées et fiabilise le pilotage de l’indexation, une fois l’accès configuré en sachant créer un compte de service.
La plupart des bugs que je rencontre sur cette API ne viennent pas du code mais d’une mauvaise compréhension de l’objet UrlNotification lui-même. Prenez le temps de bien distinguer ses champs avant d’écrire votre première requête, vous vous épargnerez des heures de débogage sur des notifications mal formées qui partent dans le vide sans jamais remonter d’erreur explicite.
Les champs de la ressource
La représentation JSON d’une UrlNotification comporte trois champs : l’URL concernée, le type d’événement et un horodatage. Les deux premiers sont ceux que vous renseignez ; le troisième est géré par l’API. Le tableau ci-dessous détaille chacun d’eux.
| Champ | Type | Rôle |
|---|---|---|
url |
string |
URL objet de la notification, qui doit vous appartenir et, pour URL_UPDATED, rester explorable |
type |
enum (UrlNotificationType) |
Événement de cycle de vie d’URL signalé à Google |
notifyTime |
string (Timestamp) |
Horodatage de création, à ne pas renseigner : il est ignoré à la requête |
{
"url": "string",
"type": "enum (UrlNotificationType)",
"notifyTime": "string"
}Les types d'événements d'URL
Le champ type s’appuie sur l’énumération UrlNotificationType. Elle précise l’événement signalé pour une URL donnée. Trois valeurs existent : une valeur indéterminée à ne pas utiliser, la mise à jour et la suppression. Le tableau ci-dessous les récapitule.
| Valeur | Signification |
|---|---|
URL_NOTIFICATION_TYPE_UNSPECIFIED |
URL indéterminée, valeur par défaut à ne pas employer |
URL_UPDATED |
L’URL spécifiée (document web) a été mise à jour |
URL_DELETED |
L’URL spécifiée (document web) a été supprimée |
Les méthodes disponibles
La ressource urlNotifications expose deux méthodes complémentaires. L’une sert à envoyer une notification, l’autre à lire l’historique des notifications reçues pour une URL. Le tableau ci-dessous précise leur rôle respectif.
| Méthode | Rôle |
|---|---|
publish |
Notifie qu’une URL a été mise à jour ou supprimée |
getMetadata |
Extrait les métadonnées relatives à un document web |
Comment ces éléments s'articulent
En pratique, vous construisez une UrlNotification avec une url et un type, puis vous l’envoyez via publish pour notifier une URL mise à jour ou supprimée. Pour vérifier sa bonne réception, vous interrogez la même URL avec getMetadata afin de suivre les dernières notifications de l’URL. La ressource sert donc à la fois d’entrée pour l’envoi et de référence pour la lecture : c’est le pivot de toute intégration à l’API.
Le champ notifyTime est un horodatage que vous ne devez pas spécifier : il est ignoré au moment de la requête et défini par l’API. Veillez aussi à ce que l’URL vous appartienne. Pour une notification URL_UPDATED, la page doit rester explorable par Google, sinon la notification perd son sens.
À faire
- renseigner les champs url et type
- choisir une valeur explicite de UrlNotificationType
- réutiliser la même ressource pour publish et getMetadata
- vérifier que l’URL vous appartient
À éviter
- remplir le champ notifyTime
- envoyer le type URL_NOTIFICATION_TYPE_UNSPECIFIED
- notifier une URL hors de votre propriété
- signaler en URL_UPDATED une page non explorable
Points clés à retenir
- elle décrit un événement de cycle de vie d'une URL
- ses champs utiles sont url et type
- le type vaut URL_UPDATED ou URL_DELETED
- ne renseignez jamais notifyTime
- elle alimente les méthodes publish et getMetadata
La ressource UrlNotification est le cœur de l’API d’indexation.
Quiz : testez vos connaissances
Quiz : testez vos connaissances
-
Quels champs devez-vous renseigner vous-même dans une ressource UrlNotification ?
- Les champs url et notifyTime
- Les champs url et type
- Uniquement le champ type, l'URL étant déduite automatiquement
Vous renseignez les champs
urlettype. Le champnotifyTimene doit pas être rempli car il est géré par l’API. -
Quelle est la différence entre les méthodes publish et getMetadata ?
- publish envoie une notification, getMetadata lit l'historique des notifications reçues
- publish lit les données, getMetadata envoie une demande d'exploration
- Les deux méthodes font la même chose mais avec des formats différents
La méthode
publishenvoie une notification de mise à jour ou de suppression, tandis quegetMetadatalit les métadonnées des dernières notifications reçues pour une URL. -
Que faut-il faire du champ notifyTime au moment de la requête ?
- Ne pas le renseigner car il est ignoré et défini par l'API
- Le remplir avec la date prévue de la prochaine exploration
- Le remplir avec la date exacte de votre modification
Le champ
notifyTimeest un horodatage que vous ne devez pas spécifier : il est ignoré au moment de la requête et défini par l’API elle-même.
À propos de l'auteur
Besoin d'un accompagnement SEO ?
Vous voulez intégrer proprement l'API d'indexation à votre site ?