TimeLine取得
タイムラインの情報を取得するAPIについて説明します。
リクエストURL
- 機能 :
- 「:id」で指定したタイムラインを取得します。
リクエストメソッド
GETまたはPOST
リクエストパラメータ
| パラメータ | 項目名 | 説明 | 必須 | 値 | デフォルト値 |
|---|---|---|---|---|---|
| id | タイムラインのID | タイムラインのID(URLに含めてください。) | ◯ | 数値 | - |
| timeline_key | APIキー | APIを利用するためのキー(プライベートモードのタイムラインを参照する場合に必要となります。詳しくはAPIキーについてを参照してください。) | - | 英数字 | - |
プライベートモードのタイムラインを取得する際は「APIキー」の指定を必須とし、APIの利用者に対して公開されたタイムラインのみ取得できるものとします。
サンプルリクエストURL
レスポンス
レスポンスは以下の要素から構成されます。| 要素名 | 説明 | 値 |
|---|---|---|
| response | ||
| status | ||
| code | ステータスコード | 数値 |
| message | ステータスメッセージ | 文字列 |
| language | 言語情報 | 文字列 |
| result | ||
| timeline | タイムラインの詳細 |
| 要素名 | 説明 | 値 |
|---|---|---|
| id | タイムラインのID | 文字列 |
| title | タイムラインのタイトル | 文字列 |
| description | タイムラインの概要 | 文字列 |
| label_for_vaxis | 縦軸の名称 | 文字列 |
| vaxis_mode | 縦軸モード | 文字列 |
| labels | ||
| label | 縦軸ラベル | 文字列 |
| time_scale | 初期表示スケール | (後述) |
| initial_position | 初期表示位置 | (後述) |
| commentable | コメント受付設定 | true/false |
| open_level | 閲覧許可設定 | 数値 |
| opened_for | 閲覧許可ユーザー | (後述) |
| lock_level | 投稿許可設定 | 数値 |
| locked_for | 投稿許可ユーザー | (後述) |
| updated_at | タイムラインの更新日時 | 日時 |
| created_at | タイムラインの作成日時 | 日時 |
| score | 現在のスコア(後述) | 数値 |
| point | 全得票点数(後述) | 数値 |
| page_view | 全PV数 | 数値 |
| category | タイムラインのカテゴリ名 | 文字列 |
「縦軸モード」には以下の値のいずれかが入ります。
- numeric: 数値モード
- label: 文字モード
「初期表示スケール」には以下の値のいずれかが入ります。
- default: 指定なし
- second: 秒
- minute: 分
- hour: 時間
- day: 日
- week: 週
- month: 月
- year: 年
- ten_years: 10年
「初期表示位置」には以下の値のいずれかが入ります。
- last: 最後の【できごと】
- first: 最初の【できごと】
- recent: 最近更新された【できごと】
閲覧・投稿権限の扱いについて
タイムラインでは閲覧・投稿制限を設定することで、その公開範囲をカスタマイズできます。
閲覧権限は、そのタイムラインをWebブラウザ上で表示したりAPIから取得できるユーザーを制限するために使用します。閲覧権限を設定していない状態を「公開タイムライン」、閲覧権限を設定し閲覧できるユーザーを制限している状態を「プライベートモードのタイムライン」と呼びます。
投稿権限は、そのタイムラインへ【できごと】を投稿できるかどうかを設定するための権限です。
「閲覧許可ユーザー」および「投稿許可ユーザー」はユーザーのニックネームを半角スペース区切りで指定します。
例えばuser_aとmember_xを閲覧許可ユーザーに設定している場合は、XML中では以下のように表示されます。
<opened_for>user_a member_x</opened_for>
閲覧制限と投稿制限の組み合わせによって表現されるタイムラインの状態は、下表のとおりです。
| 権限 | タイムラインの状態 | |
|---|---|---|
| 閲覧制限 | 投稿制限 | |
| なし(open_level=0) | なし(lock_level=0) | すべてのユーザーが閲覧・投稿できる。 「みんなでつくろう」タイムラインなど |
| あり(open_level=1) | なし(lock_level=0) |
タイムラインオーナーと閲覧許可ユーザー(opened_forで設定)のみが閲覧・投稿できる 特定のグループ(家族・同僚)のみが作るタイムラインなど |
| なし(open_level=0) | あり(lock_level=1) |
誰でも閲覧可能、投稿許可ユーザー(locked_forで設定)のみが投稿できる 外部公開したいがスタッフのみが投稿したい、イベントの様子など。 |
| あり(open_level=1) | あり(lock_level=1) |
タイムラインオーナーと閲覧許可ユーザー(opened_forで設定)、投稿許可ユーザー(locked_forで設定)のみが閲覧できる(※)。
タイムラインオーナーと投稿許可ユーザー(locked_forで設定)のみが投稿できる グループメンバーのみに公開し、さらにその一部のスタッフのみが投稿したい場合など |
「現在のスコア」と「全得票点数」について
タイムラインはページビューや投票結果をもとに、スコアを持っています。 このスコアは、トップページへの「人気のタイムライン」への表示などに利用されています。 「TimeLine情報取得API」では、このスコアを「現在のスコア」と「全得票点数」の二通りの方法で取得することができます。
- 「現在のスコア」
- 算出されたスコアをもとに算出された『現在の注目度』を表しています。毎日更新されます。
- 「全得票件数」
- これまでにえたスコアの累積値です。
「縦軸モード」について
各タイムラインには縦軸をどのように扱うかを指定する「縦軸モード」を設定できます。縦軸モードには「数値モード」と「文字モード」があります。 「数値モード」に設定されたタイムラインに【できごと】を追加するときは縦軸の値として数値を設定します。 「文字モード」に設定されたタイムラインに【できごと】を追加するときは縦軸の値として「縦軸ラベル」で指定したラベル文字列のうちいずれかを設定します。
数値モードとは？
数値モードとは縦軸に数字を入力するモードです。ダイエットのタイムラインの場合は縦軸に体重を入力して毎日の体重のチェックツール として使用したり、子供の成長記録では身長を縦軸に登録しておくなど、使い方は無限大！
タイムラインの縦軸に数値で意味を持たせたい場合にこのモードを選択してください。
文字モードとは？
文字モードとは縦軸に数字を入力するモードです。家族のタイムラインで「お父さん」、 「お母さん」。「私」などを縦軸に設定するなど、 使い方は無限大！
タイムラインの縦軸に文字で意味を持たせたい場合にこのモードを選択してください。
なお、設定できる縦軸の個数は11個までで、上から第1縦軸となります。
サンプルレスポンス
以下は、このリクエストに対するレスポンスのサンプルです。
エラー
指定されたタイムラインが存在しないか、閲覧権限のないプライベートモードのタイムラインだった場合、エラーになります。
