Timeline

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

Ressourcendarstellungen

Jedes Element auf der Zeitachse des Nutzers wird als TimelineItem-JSON-Struktur dargestellt, die unten beschrieben wird.

{
  "kind": "mirror#timelineItem",
  "id": string,
  "sourceItemId": string,
  "canonicalUrl": string,
  "bundleId": string,
  "isBundleCover": boolean,
  "selfLink": string,
  "created": datetime,
  "updated": datetime,
  "displayTime": datetime,
  "isPinned": boolean,
  "pinScore": integer,
  "isDeleted": boolean,
  "etag": etag,
  "creator": contacts Resource,
  "recipients": [
    contacts Resource
  ],
  "inReplyTo": string,
  "title": string,
  "text": string,
  "html": string,
  "speakableType": string,
  "speakableText": string,
  "attachments": [
    timeline.attachments Resource
  ],
  "location": locations Resource,
  "menuItems": [
    {
      "id": string,
      "action": string,
      "values": [
        {
          "state": string,
          "displayName": string,
          "iconUrl": string
        }
      ],
      "removeWhenSelected": boolean,
      "payload": string
    }
  ],
  "notification": {
    "level": string,
    "deliveryTime": datetime
  }
}
Property-Name Wert Beschreibung Hinweise
attachments[] list Eine Liste der Medienanhänge, die mit diesem Element verknüpft sind. Der Einfachheit halber können Sie mit dem Anhangs- oder cid-Schema auf Anhänge in Ihren HTML-Nutzlasten verweisen. Beispiel:
  • Anhang: <img src="attachment:attachment_index">, wobei Anhang_index der 0-basierte Index dieses Arrays ist
  • cid: <img src="cid:attachment_id">, wobei Anhang_ID die ID des Anhangs ist.
bundleId string Die Paket-ID für diesen Artikel. Dienste können eine Bundle-ID angeben, um mehrere Elemente zu gruppieren. Sie werden auf dem Gerät unter einem einzelnen Element auf der obersten Ebene angezeigt. Bearbeitbar
canonicalUrl string Eine kanonische URL, die auf die kanonische bzw. hochwertige Version der Daten verweist, die vom Zeitachsenelement repräsentiert werden. Bearbeitbar
created datetime Der Zeitpunkt, zu dem das Element erstellt wurde, gemäß RFC 3339 formatiert.
creator nested object Der Nutzer oder die Gruppe, die dieses Element erstellt hat. Bearbeitbar
displayTime datetime Die Zeit, die angezeigt werden soll, wenn dieses Element in der Zeitachse angezeigt wird, formatiert gemäß RFC 3339. Die Zeitachse dieses Nutzers ist nach Anzeigezeit chronologisch sortiert. Dadurch wird auch festgelegt, wo das Element in der Zeitachse angezeigt wird. Wenn der Dienst nicht festgelegt wurde, wird standardmäßig die Anzeigezeit updated verwendet. Bearbeitbar
etag etag ETag für dieses Element.
html string HTML-Inhalt für dieses Element. Wenn für ein Element sowohl text als auch html angegeben werden, wird html auf der Zeitachse gerendert.

Zulässige HTML-Elemente: Sie können diese Elemente in Ihren Zeitachsenkarten verwenden.

  • Überschriften: h1, h2, h3, h4, h5, h6
  • Bilder: img
  • Listen: li, ol, ul
  • HTML5-Semantik: article, aside, details, figure, figcaption, footer, header, nav, section, summary, time
  • Strukturell: blockquote, br, div, hr, p, span
  • Stil: b, big, center, em, i, u, s, small, strike, strong, style, sub, sup
  • Tabellen: table, tbody, td, tfoot, th, thead, tr

Blockierte HTML-Elemente: Diese Elemente und ihr Inhalt werden aus HTML-Nutzlasten entfernt.

  • Dokumentüberschriften: head, title
  • Einbettungen: audio, embed, object, source, video
  • Rahmen: frame, frameset
  • Scripting: applet, script

Andere Elemente: Nicht aufgeführte Elemente werden entfernt, ihr Inhalt bleibt jedoch erhalten.

Bearbeitbar
id string Die ID des Zeitachsenelements. Dies ist innerhalb der Zeitachse eines Nutzers eindeutig.
inReplyTo string Wenn dieser Artikel als Antwort auf einen anderen Artikel erstellt wurde, enthält dieses Feld die ID des Artikels, auf den geantwortet wird. Hiermit kann eine Antwort an die entsprechende Unterhaltung oder den entsprechenden Beitrag angehängt werden.
isBundleCover boolean Gibt an, ob es sich bei diesem Artikel um eine Set-Abdeckung handelt.

