WebResource

Une ressource WebResource est une représentation d'un site Web ou d'un domaine validé.

Il contient l'ID canonique d'un site ou d'un domaine, l'URL ou le nom de domaine et une liste de propriétaires. Notez que la liste des propriétaires inclut toujours l'utilisateur authentifié, car les seules personnes qui peuvent accéder à une ressource WebResource sont des utilisateurs authentifiés qui sont propriétaires de ce site ou de ce domaine.

La liste des méthodes associées à cette ressource est présentée au bas de la page.

Représentations de la ressource

{
  "id": string,
  "site": {
    "type": string,
    "identifier": string
  },
  "owners": [
    string
  ]
}
Nom de propriété Value Description Remarques
id string Chaîne utilisée pour identifier ce site. Cette valeur doit être utilisée dans la partie id de l'URL REST pour les opérations get, update et delete.
owners[] list Adresses e-mail de tous les propriétaires directs et validés de cette propriété exacte. Les propriétaires indirects (par exemple, les propriétaires validés du domaine parent) ne sont pas inclus dans cette liste.
site object Conteneur pour l'adresse et le type d'un site validé ou qui sera validé.
site.identifier string Identifiant du site, qui se présente sous différentes formes selon la valeur de la propriété type.
site.type string Type de site.

Les valeurs autorisées sont les suivantes :
  • "ANDROID_APP": définissez identifier sur l'URL d'une application Android. Exemple : &android-app://com.google.android.youtube/"
  • "INET_DOMAIN : définissez identifier sur un nom de domaine. Exemples : "www.example.com", "example.com" ou "sous-domaine.example.com".
  • "SITE : définissez identifier sur une URL complète pour la racine de votre site, qui se termine par une barre oblique (/). Exemples : "https://www.example.com/"" ou "https://www.example.com/subsite/""

Méthodes

La méthode insert permet de valider la propriété authentifiée d'un site Web ou d'un domaine. Utilisez les méthodes getupdateet delete pour récupérer ou modifier une ressource qui a déjà été validée pour l'utilisateur authentifié.

La liste list vous permet de voir toutes les ressources validées de l'utilisateur authentifié. Vous pouvez également obtenir un jeton à placer sur le site de l'utilisateur authentifié à l'aide de getToken.

supprimer
Annule la propriété d'un site Web ou d'un domaine.
obtenir
Récupère les données les plus récentes pour un site Web ou un domaine.
getToken
Récupère un jeton de validation que l'utilisateur authentifié doit placer sur un site Web ou un domaine.
Insérer
Vérifie la propriété d'un site Web ou d'un domaine.
list
Récupère la liste des sites Web et des domaines validés de l'utilisateur.
mettre à jour
Modifie la liste des propriétaires d'un site Web ou d'un domaine.