В этом документе описывается, как использовать Google Site Verification API.
Вызов API
Формат запроса
Большинство поддерживаемых операций Site Verification сопоставляются непосредственно с HTTP-командами REST ( GET
, POST
, PUT
, DELETE
), как описано в разделе « Операции Google Site Verification API ».
Конкретный формат для URI Google Site Verification API:
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
Формат данных
Google Site Verification API возвращает данные в формате JSON.
JSON (нотация объектов JavaScript) — это распространенный независимый от языка формат данных, обеспечивающий простое текстовое представление произвольных структур данных. Для получения дополнительной информации см. json.org .
Сводка операций
Вы можете вызывать шесть различных методов для коллекций и ресурсов в Google Site Verification API, как описано в следующей таблице. URL-адреса API относятся к https://www.googleapis.com/siteVerification/v1
.
Операция | Описание | URL-адрес и синтаксис |
---|---|---|
список | Список всех ресурсов в коллекции пользователя, прошедшего проверку подлинности. | См. пример запроса списка . |
вставлять | Проверяет сайт или домен. В случае успеха вставляет новый веб-ресурс в коллекцию пользователя. Тело запроса: см. Веб-ресурс . Параметр запроса: | |
получить | Получает последние данные для определенного веб-ресурса. | |
Обновить | Изменяет список владельцев для определенного ресурса. Тело запроса: см. Веб-ресурс . Заметки:
| |
Удалить | Удаляет ресурс из коллекции пользователя (не проверяет, принадлежит ли сайт пользователю).
| |
получитьтокен | Получает маркер проверки для размещения на веб-сайте пользователя, прошедшего проверку подлинности. Тело запроса:
| См. пример запроса getToken . |
Примеры вызовов API
В этом разделе предполагается, что вы (разработчик) также являетесь аутентифицированным пользователем, как в случае, когда вы впервые пробуете API со своими собственными тестовыми данными.
Подтвердить новый сайт
Чтобы подтвердить сайт,
- Сначала запросите токен подтверждения, вызвав getToken .
- Разместите токен на своем сайте любым удобным для вас способом.
- Попросите 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 (без содержимого), указывающий на успех.