Вызов API

В этом документе описывается, как использовать API проверки сайта Google.

Вызов API

Формат запроса

Большинство поддерживаемых операций проверки сайта сопоставляются непосредственно с HTTP-глаголами REST ( GET , POST , PUT , DELETE ), как описано в разделе «Операции API проверки сайта Google» .

Конкретный формат URI API проверки сайта Google:

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

где resourceID — это идентификатор веб-ресурса, parameters — это любые параметры, которые можно применить к запросу. Фактические параметры, которые вы используете, различаются в зависимости от того, какую операцию вы выполняете. Кроме того, если вы используете OAuth 2.0, вам следует установить в этих параметрах access_token .

Для запросов к списку не требуется идентификатор ресурса , поэтому формат следующий:

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

Вы можете вызывать операцию getToken по ее собственному уникальному URI. Формат вызова getToken :

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

Формат данных

API проверки сайта Google возвращает данные в формате JSON.

JSON (нотация объектов JavaScript) — это распространенный, независимый от языка формат данных, который обеспечивает простое текстовое представление произвольных структур данных. Для получения дополнительной информации посетите json.org .

Сводка операций

Вы можете вызвать шесть различных методов для коллекций и ресурсов в API проверки сайта Google, как описано в следующей таблице. URL-адреса API указаны относительно https://www.googleapis.com/siteVerification/v1 .

Операция Описание URL и синтаксис
список

Перечисляет все ресурсы в коллекции прошедшего проверку подлинности пользователя.

GET /webResource

См. пример запроса списка .

вставлять

Проверяет сайт или домен. В случае успеха вставляет новый веб-ресурс в коллекцию пользователя.

Тело запроса: см. веб-ресурс .

Параметр запроса: verificationMethod . Метод проверки , используемый для этого запроса. Возможные значения: FILE , META , ANALYTICS , TAG_MANAGER , DNS_TXT , DNS_CNAME

POST /webResource

См. пример запроса на вставку .

получать

Получает последние данные для определенного веб-ресурса.

GET /webResource/ resourceID

См. пример запроса на получение

обновлять

Изменяет список владельцев конкретного ресурса.

Тело запроса: см. веб-ресурс .

Примечания:

  • Вы не можете удалить аутентифицированного пользователя из списка владельцев с помощью update . Вместо этого используйте удаление .
  • Вы можете удалить из списка владельцев любого пользователя, у которого нет проверочного токена на сайте.

PUT /webResource/ resourceID

См. пример запроса на обновление .

удалить

Удаляет ресурс из коллекции пользователя (отменяет проверку принадлежности сайта пользователю).

Примечания:

  • Прежде чем вызывать delete , необходимо сначала удалить все токены проверки аутентифицированного пользователя с сайта или домена. Если какие-либо токены все еще существуют, возвращается ошибка HTTP 400 (неверный запрос).
  • Удаление влияет только на данные о владельце для аутентифицированного пользователя. Все остальные пользователи, независимо от того, были ли они делегированы или проверены независимо, сохраняют право собственности после удаления.

DELETE /webResource/ resourceID

См. пример запроса на удаление .

получить токен

Получает токен проверки для размещения на веб-сайте пользователя, прошедшего проверку подлинности.

Тело запроса:

  • identifier : URL-адрес сайта или имя домена.
  • type : тип ресурса для проверки. Возможные значения: SITE , INET_DOMAIN .
  • verificationMethod : метод, используемый при проверке вашего сайта. Возможные значения: FILE , META , ANALYTICS , TAG_MANAGER , DNS_TXT , DNS_CNAME

POST /token

См. пример запроса getToken .

Пример вызовов API

В этом разделе предполагается, что вы (разработчик) также являетесь аутентифицированным пользователем, как это было бы в случае, когда вы впервые опробуете API со своими собственными тестовыми данными.

Подтвердить новый сайт

Чтобы подтвердить сайт,

  1. Сначала запросите токен проверки, вызвав getToken .
  2. Разместите токен на своем сайте любым удобным для вас способом.
  3. Попросите Google подтвердить, что сайт принадлежит вам, используя операцию вставки .

getToken ( требуется авторизация )

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

Запрос:

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

Ответ:

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

Вставить ( требуется авторизация )

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

Запрос:

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

Ответ:

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

Получить информацию о проверенных веб-ресурсах

Полный список проверенных вами сайтов и доменов можно получить, вызвав list . Вы можете получить информацию об одном веб-ресурсе, вызвав get .

Список ( требуется авторизация )

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

Запрос:

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

Ответ:

{
  "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 https://www.googleapis.com/siteVerification/v1/webResource/http%3A%2F%2Fwww.example.com%2F?access_token= oauth2-token

Запрос: 

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

Ответ: 

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

Изменить проверочную информацию

Вы можете делегировать и отозвать право собственности, вызвав update . Вы можете лишить себя права собственности, вызвав delete .

Обновление ( требуется авторизация )

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

Запрос: 

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

Ответ: 

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

Удалить ( требуется авторизация )

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

Запрос: 

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

Ответ:

Код состояния HTTP 204 (нет контента), указывающий на успех.