Subscriptions

Mit der Mirror API können Sie Benachrichtigungen abonnieren, die gesendet werden, wenn der Nutzer bestimmte Aktionen in einem Zeitachsenelement ausführt oder der Nutzerstandort aktualisiert wurde.

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

Ressourcendarstellungen

Ein Abo für Ereignisse zu 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
  }
}

Property-Name	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 – Einstellungen wurden aktualisiert.	Bearbeitbar
id	string	Die ID des Abos.
kind	string	Der Ressourcentyp. Dies ist immer mirror#subscription.
notification	nested object	Containerobjekt für Benachrichtigungen. Wird in der Ressource Subscription nicht ausgefüllt.
notification.collection	string	Die Sammlung, von der die Benachrichtigung generiert wurde.
notification.itemId	string	Die ID des Artikels, von dem die Benachrichtigung generiert wurde.
notification.operation	string	Die Art des Vorgangs, der die Benachrichtigung generiert hat. Zulässige Werte sind: "DELETE" "INSERT" "MENU_ACTION" "UPDATE"
notification.userActions[]	list	Eine Liste der Aktionen des Nutzers, die die Benachrichtigung ausgelöst haben.
notification.userActions[].payload	string	Eine optionale Nutzlast für die Aktion. Bei Aktionen vom Typ CUSTOM ist dies die ID des benutzerdefinierten Menüelements, das ausgewählt wurde.
notification.userActions[].type	string	Die Art der Aktion. Folgende Werte sind möglich: SHARE: Der Nutzer hat ein Element freigegeben. REPLY: Der Nutzer hat auf einen Artikel geantwortet. REPLY_ALL: Der Nutzer hat allen Empfängern eines Elements geantwortet. CUSTOM: Der Nutzer hat einen benutzerdefinierten Menüpunkt 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 initiiert. . Zukünftig werden möglicherweise weitere Typen hinzugefügt. UserActions mit unbekannten 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 für die Sammlung abonniert werden. Zulässige Werte: UPDATE: Der Artikel wurde aktualisiert. INSERT: Ein neues Element wurde eingefügt. DELETE: Das Element wurde gelöscht.	Bearbeitbar
updated	datetime	Der Zeitpunkt, zu dem dieses Abonnement zuletzt geändert wurde, gemäß RFC 3339 formatiert.
userToken	string	Ein intransparentes Token, das in Benachrichtigungen an den Abonnenten gesendet wird, damit die ID des Nutzers ermittelt werden kann.	Bearbeitbar
verifyToken	string	Ein geheimes Token, das in Benachrichtigungen an den Abonnenten gesendet wird, um zu überprüfen, ob die Benachrichtigung von Google generiert wurde.	Bearbeitbar

Methoden

delete

Löscht ein Abo.

insert

Erstellt ein neues Abo.

list

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

Update

Aktualisiert ein bestehendes Abo.