Skip to main content

mobage.api

概要​

このモジュール中の機能はMobage Open Platformが提供するSocial APIをJavaScriptから呼び出す為の機能が含まれています。

機能一覧​

mobage.api モジュールには以下のサブモジュールとメソッドがあります。また原則として、このモジュールの各メソッドで用いる事が可能なパラメータ等はバックエンドのRESTful APIに準拠します。

共通事項​

Common Query Parameters​

mobage.api モジュールに属するAPIはRESTful APIと同様にGET系のメソッドや一部のPUTメソッドで絞り込みや並べ替えの為のクエリパラメータを指定する事が出来ます。
以下にクエリパラメータを指定します。これらの利用に関しては前項に記載した対応するRESTful APIのリファレンスを参考にして下さい。

propertytitletyperequireddescription
fields取得したいフィールド一覧arrayfalse取得したいフィールドをカンマ区切りのリストとして指定します。
count取得したい件数integerfalse取得したい件数を指定します。省略した場合は通常 50 が指定された物とみなされます。
startIndex開始位置integerfalse開始位置を指定します。デフォルト値及び最小値は 1 です。
filterByフィルタ条件フィールドintegerfalse条件指定したいフィールド名を指定します。
filterOpフィルタ条件式stringfalseequals 等の条件式を指定します。
filterValueフィルタ値stringfalseフィルタ条件の値を指定します。
sortByソートフィールドstringfalseソート条件のフィールド名を指定します。
sortOrderソート順stringfalseソートの順序 (ascending, descending)を指定します。

Error Response​

Social APIの実行がエラーだった場合にはmobage.error.APIErrorオブジェクトが前項で説明したCallback関数の
error引数に渡されます。この mobage.error.APIErrorオブジェクトが持つプロパティを以下に示します。

propertytitletypedescription
httpStatusHTTP レスポンスステータスコードinteger実際に返された HTTP ステータスコード値です。
titleエラータイトルstringHuman Readable なエラーのタイトルです。
detailエラー詳細string(Optional) エラーの補足情報です。

メソッド​

mobage.api.people.get​

People の取得を行う API です。People API - RESTful APIのJavaScriptインターフェースです。

構文​

mobage.api.people.get(params , cb);

パラメータ​

params​

Object 型のパラメータです。以下に示したプロパティを設定する事が出来ます。

