Subscriptions

Interfejs Mirror API umożliwia subskrybowanie powiadomień, które są wysyłane, gdy użytkownik wykona określone działania na elemencie na osi czasu lub zaktualizujesz lokalizację użytkownika.

Listę metod dla tego zasobu znajdziesz na końcu tej strony.

Reprezentacje zasobów

Subskrypcja zdarzeń w kolekcji.

{
  "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
  }
}
Nazwa usługi Wartość Opis Uwagi
callbackUrl string Adres URL, na który mają być dostarczane powiadomienia (musi zaczynać się od https://). z możliwością zapisu
collection string Kolekcja, którą chcesz zasubskrybować. Dozwolone wartości to:
  • timeline – zmiany w osi czasu, w tym wstawianie, usuwanie i aktualizacje.
  • locations – aktualizacje lokalizacji.
  • settings – aktualizacje ustawień.
z możliwością zapisu
id string Identyfikator subskrypcji.
kind string Typ zasobu. To zawsze mirror#subscription.
notification nested object Obiekt kontenera na potrzeby powiadomień. To pole nie jest wypełniane w zasobie Subscription.
notification.collection string Kolekcja, która wygenerowała powiadomienie.
notification.itemId string Identyfikator elementu, który wygenerował powiadomienie.
notification.operation string Typ operacji, która wygenerowała powiadomienie.

Akceptowane wartości to:
  • DELETE
  • INSERT
  • MENU_ACTION
  • UPDATE
notification.userActions[] list Lista działań wykonanych przez użytkownika, które spowodowały wyświetlenie powiadomienia.
notification.userActions[].payload string Opcjonalny ładunek działania.

W przypadku działań typu CUSTOM jest to identyfikator wybranej pozycji menu niestandardowego.
notification.userActions[].type string Typ działania. Możliwe wartości:
  • SHARE – użytkownik udostępnił element.
  • REPLY – użytkownik odpowiedział na produkt.
  • REPLY_ALL – użytkownik odpowiedział wszystkim adresatom elementu.
  • CUSTOM – użytkownik wybrał niestandardowy element menu na osi czasu.
  • DELETE – użytkownik usunął element.
  • PIN – użytkownik przypiął element.
  • UNPIN – użytkownik odpiął element.
  • LAUNCH – użytkownik zainicjował polecenie głosowe.
W przyszłości możemy dodać więcej typów. Akcje użytkownika o nierozpoznanych typach powinny być ignorowane.
notification.userToken string Token użytkownika udostępniany przez usługę w momencie subskrybowania powiadomień.
notification.verifyToken string Tajny token weryfikacyjny udostępniany przez usługę, gdy subskrybowała powiadomienia.
operation[] list Lista operacji, które powinny być subskrybowane. Pusta lista wskazuje, że powinny być subskrybowane wszystkie operacje na kolekcji. Dozwolone wartości to:
  • UPDATE – produkt został zaktualizowany.
  • INSERT – wstawiono nowy element.
  • DELETE – element został usunięty.
z możliwością zapisu
updated datetime Data ostatniej modyfikacji subskrypcji podana w formacie RFC 3339.
userToken string Nieprzezroczysty token wysyłany do subskrybenta w powiadomieniach, aby mógł określić identyfikator użytkownika. z możliwością zapisu
verifyToken string Tajny token wysyłany do subskrybenta w powiadomieniach, aby mógł potwierdzić, że powiadomienie zostało wygenerowane przez Google. z możliwością zapisu

Metody

usuń
Usuwa subskrypcję.
wstaw
Tworzy nową subskrypcję.
list
Pobiera listę subskrypcji uwierzytelnionego użytkownika i usługi.
zaktualizuj
Aktualizuje istniejącą subskrypcję.