OpenSocial Host は JavaScript を使用しています。JavaScript を有効にしてください。
ガイダンス
JavaScript API の概要
OpenSocial Host の JavaScript API は、（1） OpenSocial コンテナが標準で提供する API を PC とモバイルで透過的に扱えるようにするラッパー、および （2） スケーラブルでセキュア、key、value 形式の外部データベースを簡単に操作、管理する API、を提供します。
なお、サーバーサイド JavaScript のテクノロジーにより、OpenSocial Host の JavaScript API は PC でもモバイルでも同じように振る舞います。このため、PC とモバイルの両方に対応するアプリケーションを HTML と JavaScript のみで記述することが可能です。
JavaScript API のロード （PC）
ログイン後、アプリケーションを登録すると Application Key を取得できます。JavaScript API をロードするためには、アプリケーションの Gadget XML に下記のような script タグを埋め込んでください。（MySpace 等、script タグの埋め込みが禁止されているコンテナでは Core API を利用してください。）
なお、Application Key を複数のアプリケーションで共有することはできません。新しいアプリケーションを開発する際には新しい Application Key を取得してください。
JavaScript API のロード （モバイル）
モバイルのアプリケーションで JavaScript API をロードするためには、アプリケーションの mobile ビューの HTML に下記のような script タグを埋め込んでください。（Flash Lite を利用する場合は JavaScript API と併せて Core API を利用してください。）
なお、当該の HTML はマイページの 「ファイル」 で 「サーバーサイド JavaScript 用ファイルアップロード」 を選択し、OpenSocial Host のサーバーサイド JavaScript 実行環境にアップロードする必要があります。
外部データベース
OpenSocial Host の外部データベースは、OpenSocial コンテナが標準で提供する永続データと比較すると容量の制約がなく、また、より詳細なパーミッションモデル を設定することが可能です。実際のアプリケーションの開発では、この外部データベースと標準の永続データをうまく使い分けることが肝になるでしょう。
なお、OpenSocial Host の外部データベースはブラウザー上でも操作、管理できます。詳細は 「マイページ」 の 「データベース」 を参照してください。
アクセス解析
JavaScript API をロードすることで （PC でもモバイルでも） 自動的にアクセス解析が有効になります。アクセス解析の結果は 「マイページ」 の 「アクセスログ」 を参照してください。
イベント解析
アプリケーションの Gadget XML に下記のようなタグを埋め込むことで、イベント解析が有効になります。イベント解析の結果は 「マイページ」 の 「イベントログ」 を参照してください。
なお、各イベントには、各イベントに連動して実行されるサーバーサイド JavaScript を割り当てることができます。イベントの種類や内容を取得するには getEventType や getEvents を利用してください。
決済サービス
マイページの 「アプリケーション情報」 に表示される 「決済用 URL」 を poncan の通知 URL や payca の postback URL に指定することで、poncan.search や payca.search 、および 「決済ログ」 ページから各決済サービスのログを取得できるようになります。
クーロン
マイページの 「クーロン」 で、指定のタイミング毎に実行されるサーバーサイド JavaScript を割り当てることができます。クーロンの実行時には Owner ID や Viewer ID がアプリケーションに引き渡されないため、必要に応じて setOwnerId や setViewerId で Owner ID や Viewer ID を指定するようにしてください。
デバッグ
OSDE 等のローカルの環境で OpenSocial Host を利用するには、「開発用」 の Application Key を利用してください。なお、「開発用」 の Application Key で利用できる JavaScript API の一覧は次の通りです。
モバイルの注意点
キャリアや機種の判定には getHeader や getUserAgent を利用してください。
OpenSocial Host のサーバーサイド JavaScript 実行環境は非同期リクエストを処理できません。Prototype.js 等に代表される外部ライブラリの多くはそのまま利用できますが、Ajax の非同期リクエストや setTimeout 等の非同期リクエストは控えてください。
モバイルのアプリケーションの振る舞いを PC からエミュレーションできます。詳細は 「マイページ」 の 「ファイル」、「サーバーサイド JavaScript 用ファイルアップロード」 を参照してください。
広告の表示
フリープランのご利用中はビューの最下部等に広告が表示される可能性があります。広告を非表示にされたい場合はビジネスプラン のご利用をご検討ください。
サポートフォーラム
JavaScript API のご利用に関するご質問、ご要望はサポートフォーラム までお願いします。
トレーニング
弊社では OpenSocial Host のトレーニング （無料） を常時実施しています。トレーニングを受講されたい方はお気軽にお問い合わせ ください。
リファレンス （ラッパー）
opensocialhost.people.select(guid, selector, pid, conditions, callback)
指定のユーザーや指定のユーザーの友達のプロフィールを取得します。
サンプルコード
function getPeople(response) {
if (response.hadError) {
return;
}
var nickname = response.data.entry.nickname;
var thumbnailUrl = response.data.entry.thumbnailUrl;
...
};
opensocialhost.people.select(
opensocialhost.utility.getOwnerId(),
opensocialhost.Selector.SELF,
null,
null,
getPeople);
function getFriends(response) {
if (response.hadError) {
return;
}
if (response.data.entry.length) {
for (var index = 0; index < response.data.entry.length; index++) {
var nickname = response.data.entry[index].nickname;
var thumbnailUrl = response.data.entry[index].thumbnailUrl;
...
}
}
};
var conditions = new Object();
conditions[opensocialhost.Conditions.FILTER_BY] = "hasApp";
opensocialhost.people.select(
opensocialhost.utility.getOwnerId(),
opensocialhost.Selector.FRIENDS,
null,
conditions,
getFriends);
opensocialhost.activities.insert(guid, selector, data, conditions, callback)
アクティビティを通知します。
サンプルコード
function getResponse(response) {
if (response.hadError) {
return;
}
...
};
var activities = new Object();
activities["title"] = "sampleTitle";
opensocialhost.activities.insert(
opensocialhost.utility.getViewerId(),
opensocialhost.Selector.SELF,
activities,
null,
getResponse);
opensocialhost.appdata.insert(guid, selector, data, conditions, callback)
OpenSocial コンテナが提供する永続データにデータを挿入します。
サンプルコード
function getResponse(response) {
if (response.hadError) {
return;
}
...
};
var data = new Object();
data["sampleKey1"] = "sampleValue1";
data["sampleKey2"] = "sampleValue2";
opensocialhost.appdata.insert(
opensocialhost.utility.getViewerId(),
opensocialhost.Selector.SELF,
data,
null,
getResponse);
opensocialhost.appdata.update(guid, selector, data, conditions, callback)
OpenSocial コンテナが提供する永続データのデータを更新します。
サンプルコード
function getResponse(response) {
if (response.hadError) {
return;
}
...
};
var data = new Object();
data["sampleKey1"] = "sampleValue1";
data["sampleKey2"] = "sampleValue2";
opensocialhost.appdata.update(
opensocialhost.utility.getViewerId(),
opensocialhost.Selector.SELF,
data,
null,
getResponse);
opensocialhost.appdata.remove(guid, selector, conditions, callback)
OpenSocial コンテナが提供する永続データのデータを削除します。
サンプルコード
function getResponse(response) {
if (response.hadError) {
return;
}
...
};
var data = new Object();
data[opensocialhost.Conditions.FIELDS] = "sampleKey1,sampleKey2";
opensocialhost.appdata.remove(
opensocialhost.utility.getViewerId(),
opensocialhost.Selector.SELF,
data,
getResponse);
opensocialhost.appdata.select(guid, selector, conditions, callback)
OpenSocial コンテナが提供する永続データのデータを取得します。
サンプルコード
function getResponse(response) {
if (response.hadError) {
return;
}
...
};
var data = new Object();
data[opensocialhost.Conditions.FIELDS] = "sampleKey1,sampleKey2";
opensocialhost.appdata.select(
opensocialhost.utility.getViewerId(),
opensocialhost.Selector.SELF,
data,
getResponse);
opensocialhost.albums.select(guid, selector, album, conditions, callback)
指定のユーザーや指定のユーザーの友達のアルバムを取得します。（mixi 専用）
パラメーター
guid
string
対象となるユーザーの ID または @me
selector
opensocialhost.Selector
セレクター
album
string
アルバム ID
アルバム ID に null を指定する場合はアルバムの一覧を取得、
conditions
opensocialhost.Conditions
検索条件
callback
function
コールバック関数
戻り値
hadError
bool
エラーが発生した場合は true、そうでない場合は false
errorCode
opensocialhost.ErrorCode
エラーコード
data
json
アルバムの一覧または詳細を含む json オブジェクト
サンプルコード
function getResponse(response) {
if (response.hadError) {
return;
}
...
};
opensocialhost.albums.select(
opensocialhost.utility.getViewerId(),
opensocialhost.Selector.SELF,
null,
null,
getResponse);
opensocialhost.messages.insert(guid, selector, data, conditions, callback)
メッセージを送信します。（モバゲー TOWN 専用）
サンプルコード
function getResponse(response) {
if (response.hadError) {
return;
}
...
};
var messages = new Object();
messages["type"] = "NOTIFICATION";
messages["title"] = "sampleTitle";
messages["urls"] = [ { "value" : "http://...", "type" : "title" } ];
messages["recipients"] = [ 10000 ];
opensocialhost.messages.insert(
"@me",
opensocialhost.Selector.OUTBOX,
messages,
null,
getResponse);
opensocialhost.Selector
opensocialhost.Selector.SELF guid で指定するユーザー
opensocialhost.Selector.FRIENDS guid で指定するユーザーの友達
opensocialhost.Selector.ALL guid で指定するユーザーの全ての関係者
opensocialhost.Conditions
opensocialhost.Conditions.START_INDEX ページコレクションのインデックス
opensocialhost.Conditions.COUNT ページコレクションのサイズ
opensocialhost.Conditions.FIELDS 検索結果に含めるフィールドのリスト （カンマ区切り）
opensocialhost.Conditions.FILTER_BY 検索結果をフィルタするフィールド
opensocialhost.Conditions.FILTER_VALUE 検索結果をフィルタする値
opensocialhost.Conditions.SORT_BY 検索結果をソートするフィールド
opensocialhost.FilterOperation
opensocialhost.FilterOperation.EQUALS opensocialhost.Conditions.FILTER_VALUE の値と等しい
opensocialhost.FilterOperation.LT opensocialhost.Conditions.FILTER_VALUE の値より小さい
opensocialhost.FilterOperation.LE opensocialhost.Conditions.FILTER_VALUE の値以下
opensocialhost.FilterOperation.GT opensocialhost.Conditions.FILTER_VALUE の値より大きい
opensocialhost.FilterOperation.GE opensocialhost.Conditions.FILTER_VALUE の値以上
opensocialhost.SortOrder
opensocialhost.SortOrder.DESCENDING 検索結果を降順で返却する
opensocialhost.SortOrder.ASCENDING 検索結果を昇順で返却する
opensocialhost.ErrorCode
opensocialhost.ErrorCode.BAD_REQUEST 不正なリクエスト
opensocialhost.ErrorCode.FORBIDDEN 許可されないデータへのアクセス
opensocialhost.ErrorCode.INTERNAL_ERROR サーバーエラー
opensocialhost.ErrorCode.LIMIT_EXCEEDED API 使用回数の超過
opensocialhost.ErrorCode.CONTAINER コンテナエラー
opensocialhost.ErrorCode.UNAUTHORIZED 不正な Application Key
リファレンス （外部データベース）
opensocialhost.data.insert(keys, values, permissions, callback)
外部データベースにデータを挿入します。
パラメーター
keys
string または array
挿入したいデータの key （配列により最大 10 個まで指定可能）
values
string または array
挿入したいデータの value （配列により最大 10 個まで指定可能）
permissions
opensocialhost.data.Permissions
挿入したいデータのパーミッション
パーミッションに null を指定する場合、opensocialhost.data.Permissions.READ_PERMISSION は opensocialhost.data.PermissionType.PUBLIC、opensocialhost.data.Permissions.WRITE_PERMISSION は opensocialhost.data.PermissionType.PRIVATE
callback
function
コールバック関数
戻り値
hadError
bool
エラーが発生した場合は true、そうでない場合は false
errorCode
opensocialhost.data.ErrorCode
エラーコード
サンプルコード
function getResponse(response) {
if (response.hadError) {
alert(response.errorCode);
return;
}
...
};
var keys = ["sampleKey1", "sampleKey2"];
var values = ["sampleValue1", "sampleValue2"];
var permissions = {};
permissions[opensocialhost.data.Permissions.READ_PERMISSION] =
opensocialhost.data.PermissionType.SPECIFIED;
permissions[opensocialhost.data.Permissions.READ_PERMISSION_SPECIFIED] =
... // opensocial.Person.getId
opensocialhost.data.insert(keys, values, permissions, getResponse);
opensocialhost.data.update(keys, values, callback)
外部データベースのデータを更新します。
パラメーター
keys
string または array
更新したいデータの key （配列により最大 10 個まで指定可能）
values
string または array
更新したいデータの value （配列により最大 10 個まで指定可能）
callback
function
コールバック関数
戻り値
hadError
bool
エラーが発生した場合は true、そうでない場合は false
errorCode
opensocialhost.data.ErrorCode
エラーコード
サンプルコード
function getResponse(response) {
if (response.hadError) {
alert(response.errorCode);
return;
}
...
};
opensocialhost.data.update("sampleKey", "sampleValue", getResponse);
opensocialhost.data.remove(keys, callback)
外部データベースのデータを削除します。
パラメーター
keys
string または array
削除したいデータの key （配列により最大 10 個まで指定可能）
callback
function
コールバック関数
戻り値
hadError
bool
エラーが発生した場合は true、そうでない場合は false
errorCode
opensocialhost.data.ErrorCode
エラーコード
サンプルコード
function getResponse(response) {
if (response.hadError) {
alert(response.errorCode);
return;
}
...
};
opensocialhost.data.remove("sampleKey", getResponse);
opensocialhost.data.select(keys, callback)
外部データベースのデータを取得します。
パラメーター
keys
string または array
取得したいデータの key （配列により最大 10 個まで指定可能）
callback
function
コールバック関数
戻り値
hadError
bool
エラーが発生した場合は true、そうでない場合は false
errorCode
opensocialhost.data.ErrorCode
エラーコード
data
array
key と value のペアを含む json オブジェクトの配列
サンプルコード
function getResponse(response) {
if (response.hadError) {
alert(response.errorCode);
return;
}
var sampleKey = response.data[0].key;
var sampleValue = response.data[0].value;
...
};
opensocialhost.data.select("sampleKey", getResponse);
opensocialhost.data.search(conditions, callback)
外部データベースのデータを検索します。
サンプルコード
function getResponse(response) {
if (response.hadError) {
alert(response.errorCode);
return;
}
if (response.total_counts) {
for (var index = 0; index < response.data.length; index++) {
var sampleKey = response.data[index].key;
var sampleValue = response.data[index].value;
...
}
}
};
var conditions = {};
conditions[opensocialhost.data.SearchConditions.KEY] = "sampleKey";
conditions[opensocialhost.data.SearchConditions.PAGE] = 2;
conditions[opensocialhost.data.SearchConditions.PER_PAGE] = 20;
opensocialhost.data.search(conditions, getResponse);
opensocialhost.data.Permissions
opensocialhost.data.Permissions.READ_PERMISSION_SPECIFIED 読み込みのパーミッションが opensocialhost.data.PermissionType.SPECIFIED の場合、読み込みのできる opensocial.Person.getId を指定する
opensocialhost.data.Permissions.WRITE_PERMISSION_SPECIFIED 書き込みのパーミッションが opensocialhost.data.PermissionType.SPECIFIED の場合、書き込みのできる opensocial.Person.getId を指定する
opensocialhost.data.PermissionType
opensocialhost.data.PermissionType.PUBLIC 誰にでも読み込み、または書き込みを許可
opensocialhost.data.PermissionType.FRIENDS 友達にまで読み込み、または書き込みを許可 （未実装）
opensocialhost.data.PermissionType.FRIENDS_OF_FRIENDS 友達の友達にまで読み込み、または書き込みを許可 （未実装）
opensocialhost.data.PermissionType.GADGET ガジェットをインストールしたユーザーにのみ読み込み、または書き込みを許可 （未実装）
opensocialhost.data.PermissionType.PRIVATE 自分にのみ読み込み、または書き込みを許可
opensocialhost.data.PermissionType.SPECIFIED 特定のユーザー （カンマ区切り） にのみ読み込み、または書き込みを許可
opensocialhost.data.SearchConditions
opensocialhost.data.SearchConditions.KEY key に対する検索ワード
opensocialhost.data.SearchConditions.VALUE value に対する検索ワード
opensocialhost.data.SearchConditions.PAGE ページ番号
デフォルトは 1
opensocialhost.data.SearchConditions.PER_PAGE ページ辺りの検索結果の数
デフォルトは 10、最大は 100
opensocialhost.data.MatchingType
opensocialhost.data.MatchingType.LIKE 部分一致で検索する
opensocialhost.data.MatchingType.PREFIX 前方一致で検索する
opensocialhost.data.MatchingType.SUFFIX 後方一致で検索する
opensocialhost.data.SortingType
opensocialhost.data.SortingType.DESC 検索結果を降順 （挿入日時） で返却する
opensocialhost.data.SortingType.ASC 検索結果を昇順 （挿入日時） で返却する
opensocialhost.data.ErrorCode
opensocialhost.data.ErrorCode.BAD_REQUEST 不正なリクエスト
opensocialhost.data.ErrorCode.FORBIDDEN 許可されないデータへのアクセス
opensocialhost.data.ErrorCode.INTERNAL_ERROR サーバーエラー
opensocialhost.data.ErrorCode.LIMIT_EXCEEDED データベース使用量、または API 使用回数の超過
opensocialhost.data.ErrorCode.CONTAINER コンテナエラー
opensocialhost.data.ErrorCode.UNAUTHORIZED 不正な Application Key
リファレンス （イベント）
opensocialhost.event.getEventType()
イベントの種類を取得します。（mixi 専用）
サンプルコード
switch (opensocialhost.event.getEventType()) {
case opensocialhost.event.EventType.ADDAPP:
...
break;
case opensocialhost.event.EventType.REMOVEAPP:
...
break;
default:
...
break;
};
opensocialhost.event.getEvents()
イベントの内容を取得します。（mixi 専用）
戻り値
array
イベントの内容の json の配列
サンプルコード
var events = opensocialhost.event.getEvents();
for (var i = 0; i < events.length; i++) {
if (events[i]['eventtype'] == opensocialhost.event.EventType.REMOVEAPP) {
opensocialhost.utility.setOwnerId(events[i]['id']);
opensocialhost.utility.setViewerId(events[i]['id']);
opensocialhost.data.remove(events[i]['id'], null);
}
}
opensocialhost.event.EventType
opensocialhost.event.EventType.ADDAPP インストール
opensocialhost.event.EventType.REMOVEAPP アンインストール
リファレンス （ファイル）
opensocialhost.file.insert(element, button, callback)
ファイルストレージにファイルを挿入します。（1 ファイル 30 MB まで）
パラメーター
element
element
ファイルアップローダーを表示する DOM エレメント
button
string
ファイルアップローダーのアップロードボタンに表示する文字列
callback
json
コールバック関数を含む json オブジェクト
onStart （function ）
アップロードの開始時に実行されるコールバック関数 （戻り値なし）
onComplete （function ）
アップロードの完了時に実行されるコールバック関数 （戻り値あり）
戻り値
hadError
bool
エラーが発生した場合は true、そうでない場合は false
errorCode
opensocialhost.file.ErrorCode
エラーコード
url
string
新しく挿入されたファイルの URL
サンプルコード
function insertOnStart() {
...
};
function insertOnComplete(response) {
if (!response.hadError) {
alert(response.url);
...
} else {
alert(response.errorCode);
return;
}
};
opensocialhost.file.insert(
document.getElementById('sample'),
'insert',
{ onStart: insertOnStart, onComplete: insertOnComplete });
opensocialhost.file.remove(url, callback)
ファイルストレージのファイルを削除します。
パラメーター
url
string
削除したいファイルの URL
callback
json
コールバック関数を含む json オブジェクト
onStart （function ）
削除の開始時に実行されるコールバック関数 （戻り値なし）
onComplete （function ）
削除の完了時に実行されるコールバック関数 （戻り値あり）
戻り値
hadError
bool
エラーが発生した場合は true、そうでない場合は false
errorCode
opensocialhost.file.ErrorCode
エラーコード
サンプルコード
function removeOnStart() {
...
};
function removeOnComplete(response) {
if (response.hadError) {
alert(response.errorCode);
return;
}
...
};
opensocialhost.file.remove(
"http://...",
{ onStart: removeOnStart, onComplete: removeOnComplete });
opensocialhost.file.ErrorCode
opensocialhost.file.ErrorCode.BAD_REQUEST 不正なリクエスト
opensocialhost.file.ErrorCode.FORBIDDEN 許可されないデータへのアクセス
opensocialhost.file.ErrorCode.INTERNAL_ERROR サーバーエラー
opensocialhost.file.ErrorCode.LIMIT_EXCEEDED ファイル使用量、または API 使用回数の超過
opensocialhost.file.ErrorCode.CONTAINER コンテナエラー
opensocialhost.file.ErrorCode.UNAUTHORIZED 不正な Application Key
リファレンス （決済）
opensocialhost.poncan.search(conditions, callback)
poncan の決済ログを検索します。
サンプルコード
function getResponse(response) {
if (response.hadError) {
alert(response.errorCode);
return;
}
if (response.total_counts) {
for (var index = 0; index < response.data.length; index++) {
var samplePoint = response.data[index].point;
var sampleCash = response.data[index].cash;
...
}
}
};
var conditions = {};
conditions[opensocialhost.poncan.SearchConditions.START_DATE] = "20100501";
conditions[opensocialhost.poncan.SearchConditions.END_DATE] = "20100601";
conditions[opensocialhost.poncan.SearchConditions.PAGE] = 2;
conditions[opensocialhost.poncan.SearchConditions.PER_PAGE] = 20;
opensocialhost.poncan.search(conditions, getResponse);
opensocialhost.poncan.SearchConditions
opensocialhost.poncan.SearchConditions.RID 成果 ID
opensocialhost.poncan.SearchConditions.START_DATE 決済ログを期間で絞り込む （YYYYMMDD 形式）
opensocialhost.poncan.SearchConditions.END_DATE 決済ログを期間で絞り込む （YYYYMMDD 形式）
opensocialhost.poncan.SearchConditions.PAGE ページ番号
デフォルトは 1
opensocialhost.poncan.SearchConditions.PER_PAGE ページ辺りの検索結果の数
デフォルトは 10、最大は 100
opensocialhost.payca.search(conditions, callback)
payca の決済ログを検索します。
パラメーター
conditions
opensocialhost.payca.SearchConditions
検索条件
callback
function
コールバック関数
戻り値
hadError
bool
エラーが発生した場合は true、そうでない場合は false
errorCode
opensocialhost.ErrorCode
エラーコード
page
integer
ページ番号
per_page
integer
ページ辺りの検索結果の数
total_counts
integer
全体の検索結果の数
data
array
payca の決済ログを含む json オブジェクトの配列
サンプルコード
function getResponse(response) {
if (response.hadError) {
alert(response.errorCode);
return;
}
if (response.total_counts) {
for (var index = 0; index < response.data.length; index++) {
var sampleAmount = response.data[index].amount;
...
}
}
};
var conditions = {};
conditions[opensocialhost.payca.SearchConditions.START_DATE] = "20100501";
conditions[opensocialhost.payca.SearchConditions.END_DATE] = "20100601";
conditions[opensocialhost.payca.SearchConditions.PAGE] = 2;
conditions[opensocialhost.payca.SearchConditions.PER_PAGE] = 20;
opensocialhost.payca.search(conditions, getResponse);
opensocialhost.payca.SearchConditions
opensocialhost.payca.SearchConditions.PRODUCT_KEY プロダクトキー
opensocialhost.payca.SearchConditions.START_DATE 決済ログを期間で絞り込む （YYYYMMDD 形式）
opensocialhost.payca.SearchConditions.END_DATE 決済ログを期間で絞り込む （YYYYMMDD 形式）
opensocialhost.payca.SearchConditions.PAGE ページ番号
デフォルトは 1
opensocialhost.payca.SearchConditions.PER_PAGE ページ辺りの検索結果の数
デフォルトは 10、最大は 100
リファレンス （ユーティリティー）
opensocialhost.utility.getToken()
Core API で利用するセッショントークンを取得します。（モバイル、イベント、クーロン専用）
opensocialhost.utility.setApplicationId(id)
アプリケーションの ID を指定します。（モバイル、イベント、クーロン専用）
パラメーター
id
string
アプリケーションの ID
opensocialhost.utility.getApplicationId()
アプリケーションの ID を取得します。（モバイル、イベント、クーロン専用）
opensocialhost.utility.setOwnerId(id)
オーナーの ID を指定します。（モバイル、イベント、クーロン専用）
パラメーター
id
string
オーナーの ID
opensocialhost.utility.getOwnerId()
オーナーの ID を取得します。（モバイル、イベント、クーロン専用）
opensocialhost.utility.setViewerId(id)
ビューアーの ID を指定します。（モバイル、イベント、クーロン専用）
パラメーター
id
string
ビューアーの ID
opensocialhost.utility.getViewerId()
ビューアーの ID を取得します。（モバイル、イベント、クーロン専用）
エミュレーションの際に HTTP ヘッダを指定します。（モバイル専用）
パラメーター
key
string
HTTP ヘッダの key
value
string
HTTP ヘッダの value
HTTP ヘッダを取得します。（モバイル専用）
パラメーター
key
string
HTTP ヘッダの key
戻り値
string
HTTP ヘッダの value
opensocialhost.utility.setQueryString(key, value)
エミュレーションの際に GET パラメーターを指定します。
パラメーター
key
string
GET パラメーターの key
value
string
GET パラメーターの value
opensocialhost.utility.getQueryString(key)
GET パラメーターを取得します。
パラメーター
key
string
GET パラメーターの key
戻り値
string
GET パラメーターの value
opensocialhost.utility.setPostData(key, value)
エミュレーションの際に POST データを指定します。（モバイル専用）
パラメーター
key
string
POST データの key
value
string
POST データの value
opensocialhost.utility.getPostData(key)
POST データを取得します。（モバイル専用）
パラメーター
key
string
POST データの key
戻り値
string
POST データの value
opensocialhost.utility.setUserAgent(userAgent)
エミュレーションの際にユーザーエージェントを指定します。
パラメーター
userAgent
string
ユーザーエージェント
opensocialhost.utility.getUserAgent()
ユーザーエージェントを取得します。
opensocialhost.utility.setReferer(referer)
エミュレーションの際にリファラーを指定します。
パラメーター
referer
string
リファラー
opensocialhost.utility.getReferer()
リファラーを取得します。
opensocialhost.utility.setRequestModel(requestModel)
リクエストモデルを指定します。（モバゲー TOWN 専用）
opensocialhost.utility.getRequestModel()
リクエストモデルを取得します。（モバゲー TOWN 専用）
opensocialhost.utility.RequestModel
opensocialhost.utility.RequestModel.PROXY Proxy モデルで送信する
opensocialhost.utility.RequestModel.TRUSTED Trusted モデルで送信する
opensocialhost.utility.setSandbox(isSandbox)
JavaScript API をコンテナのサンドボックスで実行します。（モバゲー TOWN 専用）
パラメーター
isSandbox
bool
サンドボックスで実行する場合は true、そうでない場合は false
opensocialhost.utility.getSandbox()
JavaScript API がコンテナのサンドボックスで実行されているかを確認します。（モバゲー TOWN 専用）
戻り値
bool
サンドボックスで実行されている場合は true、そうでない場合は false
opensocialhost.utility.setDebug(isDebug)
デバッグモードに移行します。デバッグモードに移行すると、PC の場合、API の戻り値をブラウザーのコンソールが有効な場合はコンソールに、そうでない場合はダイアログに出力します。（モバイルの場合、ページの下部に出力します。）
パラメーター
isDebug
bool
デバッグモードに移行する場合は true、解除する場合は false
opensocialhost.utility.getDebug()
デバッグモードかどうかを確認します。
戻り値
bool
デバッグモードの場合は true、そうでない場合は false
opensocialhost.utility.isClient()
JavaScript API がクライアントのブラウザーで実行されているかどうかを確認します。
戻り値
bool
クライアントのブラウザーで実行されている場合は true、そうでない場合は false
opensocialhost.utility.isServer()
JavaScript API がサーバーサイドで実行されているかどうかを確認します。
戻り値
bool
サーバーサイドで実行されている場合は true、そうでない場合は false
opensocialhost.utility.sendHttpRequest(url, method, parameters, callback)
任意のページにデータを送信し、レスポンスを取得します。（モバイル、イベント、クーロン専用）
opensocialhost.utility.RequestMethod
opensocialhost.utility.RequestMethod.GET GET で送信する
opensocialhost.utility.RequestMethod.POST POST で送信する
リファレンス （mixi 拡張）
お問い合わせ
OpenSocial Host は Classmates API 等、mixi の独自の拡張にも対応しています。mixi のパートナー様には仕様をお伝えできますので、ご希望の方はお気軽にお問い合わせ ください。
リファレンス （モバゲー TOWN 拡張）
お問い合わせ
OpenSocial Host は Avatar API 等、モバゲー TOWN の独自の拡張にも対応しています。モバゲー TOWN のパートナー様には仕様をお伝えできますので、ご希望の方はお気軽にお問い合わせ ください。
