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 ペイロードでは、Attachment スキームまたは cid スキームを使用して添付ファイルを参照できます。例:
  • アタッチメント: <img src="attachment:attachment_index">。ここで、attachment_index は、この配列の 0 から始まるインデックスです。
  • cid: <img src="cid:attachment_id">（attachment_id はアタッチメントの ID です）。
bundleId string このアイテムの一括販売 ID。サービスでは、bundleId を指定して多数のアイテムをグループ化できます。デバイスの 1 つの最上位アイテムの下に表示されます。 書き込み可能
canonicalUrl string タイムライン アイテムによって表されるデータの正規バージョンまたは高品質なバージョンを指す正規 URL。 書き込み可能
created datetime この項目が作成された時刻（RFC 3339 の形式）。
creator nested object このアイテムを作成したユーザーまたはグループ。 書き込み可能
displayTime datetime このアイテムがタイムラインに表示されるときに表示される時刻（RFC 3339 の形式）。このユーザーのタイムラインは表示時間順に並べられるため、タイムライン内の位置によってアイテムの表示位置も決まります。サービスで設定されていない場合、表示時間はデフォルトで updated 時間になります。 書き込み可能
etag etag このアイテムの ETag。
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 の場合、このアイテムは固定されている（つまり「有効」にグループ化されている）ことを示します過去の（固定されていない）タイムライン アイテムのホーム画面の反対側に、ナビゲーションやハングアウトなどのアイテムが表示されます。TOGGLE_PINNED 組み込みのメニュー項目を使用して、ユーザーがこのプロパティの値を切り替えられるようにできます。
kind string リソースのタイプ。これは常に mirror#timelineItem です。
location nested object このアイテムに関連付けられている地理的な位置です。 書き込み可能
notification nested object デバイスでのこのアイテムの通知の表示方法を管理します。指定されていない場合、通知は生成されません。 書き込み可能
notification.deliveryTime datetime 通知を配信する時刻。 書き込み可能
notification.level string 通知の重要度を表します。使用できる値:
  • DEFAULT - デフォルトの重要度の通知。チャイムが鳴って、ユーザーに警告します。
 書き込み可能
pinScore integer 固定されたアイテムの場合、タイムラインにアイテムが表示される順序が決まります。時計の近くでスコアが高いほど表示されます。注: このフィールドの設定は現在サポートされていません。
recipients[] list このアイテムを共有しているユーザーまたはグループのリストです。 書き込み可能
sourceItemId string 独自のサービスのデータにタイムライン アイテムをマッピングするために使用できる不透明な文字列。 書き込み可能
speakableText string このアイテムのコンテンツの読み上げバージョン。READ_ALOUD のメニュー項目と併せて、このフィールドを使用して、読み上げたテキストが明瞭なテキストを提供したり、Glass で視覚的に表示される情報に詳細な情報を提供したりできます。

Glassware では、speechableType フィールドも指定する必要があります。これは、追加のコンテキストが有用な場合（ユーザーが通知の後にアイテムを読み上げるようにする場合など）に、このテキストの前に読み上げられます。
 書き込み可能
speakableType string このアイテムのタイプに関する音声による説明。これは、追加のコンテキストが有用である場合（通知の後でアイテムの読み上げをユーザーがリクエストした場合など）、アイテムを読む前にユーザーに読み上げられます。

「メール」、「テキスト メッセージ」、「Daily Planet News Update」などの短いシンプルな名詞にする必要があります。

Glassware では、ユーザーが画面を見ずにアイテムのタイプを確認できるように、タイムライン アイテムごとに、アイテムに speechableText やテキストが含まれていない場合でも、このフィールドに値を入力することが推奨されます。		 書き込み可能
text string このアイテムのテキスト コンテンツ。 書き込み可能
title string このアイテムのタイトル。 書き込み可能
updated datetime このアイテムの最終更新日時（RFC 3339 形式）。

メソッド

delete
タイムライン アイテムを削除します。
get
ID により、単一のタイムライン アイテムを取得します。
insert
タイムラインに新しいアイテムを挿入します。
list
認証されたユーザーのタイムライン アイテムのリストを取得します。
patch
所定の位置のタイムライン アイテムを更新します。このメソッドは、パッチのセマンティクスをサポートしています。
update
所定の位置のタイムライン アイテムを更新します。