Subscriptions

API-интерфейс Mirror позволяет подписаться на уведомления , которые отправляются, когда пользователь выполняет определенные действия с элементом временной шкалы или когда местоположение пользователя обновляется.

Список методов для этого ресурса см. в конце этой страницы.

Представления ресурсов

Подписка на события в коллекции.

{
  "kind": "mirror#subscription",
  "id": string,
  "updated": datetime,
  "collection": string,
  "operation": [
    string
  ],
  "callbackUrl": string,
  "verifyToken": string,
  "userToken": string,
  "notification": {
    "collection": string,
    "itemId": string,
    "operation": string,
    "userActions": [
      {
        "type": string,
        "payload": string
      }
    ],
    "verifyToken": string,
    "userToken": string
  }
}
Имя свойства Ценить Описание Примечания
callbackUrl string URL-адрес, по которому должны быть доставлены уведомления (должен начинаться с https:// ). доступный для записи
collection string Коллекция, на которую нужно подписаться. Допустимые значения:
  • timeline — изменения на временной шкале, включая вставку, удаление и обновление.
  • locations - Обновления локаций.
  • settings - обновления настроек.
 доступный для записи
id string Идентификатор подписки.
kind string Тип ресурса. Это всегда mirror#subscription .
notification nested object Объект-контейнер для уведомлений. Это не заполняется в ресурсе Subscription .
notification. collection string Коллекция, создавшая уведомление.
notification. itemId string Идентификатор элемента, сгенерировавшего уведомление.
notification. operation string Тип операции, создавшей уведомление.

Допустимые значения:
  • " DELETE "
  • " INSERT "
  • " MENU_ACTION "
  • " UPDATE "
notification. userActions[] list Список действий, предпринятых пользователем, которые вызвали уведомление.
notification.userActions[]. payload string Необязательная полезная нагрузка для действия.

Для действий типа CUSTOM это идентификатор выбранного пользовательского пункта меню.
notification.userActions[]. type string Тип действия. Значение этого может быть:
  • SHARE - пользователь поделился элементом.
  • REPLY - пользователь ответил на элемент.
  • REPLY_ALL — пользователь ответил всем получателям сообщения.
  • CUSTOM — пользователь выбрал пользовательский пункт меню на временной шкале.
  • DELETE — пользователь удалил элемент.
  • PIN — пользователь закрепил элемент.
  • UNPIN — пользователь открепил элемент.
  • LAUNCH — пользователь инициировал голосовую команду.
В будущем могут быть добавлены дополнительные типы. UserActions с нераспознанными типами следует игнорировать.
notification. userToken string Маркер пользователя, предоставленный службой при подписке на уведомления.
notification. verifyToken string Секретный токен подтверждения, предоставленный службой при подписке на уведомления.
operation[] list Список операций, на которые следует подписаться. Пустой список указывает, что на все операции над коллекцией следует подписаться. Допустимые значения:
  • UPDATE - Товар обновлен.
  • INSERT — вставлен новый элемент.
  • DELETE — элемент удален.
 доступный для записи
updated datetime Время последнего изменения этой подписки, отформатированное в соответствии с RFC 3339.
userToken string Непрозрачный токен, отправляемый подписчику в уведомлениях, чтобы он мог определить ID пользователя. доступный для записи
verifyToken string Секретный токен, отправляемый подписчику в уведомлениях, чтобы он мог убедиться, что уведомление было сгенерировано Google. доступный для записи

Методы

удалить
Удаляет подписку.
вставлять
Создает новую подписку.
список
Извлекает список подписок для аутентифицированного пользователя и службы.
обновлять
Обновляет существующую подписку на месте.