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 このアイテムに関連付けられているメディア アタッチメントのリスト。便宜上、添付ファイルまたはお客様 ID スキームを使用して HTML ペイロード内の添付ファイルを参照できます。例:
  • 添付ファイル: <img src="attachment:attachment_index">。ここで、attachment_index は、この配列の 0 ベースのインデックスです。
  • お客様 ID: <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 コンテンツ。アイテムに texthtml の両方が指定されている場合、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 と同じ商品を含む一括販売商品へのエントリ ポイントとなります。メイン タイムラインにのみ表示されます。開いたバンドル内には表示されません

メインのタイムラインでは、次の項目が表示されます。
  • isBundleCovertrueに設定されているアイテム
  • bundleId のないアイテム
一括販売のサブタイムラインに表示される項目は次のとおりです。
  • 問題の bundleId isBundleCoverfalse に設定されているアイテム
書き込み可能
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 このアイテムのタイプに関する説明を表示します。通知の後でアイテムが読み上げられることをユーザーがリクエストした場合など、追加のコンテキストが役立つ場合は、アイテムの内容を読む前にユーザーに通知が届きます。

「メール」、「テキスト メッセージ」、「今日の惑星ニュースの更新」など、短い名詞句にする必要があります。

Glassware では、スピーディなテキストやテキストが含まれていない場合でも、タイムライン アイテムごとにこのフィールドに値を設定することをおすすめします。これにより、ユーザーは画面を見なくてもアイテムのタイプを把握できます。
書き込み可能
text string このアイテムのテキスト コンテンツ。 書き込み可能
title string このアイテムのタイトル。 書き込み可能
updated datetime このアイテムが最後に変更された時刻(RFC 3339 の形式)。

Methods

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