Cette page a été traduite par l'API Cloud Translation.

Appeler l'API

Ce document explique comment utiliser l'API Google Site Verification.

Appeler l'API

Format de requête

La plupart des opérations de validation de site compatibles sont mappées directement à des verbes HTTP REST (GET, POST, PUT, DELETE), comme décrit dans la section Opérations de l'API Google Site Verification.

Le format spécifique des URI de l'API Google Site Verification est le suivant:

https://www.googleapis.com/siteVerification/v1/webResource/resourceID?parameters

où resourceID est l'identifiant d'une ressource Web, et parameters correspond aux paramètres à appliquer à la requête. Les paramètres réels à utiliser varient en fonction de l'opération que vous effectuez. De plus, si vous utilisez OAuth 2.0, vous devez définir access_token dans ces paramètres.

Les requêtes de liste ne nécessitent pas de resourceID. Le format est donc le suivant:

https://www.googleapis.com/siteVerification/v1/webResource?parameters

Vous pouvez appeler l'opération getToken via son propre URI unique. Le format d'un appel à getToken est le suivant:

https://www.googleapis.com/siteVerification/v1/token?parameters

Format des données

L'API Google Site Verification renvoie les données au format JSON.

JSON (JavaScript Object Notation) est un format de données qui ne dépend pas d'un langage et qui fournit une représentation textuelle simple de structures de données arbitraires. Pour en savoir plus, accédez à json.org.

Résumé des opérations

Vous pouvez appeler six méthodes différentes sur les collections et les ressources dans l'API Google Site Verification, comme décrit dans le tableau suivant. Les URL de l'API sont relatives à https://www.googleapis.com/siteVerification/v1.

Opération	Description	URL et syntaxe
liste	Répertorie toutes les ressources de la collection de l'utilisateur authentifié.	`GET /webResource` Consultez l'exemple de requête list.
insérer	Vérifie un site ou un domaine. Si l'opération réussit, insère une nouvelle ressource Web dans la collection de l'utilisateur. Corps de la requête: consultez la page Ressource Web. Paramètre de requête: `verificationMethod`. Méthode de validation à utiliser pour cette requête. Valeurs possibles: `FILE`, `META`, `ANALYTICS`, `TAG_MANAGER`, `DNS_TXT`, `DNS_CNAME`	`POST /webResource` Consultez l'exemple de requête insert.
get	Récupère les données les plus récentes pour une ressource Web spécifique.	`GET /webResource/resourceID` Consultez l'exemple de requête get.
mise à jour	Modifie la liste des propriétaires d'une ressource spécifique. Corps de la requête: consultez la page Ressource Web. Remarques : Vous ne pouvez pas supprimer l'utilisateur authentifié de la liste des propriétaires à l'aide de la commande update. Utilisez plutôt delete. Vous pouvez supprimer de la liste des propriétaires tout utilisateur ne disposant pas d'un jeton de validation sur le site.	`PUT /webResource/resourceID` Consultez l'exemple de requête de mise à jour.
supprimer	Supprime une ressource de la collection de l'utilisateur (ne vérifie pas que le site appartient à l'utilisateur). Remarques: Vous devez d'abord supprimer tous les jetons de validation de l'utilisateur authentifié du site ou du domaine avant d'appeler la méthode delete. Si des jetons existent encore, une erreur HTTP 400 (Requête incorrecte) est renvoyée. La suppression n'affecte que les données de propriété de l'utilisateur authentifié. Tous les autres utilisateurs, qu'ils aient été délégués ou validés indépendamment, conservent la propriété après la suppression.	`DELETE /webResource/resourceID` Consultez l'exemple de requête delete.
getToken	Récupère le jeton de validation à placer sur le site Web de l'utilisateur authentifié. Corps de la requête : `identifier`: URL du site ou nom de domaine. `type`: type de ressource à vérifier. Valeurs possibles: `SITE`, `INET_DOMAIN`. `verificationMethod`: méthode à utiliser lors de la validation de votre site. Valeurs possibles: `FILE`, `META`, `ANALYTICS`, `TAG_MANAGER`, `DNS_TXT`, `DNS_CNAME`	`POST /token` Consultez l'exemple de requête getToken.

Exemples d'appels d'API

Dans cette section, nous partons du principe que vous (le développeur) êtes également l'utilisateur authentifié, ce qui est le cas lorsque vous essayez d'abord l'API avec vos propres données de test.

