mobage.api
概要
このモジュール中の機能はMobage Open Platformが提供するSocial APIをJavaScriptから呼び出す為の機能が含まれています。
機能一覧
mobage.api モジュールには以下のサブモジュールとメソッドがあります。また原則として、このモジュールの各メソッドで用いる事が可能なパラメータ等はバックエンドのRESTful APIに準拠します。
- mobage.api.people
- mobage.api.appdata
- mobage.api.avatar
- mobage.api.textdata
- mobage.api.textdataGroup
- mobage.api.profanity
- mobage.api.blacklist
- mobage.api.bankInventory
- mobage.api.chatChannel
- mobage.api.chatMember
- mobage.api.chatMessage
- mobage.api.chatUserChannel
共通事項
Common Query Parameters
mobage.api モジュールに属するAPIはRESTful APIと同様にGET系のメソッドや一部のPUTメソッドで絞り込みや並べ替えの為のクエリパラメータを指定する事が出来ます。
以下にクエリパラメータを指定します。これらの利用に関しては前項に記載した対応するRESTful APIのリファレンスを参考にして下さい。
| property | title | type | required | description |
|---|---|---|---|---|
| fields | 取得したいフィールド一覧 | array | false | 取得したいフィールドをカンマ区切りのリストとして指定します。 |
| count | 取得したい件数 | integer | false | 取得したい件数を指定します。省略した場合は通常 50 が指定された物とみなされます。 |
| startIndex | 開始位置 | integer | false | 開始位置を指定します。デフォルト値及び最小値は 1 です。 |
| filterBy | フィルタ条件フィールド | integer | false | 条件指定したいフィールド名を指定します。 |
| filterOp | フィルタ条件式 | string | false | equals 等の条件式を指定します。 |
| filterValue | フィルタ値 | string | false | フィルタ条件の値を指定します。 |
| sortBy | ソートフィールド | string | false | ソート条件のフィールド名を指定します。 |
| sortOrder | ソート順 | string | false | ソートの順序 (ascending, descending)を指定します。 |
Error Response
Social APIの実行がエラーだった場合にはmobage.error.APIErrorオブジェクトが前項で説明したCallback関数の
error引数に渡されます。この mobage.error.APIErrorオブジェクトが持つプロパティを以下に示します。
| property | title | type | description |
|---|---|---|---|
| httpStatus | HTTP レスポンスステータスコード | integer | 実際に返された HTTP ステータスコード値です。 |
| title | エラータイトル | string | Human Readable なエラーのタイトルです。 |
| detail | エラー詳細 | string | (Optional) エラーの補足情報です。 |
メソッド
mobage.api.people.get
People の取得を行う API です。People API - RESTful APIのJavaScriptインターフェースです。
構文
mobage.api.people.get(params , cb);
パラメータ
params
Object 型のパラメータです。以下に示したプロパティを設定する事が出来ます。
| property | title | type | required | description |
|---|---|---|---|---|
| userId | ユーザー ID | string | true | 中心となるユーザーのIDを指定します。@meを指定するとaccess tokenのRe-sourceOwnerのユーザIDが指定された物とみなされます。 |
| groupId | グループ ID | string | true | @self を指定した場合には自分自身のリソースを参照し@friends, @allを指定した場合は{userId}で指定したユーザーの友達一覧のリソースが参照されます。 |
| personId | 相手のユーザーID | string | false | {groupId}に@friends, @all が指定された場合に{personId}を指定した場合、友達ではない場合に404 Not Found が返って来ます。 |
cb
function型のパラメータです。
説明
詳細についてはPeople API - RESTful APIもあわせてご確認下さい。
mobage.api.appdata.get
Appdataの設定、取得を行うAPI です。AppData API - RESTful APIのJavaScriptインターフェースです。
構文
mobage.api.appdata.get(params , cb);
パラメータ
params
Object 型のパラメータです。以下に示したプロパティを設定する事が出来ます。
| property | title | type | required | description |
|---|---|---|---|---|
| userId | ユーザー ID | string | true | 中心となるユーザーのIDを指定します。@meを指定するとaccess tokenのRe-sourceOwnerのユーザIDが指定された物とみなされます。 |
| groupId | グループ ID | array | true | @self を指定した場合には自分自身のリソースを参照し@friends, @allを指定した場合はuserIdで指定したユーザーの友達一覧のリソースが参照されます。 |
| appId | アプリケーション ID | array | true | @appまたは現在実行しているアプリケーションの ID を指定して下さい。 |
cb
function型のパラメータです。
mobage.api.appdata.update
Appdataの作成および更新される場合はこちらのメソッドをご利用ください。
構文
mobage.api.appdata.update(params , cb);
パラメータ
params
Object型のパラメータです。以下に示したプロパティを設定する事が出来ます。
| property | title | type | required | description |
|---|---|---|---|---|
| userId | ユーザー ID | string | true | 中心となるユーザーのIDを指定します。@meを指定するとaccess tokenのRe-sourceOwnerのユーザIDが指定された物とみなされます。 |
| groupId | グループ ID | array | true | @self を指定した場合には自分自身のリソースを参照し@friends, @allを指定した場合はuserIdで指定したユーザーの友達一覧のリソースが参照されます。 |
| appId | アプリケーション ID | array | true | @appまたは現在実行しているアプリケーションの ID を指定して下さい。 |
cb
function 型のパラメータです。
mobage.api.appdata.delete
構文
mobage.api.appdata.delete(params , cb);
パラメータ
params
Object型のパラメータです。以下に示したプロパティを設定する事が出来ます。
| property | title | type | required | description |
|---|---|---|---|---|
| userId | ユーザー ID | string | true | 中心となるユーザーのIDを指定します。@meを指定するとaccess tokenのRe-sourceOwnerのユーザIDが指定された物とみなされます。 |
| groupId | グループ ID | array | true | @self を指定した場合には自分自身のリソースを参照し@friends, @allを指定した場合はuserIdで指定したユーザーの友達一覧のリソースが参照されます。 |
| appId | アプリケーション ID | array | true | @appまたは現在実行しているアプリケーションの ID を指定して下さい。 |
cb
function型のパラメータです。
mobage.api.avatar.get
Avatarの取得を行う API です。Avatar API - RESTful APIのJavaScriptインターフェースです。
構文
mobage.api.avatar.get(params , cb);
パラメータ
params
Object 型のパラメータです。以下に示したプロパティを設定する事が出来ます。
| property | title | type | required | description |
|---|---|---|---|---|
| userId | ユーザー ID | string or array | true | 中心となるユーザーのIDを指定します。@meを指定するとaccess tokenのRe-sourceOwnerのユーザIDが指定された物とみなされます。 |
| groupId | グループ ID | string | true | @self を指定した場合には自分自身のリソースを参照し@friends, @allを指定した場合はuserIdで指定したユーザーの友達一覧のリソースが参照されます。 |
| size | 大きさ | string | false | large/medium/small のいずれかを指定します。 |
| view | 表示 | string | false | entire/upper のいずれかを指定します。 |
| emotion | 表情 | string | false | defined/normal/smile/cry/angry/shyのいずれかを指定します。 |
| dimension | 2D/3D の選択 | string | false | defined/2D/3D のいずれかを指定します。 |
| transaparent | 透過 | string | false | true/false のいずれかを指定します。 |
| type | フォーマット形式 | string | false | image のいずれかを指定します。 |
| extension | フォーマット拡張子 | string | false | gif/png のいずれかを指定します。 |
cb
function型のパラメータです。
説明
詳細については Avatar API - RESTful APIもあわせてご確認下さい。
mobage.api.textdata.get
TextDataの取得を行うAPI です。TextData API - RESTful APIのJavaScriptインターフェースです。
構文
mobage.api.textdata.get(params , cb);
パラメータ
params
Object 型のパラメータです。以下に示したプロパティを設定する事が出来ます。
| property | title | type | required | description |
|---|---|---|---|---|
| appId | アプリケーション ID | string | true | @appまたは現在実行しているアプリケーションの ID を指定して下さい。 |
| textdataGroupName | TextDataGroup の name | string | true | TextDataGroup の name フィールド値を指定します。 |
| groupId | グループ ID | string | true | @all を指定します。 |
| textdataId | TextData の id | string or array | false | TextData の id を指定します。 |
cb
function型のパラメータです。
説明
詳細についてはTextdata API - RESTful APIもあわせてご確認下さい。
mobage.api.textdataGroup.get
TextDataGroupの取得を行う API です。TextData API - RESTful APIのJavaScriptインターフェースです。
構文
mobage.api. textdataGroup .get(params , cb);
パラメータ
params
Object 型のパラメータです。以下に示したプロパティを設定する事が出来ます。
| property | title | type | required | description |
|---|---|---|---|---|
| appId | アプリケーション ID | string | true | @appまたは現在実行しているアプリケーションの ID を指定して下さい。 |
| groupId | グループ ID | string | true | @all を指定します。 |
cb
function 型のパラメータです。
説明
詳細についてはTextdata API - RESTful APIもあわせてご確認下さい。
mobage.api.profanity.check
ユーザー入力文字列に対して不適切な文言が含まれていないかを調べる API です。Profanity API - RESTful APIのJavaScriptインターフェースです。
構文
mobage.api. profanity .check(params , cb);
パラメータ
params
Object 型のパラメータです。以下に示したプロパティを設定する事が出来ます。
| property | title | type | required | description |
|---|---|---|---|---|
| text | 自由文テキスト | string | true | ユーザーから投稿された自由文テキストを指定して下さい。 |
cb
function 型のパラメータです。
説明
詳細については profanity API - RESTful API もあわせてご確認下さい。
mobage.api.blacklist.get
BlackListの取得を行う API です。BlackList API - RESTful APIのJavaScriptインターフェースです。
構文
mobage.api. blacklist .get(params , cb);
パラメータ
params
Object 型のパラメータです。以下に示したプロパティを設定する事が出来ます。
| property | title | type | required | description |
|---|---|---|---|---|
| userId | ユーザー ID | string | true | 現在ログインしているユーザを表す @me、またはユーザID。 |
| groupId | グループ ID | string | true | @all を指定します。 |
| personId | ユーザー ID | string | true | ユーザのブラックリストに登録されているかを確認したいユーザ ID。 |
cb
function型のパラメータです。
説明
詳細についてはBlacklist API - RESTful APIもあわせてご確認下さい。
mobage.api.bankInventory.get
Bank Inventoryの取得を行うAPI です。Bank API - RESTful API 中の Inventory を扱うJavaScriptインターフェースです。
構文
mobage.api. bankInventory .get(params , cb);
パラメータ
params
Object 型のパラメータです。以下に示したプロパティを設定する事が出来ます。
| property | title | type | required | description |
|---|---|---|---|---|
| appId | アプリケーション ID | string | true | @app またはアプリケーションID を指定します。 |
| itemId | アイテム ID | string | false | Mobage Developers Japan(デベロッパーサイト)に登録した特定のアイテムIDを指定します。 |
cb
function 型のパラメータです。
説明
詳細についてはBlacklist API - RESTful APIもあわせてご確認下さい。
mobage.api.chatChannel.get
Chat Channelの取得を行うAPI です。Chat Channel API - RESTful APIのJavaScriptインターフェースです。
構文
mobage.api. chatChannel .get(params , cb);
パラメータ
params
Object 型のパラメータです。以下に示したプロパティを設定する事が出来ます。
| property | title | type | required | description |
|---|---|---|---|---|
| appId | アプリケーション ID | string | true | @app またはアプリケーションの ID を指定します。 |
| channelId | チャンネル ID | string | false | チャンネルの ID を指定します。 |
cb
function 型のパラメータです。
説明
詳細については ChatChannel API - RESTful API もあわせてご確認下さい。
mobage.api.chatMember.get
Chat Member の取得を行う API です。Chat Member API - RESTful APIのJavaScript インターフェースです。
構文
mobage.api. chatMember .get(params , cb);
パラメータ
params
Object 型のパラメータです。以下に示したプロパティを設定する事が出来ます。
| property | title | type | required | description |
|---|---|---|---|---|
| appId | アプリケーション ID | string | true | @app またはアプリケーションの ID を指定します。 |
| channelId | チャンネル ID | string | true | チャンネルの ID を指定します。 |
| id | Chat Member の id | string | false | Chat Member オブジェクトの ID を指定します。 |
cb
function型のパラメータです。
説明
詳細についてはChatMember API - RESTful APIもあわせてご確認下さい。
mobage.api.chatMessage.get
Chat Message の取得を行う API です。Chat Message API - RESTful API の JavaScript インターフェースです。
構文
mobage.api. chatMessage .get(params , cb);
パラメータ
params
Object型のパラメータです。以下に示したプロパティを設定する事が出来ます。
| property | title | type | required | description |
|---|---|---|---|---|
| appId | アプリケーション ID | string | true | @app またはアプリケーションの ID を指定します。 |
| channelId | チャンネル ID | string | true | チャンネルの ID を指定します。 |
| id | Chat Member の id | string | false | Chat Member オブジェクトの ID を指定します。 |
cb
function型のパラメータです。
説明
詳細についてはChatMessage API - RESTful APIもあわせてご確認下さい。
mobage.api.userChatChannel.get
User Chat Channelの取得を行う API です。User Chat Channel API - RESTful APIのJavaScript インターフェースです。
構文
mobage.api. userChatChannel .get(params , cb);
パラメータ
params
Object型のパラメータです。以下に示したプロパティを設定する事が出来ます。
| property | title | type | required | description |
|---|---|---|---|---|
| userId | ユーザー ID | string | true | @me またはユーザーの ID を指定します。 |
| groupId | グループ ID | string | true | @self を指定します。 |
| channelId | チャンネル ID | string | false | チャンネルの ID を指定します。 |
cb
function型のパラメータです。
説明
詳細についてはUserChatChannel API - RESTful APIもあわせてご確認下さい。