livedoor クリップについての Wiki です。

概要


指定したユーザーの最近のクリップデータを JSON 形式で返します。

リクエストの形式


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 データの構造


返り値として得られる JSON データは以下のような構造になっています。
livedoor_id
指定したユーザーの livedoor ID を返します。ユーザーが存在しない場合、 null を返します。
title
指定したユーザーのマイクリップのタイトルを返します。リクエストが失敗した場合、 null を返します。
isSuccess
リクエストが成功した場合、 1 を返します。リクエストが失敗した場合、 0 を返します。
clips
マイクリップのデータの配列を返します。リクエストが失敗した場合、空の配列を返します。各要素のデータ構造は以下のようになっています。
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 エスケープされません。

指定したユーザーがマイクリップを非公開にしている場合、クリップデータを取得することはできません。また、マイクリップを公開しているユーザーが非公開クリップしたデータも取得することはできません。

注意事項


  • この API は実験的に公開しているものであり、予告なく仕様の変更や公開の停止がある場合がございます。また、内部でデータをキャッシュしているため、実際のマイクリップの内容と異なる場合がございます。あらかじめご了承ください。
  • この API の仕様は流動的なものであるため、公開された内容と必ずしも一致しない場合がございます。このページの内容は現実の仕様にあわせて随時更新して参りますので、ご理解、ご協力のほどをよろしくお願いいたします。

このページへのコメント

タグを指定できるといいですね.

Posted by takayuki0510 2007年04月02日(月) 17:04:13

コメントをかく


画像に記載されている文字を下のフォームに入力してください。

「http://」を含む投稿は禁止されています。

利用規約をご確認のうえご記入下さい

メンバーのみ編集できます