http://api.clip.livedoor.com/json/clips に対して以下のパラメータを GET リクエストで送信することで、 JSON 形式でマイクリップのデータを取得することができます。
- livedoor_id
- マイクリップを取得したいユーザーの livedoor ID を指定します。
- limit
- 一度に取得したいクリップデータ数を指定します。 limit の値は 0 から 20 までの間の整数である必要があります。整数以外の値が指定された場合、 limit=5 が指定されたものとして扱われます。 20 以上の整数が指定された場合、 limit=20 が指定されたものとして扱われます。
- offset
- 取得するクリップデータのオフセット値を指定します。 offset の値は 0 以上の整数である必要があります。それ以外の値が指定された場合、 offset=0 が指定されたものとして扱われます。
また、 callback パラメータを指定することで、 JSONP 形式のコールバック関数で囲まれたデータを取得することも可能です。
- callback
- JSONP によるコールバック関数名を指定します。 callback パラメータの値は Perl の正規表現 /^[a-zA-Z0-9\.\_\[\]]+$ / に一致する必要があります。
返り値として得られる JSON データは以下のような構造になっています。
- livedoor_id
- 指定したユーザーの livedoor ID を返します。ユーザーが存在しない場合、 null を返します。
- title
- 指定したユーザーのマイクリップのタイトルを返します。リクエストが失敗した場合、 null を返します。
- isSuccess
- リクエストが成功した場合、 1 を返します。リクエストが失敗した場合、 0 を返します。
- clips
- マイクリップのデータの配列を返します。リクエストが失敗した場合、空の配列を返します。各要素のデータ構造は以下のようになっています。
- title
- クリップのタイトルを返します。
- link
- クリップの URL を返します。
- notes
- クリップにつけられたコメントを返します。
- tags
- クリップにつけられたタグの配列を返します。
- rate
- クリップにつけられたレートを返します。
- public
- 公開クリップされたデータの場合に 1 を返します。
- public_clip_count
- その URL がクリップされている件数を返します。
- created_on
- クリップされた日時を epoch 秒で返します。
- livedoor_id
- クリップしたユーザーの livedoor ID を返します。
staff_clip のマイクリップから最新一件を JSON 形式で取得する場合のリクエストは以下のようになります。
http://api.clip.livedoor.com/json/clips?livedoor_i...
返り値として得られるデータは以下のようになります。
{ "title":"livedoor クリップ開発スタッフのクリップ", "clips": [ { "link":"http://blog.livedoor.jp/staff_clip/archives/505831...", "public_clip_count":20, "tags":["livedoor","クリップ"], "rate":0, "created_on":1157539955, "notes":"", "public":1, "title":"livedoor クリップ開発日誌:クリップ数を表示する画像カウンター - livedoor Blog(ブログ)", "livedoor_id":"staff_clip" } ], "livedoor_id":"staff_clip" }
オプションとして、リクエスト時に以下のパラメータも受け付けます。
- escape
- escape=1 が指定されると、一部の値を HTML エスケープして返します。エスケープの対象となるのは、 title (マイクリップのタイトル)と、 各クリップごとの clips.link, clips.title, clips.notes, clips.tags の値です。デフォルト値は 0 です。明示的に指定しない場合、値は HTML エスケープされません。
指定したユーザーがマイクリップを非公開にしている場合、クリップデータを取得することはできません。また、マイクリップを公開しているユーザーが非公開クリップしたデータも取得することはできません。
このページへのコメント
タグを指定できるといいですね.