Subscriptions

Interfejs Mirror API umożliwia subskrypcję powiadomień wysyłanych, gdy użytkownik wykona określone działania na elemencie osi czasu lub zostanie zaktualizowana jego lokalizacja.

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

Reprezentacje zasobów

Subskrypcja wydarzeń z 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://). zapisywalny
collection string Kolekcja, którą chcesz zasubskrybować. Dozwolone wartości to:
  • timeline – zmiany na osi czasu, w tym wstawianie, usuwanie i aktualizacje.
  • locations – aktualizacje lokalizacji.
  • settings – ustawienia.
 zapisywalny
id string Identyfikator subskrypcji.
kind string Typ zasobu. To jest zawsze mirror#subscription.
notification nested object Obiekt kontenera na potrzeby powiadomień. Ta wartość nie jest wypełniana 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 wywołała powiadomienie.

Akceptowane wartości:
  • „DELETE”
  • „INSERT”
  • „MENU_ACTION”
  • „UPDATE”
notification.userActions[] list Lista działań użytkownika, którzy wywołali powiadomienie.
notification.userActions[].payload string Opcjonalny ładunek dla działania.

W przypadku działań typu CUSTOM jest to identyfikator wybranej pozycji menu niestandardowego.
notification.userActions[].type string Typ działania. Oto możliwe wartości:
  • SHARE – użytkownik udostępnił element.
  • REPLY – użytkownik odpowiedział na pytanie.
  • REPLY_ALL – użytkownik odpowiedział na wszystkich odbiorców elementu.
  • CUSTOM – użytkownik wybrał element menu niestandardowego na pozycji osi czasu.
  • DELETE – użytkownik usunął element.
  • PIN – użytkownik przypiął element.
  • UNPIN – użytkownik odpiął element
  • LAUNCH – użytkownik uruchomił polecenie głosowe.
W przyszłości możemy dodać więcej typów. Działania użytkownika z nierozpoznanym typem należy zignorować.
notification.userToken string Token użytkownika podany przez usługę, gdy zasubskrybował powiadomienia.
notification.verifyToken string Tajny token weryfikacyjny przekazany przez usługę, gdy zasubskrybował powiadomienia.
operation[] list Lista operacji, które należy zasubskrybować. Pusta lista oznacza, że wszystkie działania w kolekcji powinny być subskrybowane. Dozwolone wartości to:
  • UPDATE – element został zaktualizowany.
  • INSERT – wstawiono nowy element.
  • DELETE – element został usunięty.
 zapisywalny
updated datetime Data ostatniej modyfikacji tej subskrypcji, zgodnie z RFC 3339.
userToken string Nieprzejrzysty token wysyłany do subskrybenta w celu określenia identyfikatora użytkownika. zapisywalny
verifyToken string Tajny token wysyłany do subskrybenta w powiadomieniach, aby mógł on sprawdzić, czy powiadomienie zostało wygenerowane przez Google. zapisywalny

Metody

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