mixi Developer Center (ミクシィ デベロッパーセンター)

mixi Connect

mixi Connect » mixi Graph API » 技術仕様 » Profile Image API

Profile Image API

プロフィール画像は、mixi内で最も多く目にするユーザ情報の一つだと言えるでしょう。
ユーザの分身として常に表示され、それを目にすることによって各ユーザは友人の姿をより具体的に思い浮かべる事ができます。
Profile Image APIを利用することで、自分や友人の様々なプロフィール画像を目にする事が可能となり、 また、それらの投稿や編集を行う事によって、ユーザの情報は一層華やかで個性的なものとなるでしょう。

事前に必要なもの

Profile Image APIを利用するためには、以下の情報をすでに入手している必要があります。

  • “r_profile”または”w_profile”スコープおよびその両方について認可されたアクセストークン

上記以外のスコープで認可されたアクセストークンを使用して、Profile Image APIにアクセスすることはできません。アクセストークンの入手方法については、認証認可手順のページをご覧ください。

Profile Image APIで提供される機能とスコープ

Profile Image APIでは様々な機能が提供されますが、それらは大きく「参照系」「投稿系」の2つに分類されます。この分類は、そのままProfile Image APIを利用するためのスコープに対応します。以下に、スコープと各機能の対応を示します。

スコープ 機能
r_profile プロフィール画像の取得
w_profile プロフィール画像の投稿
プロフィール画像の設定の変更
プロフィール画像の削除

プロフィール画像一覧の取得

プロフィール画像一覧を取得するためのURIは以下となります。

GET https://api.mixi-platform.com/2/people/images/[User-ID]/@self/[Image-ID]
パラメータ名 指定する値
User-ID 認可ユーザのユーザID、および認可ユーザ自身を示す"@me"、または友人のユーザID。
Image-ID あるプロフィール画像のID。これを指定した場合は、API呼び出しの結果として、そのプロフィール画像の情報のみが返却されます。省略可。

さらに、以下のクエリパラメータをサポートしています。

パラメータ名 説明
privacy このパラメータ値を指定する事によって、該当する公開範囲の画像のみを取得対象とする事が可能です。 設定可能なパラメータは、"everyone"(全体に公開している画像), "friends"(友人まで公開の画像), "self"(未公開の画像)となります。
primary trueを指定する事によって、メイン画像として設定してあるプロフィール画像のみを取得対象とする事が可能です。
startIndex開始インデックス。
count取得件数。
fields 取得したい情報の項目をカンマ区切りで指定します。 指定可能な項目名は「id,thumbnailUrl,privacy,primary,created,recommender」です。 もしfieldsパラメータを省略した場合には、「id,thumbnailUrl,privacy,primary」が指定されたと見なされます。 また"@all"にて全項目を指定可能です。 これらの内、idおよびthumbnailUrlについては、必ず結果に含まれます。

正常に取得できた場合は、以下のような結果を得ることができます。下記の例は、JSON形式の結果です。

{
    "entry" : [
        {
            "id" : "e82686f7306cd840d51d3f548e4ed8fd606062f094",
            "thumbnailUrl" : "http://profile.img.mixi.jp/photo/user/1FGOBIWJSAOCUWBBC_214356712.jpg",
            "privacy" : "friends",
            "primary" : "true",
            "created" : "2011-06-27T16:49:53+09:00",
            "recommender" : {
                    "thumbnailUrl" : "http://mixi/photo/member/p/68/a9/68a751a1793f3e7b1969403572df4f782aa520c29619.jpg",
                    "id" : "zx4r5dmbrd5mx",
                    "displayName" : "Jack",
                    "profileUrl" : "http://mixi.jp/redirect_friend_api.pl?puid=xxxxxxxxxxxxx&client_id=xxxxxxxx",
                    "message" : "Here is the recommend image"
             },
        }...
    ]...

}

個々のエントリに含まれる情報は、以下のとおりです。