Wenn ein Artikel als Set-Cover markiert ist, ist er der Einstiegspunkt für das Set mit Artikeln, die dieselbe bundleId haben wie dieser Artikel. Sie wird nur auf der Hauptzeitachse angezeigt, nicht im geöffneten Set.

Auf der Hauptzeitachse werden folgende Elemente angezeigt:
  • Elemente, für die „isBundleCover“ auf „true“ festgelegt ist
  • Artikel ohne bundleId
In einer Paket-Unterzeitachse werden folgende Elemente angezeigt:
  • Artikel, bei denen die betreffende bundleId UND isBundleCover auf false festgelegt ist
Bearbeitbar
isDeleted boolean Wenn wahr, bedeutet das, dass dieses Element gelöscht wurde und nur die ID-Eigenschaft festgelegt ist.
isPinned boolean Wenn „true“ festgelegt ist, ist dieses Element angepinnt, d. h., es ist neben „Aktiv“ gruppiert Elemente wie Navigation und Hangouts auf der gegenüberliegenden Seite des Startbildschirms von historischen (nicht angepinnten) Zeitachsenelementen. Mit dem integrierten Menüpunkt TOGGLE_PINNED können Sie dem Nutzer erlauben, den Wert dieser Eigenschaft zu ändern.
kind string Der Ressourcentyp. Dies ist immer mirror#timelineItem.
location nested object Der mit diesem Element verknüpfte geografische Standort. Bearbeitbar
notification nested object Steuert, wie Benachrichtigungen für dieses Element auf dem Gerät angezeigt werden. Fehlt diese Angabe, wird keine Benachrichtigung generiert. Bearbeitbar
notification.deliveryTime datetime Der Zeitpunkt, zu dem die Benachrichtigung zugestellt werden soll. Bearbeitbar
notification.level string Beschreibt, wie wichtig die Benachrichtigung ist. Zulässige Werte:
  • DEFAULT: Benachrichtigungen von standardmäßiger Wichtigkeit. Nutzer werden durch einen Glockenton gewarnt.
Bearbeitbar
pinScore integer Bei angepinnten Elementen wird dadurch die Reihenfolge festgelegt, in der das Element auf der Zeitachse angezeigt wird, wobei eine höhere Punktzahl näher an der Uhr erscheint. Hinweis: Das Festlegen dieses Feldes wird derzeit nicht unterstützt.
recipients[] list Eine Liste der Nutzer oder Gruppen, für die dieses Element freigegeben wurde. Bearbeitbar
sourceItemId string Undurchsichtiger String, mit dem Sie ein Zeitachsenelement Daten in Ihrem eigenen Dienst zuordnen können. Bearbeitbar
speakableText string Die vorlesbare Version des Inhalts dieses Elements. Verwenden Sie dieses Feld zusammen mit dem Menüpunkt READ_ALOUD für Text, der beim Vorlesen klarer ist, oder um ausführlichere Informationen zu dem zu geben, was auf Glass angezeigt wird.

Glassware sollte außerdem das Feld „SpeakableType“ angeben, das vor diesem Text vorgelesen wird, wenn der zusätzliche Kontext nützlich ist, z. B. wenn der Nutzer das Vorlesen des Elements nach einer Benachrichtigung anfordert.
Bearbeitbar
speakableType string Eine vorlesbare Beschreibung des Elementtyps. Dies wird dem Nutzer vor dem Lesen des Inhalts angezeigt, wenn der zusätzliche Kontext nützlich ist, z. B. wenn der Nutzer anfordert, dass der Artikel nach einer Benachrichtigung vorgelesen wird.

Dies sollte eine kurze, einfache Wortgruppe wie „Email“, „SMS“ oder „Daily Planet News Update“ sein.

Glassware wird empfohlen, dieses Feld für jedes Zeitachsenelement auszufüllen, auch wenn das Element keinen speechableText oder Text enthält. So können Nutzer den Typ des Elements kennenlernen, ohne auf den Bildschirm sehen zu müssen.
Bearbeitbar
text string Textinhalt dieses Elements. Bearbeitbar
title string Der Titel dieses Elements. Bearbeitbar
updated datetime Der Zeitpunkt, zu dem dieses Element zuletzt geändert wurde, gemäß RFC 3339 formatiert

Methoden

Delete
Löscht ein Zeitachsenelement.
get
Ruft ein einzelnes Zeitachsenelement nach ID ab.
insert
Ein neues Element wird in die Zeitachse eingefügt.
list
Ruft eine Liste mit Zeitachsenelementen für den authentifizierten Nutzer ab.
patch
Aktualisiert ein Zeitachsenelement. Diese Methode unterstützt die Patch-Semantik.
Update
Aktualisiert ein Zeitachsenelement.