【できごと】検索
タイムライン上の【できごと】を検索するAPIについて説明します。
リクエストURL
- 機能：
- キーワードや日時の範囲からタイムライン上の【できごと】を検索します。
リクエストメソッド
GETまたはPOST
リクエスト
| パラメータ | 項目名 | 説明 | 必須 | 値 | デフォルト値 |
|---|---|---|---|---|---|
| timeline_key | APIキー | APIのユーザ認証するためのキー (プライベートモードのタイムライン上の【できごと】を参照する場合に必要となります。APIキーについて,詳しくはAPIキーについてを参照してください。) | - | 英数字 | なし |
| timeline_id | タイムラインのID | 指定したタイムライン上の【できごと】を取得する場合に指定するID | ※1 | 数値 | なし |
| phrase | 検索フレーズ | 【できごと】を全文検索する場合に指定する検索フレーズ | ※1 | 文字列 | なし |
| time_spec | 期間検索指定 | 【できごと】を期間指定で検索する場合に指定する期間の評価方法 | ※1 | (後述) | なし |
| start_time | 期間開始日時 | 期間指定の開始時刻 | - | 日時 | 0001-01-01T00:00Z |
| end_time | 期間開始日時 | 期間指定の終了時刻 | - | 日時 | 9999-12-31T23:59Z |
| page | 取得ページ | 【できごと】の一覧の何ページ番号 | - | 数値 | 1 |
| hits | 取得件数 | レスポンスに含まれる【できごと】の件数 | - | 数値 | 20 |
| order | 表示順指定 | 【できごと】のソート順 | - | (後述) | updated |
| has_image | 画像条件指定 | 画像がある【できごと】からのみ検索する | - | なし | なし |
※1 「タイムラインのID」と「【できごと】検索フレーズ」と「期間検索指定」の各検索条件の指定はそれぞれ排他とし、同時に複数指定された場合は「タイムラインのID」「【できごと】検索フレーズ」「時間検索指定」の順に優先するものとします。
プライベートモードのタイムラインの【できごと】を取得する場合は「APIキー」の指定を必須とします。また「タイムラインのID」を指定した場合はAPIの利用者に対して公開されたタイムラインの【できごと】のみ取得できるものとします。それ以外のケースではプライベートモードのタイムラインの【できごと】は結果に含みません。
「期間検索指定」を指定した場合は「期間開始日時」と「期間終了時刻」を指定して、特定の期間の【できごと】を検索することができます。「期間検索指定」には「期間開始日時」と「期間終了日時」の評価方法として、以下のいずれかの値を取ります。
- include: 完全にその期間内に入る【できごと】
- cross: その範囲内に少しでも被る【できごと】
- start: 範囲内で開始する【できごと】
- end: 範囲内で終了する【できごと】
「表示順指定」は以下のいずれかの値を取ります。
- old_to_new: 【できごと】の開始時刻昇順
- new_to_old: 【できごと】の開始時刻降順
- created: 【できごと】の作成時刻降順
- updated: 【できごと】の編集時刻降順
サンプルリクエストURL
timeline_idが1の【できごと】を検索するには次のURLにアクセスします。
レスポンス
レスポンスは以下の要素から構成されます。
| 要素名 | 説明 | 値 |
|---|---|---|
| response | ||
| status | ||
| code | ステータスコード | 数値 |
| message | ステータスメッセージ | 文字列 |
| language | 言語情報 | 文字列 |
| result | ||
| summary | ||
| total | 検索条件に一致する【できごと】の全件数 | 数値 |
| page | 現在のページ番号 | 数値 |
| page_count | 一覧の全ページ数 | 数値 |
| articles | 【できごと】の一覧 | |
| articles | 【できごと】の詳細 |
「【できごと】の詳細」に含まれる要素については【できごと】取得APIを参照してください。
サンプルレスポンス
以下は、ID=1のタイムライン上の【できごと】を取得するリクエストに対するレスポンスです。
エラー
検索条件の指定が不充分な場合はエラーとなります。