Valider un nouveau site

Pour valider un site :

Commencez par demander un jeton de validation en appelant getToken.
Placez le jeton sur votre site en utilisant la méthode de votre choix.
Demandez à Google de confirmer que le site vous appartient, en utilisant l'opération insert.

getToken (autorisation requise)

POST https://www.googleapis.com/siteVerification/v1/token?access_token=oauth2-token

Requête :

POST https://www.googleapis.com/siteVerification/v1/token?access_token=oauth2-token
Content-Type: application/json

{
  "verificationMethod": "FILE",
  "site": {
    "identifier": "http://www.example.com",
    "type": "SITE"
  }
}

Solution :

{
  "token": "google12cfc68677988bb4.html",
  "method": "FILE"
}

Insérer (autorisation requise)

POST https://www.googleapis.com/siteVerification/v1/webResource?verificationMethod=FILE&access_token=oauth2-token

Requête :

POST https://www.googleapis.com/siteVerification/v1/webResource?verificationMethod=FILE&access_token=oauth2-token
Content-Type: application/json

{
  "site": {
    "identifier": "http://www.example.com",
    "type": "SITE"
  }
}

Solution :

{
  "owners": [
    "myself@example.com",
  ],
  "id": "http%3A%2F%2Fwww.example.com%2F",
  "site": {
    "identifier": "http://www.example.com/",
    "type": "SITE"
  }
}

Récupérer des informations sur des ressources Web validées

Pour récupérer la liste complète de vos sites et domaines validés, appelez la méthode list. Vous pouvez récupérer des informations concernant une seule ressource Web en appelant get.

Liste (autorisation requise)

GET https://www.googleapis.com/siteVerification/v1/webResource?access_token=oauth2-token

Requête :

GET https://www.googleapis.com/siteVerification/v1/webResource?access_token=oauth2-token

Solution :

{
  "items": [
    {
      "owners": [
        "myself@example.com",
      ],
      "id": "http%3A%2F%2Fwww.example.com%2F",
      "site": {
        "identifier": "http://www.example.com/site1",
        "type": "SITE"
      }
    },
    {
      "owners": [
        "myself@example.com",
      ],
      "id": "http%3A%2F%2Fwww.example.com%2F",
      "site": {
        "identifier": "http://www.example.com/site2",
        "type": "SITE"
      }
    }
  ]
}

Obtenir (autorisation requise)

GET https://www.googleapis.com/siteVerification/v1/webResource/http%3A%2F%2Fwww.example.com%2F?access_token=oauth2-token

Requête :

GET https://www.googleapis.com/siteVerification/v1/webResource/http%3A%2F%2Fwww.example.com%2F?access_token=oauth2-token

Solution :

{
  "owners": [
    "myself@example.com",
  ],
  "id": "http%3A%2F%2Fwww.example.com%2F",
  "site": {
    "identifier": "http://www.example.com/",
    "type": "SITE"
  }
}

Modifier les informations de validation

Vous pouvez déléguer et révoquer la propriété en appelant update. Vous pouvez supprimer vos droits de propriété en appelant la méthode delete.

Mise à jour (autorisation requise)

PUT https://www.googleapis.com/siteVerification/v1/webResource/http%3A%2F%2Fwww.example.com%2F?access_token=oauth2-token

Requête :

PUT https://www.googleapis.com/siteVerification/v1/webResource/http%3A%2F%2Fwww.example.com%2F?access_token=oauth2-token
Content-Type: application/json

{
  "owners": [
    "myself@example.com",
    "another@example.com",
  ],
  "id": "http%3A%2F%2Fwww.example.com%2F",
  "site": {
    "identifier": "http://www.example.com",
    "type": "SITE"
  }
}

Solution :

{
  "owners": [
    "myself@example.com",
    "another@example.com",
  ],
  "id": "http%3A%2F%2Fwww.example.com%2F",
  "site": {
    "identifier": "http://www.example.com/",
    "type": "SITE"
  }
}

Supprimer (autorisation requise)

DELETE https://www.googleapis.com/siteVerification/v1/webResource/http%3A%2F%2Fwww.example.com%2F?access_token=oauth2-token

Requête :

DELETE https://www.googleapis.com/siteVerification/v1/webResource/http%3A%2F%2Fwww.example.com%2F?access_token=oauth2-token

Solution :

Code d'état HTTP 204 (Aucun contenu), indiquant la réussite de l'opération.