メインコンテンツまでスキップ

opensocial.Payment


メソッド​

opensocial.newPayment​

<static> opensocial.Payment newPayment(params)

Payment オブジェクトを生成します。

パラメータ​
名前型説明
paramsMap.<opensocial.Payment.FieldObject>
返り値​
型説明
opensocial.Payment新しい Payment オブジェクト
サンプル​
var params = {};
params[opensocial.Payment.Field.ITEMS] = [item];
params[opensocial.Payment.Field.AMOUNT] = 200;
params[opensocial.Payment.Field.PAYMENT_TYPE] = opensocial.Payment.PaymentType.PAYMENT;
var payment = opensocial.newPayment(params);

opensocial.newBillingItem​

<static> opensocial.BillingItem newBillingItem(params)

BillingItem オブジェクトを生成します。

パラメータ​
名前型説明
paramsMap.<opensocial.BillingItem.FieldObject>
返り値​
型説明
opensocial.BillingItem新しい BillingItem オブジェクト
サンプル​
var itemParams = {};
itemParams[mbga.BillingItem.Field.NAME] = "マシンガン";
itemParams[opensocial.BillingItem.Field.SKU_ID] = 'XA123';
itemParams[opensocial.BillingItem.Field.PRICE] = 100;
itemParams[opensocial.BillingItem.Field.COUNT] = 2;
itemParams[opensocial.BillingItem.Field.IMAGE_URL] = "http://example.com/iten.gif";
itemParams[mbga.BillingItem.Field.COUNT] = 2;
var item = opensocial.newBillingItem(itemParams);

opensocial.requestPayment​

<static> requestPayment(payment, opt_callback)

指定したアクティビティの作成を操作の完了を待たずにリクエストします。

パラメータ​
名前型説明
paymentopensocial.PaymentPayment オブジェクト
opt_callbackFunctionリクエストが完了したときに呼び出されるコールバック関数
返り値​

なし

サンプル​
opensocial.requestPayment(payment, function(response) {
if (response.hadError()) {
// error
} else {
var payment = response.getData();
var orderId = payment.getField(opensocial.Payment.Field.ORDER_ID);
// ...
}
});

opensocial.requestPaymentRecords​

サポートされていません。

opensocial.Payment.isPayment​

Boolean isPayment()

この Payment オブジェクトの type が PAYMENT の場合 true を返します。

パラメータ​

なし

返り値​
型説明
Booleanこの Payment の type が PAYMENT である場合、true 、さもなくばfalse。
サンプル​
if (payment.isPayment()) {
// ...
} else {
// ...
}

opensocial.Payment.isCredit​

Boolean isCredit()

この Payment オブジェクトの type が CREDIT の場合 true を返します。

パラメータ​

なし

返り値​
型説明
Booleanこの Payment の type が CREDIT である場合、true 、さもなくばfalse。
サンプル​
if (payment.isCredit()) {
// ...
} else {
// ...
}

opensocial.Payment.isComplete​

Boolean isComplete()

この Payment オブジェクトの PAYMENT_COMPLETE フィールドが設定されている場合 true を返します。

パラメータ​

なし

返り値​
型説明
Booleanこの Payment が完了している場合、true 、さもなくばfalse。
サンプル​
if (payment.isComplete()) {
// ...
} else {
// ...
}

opensocial.Payment.getField​

String getField(key, opt_params)

指定したキーに関連づけされた Payment のデータを取得します。

パラメータ​
名前型説明
keyStringデータを取得するためのキー。可能な値はFieldクラスを参照。
opt_paramsMap.<opensocial.DataRequest.DataRequestFieldsObject>
返り値​
型説明
Stringデータ
サンプル​
var title = payment.getField(opensocial.Payment.Field.AMOUNT);

opensocial.Payment.setField​

setField(key, data)

指定されたキーで Payment にデータを設定します。

パラメータ​
名前型説明
keyStringデータに設定するキー
StringString設定するデータ
返り値​

なし

サンプル​
payment.setField(opensocial.Payment.Field.AMOUNT, 200);

