Subscriptions

Mit der Mirror API können Sie Benachrichtigungen abonnieren, die gesendet werden, wenn der Nutzer bestimmte Aktionen auf einer Zeitachse ausführt oder wenn der Standort des Nutzers aktualisiert wurde.

Am Ende dieser Seite finden Sie eine Liste der Methoden für diese Ressource.

Ressourcendarstellungen

Ein Abo für Ereignisse in einer Sammlung.

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

Attributname	Wert	Beschreibung	Hinweise
callbackUrl	string	Die URL, an die Benachrichtigungen gesendet werden sollen (muss mit https:// beginnen).	Bearbeitbar
collection	string	Die Sammlung, die abonniert werden soll. Zulässige Werte: timeline: Änderungen in der Zeitachse, einschließlich Einfügen, Löschen und Aktualisierungen locations: Standortaktualisierungen. settings: Änderungen an den Einstellungen.	Bearbeitbar
id	string	Die ID des Abos.
kind	string	Der Ressourcentyp. Das ist immer mirror#subscription.
notification	nested object	Containerobjekt für Benachrichtigungen. Dies wird in der Ressource Subscription nicht ausgefüllt.
notification.collection	string	Die Sammlung, die die Benachrichtigung generiert hat.
notification.itemId	string	Die ID des Elements, das die Benachrichtigung generiert hat.
notification.operation	string	Die Art des Vorgangs, der die Benachrichtigung generiert hat. Folgende Werte sind zulässig: „DELETE“ „INSERT“ „MENU_ACTION“ „UPDATE“
notification.userActions[]	list	Eine Liste der Aktionen des Nutzers, der die Benachrichtigung ausgelöst hat.
notification.userActions[].payload	string	Eine optionale Nutzlast für die Aktion. Bei Aktionen vom Typ CUSTOM ist dies die ID des ausgewählten benutzerdefinierten Menüs.
notification.userActions[].type	string	Die Art der Aktion. Mögliche Werte sind: SHARE: Der Nutzer hat ein Element freigegeben. REPLY: Der Nutzer hat auf ein Element geantwortet. REPLY_ALL: Der Nutzer hat allen Empfängern eines Elements geantwortet. CUSTOM: Der Nutzer hat ein benutzerdefiniertes Menüelement auf der Zeitachse ausgewählt. DELETE: Der Nutzer hat das Element gelöscht. PIN: Der Nutzer hat das Element angepinnt. UNPIN: Der Nutzer hat das Element losgelöst. LAUNCH: Der Nutzer hat einen Sprachbefehl gestartet. In Zukunft werden möglicherweise weitere Typen hinzugefügt. UserActions mit nicht erkannten Typen sollten ignoriert werden.
notification.userToken	string	Das Nutzertoken, das vom Dienst beim Abonnieren von Benachrichtigungen bereitgestellt wurde.
notification.verifyToken	string	Das geheime Bestätigungstoken, das vom Dienst beim Abonnieren von Benachrichtigungen bereitgestellt wurde.
operation[]	list	Eine Liste der Vorgänge, die abonniert werden sollten. Bei einer leeren Liste müssen alle Vorgänge in der Sammlung abonniert werden. Zulässige Werte: UPDATE: Das Element wurde aktualisiert. INSERT: Ein neues Element wurde eingefügt. DELETE: Das Element wurde gelöscht.	Bearbeitbar
updated	datetime	Der Zeitpunkt, zu dem dieses Abo zuletzt geändert wurde, formatiert gemäß RFC 3339.
userToken	string	Ein intransparentes Token, das in Benachrichtigungen an den Abonnenten gesendet wird, damit es die ID des Nutzers ermitteln kann.	Bearbeitbar
verifyToken	string	Ein geheimes Token, das in Benachrichtigungen an den Abonnenten gesendet wird, damit überprüft werden kann, ob die Benachrichtigung von Google generiert wurde.	Bearbeitbar

Methoden

Delete

Abo wird gelöscht.

Einfügen

Erstellt ein neues Abo.

list

Ruft eine Liste der Abos für den authentifizierten Nutzer und Dienst ab.

Aktualisieren

Aktualisiert ein bestehendes Abo.