跳到主要内容

BlackList

BlackList API では、特定のユーザーがアプリケーションをインストールしているユーザーの中でブラックリストに登録しているユーザーを取得します。


BlackList オブジェクトフィールド​

値説明型名前空間補足
idBlackList の所持者の guidxs:stringhttp://ns.dena.jp/mbga/gameapi/v1–
appId現在実行中のアプリケーション IDxs:inthttp://ns.dena.jp/mbga/gameapi/v1–
targetIdBlackList に追加されているユーザーの guidxs:stringhttp://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 パラメータは下記のいずれかの値を指定します。

値説明備考
@meviewer の guid必須
{guid}ユーザー ID必須

guid に有効なユーザー ID を指定する場合、そのアプリケーションをユーザーがインストールしている必要があります。

selector​

selector パラメータは下記のいずれかの値を指定します。

値説明備考
@allguid パラメータで指定したユーザーがブラックリストに登録しており、現在実行中のアプリケーションをインストールしているユーザーを対象とした 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 メソッドレスポンスコードレスポンスメッセージ説明
GET200OK正常にデータ取得が完了しました
GET400Bad Requestリクエストデータが不正です
GET401UnauthorizedOAuth による認可が失敗しています
GET403Forbiddenアプリケーションをインストールしていないユーザーです
GET404Not Foundブラックリストに登録されていないユーザーです
GET500Internal Server ErrorAPI 側の問題による失敗です

注意事項​

  • 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
    • 新規作成
  • BlackList オブジェクトフィールド
  • API リクエスト
    • HTTP メソッド
    • エンドポイント URL
    • クエリパラメータ
  • API レスポンス
    • レスポンスコード
  • 注意事項
  • サンプル
    • viewer が登録している BlackList コレクションを取得する
  • 二者間でのブラックリストチェック
  • 参考資料
  • 更新履歴