opensocial.Payment.Field​

opensocial.Payment.Field.SANDBOX​

Sandbox 環境ではこの値に true が入ります。

opensocial.Payment.Field.ITEMS​

この決済に含まれるアイテムのリストです。BillingItem を配列で指定します。現在は1つのみ指定可能です。この値は必須です。

opensocial.Payment.Field.AMOUNT​

この決済の総額です。正の整数(1~50000)で指定します。この値は必須です。

opensocial.Payment.Field.MESSAGE​

現在はサポートしていません。

opensocial.Payment.Field.ATTACHMENT​

現在はサポートしていません。

opensocial.Payment.Field.PAYMENT_TYPE​

Payment オブジェクトのタイプです。 opensocial.Payment.PaymentType で指定します。opensocial.Payment.PaymentType.PAYMENT のみ指定可能です。

opensocial.Payment.Field.ORDER_ID​

アプリケーションでユニークな決済IDです。正の整数です。

opensocial.Payment.Field.ORDER_TIME​

決済が要求された時間です。epoch からのミリ秒で表されます。この値はブラウザによって生成されるため正しいとは限りません。ログでの参照程度で使います。

opensocial.Payment.Field.SUBMITTED_TIME​

ユーザーが決済を許可した時間です。epoch からのミリ秒で表されます。この値はブラウザによって生成されるため正しいとは限りません。ログでの参照程度で使います。

opensocial.Payment.Field.EXECUTED_TIME​

コインが引き落とされた時間です。epoch からのミリ秒で表されます。

opensocial.Payment.Field.RESPONSE_CODE​

決済のレスポンスコードです。エラーがない場合は OK を指定します。

opensocial.Payment.Field.RESPONSE_MESSAGE​

可読可能なレスポンスの説明です。NULL が許可されます。

opensocial.Payment.Field.PAYMENT_COMPLETE​

決済が完了されたかどうかの boolean 値です。


mbga.Payment.Field​

mbga.Payment.Field.PAYMENT_ID​

Mobage でユニークな決済IDです。


opensocial.PaymentType​

opensocial.PaymentType.PAYMENT​

通常のコイン支払いタイプです。

opensocial.PaymentType.CREDIT​

サポートしていません。


opensocial.Payment.ResponseCode​

opensocial.Payment.ResponseCode.APP_LOGIC_ERROR​

アプリケーションサーバーがロジック上の問題でエラーが起こった場合にこのステータスを指定ください。

opensocial.Payment.ResponseCode.LOGIC_ERROR​

opensocial.Payment.ResponseCode.APP_NETWORK_FAILURE​

payment handler url が設定されていない、もしくは接続できない、タイムアウトが起こったなどの問題が起きた場合にこのステータスが返ります。

opensocial.Payment.ResponseCode.INSUFFICIENT_MONEY​

opensocial.Payment.ResponseCode.INVALID_TOKEN​

opensocial.Payment.ResponseCode.MALFORMED_REQUEST​

リクエストが正しくない場合にこのステータスが返ります。

opensocial.Payment.ResponseCode.NOT_IMPLEMENTED​

opensocial.Payment.ResponseCode.OK​

正常なレスポンス。

opensocial.Payment.ResponseCode.PAYMENT_ERROR​

決済で何か問題があった場合にこのエラーが返ります。

opensocial.Payment.ResponseCode.PAYMENT_PROCESSOR_ALREADY_OPENED​

opensocial.Payment.ResponseCode.UNKNOWN_ERROR​

opensocial.Payment.ResponseCode.USER_CANCELLED​

ユーザーがキャンセルをした場合にこのステータスが返ります。


opensocial.Payment.RecordsRequestFields​

opensocial.Payment.RecordsRequestFields.TYPE​

opensocial.Payment.RecordsRequestFields.IS_COMPLETE​

opensocial.Payment.RecordsRequestFields.MAX​

opensocial.Payment.RecordsRequestFields.START_TIME​

更新履歴​

  • 2013/03/15
    • ドキュメント移行