1.概要
People APIは、ゲームプラットフォームが持つ以下の情報にアクセスできます。
-
- ニックネーム
- 生年月日
- 性別
- 地域
- アバター画像(SP用)
- アバター画像(FP用)
- 初心者フラグ
- 友達リスト
- myCode
2.オブジェクトフィールド
2.1 Person
| パラメータ | 内容 | 型 |
| id | ユーザーID | string |
| nickname | ニックネーム | string |
| birthday | 誕生日 | date |
| age | 年齢 | string |
| region | 地域 | string |
| avatar_sp | アバター画像(SP用) | string |
| avatar_fp | アバター画像(FP用) | string |
| beginner | 初心者向けガチャ対象者 0:非対象、1:対象 ※パラメータ「selector」が@selfの場合のみ表示 |
Integer |
| mycode | myCode ※ユーザー向けの特定用コード |
String |
3.リクエスト
3.1 エンドポイントURL
http://gpf-api.[対象ドメイン]/social/people/{uid}/{selector}
3.2 HTTPメソッド
| HTTPメソッド | 機能 |
| GET | Personオブジェクトの取得 |
| PUT | – |
| POST | – |
| DELETE | – |
3.3 認証
HTTPヘッダーに以下の値を設定してください。全て必須項目です。
| キー | 値 |
| Authorization | 呼び出しユーザーのsapkeyを指定 |
| GAME_CODE | 利用ゲームのGAME_CODE |
| Hash | SHA1(Authorizaion + GAME_CODE + API_KEY) |
3.4 テンプレートパラメータ
uid（必須）
| パラメータ | 内容 |
| @me | 呼び出しユーザー |
selector（必須）
| パラメータ | 内容 |
| @self | uidパラメータで指定したユーザー自身のプロフィール情報を取得します |
| @friends | uidパラメータで指定したユーザーの友達情報を取得します |
3.5 クエリパラメータ
format
| パラメータ | 内容 | 備考 |
| json | “application/json;charset=utf8” | デフォルトでセットされます。 |
fields
| パラメータ | 内容 | 備考 |
| 任意の文字列 | 取得対象となるPersonオブジェクトのフィールド名 | 複数の場合カンマ区切りで指定可能 |
count
| パラメータ | 内容 | 備考 |
| 任意の自然数 | 最大取得件数 |
startIndex
| パラメータ | 内容 | 備考 |
| 任意の自然数 | 取得するPersonオブジェクトの開始値 |
filterBy
| パラメータ | 内容 | 備考 |
| isMobile | モバイル会員かどうか | 必ずfilterOp、filterValueと共に用いる |
| isGame | ゲーム会員かどうか | 必ずfilterOp、filterValueと共に用いる |
filterOp
| パラメータ | 内容 | 備考 |
| equals | filterByで指定したフィールドがfilterValueで指定した値と等しいかどうか | 必ずfilterBy、filterValueと共に用いる |
filterValue
| パラメータ | 内容 | 備考 |
| true | 真 | 必ずfilterBy、filterOpと共に用いる |
| false | 偽 | 必ずfilterBy、filterOpと共に用いる |
4.レスポンス
| HTTPメソッド | レスポンスコード | 内容 |
| GET | 200 | データ取得正常終了 |
| GET | 400 | リクエスト不正 |
| GET | 401 | 認証失敗 |
| POST/PUT/DELETE | 403 | 許可されていないメソッド |
| GET | 500 | プラットフォームエラー |
X.サンプル
X.1 ユーザーの情報を取得する
| リクエスト | http://gpf-api.ymdunisys.jp/social/people/@me/@self |
| JSON | { “entry”:[ { “age”:”18″, “birthday”:”1995/04/30″, “gender”:”2″, “id”:”1151252574130c50684384386c99268003465a46d9c732c0b5baecdaed631dfa”, “nickname”:”会員⑥”, “region”: “名古屋”, “avatar_fp”:”http://gpf.ymdunisys.jp/images/avatar/avatar_fp1_2.jpg”, “avatar_sp”:”http://gpf.ymdunisys.jp/images/avatar/avatar_sp1_2.png”, “beginner”:”1″, “mycode”:”123avcd” } ], “itemsPerPage”: 0, “startIndex”: 0, “totalResults”: 1 } |
X.2 フレンド情報を取得する
| リクエスト | http://gpf-api.ymdunisys.jp/social/people/@me/@friends |
| JSON | { “entry”:[ { “region”:null, “id”:”11512525742bf95ad365457f765ee35260b58de1d32b095f860ce4cfc42307a7″, “birthday”:null, “nickname”:””, “age”:null, “gender”:null, “avatar_fp”:”http://gpf.ymdunisys.jp/images/avatar/avatar_fp1_2.jpg”, “avatar_sp”:”http://gpf.ymdunisys.jp/images/avatar/avatar_sp1_2.png”, “mycode”:”123avcd” },{ “region”:null, “id”:”115125257446a9056f06d3bfdd15f425a5350a1f38e4d13d1b3a963623c814a9″, “birthday”:null, “nickname”:null, “age”:null, “gender”:null, “avatar_fp”:”http://gpf.ymdunisys.jp/images/avatar/avatar_fp1_2.jpg”, “avatar_sp”:”http://gpf.ymdunisys.jp/images/avatar/avatar_sp1_2.png”, “mycode”:”99999a” }, ※以下、フレンドの情報が続きます※ ], “itemsPerPage”:0, “startIndex”:0, “totalResults”:20 } |
※以下のパターンのGET引数のパラメータは複合して設定する事が可能です。
X.3 フレンド情報またはユーザー情報を、取得項目を指定して取得する
| リクエスト | http://gpf-api.ymdunisys.jp/social/people/@me/@friends?fields=region,nickname |
| JSON | { “entry”:[ { “region”:null, “nickname”:”会員ガラケー” }, { “region”:”東京”, “nickname”:”エーユー 1111″ },※以下、フレンドの情 報が続きます※ ], “itemsPerPage”:0, “startIndex”:0, “totalResults”:20 } |
X.4 フレンド情報を、取得件数を指定して取得する
| リクエスト | http://gpf-api.ymdunisys.jp/social/people/@me/@friends?count=5 |
| JSON | { “entry”:[ { “region”:null, “id”:”115125257446a9056f06d3bfdd15f425a5350a1f38e4d13d1b3a963623c814a9″, “birthday”:null, “nickname”:null, “age”:null, “gender”:null, “avatar_fp”:”http://gpf.ymdunisys.jp/images/avatar/avatar_fp1_2.jpg”, “avatar_sp”:”http://gpf.ymdunisys.jp/images/avatar/avatar_sp1_2.png”, “mycode”:”123avcd” }, { “region”:null, “id”:”1151252574988b2e6c9fb925b054c7b03243e560dd5c4e1f76efdc3ebcf4c9d2″, “birthday”:null, “nickname”:null, “age”:null, “gender”:null, “avatar_fp”:”http://gpf.ymdunisys.jp/images/avatar/avatar_fp1_2.jpg”, “avatar_sp”:”http://gpf.ymdunisys.jp/images/avatar/avatar_sp1_2.png” }, { “region”:null, “id”:”11512525748931a2399a7e9663705b0bc49a605112b4b47b5f286f3a88cda02a”, “birthday”:null, “nickname”:”hamamatsu”, “age”:null, “gender”:null “avatar_fp”:”http://gpf.ymdunisys.jp/images/avatar/avatar_fp1_2.jpg”, “avatar_sp”:”http://gpf.ymdunisys.jp/images/avatar/avatar_sp1_2.png”, “mycode”:”123avcd” }, { “region”:”東京”, “id”:”22221111″, “birthday”:”2000/03/05″, “nickname”:null, “age”:”13″, “gender”:”2″, “avatar_fp”:”http://gpf.ymdunisys.jp/images/avatar/avatar_fp1_2.jpg”, “avatar_sp”:”http://gpf.ymdunisys.jp/images/avatar/avatar_sp1_2.png”, “mycode”:”123avcd” }, { “region”:”大阪”, “id”:”2222111d1″, “birthday”:”1981/08/12″, “nickname”:null, “age”:”31″, “gender”:”1″, “avatar_fp”:”http://gpf.ymdunisys.jp/images/avatar/avatar_fp1_2.jpg”, “avatar_sp”:”http://gpf.ymdunisys.jp/images/avatar/avatar_sp1_2.png” } ], “itemsPerPage”:5, “startIndex”:0, “totalResults”:5 } |
X.5 フレンド情報を、取得開始データを指定して取得する
| リクエスト | http://gpf-api.ymdunisys.jp/social/people/@me/@friends?startIndex=2 ※1件目からの場合は0、2件目からの場合は1、のように「取得開始データ-1」の値を指定してください。 |
| JSON | { “entry”:[ { “region”:null, “id”:”1151252574df867cbf9afb972b4a6d9ecacf37f950c3d60e4e9852ff6da9600e”, “birthday”:null, “nickname”:”エーユージクス2″, “age”:null, “gender”:null, “avatar_fp”:”http://gpf.ymdunisys.jp/images/avatar/avatar_fp1_2.jpg”, “avatar_sp”:”http://gpf.ymdunisys.jp/images/avatar/avatar_sp1_2.png” }, { “region”:null, “id”:”1151252574993e8326517a6cf87078bfeb01893a351ffdc4bf362228acefaf21″, “birthday”:null, “nickname”:”会員ガラケー”, “age”:null, “gender”:null, “avatar_fp”:”http://gpf.ymdunisys.jp/images/avatar/avatar_fp1_2.jpg”, “avatar_sp”:”http://gpf.ymdunisys.jp/images/avatar/avatar_sp1_2.png” }, ※以下、フレンドの情報が続きます※ ], “itemsPerPage”:0, “startIndex”:2, “totalResults”:18 } |
X.6 フレンド情報を、モバイル会員、ゲーム会員の状態を指定して取得する
| リクエスト | http://gpf-api.ymdunisys.jp/social/people/@me/@friends?filterBy=isGame&filterOp=equals&filterValue=true |
| JSON | { “entry”:[ { “region”:null, “id”:”115125257446a9056f06d3bfdd15f425a5350a1f38e4d13d1b3a963623c814a9″, “birthday”:null, “nickname”:null, “age”:null, “gender”:null, “avatar_fp”:”http://gpf.ymdunisys.jp/images/avatar/avatar_fp1_2.jpg”, “avatar_sp”:”http://gpf.ymdunisys.jp/images/avatar/avatar_sp1_2.png”, “mycode”:”123avcd” }, { “region”:null, “id”:”1151252574e83eb4bb450aa6742171dfb86d9ae79fddec80e29d9018db5159d9″, “birthday”:null, “nickname”:null, “age”:null, “gender”:null, “avatar_fp”:”http://gpf.ymdunisys.jp/images/avatar/avatar_fp1_2.jpg”, “avatar_sp”:”http://gpf.ymdunisys.jp/images/avatar/avatar_sp1_2.png”, “mycode”:”123avcd” }, { “region”:null, “id”:”1151252574988b2e6c9fb925b054c7b03243e560dd5c4e1f76efdc3ebcf4c9d2″, “birthday”:null, “nickname”:null, “age”:null, “gender”:null, “avatar_fp”:”http://gpf.ymdunisys.jp/images/avatar/avatar_fp1_2.jpg”, “avatar_sp”:”http://gpf.ymdunisys.jp/images/avatar/avatar_sp1_2.png”, “mycode”:”123avcd” }, { “region”:null, “id”:”1151252574127e325228da45854beb082c03c381ccad5bb6a6af3df0fb2a85de”, “birthday”:null, “nickname”:null, “age”:null, “gender”:null, “avatar_fp”:”http://gpf.ymdunisys.jp/images/avatar/avatar_fp1_2.jpg”, “avatar_sp”:”http://gpf.ymdunisys.jp/images/avatar/avatar_sp1_2.png”, “mycode”:”123avcd” } ], “itemsPerPage”:0, “startIndex”:0, “totalResults”:4 } |