ユーザークリップの取得
ユーザークリップの一覧を取得するAPIについて説明します。
- 機能 :
- 指定した条件のユーザークリップ一覧を取得します。
リクエストメソッド
GETまたはPOST
リクエストパラメータ
| パラメータ | 項目名 | 説明 | 必須 | 値 | デフォルト値 |
|---|---|---|---|---|---|
| api_key | APIキー | APIを利用するためのキー（詳しくは@niftyクリップAPIキーについてを参照してください） | △(※1) | - | - |
| user | ユーザー名 | 対象とするユーザー（http://clip.nifty.com/users/の後の文字列のことです） | △(※1) | - | - |
| tag | タグ | 絞り込みたいタグを指定します。 また複数指定することが可能です | △ | (※2) | - |
| max | 取得件数 | 取得件数は0から最大100までが指定可能です | - | 数値 | 10 |
| start | スタート値のインデックス | 結果の何番目から表示するか | - | 0以上の数値 | 0 |
| alt | フォーマット | 共通仕様の要求メッセージを参照してください | - | 文字列 | XML |
| callback | コールバック関数名 | 共通仕様の要求メッセージを参照してください | - | 文字列 | - |
※1）「APIキー」または「ユーザー名」のどちらかを必ず指定してください。非公開のクリップを表示する場合は「APIキー」が必要です。
※2）「タグ」は文字列をUTF-8でURLエンコードしてください。
レスポンス
レスポンスは以下の要素から構成されます。
| 要素名 | 説明 | 値 |
|---|---|---|
| response | ||
| status | ||
| code | ステータスコード | 数値 |
| message | ステータスメッセージ | 文字列 |
| language | 言語情報 | 文字列 |
| result | ||
| clips | クリップ一覧 | |
| clip | クリップの詳細 | （※3） |
※3）JSON、JSONPの場合はclipは使用しません。
「クリップの詳細」は以下の要素から構成されます。
| clip_id | クリップID（クリップの編集や削除で使うことができます） | 数値 |
| title | クリップのタイトル | 文字列 |
| url | クリップ元のリンク | 文字列 |
| entry_url | クリップのリンク | 文字列 |
| tags | タグ一覧 | |
| tag | タグの詳細 | （※4） |
| tag_name | タグ | 文字列 |
| tag_url | ユーザーのタグのリンク | 文字列 |
| comment | コメント | 文字列 |
| created_at | クリップした日付 | 文字列 |
| count | クリップ数 | 数値 |
※4）JSON、JSONPの場合はtagは使用しません。
サンプルレスポンス
以下は、リクエストに対するレスポンスのサンプルです。
