Timeline

如需本資源的方法清單，請見本頁結尾。

資源表示法

使用者時間軸中的每個項目都會以 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
  }
}

屬性名稱	值	說明	附註
attachments[]	list	與此項目相關聯的媒體附件清單。為了方便起見，您可以參照 HTML 酬載中的附件或 cid 配置。例如： link：<img src="attachment:attachment_index">，其中 links_index 是這個陣列的索引 (從 0 開始)。 cid：<img src="cid:attachment_id">，其中 link_id 是附件的 ID。
bundleId	string	這個項目的軟體包 ID。服務可以指定一個 bundleId，將多個商品歸為一組。這類素材資源會顯示在裝置上的單一頂層項目底下。	可寫入
canonicalUrl	string	指向時間軸項目所代表資料的標準/高品質版本標準網址。	可寫入
created	datetime	建立這個項目的時間 (根據 RFC 3339 格式)。
creator	nested object	建立這個項目的使用者或群組。	可寫入
displayTime	datetime	透過時間軸查看這個項目時應顯示的時間，採用 RFC 3339 格式。這位使用者的時間軸是依顯示時間先後排序，因此也會決定該項目在時間軸中的顯示位置。如果服務未設定，顯示時間會預設為 updated 時間。	可寫入
etag	etag	這個項目的 E 代碼。
html	string	這個項目的 HTML 內容。如果同時為某個項目提供 text 和 html，系統會在時間軸中顯示 html。 允許的 HTML 元素 - 您可以在時間軸資訊卡中使用這些元素。 標題：h1, h2, h3, h4, h5, h6 圖片：img 清單：li, ol, ul HTML5 語意：article, aside, details, figure, figcaption, footer, header, nav, section, summary, time 結構：blockquote, br, div, hr, p, span 樣式：b, big, center, em, i, u, s, small, strike, strong, style, sub, sup 資料表：table, tbody, td, tfoot, th, thead, tr 封鎖的 HTML 元素：這些元素及其內容會從 HTML 酬載中移除。 文件標頭：head, title 嵌入資產數：audio, embed, object, source, video 頁框：frame, frameset 指令碼：applet, script 其他元素：系統會移除未列出的元素，但保留其內容。	可寫入
id	string	時間軸項目的 ID。在使用者時間軸中為不重複值。
inReplyTo	string	如果這個項目是其他項目的回覆而產生，這個欄位會設為待回覆項目的 ID。這可以用來在適當的對話或貼文中附加回覆。
isBundleCover	boolean	這項商品是否為套裝組合封面。 如果商品已標示為套裝組合封面，則系統會將該商品設為與該項目具有相同 bundleId 的項目組合的進入點。此圖表只會顯示在主要時間軸上，而「不會顯示在已開啟的套件中」。 主要時間軸會顯示的項目如下： 「isBundleCover」設為「true」的項目 沒有 bundleId 的項目 套裝組合子時間軸會顯示的項目如下： 具有爭議的bundleId 且 isBundleCover 設為 false 的項目	可寫入
isDeleted	boolean	設為 true 時，表示此項目已刪除，且只會設定 ID 屬性。
isPinned	boolean	如果為 true，表示此項目已固定，表示此項目已和「有效」組合在一起「導覽」和「Hangouts」等項目均來自歷史 (未固定) 時間軸項目。您可以讓使用者利用 TOGGLE_PINNED 內建的選單項目切換這個屬性的值。
kind	string	資源的類型。一律為 mirror#timelineItem。
location	nested object	與這個項目相關聯的地理位置。	可寫入
menuItems[]	list	使用者在時間軸中選取這個項目時，會看到選單項目清單。	可寫入
menuItems[].action	string	控管使用者選取選單選項時的行為。允許的值包括： CUSTOM - 服務設定的自訂動作。使用者選取這個 menuItem 時，API 會觸發系統發送至您的 callbackUrl 的通知，將 userActions.type 設為 CUSTOM，並將 userActions.payload 設為這個選單項目的 ID。這是預設值。 內建動作： REPLY - 使用語音錄音 UI 啟動回覆時間軸項目。您必須在時間軸項目中設定 creator 屬性，這個選單才能使用。 REPLY_ALL - 行為與 REPLY 相同。系統會將原始時間軸項目的 recipients 新增至回覆項目。 DELETE - 刪除時間軸項目。 SHARE - 將時間軸項目分享給可用聯絡人。 READ_ALOUD - 朗讀時間軸項目的 speakableText。如未設定這個欄位，則讀取 text 欄位；如未設定上述任何欄位，系統就會忽略這個選單項目。 GET_MEDIA_INPUT - 允許使用者透過選單項目將媒體酬載提供給 Glassware (目前僅支援透過語音輸入轉錄的文字)。訂閱通知，即可在使用者叫用這個選單項目接收時間軸項目 ID 時接收通知。從 payload 屬性中的時間軸項目擷取媒體。 VOICE_CALL - 使用時間軸項目的 creator.phoneNumber 屬性做為接收者啟動通話。 NAVIGATE - 前往時間軸項目的 location。 TOGGLE_PINNED：切換時間軸項目的 isPinned 狀態。 OPEN_URI - 在瀏覽器中開啟選單項目的 payload。 PLAY_VIDEO - 在 Glass 影片播放器中開啟選單項目的 payload。 SEND_MESSAGE - 開始傳送訊息至時間軸項目的 creator： 如果已設定 creator.phoneNumber，且 Glass 已連線至 Android 手機，則訊息就會是簡訊。 否則，如果設定了 creator.email，郵件就是電子郵件。	可寫入
menuItems[].id	string	這個選單項目的 ID。這項資訊是由應用程式產生，並視為不透明權杖。	可寫入
menuItems[].payload	string	一般酬載，其意義會因此 MenuItem 的動作而異。 當動作為 OPEN_URI 時，酬載是要查看的網站的網址。 當動作為 PLAY_VIDEO 時，酬載是影片的串流網址 當動作為 GET_MEDIA_INPUT 時，酬載是使用者語音輸入的文字轉錄內容	可寫入
menuItems[].removeWhenSelected	boolean	如果針對 CUSTOM 選單項目設為 true，選取後就會從選單移除。	可寫入
menuItems[].values[]	list	針對 CUSTOM 項目，這裡列出的值清單，用於控制選單項目在各個狀態下的外觀。必須提供 DEFAULT 狀態的值。如果缺少 PENDING 或 CONFIRMED 狀態，就不會顯示。	可寫入
menuItems[].values[].displayName	string	選單項目的顯示名稱。如果您為內建選單項目指定這個屬性，系統就不會顯示該選單項目的預設內容相關語音指令。	可寫入
menuItems[].values[].iconUrl	string	與選單項目一同顯示的圖示網址。	可寫入
menuItems[].values[].state	string	此值適用的狀態。允許的值包括： DEFAULT：顯示在 menuItems 清單時顯示的預設值。 PENDING - 使用者已選取 menuItem 時顯示的值，但仍可取消。 CONFIRMED - 使用者選取 menuItem 後，無法再取消，就會顯示這個值。	可寫入
notification	nested object	控管這個項目的通知在裝置上的顯示方式。如果缺少這項資訊，系統就不會產生任何通知。	可寫入
notification.deliveryTime	datetime	傳送通知的時間。	可寫入
notification.level	string	說明通知的重要性。允許的值包括： DEFAULT - 預設重要性的通知。系統會播放鈴聲來提醒使用者。	可寫入
pinScore	integer	如果是釘選的項目，這會決定項目在時間軸中的顯示順序，分數越高，越接近時鐘。注意：目前不支援設定這個欄位。
recipients[]	list	可與這個項目共用的使用者或群組清單。	可寫入
selfLink	string	可用來擷取此項目的網址。
sourceItemId	string	不透明字串，可用來將時間軸項目對應至自家服務中的資料。	可寫入
speakableText	string	這個項目的內容可朗讀版本。除了 READ_ALOUD 選單項目外，您也可以使用這個欄位提供清楚的文字，在大聲朗讀時要清楚辨識，或是針對 Glass 顯示的視覺內容提供延伸資訊。 Glassware 也應指定 readableType 欄位，如果能提供其他背景資訊相當實用，例如在通知後朗讀項目，例如使用者要求系統朗讀該項目時，系統就會直接讀出該欄位。	可寫入
speakableType	string	這個項目的類型說明。若使用者要求系統朗讀某項商品時，在通知後建議系統朗讀該項目，系統會在使用者閱讀該項目內容前向他們宣布。 請使用簡短且簡單的名詞片語，例如「電子郵件」、「簡訊」或「每日星球新聞最新消息」。 我們鼓勵在每個時間軸項目填入這個欄位，即使該項目未包含 readableText 或文字，也能讓使用者不必查看螢幕就知道項目的類型。	可寫入
text	string	這個項目的文字內容。	可寫入
title	string	這個項目的標題。	可寫入
updated	datetime	上次修改這個項目的時間，採用 RFC 3339 格式。

方法

刪除

刪除時間軸項目。

取得

按 ID 取得單一時間軸項目。

插入

在時間軸中插入新項目。

list

擷取已驗證使用者的時間軸項目清單。

修補程式

更新現有的時間軸項目。這個方法支援修補語意。

更新

更新現有的時間軸項目。