Timeline

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

Ressourcendarstellungen

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

{
  "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
  }
}
Attributname Wert Beschreibung Hinweise
attachments[] list Eine Liste der mit diesem Element verknüpften Medienanhänge. Der Einfachheit halber können Sie auf Anhänge in Ihren HTML-Nutzlasten mit dem Anhang- oder CID-Schema verweisen. Beispiel:
  • Anlage: <img src="attachment:attachment_index">, wobei Anhang_Index der 0-basierte Index dieses Arrays ist.
  • cid: <img src="cid:attachment_id">, wobei „attachment_id“ die ID des Anhangs ist
bundleId string Die Bundle-ID für diesen Artikel. Dienste können eine Bundle-ID angeben, um mehrere Elemente zu gruppieren. Sie werden unter einem einzelnen Element der obersten Ebene auf dem Gerät angezeigt. Bearbeitbar
canonicalUrl string Eine kanonische URL, die auf die kanonische/hochwertige Version der durch das Zeitachsenelement dargestellten Daten verweist. Bearbeitbar
created datetime Der Zeitpunkt, zu dem dieser Artikel erstellt wurde, formatiert gemäß RFC 3339.
creator nested object Der Nutzer oder die Gruppe, der bzw. die dieses Element erstellt hat. Bearbeitbar
displayTime datetime Die Zeit, die angezeigt werden soll, wenn dieses Element auf der Zeitachse angezeigt wird, formatiert gemäß RFC 3339. Die Zeitachse dieses Nutzers wird chronologisch nach der Anzeigezeit sortiert. Dadurch wird auch bestimmt, wo das Element in der Zeitachse angezeigt wird. Wenn dies nicht vom Dienst festgelegt ist, wird standardmäßig updated verwendet. Bearbeitbar
etag etag ETag für dieses Element.
html string HTML-Inhalt für dieses Element. Wenn sowohl text als auch html für ein Element angegeben werden, wird das html in der Zeitachse gerendert.

Zulässige HTML-Elemente: Diese Elemente können auf den Zeitachsenkarten verwendet werden.

  • Ü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 ihre Inhalte werden aus HTML-Nutzlasten entfernt.

  • Dokumentheader: head, title
  • Einbettungen: audio, embed, object, source, video
  • Rahmen: frame, frameset
  • Skripterstellung: applet, script

Andere Elemente: Alle nicht aufgeführten Elemente werden entfernt, ihr Inhalt bleibt jedoch erhalten.

Bearbeitbar
id string Die ID des Zeitachsenelements. Er ist innerhalb der Zeitachse eines Nutzers einmalig.
inReplyTo string Wenn dieses Element als Antwort auf ein anderes Element generiert wurde, wird in diesem Feld die ID des Elements festgelegt, auf das geantwortet wird. Hiermit können Sie eine Antwort an die entsprechende Unterhaltung oder den entsprechenden Beitrag anhängen.
isBundleCover boolean Gibt an, ob es sich bei diesem Artikel um ein Set handelt.

Wenn ein Element als Set gekennzeichnet ist, ist es der Einstiegspunkt für das Set mit Elementen, die dieselbe bundleId haben. Sie wird nur auf der Hauptzeitachse eingeblendet – nicht innerhalb des geöffneten Sets.

Auf der Hauptzeitachse werden folgende Elemente angezeigt:
  • Elemente mit isBundleCover, die auf true gesetzt sind
  • Elemente ohne bundleId
In einer Bundle-Unterzeitachse werden folgende Elemente angezeigt:
  • Elemente mit dem betreffenden bundleId UND isBundleCover auf false
Bearbeitbar
isDeleted boolean Wenn „true“ bedeutet, wird dieses Element gelöscht und nur die ID-Property festgelegt.
isPinned boolean Wenn dieser Wert wahr ist, wird dieses Element angepinnt, d. h., es wird zusammen mit „aktiven“ Elementen wie Navigation und Hangouts auf der gegenüberliegenden Seite des Startbildschirms von nicht angehefteten Zeitachsenelementen gruppiert. Sie können Nutzern erlauben, den Wert dieser Eigenschaft mit dem integrierten Menüelement TOGGLE_PINNED umzuschalten.
kind string Der Ressourcentyp. Das ist immer mirror#timelineItem.
location nested object Der geografische Standort, der diesem Element zugeordnet ist. Bearbeitbar
notification nested object Steuert, wie Benachrichtigungen für diesen Artikel auf dem Gerät dargestellt werden. Fehlt diese Angabe, wird keine Benachrichtigung erstellt. Bearbeitbar
notification.deliveryTime datetime Der Zeitpunkt, zu dem die Benachrichtigung gesendet werden soll. Bearbeitbar
notification.level string Beschreibt, wie wichtig die Benachrichtigung ist. Zulässige Werte sind:
  • DEFAULT: Standardbenachrichtigungen. Ein Glockenton wird abgespielt, um die Nutzer zu warnen.
Bearbeitbar
pinScore integer Bei angepinnten Elementen wird dadurch die Reihenfolge festgelegt, in der die Elemente auf der Zeitachse zu sehen sind. Je höher die Zahl, desto höher die Punktzahl. Hinweis: Das Festlegen dieses Felds wird derzeit nicht unterstützt.
recipients[] list Eine Liste der Nutzer oder Gruppen, für die das Element freigegeben wurde. Bearbeitbar
sourceItemId string Intransparenter String, den Sie verwenden können, um ein Zeitachsenelement Daten in Ihrem eigenen Dienst zuzuordnen. Bearbeitbar
speakableText string Die vorlesbare Version des Inhalts dieses Artikels. Verwenden Sie dieses Feld zusammen mit dem Menüpunkt READ_ALOUD, um Text anzugeben, der beim Vorlesen klarer wird, oder um zusätzliche Informationen zu den Elementen in Glass bereitzustellen.

Glassware sollte auch das Feld „SpeakableType“ angeben. Dieses wird vor diesem Text gesprochen, wenn der zusätzliche Kontext nützlich ist, z. B. wenn der Nutzer nach einer Benachrichtigung anfordert, dass der Artikel vorgelesen wird.
Bearbeitbar
speakableType string Eine gut lesbare Beschreibung des Typs dieses Elements. Dies wird dem Nutzer vor dem Lesen des Inhalts mitgeteilt, wenn der zusätzliche Kontext nützlich ist, z. B. wenn der Nutzer nach einer Benachrichtigung anfordert, dass der Artikel vorgelesen wird.

Das sollte eine kurze, einfache Nominalphrase sein, z. B. „E-Mail“, „SMS“ oder „Daily Planet News“.

Glassware wird empfohlen, dieses Feld für jedes Zeitachsenelement auszufüllen, auch wenn das Element keinen Sprecher oder Text enthält. So kann der Nutzer den Typ des Elements erkennen, ohne auf den Bildschirm zu sehen.
Bearbeitbar
text string Textinhalt dieses Artikels. Bearbeitbar
title string Der Titel dieses Artikels. Bearbeitbar
updated datetime Der Zeitpunkt, zu dem dieser Artikel zuletzt geändert wurde, gemäß RFC 3339 formatiert.

Methoden

Delete
Löscht ein Zeitachsenelement.
erhalten
Ruft ein einzelnes Zeitachsenelement nach ID ab.
Einfügen
Fügt ein neues Element in die Zeitachse ein.
list
Ruft eine Liste mit Zeitachsenelementen für den authentifizierten Nutzer ab.
Patch
Aktualisiert ein Zeitachsenelement. Diese Methode unterstützt die Patch-Semantik.
Aktualisieren
Aktualisiert ein Zeitachsenelement.