BlackList
BlackList API では、特定のユーザーがアプリケーションをインストールしているユーザーの中でブラックリストに登録しているユーザーを取得します。
BlackList オブジェクトフィールド
| 値 | 説明 | 型 | 名前空間 | 補足 |
|---|---|---|---|---|
| id | BlackList の所持者の guid | xs:string | http://ns.dena.jp/mbga/gameapi/v1 | – |
| appId | 現在実行中のアプリケーション ID | xs:int | http://ns.dena.jp/mbga/gameapi/v1 | – |
| targetId | BlackList に追加されているユーザーの guid | xs:string | http://ns.dena.jp/mbga/gameapi/v1 | – |
API リクエスト
HTTP メソッド
Proxy モデル
- GET
- ブラックリストエントリの取得
- ブラックリストコレクションの取得
Trusted モデル
- GET
- ブラックリストエントリの取得
- ブラックリストコレクションの取得
エンドポイント URL
-
Sandbox 環境
http://sb.sp.app.mbga.jp/api/restful/v1/blacklist/{guid}/{selector}{-prefix|/|pid} -
本番環境
http://sp.app.mbga.jp/api/restful/v1/blacklist/{guid}/{selector}{-prefix|/|pid}
guid
guid パラメータは下記のいずれかの値を指定します。
| 値 | 説明 | 備考 |
|---|---|---|
| @me | viewer の guid | 必須 |
| {guid} | ユーザー ID | 必須 |
guid に有効なユーザー ID を指定する場合、そのアプリケーションをユーザーがインストールしている必要があります。
selector
selector パラメータは下記のいずれかの値を指定します。
| 値 | 説明 | 備考 |
|---|---|---|
| @all | guid パラメータで指定したユーザーがブラックリストに登録しており、現在実行中のアプリケーションをインストールしているユーザーを対象とした BlackList のコレクションリソースを表します | 必須 |
pid
pid パラメータは selector が @all の時に指定出来ます。
| 値 | 説明 | 備考 |
|---|---|---|
| {guid} | guid パラメータで指定したユーザーがブラックリストに登録しているユーザーの guid です | 任意 |
pid パラメータを指定してエントリリソースの取得を行おうとした際に 200 OK が返ってくればブラックリストに登録されています。404 Not Found が返ってくる場合は、ブラックリストに登録されていないユーザーです。
クエリパラメータ
下記のクエリパラメータを指定する事が出来ます。
format
レスポンス形式を指定する事が出来ます。
| 値 | 説明 | 備考 |
|---|---|---|
| json | "application/json; charset=utf8" | 任意、デフォルト値 |
fields
取得したい属性情報を指定する事が出来ます。指定可能なフィールド名については BlackList オブジェクトフィールドを参照して下さい。
複数指定する場合はスペース無しのカンマ (,) 区切りで指定します。
fields パラメータを省略した場合、下記の属性情報全てを取得します。
パフォーマンス向上の為に、必要な属性のみを取得するようにして下さい。
count
コレクションリソースとしてレスポンスを取得する際に、最大何件のエントリリソースを取得するかを指定出来ます。
デフォルト値は 50 件で、最大 1000 件まで指定出来ます。
startIndex
コレクションリソースの開始値を指定します。省略時は 1 (最小値) が指定されます。
API レスポンス
レスポンスコード
API のレスポンスコードは以下のいずれかになります。
| リクエスト HTTP メソッド | レスポンスコード | レスポンスメッセージ | 説明 |
|---|---|---|---|
| GET | 200 | OK | 正常にデータ取得が完了しました |
| GET | 400 | Bad Request | リクエストデータが不正です |
| GET | 401 | Unauthorized | OAuth による認可が失敗しています |
| GET | 403 | Forbidden | アプリケーションをインストールしていないユーザーです |
| GET | 404 | Not Found | ブラックリストに登録されていないユーザーです |
| GET | 500 | Internal Server Error | API 側の問題による失敗です |
注意事項
- guid に @me 以外を指定した場合は、guid のユーザーがそのアプリケーションをインストールしている必要があります。
- Trusted モデル (Consumer Request) の場合、guid に @me を指定する事は出来ません。400 Bad Request 扱いになります。
- guid に数値以外の値を指定された場合、レスポンスコードは 400 が返ります。
- ユーザーがそのアプリケーションをインストールしていない場合、レスポンスコードは 403 が返ります。
サンプル
viewer が登録している BlackList コレクションを取得する
リクエスト形式
GET /api/restful/v1/blacklist/@me/@all?format=json&fields=id,targetId&count=10&startIndex=1
レスポンス形式
200 OK
{
"entry" : [
{
"targetId" : "sb.mbga.jp:10032",
"id" : "sb.mbga.jp:10028"
},
{
"targetId" : "sb.mbga.jp:10033",
"id" : "sb.mbga.jp:10028"
},
{
"targetId" : "sb.mbga.jp:10039",
"id" : "sb.mbga.jp:10028"
}
],
"startIndex" : 1,
"itemsPerPage" : 10,
"totalResults" : 3
}
二者間でのブラックリストチェック
リクエスト形式
GET /api/restful/v1/blacklist/10028/@all/10045?format=json
レスポンス形式
10028 のユーザーは 10045 のユーザーをブラックリストに登録していないので、404 Not Found が返って来ます。10045 をブラックリストに登録している場合は 200 OK が返って来ます。
404 Not Found
参考資料
XML Schema Part 2: Datatypes Second Edition
URI Template draft-gregorio-uritemplate-03
更新履歴
- 2012/12/11
- 新規作成