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:
|
|
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.
Blockierte HTML-Elemente: Diese Elemente und ihr Inhalt werden aus HTML-Nutzlasten entfernt.
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:
|
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 |
menuItems[] |
list |
Eine Liste von Menüpunkten, die dem Nutzer angezeigt werden, wenn dieses Element in der Zeitachse ausgewählt wird. | Bearbeitbar |
menuItems[].action |
string |
Steuert das Verhalten, wenn der Nutzer die Menüoption auswählt. Zulässige Werte:
|
Bearbeitbar |
menuItems[].id |
string |
Die ID für diesen Menüpunkt. Dieses wird von der Anwendung generiert und als intransparentes Token behandelt. | Bearbeitbar |
menuItems[].payload |
string |
Eine generische Nutzlast, deren Bedeutung sich abhängig von der Aktion dieses MenuItems ändert.
|
Bearbeitbar |
menuItems[].removeWhenSelected |
boolean |
Wenn die Richtlinie für den Menüpunkt „CUSTOM “ auf „true“ gesetzt ist, wird das Element nach der Auswahl aus dem Menü entfernt. |
Bearbeitbar |
menuItems[].values[] |
list |
Für CUSTOM -Elemente eine Liste von Werten, die die Darstellung des Menüelements in jedem seiner Status steuern. Für den Status DEFAULT muss ein Wert angegeben werden. Wenn der Status PENDING oder CONFIRMED fehlt, wird er nicht angezeigt. |
Bearbeitbar |
menuItems[].values[].displayName |
string |
Der Name, der für den Menüpunkt angezeigt werden soll. Wenn Sie diese Eigenschaft für einen integrierten Menüpunkt festlegen, wird der standardmäßige kontextabhängige Sprachbefehl für diesen Menüpunkt nicht angezeigt. | Bearbeitbar |
menuItems[].values[].iconUrl |
string |
Die URL eines Symbols, das mit dem Menüpunkt angezeigt werden soll. | Bearbeitbar |
menuItems[].values[].state |
string |
Der Bundesstaat, für den dieser Wert gilt. Zulässige Werte:
|
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:
|
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 |
selfLink |
string |
Eine URL, mit der dieses Element abgerufen werden kann. | |
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.