mixiアプリ » 技術仕様(RESTful API方式) » リファレンス » RESTful API » Albums API
Albums API
アルバム情報の取得、アルバムに含まれるフォト情報の取得を行います。
アルバム情報の取得
ユーザが作成したアルバムの情報を取得する。
エンドポイントURL
GET http://api.mixi-platform.com/os/0.8/albums/{guid}/@self
Templateパラメータ
パラメータ | 説明 | 必須 | 備考 |
---|---|---|---|
guid |
ユーザを指定。
|
○ |
クエリパラメータ
パラメータ | 説明 | 必須 | 備考 |
---|---|---|---|
visibility |
取得するアルバムの公開範囲を指定。
未指定のときは、「全体公開」に設定しているアルバムのみ取得します。 |
※共通クエリパラメータを使用できます。
レスポンスのデータ構造
json形式
プロパティ名 | 説明 | 型 | 備考 |
---|---|---|---|
entry[] | アルバムオブジェクトの配列 | array | |
entry[].thumbnailUrl | サムネイルURL | string | |
entry[].description | アルバム説明 | string | |
entry[].mediaItemCount | アルバムに含まれるフォトの数 | integer | |
entry[].caption | アルバムキャプション | string | |
entry[].id | アルバムID | string | |
entry[].title | アルバムタイトル | string | |
entry[].ownerId | platformUserId | string | |
entry[].mediaMimeType[] | mime type | string | |
startIndex | 取得開始インデックス | integer | |
itemsPerPage | 1ページあたりの件数 | integer | |
totalResults | 条件に一致した総件数 | integer |
サンプル
リクエスト
GET http://api.mixi-platform.com/os/0.8/albums/@me/@self
レスポンス
200 OK { "entry": [ { "thumbnailUrl": "http://ic.photo.mixi.jp/v/xxxxxxx/xxxx/picture/xxxxxx_XXXXXXX_XXXXsmall.jpg", "description": "マイアルバム1", "mediaItemCount": "2", "caption": "アルバム1", "id": "mixi.jp:XXXXXXXXXXXXXXX", "title": "アルバム1", "ownerId": "mixi.jp:xxxxxxxxxxxxx", "mediaMimeType": [ "image/jpeg" ] }, { "thumbnailUrl": "http://ic.photo.mixi.jp/v/xxxxxxx/xxxx/picture/xxxxxx_XXXXXXX_XXXXsmall.jpg", "description": "マイアルバム2", "mediaItemCount": "1", "caption": "アルバム2", "id": "mixi.jp:XXXXXXXXXXXXXXX", "title": "アルバム2", "ownerId": "mixi.jp:xxxxxxxxxxxxx", "mediaMimeType": [ "image/jpeg" ] } ], "itemsPerPage": "20", "startIndex": "0", "totalResults": 2 }
フォト情報の取得
アルバムに含まれるフォトを取得します。
エンドポイントURL
GET http://api.mixi-platform.com/os/0.8/mediaitems/{guid}/@self/{albumId}
Templateパラメータ
パラメータ | 説明 | 必須 | 備考 |
---|---|---|---|
albumId | アルバムIDを指定 | ○ | 必須 |
クエリパラメータ
なし
※共通クエリパラメータを使用できます。
レスポンスのデータ構造
json形式
プロパティ名 | 説明 | 型 | 備考 |
---|---|---|---|
entry[] | フォトオブジェクトの配列 | array | |
entry[].albumId | アルバムID | string | |
entry[].fileSize | ファイルサイズ | integer | |
entry[].thumbnailUrl | サムネイルURL | string | |
entry[].url | URL | string | |
entry[].id | フォトID | string | |
entry[].title | タイトル | string | |
entry[].description | 説明 | string | |
startIndex | 取得開始インデックス | integer | |
itemsPerPage | 1ページあたりの件数 | integer | |
totalResults | 条件に一致した総件数 | integer |
サンプル
リクエスト
GET http://api.mixi-platform.com/os/0.8/mediaitems/@me/@self/123456
レスポンス
application/json 形式:
200 OK { "entry": [ { "albumId": "mixi.jp:123456", "fileSize": "9261", "thumbnailUrl": "http://ic.photo.mixi.jp/v/xxxxxxxxxxxxxxx/xxxxx/picture/xxxxxxxxxxxxx_XXXXXXXXXX_XXXsmall.jpg", "url": "http://ic.photo.mixi.jp/v/xxxxxxxxxxxxxxx/xxxxx/picture/xxxxxxxxxxxxx_XXXXXXXXXX_XXXlarge.jpg", "id": "mixi.jp:XXXXXXXXXX", "title": "フォトタイトル1", "description": "フォト説明1" }, { "albumId": "mixi.jp:123456", "fileSize": "10522", "thumbnailUrl": "http://ic.photo.mixi.jp/v/xxxxxxxxxxxxxxx/xxxxx/picture/xxxxxxxxxxxxx_XXXXXXXXXX_XXXsmall.jpg", "url": "http://ic.photo.mixi.jp/v/xxxxxxxxxxxxxxx/xxxxx/picture/xxxxxxxxxxxxx_XXXXXXXXXX_XXXlarge.jpg", "id": "mixi.jp:XXXXXXXXXX", "title": "フォトタイトル2", "description": "フォト説明2" } ], "startIndex": "0", "itemsPerPage": "20", "totalResults": 2 }
参照
モバイル: http://developer.mixi.co.jp/appli/spec/mob/mobile_api_detail/