属性名 説明
id プロフィール画像を特定するためのID (Image-ID)
thumbnailUrl プロフィール画像のURL
privacy プロフィール画像の公開範囲。"everyone"(全体に公開している画像), "friends"(友人まで公開の画像), "self"(未公開の画像)のいずれかとなります。
primary そのプロフィール画像をメイン画像として設定していればtrueが、そうでなければfalseとなります。
created プロフィール画像の作成日時。日時の書式は「yyyy-mm-ddThh:mm:ss+09:00」となります(詳しくは[XSdateTime]を参照)
recommender プロフィール画像の使用をおすすめしたユーザの情報。 "id" (ユーザのID)、"displayName"(ニックネーム)、"thumbnailUrl"(プロフィール画像URL)、"profileUrl"(プロフィールページのURL)、"message"(おすすめ文)が含まれます。 そのユーザが認可ユーザと友人関係ではない場合は、「id、displayNameおよびthumbnailUrl」のみが結果に含まれます。

プロフィール画像の投稿

プロフィール画像を投稿するためのURIは以下となります。

 POST https://api.mixi-platform.com/2/people/images/[User-ID]/@self 
パラメータ名 指定する値
User-ID 認可ユーザのユーザID、および認可ユーザ自身を示す"@me"

さらに、以下のクエリパラメータをサポートしています。

パラメータ名 説明
privacy 投稿するプロフィール画像の、初期状態での公開範囲。 "everyone"(全体に公開している画像)または"friends"(友人まで公開の画像)を指定することとなります。 このパラメータは必須であり、省略できません。

Content-Typeリクエストヘッダには"image/jpeg"を指定し、 登録する画像ファイルは、リクエストボディとしてそのファイルのバイナリデータを指定します。具体的には、以下のようなリクエストとなります。

POST https://api.mixi-platform.com/2/people/images/@me/@self?privacy=everyone HTTP/1.1
Host: api.mixi-platform.com
Content-Type: image/jpeg
Content-Length: 123456

d84ba376eaaa786249...

プロフィール画像の投稿に成功した場合は、ステータスコード201、およびそのプロフィール画像を特定するためのIDを持つ以下のようなJSON文字列が返却されます。

{
    "id" : "73a1354313a8dced1ca07a68c1204b3d727042d048"
}

プロフィール画像の設定変更

プロフィール画像の設定を変更するためのURIは以下となります。

PUT https://api.mixi-platform.com/2/people/images/[User-ID]/@self/[Image-ID]
パラメータ名 指定する値
User-ID 認可ユーザのユーザID、および認可ユーザ自身を示す"@me"
Image-ID プロフィール画像を識別するためのID。必須

リクエストボディとして、プロフィール画像の新しい設定を以下のようにapplication/json形式にて指定します。

{
    "privacy" : "everyone",
    "primary"  : true
}

個々の項目に指定すべき値は、以下となります。

パラメータ名 指定する値
privacy プロフィール画像の公開範囲。"everyone"(全体に公開している画像), "friends"(友人まで公開の画像)のいずれかとなります。
primary trueを指定することによって、Image-IDのプロフィール画像をメイン画像として設定する事になります。

変更処理が成功した場合は、ステータスコードは200、 および設定変更後のプロフィール画像を識別するための新たなIDを持つ以下のようなJSON文字列が返却されます。

{
    "id" : "73a1312d23a8dced1ca07a68c1204b3d727042d044",
}

プロフィール画像の削除

プロフィール画像を削除設定を変更するためのURIは以下となります。

DELETE https://api.mixi-platform.com/2/people/images/[User-ID]/@self/[Image-ID]
パラメータ名 指定する値
User-ID アクセストークンを認可したユーザのIDまたは "@me"
Image-ID プロフィール画像を識別するためのID。必須

削除に成功した場合は、HTTPステータスコード200が返却されます。

このページの上部へ