如需本資源的方法清單,請見本頁結尾。
資源表示法
使用者時間軸中的每個項目都會表示為 TimelineItem
JSON 結構,如下所述。
{ "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 } }
資源名稱 | 值 | 說明 | Notes |
---|---|---|---|
attachments[] |
list |
與這個項目相關聯的媒體附件清單。為了方便起見,您可以在 HTML 酬載中使用附件或 DN 配置參照附件。例如:
|
|
bundleId |
string |
此商品的套裝組合編號。服務可以指定 BundleId 來將多個項目分組。這些項目會顯示在裝置上的單一頂層項目下方。 | 可寫入 |
canonicalUrl |
string |
標準網址,可指向時間軸項目所代表資料的標準/高品質版本。 | 可寫入 |
created |
datetime |
此項目建立時間,根據 RFC 3339 格式。 | |
creator |
nested object |
建立這個項目的使用者或群組。 | 可寫入 |
displayTime |
datetime |
在時間軸上檢視這個項目時應顯示的時間,採用 RFC 3339 格式。系統按照時間順序排序這位使用者的時間軸,因此也會決定項目在時間軸中的顯示位置。如果沒有設定服務,顯示時間預設為 updated 時間。 |
可寫入 |
etag |
etag |
此項目的 ETag。 | |
html |
string |
此項目的 HTML 內容。如果為項目同時提供 text 和 html ,則 html 會在時間軸中算繪。允許 HTML 元素:您可以在時間軸資訊卡中使用這些元素。
已封鎖的 HTML 元素:這些元素及其內容會從 HTML 酬載中移除。
其他元素:所有未列於元素的元素都會遭到移除,但會保留其內容。 |
可寫入 |
id |
string |
時間軸項目的 ID。在使用者的時間表中不得重複。 | |
inReplyTo |
string |
如果這個項目是為了回覆另一個項目而產生,這個欄位將設為所回覆項目的 ID。這可以用來回覆適當的對話或訊息。 | |
isBundleCover |
boolean |
這個項目是否為套裝組合的封面。 。這項資訊只會在主要時間軸上顯示,而不會顯示在公開的套件中。 主要時間軸顯示的是:
|
可寫入 |
isDeleted |
boolean |
如果為 true,表示該項目已刪除,且只設定了 ID 屬性。 | |
isPinned |
boolean |
如果為 true,代表該項目會固定在「主畫面」中的歷來 (未固定) 時間軸項目中的「進行中」項目 (例如導覽和 Hangouts),您可以讓使用者使用 TOGGLE_PINNED 的內建選單項目來切換這個屬性的值。 |
|
kind |
string |
資源類型。一律為 mirror#timelineItem 。 |
|
location |
nested object |
與這個項目相關聯的地理位置。 | 可寫入 |
menuItems[] |
list |
在時間軸上選取這個項目時,使用者會看到的選單項目清單。 | 可寫入 |
menuItems[].action |
string |
控制使用者選取選單選項的行為。允許的值包括:
|
可寫入 |
menuItems[].id |
string |
這個選單項目的編號。應用程式是由應用程式產生,而且會視為不透明的符記。 | 可寫入 |
menuItems[].payload |
string |
一般酬載,這個選單的意義會因此選單項目的動作而改變。
|
可寫入 |
menuItems[].removeWhenSelected |
boolean |
如果在 CUSTOM 選單項目設為 true,該項目會在選取後從選單移除。 |
可寫入 |
menuItems[].values[] |
list |
針對 CUSTOM 項目,可控制選單項目各狀態外觀的外觀值。必須提供 DEFAULT 狀態的值。如果缺少 PENDING 或 CONFIRMED 狀態,就不會顯示。 |
可寫入 |
menuItems[].values[].displayName |
string |
選單項目顯示的名稱。如果為內建選單項目指定這個屬性,系統就不會顯示該選單項目的預設內容比對語音指令。 | 可寫入 |
menuItems[].values[].iconUrl |
string |
與選單項目一併顯示的圖示網址。 | 可寫入 |
menuItems[].values[].state |
string |
這個值適用的狀態。允許的值包括:
|
可寫入 |
notification |
nested object |
控制這個項目在裝置上顯示方式。如果缺少此資訊,系統就不會產生通知。 | 可寫入 |
notification.deliveryTime |
datetime |
通知的傳送時間。 | 可寫入 |
notification.level |
string |
說明通知的重要性。有效值如下:
|
可寫入 |
pinScore |
integer |
如果是固定的項目,這會決定項目在時間軸中的顯示順序,分數越高,時鐘越接近。注意:目前無法設定這個欄位。 | |
recipients[] |
list |
共用此項目的使用者或群組清單。 | 可寫入 |
selfLink |
string |
可用來擷取這個項目的網址。 | |
sourceItemId |
string |
不透明字串可用於將時間軸項目對應至自有服務中的資料。 | 可寫入 |
speakableText |
string |
這個項目的口說版本。除了使用 READ_ALOUD 選單項目之外,您也可以使用這個欄位來提供文字,讓文字更清楚易讀,或針對 Glass 的視覺顯示提供額外資訊。Glassware 也應指定「SpeakableType」欄位,如果額外的背景資訊有所幫助,例如這段文字會在使用者於通知後要求系統朗讀項目時發出通知。 |
可寫入 |
speakableType |
string |
此項目類型的口說方式說明。在使用者要讀取項目內容前,系統會先向使用者說明這類情況,如果其他情況有所幫助,例如使用者在要求通知後,系統就會朗讀該項目。 建議 Google Glass 軟體在各個時間軸項目中填入這個欄位,即使該項目不包含口頭文字或文字,使用者也能在不看螢幕的情況下學習項目類型。 |
可寫入 |
text |
string |
此項目的文字內容。 | 可寫入 |
title |
string |
此商品的名稱。 | 可寫入 |
updated |
datetime |
上次修改這個項目的時間,根據 RFC 3339 格式。 |