propertytitletyperequireddescription
userIdユーザー IDstringtrue中心となるユーザーのIDを指定します。@meを指定するとaccess tokenのRe-sourceOwnerのユーザIDが指定された物とみなされます。
groupIdグループ IDstringtrue@self を指定した場合には自分自身のリソースを参照し@friends, @allを指定した場合は{userId}で指定したユーザーの友達一覧のリソースが参照されます。
personId相手のユーザーIDstringfalse{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 型のパラメータです。以下に示したプロパティを設定する事が出来ます。

propertytitletyperequireddescription
userIdユーザー IDstringtrue中心となるユーザーのIDを指定します。@meを指定するとaccess tokenのRe-sourceOwnerのユーザIDが指定された物とみなされます。
groupIdグループ IDarraytrue@self を指定した場合には自分自身のリソースを参照し@friends, @allを指定した場合はuserIdで指定したユーザーの友達一覧のリソースが参照されます。
appIdアプリケーション IDarraytrue@appまたは現在実行しているアプリケーションの ID を指定して下さい。

cb​

function型のパラメータです。

mobage.api.appdata.update​

note

Appdataの作成および更新される場合はこちらのメソッドをご利用ください。

構文​

mobage.api.appdata.update(params , cb);

パラメータ​

params​

Object型のパラメータです。以下に示したプロパティを設定する事が出来ます。

propertytitletyperequireddescription
userIdユーザー IDstringtrue中心となるユーザーのIDを指定します。@meを指定するとaccess tokenのRe-sourceOwnerのユーザIDが指定された物とみなされます。
groupIdグループ IDarraytrue@self を指定した場合には自分自身のリソースを参照し@friends, @allを指定した場合はuserIdで指定したユーザーの友達一覧のリソースが参照されます。
appIdアプリケーション IDarraytrue@appまたは現在実行しているアプリケーションの ID を指定して下さい。

cb​

function 型のパラメータです。

mobage.api.appdata.delete​

構文​

mobage.api.appdata.delete(params , cb);

パラメータ​

params​

Object型のパラメータです。以下に示したプロパティを設定する事が出来ます。

propertytitletyperequireddescription
userIdユーザー IDstringtrue中心となるユーザーのIDを指定します。@meを指定するとaccess tokenのRe-sourceOwnerのユーザIDが指定された物とみなされます。
groupIdグループ IDarraytrue@self を指定した場合には自分自身のリソースを参照し@friends, @allを指定した場合はuserIdで指定したユーザーの友達一覧のリソースが参照されます。
appIdアプリケーション IDarraytrue@appまたは現在実行しているアプリケーションの ID を指定して下さい。

cb​

function型のパラメータです。

mobage.api.avatar.get​

Avatarの取得を行う API です。Avatar API - RESTful APIのJavaScriptインターフェースです。

構文​

mobage.api.avatar.get(params , cb);

パラメータ​

params​

Object 型のパラメータです。以下に示したプロパティを設定する事が出来ます。

propertytitletyperequireddescription
userIdユーザー IDstring or arraytrue中心となるユーザーのIDを指定します。@meを指定するとaccess tokenのRe-sourceOwnerのユーザIDが指定された物とみなされます。
groupIdグループ IDstringtrue@self を指定した場合には自分自身のリソースを参照し@friends, @allを指定した場合はuserIdで指定したユーザーの友達一覧のリソースが参照されます。
size大きさstringfalselarge/medium/small のいずれかを指定します。
view表示stringfalseentire/upper のいずれかを指定します。
emotion表情stringfalsedefined/normal/smile/cry/angry/shyのいずれかを指定します。
dimension2D/3D の選択stringfalsedefined/2D/3D のいずれかを指定します。
transaparent透過stringfalsetrue/false のいずれかを指定します。
typeフォーマット形式stringfalseimage のいずれかを指定します。
extensionフォーマット拡張子stringfalsegif/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 型のパラメータです。以下に示したプロパティを設定する事が出来ます。

propertytitletyperequireddescription
appIdアプリケーション IDstringtrue@appまたは現在実行しているアプリケーションの ID を指定して下さい。
textdataGroupNameTextDataGroup の namestringtrueTextDataGroup の name フィールド値を指定します。
groupIdグループ IDstringtrue@all を指定します。
textdataIdTextData の idstring or arrayfalseTextData の 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 型のパラメータです。以下に示したプロパティを設定する事が出来ます。

propertytitletyperequireddescription
appIdアプリケーション IDstringtrue@appまたは現在実行しているアプリケーションの ID を指定して下さい。
groupIdグループ IDstringtrue@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 型のパラメータです。以下に示したプロパティを設定する事が出来ます。

propertytitletyperequireddescription
text自由文テキストstringtrueユーザーから投稿された自由文テキストを指定して下さい。

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 型のパラメータです。以下に示したプロパティを設定する事が出来ます。

propertytitletyperequireddescription
userIdユーザー IDstringtrue現在ログインしているユーザを表す @me、またはユーザID。
groupIdグループ IDstringtrue@all を指定します。
personIdユーザー IDstringtrueユーザのブラックリストに登録されているかを確認したいユーザ 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 型のパラメータです。以下に示したプロパティを設定する事が出来ます。

propertytitletyperequireddescription
appIdアプリケーション IDstringtrue@app またはアプリケーションID を指定します。
itemIdアイテム IDstringfalseMobage 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 型のパラメータです。以下に示したプロパティを設定する事が出来ます。

propertytitletyperequireddescription
appIdアプリケーション IDstringtrue@app またはアプリケーションの ID を指定します。
channelIdチャンネル IDstringfalseチャンネルの 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 型のパラメータです。以下に示したプロパティを設定する事が出来ます。

propertytitletyperequireddescription
appIdアプリケーション IDstringtrue@app またはアプリケーションの ID を指定します。
channelIdチャンネル IDstringtrueチャンネルの ID を指定します。
idChat Member の idstringfalseChat 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型のパラメータです。以下に示したプロパティを設定する事が出来ます。

propertytitletyperequireddescription
appIdアプリケーション IDstringtrue@app またはアプリケーションの ID を指定します。
channelIdチャンネル IDstringtrueチャンネルの ID を指定します。
idChat Member の idstringfalseChat 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型のパラメータです。以下に示したプロパティを設定する事が出来ます。

propertytitletyperequireddescription
userIdユーザー IDstringtrue@me またはユーザーの ID を指定します。
groupIdグループ IDstringtrue@self を指定します。
channelIdチャンネル IDstringfalseチャンネルの ID を指定します。

cb​

function型のパラメータです。

説明​

詳細についてはUserChatChannel API - RESTful APIもあわせてご確認下さい。