Invoking the API

Invoking the API

Request format

Most of the supported Site Verification operations map directly to REST HTTP verbs (GET, POST, PUT, DELETE), as described in Google Site Verification API operations.

The specific format for Google Site Verification API URIs are:

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

where resourceID is the identifier for a web resource, parameters are any parameters to apply to the query. The actual parameters you use varies depending on which operation you are performing. Additionally, if you are using OAuth 2.0, you should set access_token in these parameters.

List queries do not require a resourceID, so the format is:

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

You can make calls to the getToken operation by its own unique URI. The format for a call to getToken is:

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

Data format

The Google Site Verification API returns data in JSON format.

JSON (JavaScript Object Notation) is a common, language-independent data format that provides a simple text representation of arbitrary data structures. For more information, see json.org.

Operations summary

You can invoke six different methods on collections and resources in the Google Site Verification API, as described in the following table. The API URLs are relative to https://www.googleapis.com/siteVerification/v1.

Example API calls

This section assumes that you (the developer) are also the authenticated user, as would be the case when you first try out the API with your own test data.

Verify a new site

To verify a site,

1. First request a verification token by calling getToken.
2. Place the token on your site using whatever method you choose.
3. Ask Google to verify that the site is yours, using the insert operation.

getToken (requires authorization)

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

Request:

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"
  }
}

Response:

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

Insert (requires authorization)

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

Request:

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"
  }
}

Response:

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

Retrieve information for verified web resources

You can retrieve the full list of your verified sites and domains by calling list. You can retrieve information for a single web resource by calling get.

List (requires authorization)

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

Request:

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

Response:

{
  "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"
      }
    }
  ]
}

Get (requires authorization)

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

Request:

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

Response:

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

Modify verification information

You can delegate and revoke ownership by calling update. You can remove ownership for yourself by calling delete.

Update (requires authorization)

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

Request:

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"
  }
}

Response:

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

Delete (requires authorization)

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

Request:

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

Response:

HTTP 204 (No Content) status code, indicating success.