アバターを取得する
事前準備
Mobage のユーザーはそれぞれアバターを持っています。Mobageオープンプラットフォームではユーザーのアバターをアプリケーション内で利用できるようにAPIを提供しています。
このAPIを利用するには Gadget XMLで Require 要素で mbga feature の仕様を宣言する必要があります。
<?xml version="1.0" encoding="UTF-8"?>
<Module>
<ModulePrefs title="Hello, world!">
<Require feature="opensocial-0.8" />
<Require feature="mbga" />
...
VIEWER のアバターを取得する
VIEWERのアバターを取得するサンプルは以下のようになります。
var idSpec = opensocial.newIdSpec();
idSpec.setField(opensocial.IdSpec.Field.USER_ID, opensocial.IdSpec.PersonId.VIEWER);
idSpec.setField(opensocial.IdSpec.Field.GROUP_ID, opensocial.IdSpec.GroupId.SELF);
var opt_params = {};
mbga.requestFetchAvatar(idSpec, opt_params, function(response) {
if (response.hadError()) {
// error
} else {
var avatar = response.getData();
var url = avatar.getUrl();
// ...
}
});
- 対象となるユーザーの IdSpec を作成します。このとき、USER_IDには VIEWER、OWNER、任意のユーザーIDを配列で指定します。GROUP_ID には SELF のみが指定できます。
- mbga.requestFetchAvatar() メソッドでアバター情報の取得を要求します。
- リクエストが成功すると DataResponse に mbga.Avatar オブジェクトが格納されて返ってきます。
パラメータを指定しなかった場合、Avatarオブジェクトの各パラメータは
- フォーマット: GIF
- サイズ: MEDIUM
- 表示: ENTIRE
- 表情: ユーザーが指定しているもの
になります。
詳細なアバター属性を指定する
より詳細な属性を指定する場合には以下のようにします。
var idSpec = opensocial.newIdSpec();
idSpec.setField(opensocial.IdSpec.Field.USER_ID, opensocial.IdSpec.PersonId.VIEWER);
idSpec.setField(opensocial.IdSpec.Field.GROUP_ID, opensocial.IdSpec.GroupId.SELF);
var avatar_params = {};
avatar_params[mbga.Avatar.Field.SIZE] = mbga.Enum.Avatar.Size.X_LARGE;
avatar_params[mbga.Avatar.Field.EMOTION] = mbga.Enum.Avatar.Emotion.SMILE;
avatar_params[mbga.Avatar.Field.TYPE] = mbga.Enum.Avatar.Type.IMAGE;
avatar_params[mbga.Avatar.Field.EXTENSION] = mbga.Enum.Avatar.Extension.GIF;
var opt_params = {};
opt_params[mbga.AvatarRequestFields.AVATAR] = avatar_params;
mbga.requestFetchAvatar(idSpec, opt_params, function(response) {
if (response.hadError()) {
// error
} else {
var avatar = response.getData();
var url = avatar.getUrl();
}
});
複数のユーザーのアバターを取得する
複数のユーザーのアバターを一度に取ることも出来ます。VIEWERのモバ友のアバターを取得するには以下のようにします。
var params = {};
params[opensocial.IdSpec.Field.USER_ID] = opensocial.IdSpec.PersonId.VIEWER;
params[opensocial.IdSpec.Field.GROUP_ID] = opensocial.IdSpec.GroupId.FRIENDS;
var idSpec = opensocial.newIdSpec(params);
var req = opensocial.newDataRequest();
req.add(req.newFetchPeopleRequest(idSpec), "friends");
req.send(function(response) {
if (response.hadError()) {
// error
} else {
var friendIds = [];
var friends = response.get("friends").getData();
friends.each(function(friend) {
friendIds.push(friend.getId());
});
idSpec = opensocial.newIdSpec();
idSpec.setField(opensocial.IdSpec.Field.USER_ID, friendIds);
idSpec.setField(opensocial.IdSpec.Field.GROUP_ID, opensocial.IdSpec.GroupId.SELF);
var opt_params = {};
mbga.requestFetchAvatar(idSpec, opt_params, function(response) {
if (response.hadError()) {
// error
} else {
var avatars = response.getData();
avatars.each(function(avatar) {
var url = avatar.getUrl();
// ...
});
}
});
}
});
- まず newFetchPeopleRequest() メソッドで VIEWER のモバ友を取得します。
- モバ友のユーザーIDの配列を作ります。
- この配列を requestFetchAvatar() メソッドの引数にしてアバター情報の取得を要求します。
- 複数のユーザーを指定した場合、 DataResponse には Avatar オブジェクトのコレクションが格納されるので、それを処理します。
アバター取得時の制限事項
- 3Dアバターのみの取得になります。
更新履歴
- 2013/03/15
- ドキュメント移行