mobage.ui
This page is not available in English.
Please select another language.
概要
このモジュール中の機能は Widget Service との連携に関わる機能が含まれています。
機能一覧
mobage.ui モジュールには以下のメソッドがあります。各メソッドに指定できる service パラメータによって呼び出せる Widget が変化します。mobage.ui.open()
Widget Service を対話的に呼び出すメソッドです。
 | このメソッドはクリックイベントなどのブラウザによって開始されたイベントハンドラの中で呼び出して下さい。 |
構文
パラメータ
service
string 型のパラメータです。詳細は以下の通りです。service | description | service の詳細 |
|---|---|---|
payment | 作成したトランザクションを用いてアイテム課金を行う為の Widget Service を起動します。 | |
user_upgrade | ユーザーアップグレードを行うための Widget Service を起動します。 | |
invitation | ゲームへ友達招待を行うための Widget Service を起動します。 | invitation |
client_configuration | 設定変更画面を提供する機能です。 |
params
object 型のパラメータです。
callback
function 型のパラメータです。
return
object を return として受け取り、mobage.ui.open で開いた tab/iframe を以下のように閉じることが出来ます。
説明
このメソッドは対話形式で各サービスを呼び出し、そのレスポンスを callback 引数で指定したコールバック関数で受け取る事が出来ます。
指定できるパラメータやコールバック関数で渡されるパラメータの詳細は各サービスのページを参照して下さい。
例
このメソッドは window.open() によって新しいタブが開かれる場合があるので、クリックイベントなどのブラウザによって開始されたイベントハンドラなどの中で呼び出す必要があります。
この際に XMLHttpRequest などの非同期処理のコールバックなどから呼び出すと window.open() の呼び出し時にブラウザのポップアップブロック等によって新しいwindow の作成に失敗する場合があります。
このような前提の元でサンプルコードを以下に示します。
mobage.ui.show()
Widget Service を開くメソッドです。
| このメソッドはクリックイベントなどのブラウザによって開始されたイベントハンドラの中で呼び出して下さい。 |
構文
パラメータ
service
string 型のパラメータです。指定できる値は以下を参照して下さい。
| service | description | service の詳細 |
|---|---|---|
redirect | 外部サイト遷移時にユーザーに対して確認画面を提供する機能です。 | |
client_agreement | ユーザー同意事項を表示します。 | |
client_agreement_menu | ユーザー同意事項などの各種規約をメニュー形式で表示します。 | client_agreement_menu |
client_community | 公式サークルを開きます。 | |
commercial_transaction | 特定商取引法に基づく表記を開きます | |
inquiry | お問い合わせを開きます | |
mygame | マイゲームを開きます | |
| mypage | マイページを開きます | |
portal | Mobage のトップを開きます | |
| browser_switch_guide | Facebook や Twitter など iOS 向け公式アプリケーションの UIWebView 内で JavaScript SDK で出来たタイトルが開かれた際に、 Safari で開くよう促す画面を表示する為のサービスです。 | |
| shortcut_icon | ユーザが iOS や Android 端末上のホームスクリーンに ゲームへのショートカットアイコンを置けるようにする為のサービスです。 |
 | Shell App SDK for iOS 1.4.1 未満では、mobage.ui.show() の client_community（公式サークル）, my game（マイゲーム）, my page（マイページ）, portal（Mobage のトップ） は呼び出さないでください。Shell App SDK for iOS 1.4.1 未満のみこれらを呼び出さない出し分けの対応がゲーム側で必要になります。 Shell App SDK for iOS 1.4.1 以降では、これらの API の呼び出しは任意です。Shell App SDK 1.4.1 以降では、これらの API を呼び出すと Shell App SDK を用いたアプリから端末ブラウザに遷移します。 |
params
object 型のパラメータです。
return
object を return として受け取り、mobage.ui.show で開いた tab/iframe を以下のように閉じることが出来ます。
説明
この機能は主に Mobage 上の機能を新しいタブで開く為の機能です。レギュレーション上、幾つかのサービスはゲーム起動画面から 2 タップ以内に導線を設置して頂く必要があります。
例
このメソッドは window.open() によって新しいタブが開かれるので、クリックイベントなどのブラウザによって開始されたイベントハンドラなどの中で呼び出す必要があります。
この際に XMLHttpRequest などの非同期処理のコールバックなどから呼び出すと window.open() の呼び出し時にブラウザのポップアップブロック等によって新しい windowの作成に失敗する場合があります。
このような前提の元でユーザー同意事項を開くサンプルコードを以下に示します。
また、外部サイトへ移動する際の確認画面の表示のサンプルコードを以下に示します。
mobage.ui.embed()
Widget Service を埋め込むメソッドです。
構文
パラメータ
service
string 型のパラメータです。指定できる値は以下を参照して下さい。
| service | description | service の詳細 |
|---|---|---|
| chat | Chat Widget の埋め込みを行う機能です。 |
params
object 型のパラメータです。
説明
この機能は主に Mobage 上の機能を指定した id の DOM に埋め込む為の機能です。
例
このメソッドは getConnectedStatus() メソッドで ログインかつインストールがなされていることを確認した上で呼び出す必要があります。
このような前提の元で Widget Service を埋め込むサンプルコードを以下に示します。
また、HTMLファイルに下記のように記載しておく事で、 Widget SDervice の埋め込みを行えます。
サービス一覧
| mobage.ui.open()メソッドで扱う WidgetService は以下を参照ください。 |
| mobage.ui.show()メソッドで扱う WidgetService は以下を参照ください。 |
- redirect
- client_agreement
- client_community
- commercial_transaction
- inquiry
- mygame
- mypage
- portal
- browser_switch_guide
- shortcut_icon
| mobage.ui.embed()メソッドで扱う WidgetService は以下を参照ください。 |
mobage.ui.open() payment
指定されたトランザクションに対してユーザーにアイテム購入機能を提供するサービスです。
構文
mobage.ui.open() でサービスを利用する際に指定する引数は以下を参照して下さい。
field |
type |
required |
description |
|---|---|---|---|
service |
string |
true |
payment を指定して下さい |
params |
object |
true |
|
params.zIndex |
string |
false |
ポップアップの z-index 値を指定します |
params.transactionId |
string |
true |
Transaction ID を指定します |
params.orderId |
string |
false |
Order ID を指定します |
params.customTheme |
string |
false |
アイテム購入画面用にカスタマイズされたカスタムテーマを文字列で指定できます。カスタムテーマはデベロッパーサイトで指定してください。 ※ JS SDK 2.15.0 より指定できます。 |
params.appearanceVersion |
number |
false |
アイテム購入画面用にカスタマイズされたカスタムテーマのバージョンを指定できます。カスタムテーマのバージョンはデベロッパーサイトでご確認ください。※ JS SDK 2.15.0 より指定できます。 |
params.closeTimeout |
number |
false |
アイテム購入完了画面を何ミリ秒で閉じるかを指定できます。 0 に設定した場合は完了画面を表示後すぐに閉じられます。 |
callback |
Function |
true |
Callback 関数を指定します |
Callback 関数に渡される error, result オブジェクトについては以下を参照して下さい。
field |
title |
type |
description |
|---|---|---|---|
error |
エラーコード |
string |
エラーコードが返されます |
errorDescription |
エラーの説明文 |
string |
エラーの説明文が返されます |
Callback 関数に渡される result オブジェクトについては以下を参照して下さい。
property |
title |
type |
description |
|---|---|---|---|
response |
実行結果 |
object |
Bank Debit API のリソース及び OrderID を含むオブジェクト |
signedResponse |
実行結果を JWT で表現した物 |
string |
response に指定される JSON Objectを JWT で表現した文字列 |
response の値については以下を参照して下さい。
property |
title |
type |
required |
description |
|---|---|---|---|---|
service |
サービス名 |
string |
true |
payment が設定されています |
response.result |
結果オブジェクト |
object |
true |
|
response.result.payment |
トランザクション |
object |
true |
|
response.result.payment.id |
Transaction ID |
string |
true |
Bank Debit API で作成したトランザクションの識別子です |
response.result.payment.items |
購入アイテムリスト |
array |
true |
Bank Debit API で作成したトランザクション中に含まれる購入アイテム一覧です |
response.result.payment.items.0.item.id |
アイテム ID |
string |
true |
アイテムの識別子です |
response.result.payment.items.0.item.name |
アイテム名 |
string |
true |
アイテムの名称です |
response.result.payment.items.0.item.price |
アイテム単価 |
integer |
true |
アイテムの単価です |
response.result.payment.items.0.item.description |
アイテム説明文 |
string |
true |
アイテムの説明文です |
response.result.payment.items.0.item.imageUrl |
アイテム画像URL |
string |
true |
アイテム画像のURLです |
response.result.payment.state |
ステート |
string |
true |
トランザクションの状態です。new,authorized, open, closed, error のいずれかになります。 |
response.result.payment.comment |
コメント |
string |
true |
トランザクションに紐づくコメント文です |
response.result.payment.published |
作成日時 |
string |
true |
トランザクションの作成日時です |
response.result.payment.updated |
更新日時 |
string |
true |
トランザクションの作成日時です |
response.result.order_id |
Order ID |
string |
false |
|
error.error プロパティの一覧
error |
description |
|---|---|
invalid_request |
リクエストパラメータが妥当では無い場合 |
access_denied |
フォーム送信までの時間が長過ぎる場合 |
canceled |
アイテム決済処理がキャンセルされた場合 |
conflict |
トランザクションは存在するが、state が妥当ではない場合 |
transction_is_not_found |
トランザクションが存在しない場合 |
system_error |
システムエラーが発生した場合 |
画面例
呼び出すと以下の様な画面が表示されます。
説明
詳細は モバコインによるアイテム課金 をご確認ください。
mobage.ui.open() user_upgrade
ユーザーアップグレードを行うためのサービスです。
構文
mobage.ui.open() でサービスを利用する際に指定する引数は以下を参照して下さい。
field |
type |
required |
description |
|---|---|---|---|
service |
string |
true |
user_upgrade を指定して下さい |
params |
object |
true |
|
params.requiredGrade |
string |
true |
アップグレードするグレード 2 または 3 を指定します |
callback |
Function |
true |
Callback 関数を指定します |
Callback 関数に渡される error, result オブジェクトについては以下を参照して下さい。
field |
title |
type |
description |
|---|---|---|---|
error |
エラーコード |
string |
"already_sufficient_grade" や "user_canceled" などエラーの種類を表す識別子 |
errorDescription |
エラーの説明文 |
string |
エラーの説明文が返されます |
Callback 関数に渡される result オブジェクトについては以下を参照して下さい。
property |
title |
type |
description |
|---|---|---|---|
grade |
グレード |
string |
アップグレード後のユーザーグレード |
| mobage.ui.open user_upgrade を呼び出す前には必ず People API を呼び出し、 グレードの確認を行った上で適切なグレードへのアップグレードをお願いします。 requiredGrade には 2 と 3 が設定でき、『1 → 2』と『2 → 3』のアップグレードは通常通り行えますが、『1 → 3』『2 → 2』『3 → 2』『3 → 3』の場合のアップグレードの場合はエラー画面が表示されてしまいますので、ご注意ください。 |
画面例
呼び出すと以下の様な画面が表示されます。
説明
詳細は ユーザーアップグレード機能の実装 をご確認ください。
mobage.ui.open() invitation
ゲームへ友だち招待を行うためのサービスです。
構文
mobage.ui.open() でサービスを利用する際に指定する引数は以下を参照して下さい。
field |
type |
required |
description |
|---|---|---|---|
service |
string |
true |
user_upgrade を指定して下さい |
callback |
Function |
true |
Callback 関数を指定します |
Callback 関数に渡される error, result オブジェクトについては以下を参照して下さい。（Shell App SDK の場合、「アプリにもどる」がタップされた場合コールバックが返って来ません）
field |
title |
type |
description |
|---|---|---|---|
error |
エラーコード |
string |
エラーコードが返されます |
errorDescription |
エラーの説明文 |
string |
エラーの説明文が返されます |
Callback 関数に渡される result オブジェクトについては以下を参照して下さい。
property |
title |
type |
description |
|---|---|---|---|
response |
実行結果 |
object |
Invitation, Message, Mygame などの設定結果を含むオブジェクト |
signedResponse |
実行結果を JWT で表現した物 |
string |
response に指定される JSON Objectを JWT で表現した文字列 |
response の値については以下を参照して下さい。
property |
title |
type |
required |
description |
|---|---|---|---|---|
response.service |
サービス名 |
string |
true |
initation が設定されています |
response.result |
結果オブジェクト |
object |
true |
|
response.result.channel |
招待チャネル |
string |
true |
どの招待方法で招待したかが入ります |
response.result.invitee |
招待者の ID |
array |
false |
モバ友招待した人の userId が入ります。モバ友招待以外の場合にはこのパラメータはありません。 |
response.result.inviteeUserId |
招待者の ID |
array |
false |
モバ友招待した人の userId が入ります。モバ友招待以外の場合にはこのパラメータはありません。 |
画面例
呼び出すと以下の様な画面が表示されます。
説明
詳細は 友達招待サービス をご確認ください。
mobage.ui.open() client_configuration
ゲームごとにユーザーが設定可能な Mobage 上の設定を変更する為のサービスです。
構文
mobage.ui.open() でサービスを利用する際に指定する引数は以下を参照して下さい。
field |
type |
required |
description |
|---|---|---|---|
service |
string |
true |
client_configuration を指定して下さい |
params |
object |
true |
|
params.requiredInvitation |
integer |
false |
招待設定を表示する場合は1を、表示しない場合は0を指定します。デフォルトは1です。 |
params.requiredMessage |
integer |
false |
ゲームからのお知らせ (Message API) 受信設定を表示する場合は1を、表示しない場合は0を指定します。デフォルトは1です。 |
params.requiredMygame |
integer |
false |
マイゲーム設定を表示する場合は1を、表示しない場合は0を指定します。デフォルトは1です。 |
params.modal |
boolean |
false |
ポップアップブロック抑制のため、リンクをモーダルで表示します。デフォルトはfalseです。 |
callback |
Function |
true |
Callback 関数を指定します。 |
Callback 関数に渡される error, result オブジェクトについては以下を参照して下さい。
field |
title |
type |
description |
|---|---|---|---|
error |
エラーコード |
string |
エラーコードが返されます |
errorDescription |
エラーの説明文 |
string |
エラーの説明文が返されます |
Callback 関数に渡される result オブジェクトについては以下を参照して下さい。
property |
title |
type |
description |
|---|---|---|---|
response |
実行結果 |
object |
Invitation, Message, Mygame などの設定結果を含むオブジェクト |
signedResponse |
実行結果を JWT で表現した物 |
string |
response に指定される JSON Objectを JWT で表現した文字列 |
response の値については以下を参照して下さい。
property |
title |
type |
description |
|---|---|---|---|
response.service |
サービス名 |
string |
client_configuration が設定されています |
response.result |
結果オブジェクト |
object |
|
response.result.invitation |
招待を送信可能かどうか |
boolean |
|
response.result.message |
ゲームからのお知らせを受け取るかどうか |
boolean |
|
response.result.mygame |
マイゲームに加えるかどうか |
boolean |
|
error.error プロパティの一覧
error |
description |
|---|---|
impossible_to_continue_process |
設定可能な項目が無い場合 |
canceled |
ユーザーが設定の更新をキャンセルした場合 |
invalid_request |
リクエストパラメータが妥当ではない場合 |
invalid_client |
妥当な client ではない場合 |
system_error |
システムエラーが発生した場合 |
説明
ゲームごとにユーザーが設定可能な Mobage 上の設定には以下の物があります。
- 招待の受信設定
- 「ゲームからのお知らせ」の受信設定
- マイゲームの追加/削除
これらのうちゲームが設定項目として必要である物を選択した上で、ユーザーに設定画面を提供する事が出来ます。例
「ゲームからのお知らせ」の受信設定とマイゲームの追加/削除のみを設定項目として表示させる例を以下に示します。画面例
呼び出すと以下の様な画面が表示されます。
mobage.ui.show() redirect
外部サイトにリンクする際にユーザーの同意を求める為のサービスです。
構文
mobage.ui.show() でサービスを利用する際に指定する引数は以下を参照して下さい。
field |
type |
required |
description |
|---|---|---|---|
service |
string |
true |
redirect を指定して下さい |
params |
object |
true |
|
params.uri |
string |
true |
外部サイトの URI を指定します |
説明
Mobage JS SDKを用いたアプリケーションを作成する場合に、Mobageのサブドメイン(*.mobage.jp, *.mbga.jp等) を用いている場合は、
外部リンクガイドラインに沿って中間ページ及び、AD 表記が必要になります。もし独自ドメインで提供している場合は中間ページ及び AD 表記は必須ではありません。
redirect サービスはこの中間ページを表示する為に外部リンクに対して適用して頂く必要があります。
ユーザーが「新規ウィンドウで開く」ボタンを押した場合は新しいウィンドウで外部サイトが開き、キャンセルを押した場合はモーダルウィンドウが自動的に消えます。
例
リンクに redirect サービスを適用する例を以下に示します。
画面例
呼び出すと以下の様な画面が表示されます。
説明
詳細は Client 側での対応概要 をご確認ください。
mobage.ui.show() client_agreement
同意事項を開く為のサービスです。
構文
mobage.ui.show() でサービスを利用する際に指定する引数は以下を参照して下さい。
field |
type |
required |
description |
|---|---|---|---|
service |
string |
true |
client_agreement を指定して下さい |
params |
object |
false |
|
説明
ユーザー同意事項を開きます。
例
画面例
呼び出すと以下の様な画面が表示されます。
mobage.ui.show() client_agreement_menu
同意事項などの各種規約をメニュー形式で開く為のサービスです。
構文
mobage.ui.show() でサービスを利用する際に指定する引数は以下を参照して下さい。
field |
type |
required |
description |
|---|---|---|---|
service |
string |
true |
client_agreement_menu を指定して下さい |
params |
object |
false |
|
params.isEasyRegistration |
boolean |
false |
かんたん会員向け同意事項を表示する場合は true を指定して下さい |
説明
ユーザー同意事項などの各種規約をメニュー形式で表示します。
例
画面例
呼び出すと以下の様な画面が表示されます。
mobage.ui.show() client_community
| Shell App SDK for iOS 1.4.1 未満では、mobage.ui.show() の client_community（公式サークル）, my game（マイゲーム）, my page（マイページ）, portal（Mobage のトップ） は呼び出さないでください。Shell App SDK for iOS 1.4.1 未満のみこれらを呼び出さない出し分けの対応がゲーム側で必要になります。 Shell App SDK for iOS 1.4.1 以降では、これらの API の呼び出しは任意です。Shell App SDK 1.4.1 以降では、これらの API を呼び出すと Shell App SDK を用いたアプリから端末ブラウザに遷移します。 |
公式サークルを開く為のサービスです。
構文
mobage.ui.show() でサービスを利用する際に指定する引数は以下を参照して下さい。
field |
type |
required |
description |
|---|---|---|---|
service |
string |
true |
client_community を指定して下さい |
params |
object |
false |
|
説明
公式サークルを新しい window で開きます。
例
画面例
呼び出すと以下の様な画面が表示されます。
mobage.ui.show() commercial_transaction
特定商取引法に伴う表示を開く為のサービスです。
構文
mobage.ui.show() でサービスを利用する際に指定する引数は以下を参照して下さい。
field |
type |
required |
description |
|---|---|---|---|
service |
string |
true |
commercial_transaction を指定して下さい |
params |
object |
false |
|
params.modal |
boolean |
false |
ポップアップブロック抑制のため、リンクをモーダルで表示します。デフォルトはfalseです。 |
説明
特定商取引法に伴う表示を新しい window で開きます。
例
画面例
呼び出すと以下の様な画面が表示されます。
mobage.ui.show() inquiry
ユーザーからデベロッパーへのお問い合わせを開く為のサービスです。
構文
mobage.ui.show() でサービスを利用する際に指定する引数は以下を参照して下さい。
field |
type |
required |
description |
|---|---|---|---|
service |
string |
true |
inquiry を指定して下さい |
params |
object |
false |
|
params.modal |
boolean |
false |
ポップアップブロック抑制のため、リンクをモーダルで表示します。デフォルトはfalseです。 |
説明
ユーザーからデベロッパーへのお問い合わせを開く為のサービスです。
例
画面例
呼び出すと以下の様な画面が表示されます。
mobage.ui.show() mygame
| Shell App SDK for iOS 1.4.1 未満では、mobage.ui.show() の client_community（公式サークル）, my game（マイゲーム）, my page（マイページ）, portal（Mobage のトップ） は呼び出さないでください。Shell App SDK for iOS 1.4.1 未満のみこれらを呼び出さない出し分けの対応がゲーム側で必要になります。 Shell App SDK for iOS 1.4.1 以降では、これらの API の呼び出しは任意です。Shell App SDK 1.4.1 以降では、これらの API を呼び出すと Shell App SDK を用いたアプリから端末ブラウザに遷移します。 |
マイゲームを開く為のサービスです。
構文
mobage.ui.show() でサービスを利用する際に指定する引数は以下を参照して下さい。
field |
type |
required |
description |
|---|---|---|---|
service |
string |
true |
mygame を指定して下さい |
params |
object |
false |
|
説明
マイゲームを開く為のサービスです。
例
画面例
呼び出すと以下の様な画面が表示されます。
mobage.ui.show() mypage
| Shell App SDK for iOS 1.4.1 未満では、mobage.ui.show() の client_community（公式サークル）, my game（マイゲーム）, my page（マイページ）, portal（Mobage のトップ） は呼び出さないでください。Shell App SDK for iOS 1.4.1 未満のみこれらを呼び出さない出し分けの対応がゲーム側で必要になります。 Shell App SDK for iOS 1.4.1 以降では、これらの API の呼び出しは任意です。Shell App SDK 1.4.1 以降では、これらの API を呼び出すと Shell App SDK を用いたアプリから端末ブラウザに遷移します。 |
マイページを開く為のサービスです。
構文
mobage.ui.show() でサービスを利用する際に指定する引数は以下を参照して下さい。
field |
type |
required |
description |
|---|---|---|---|
service |
string |
true |
mypage を指定して下さい |
params |
object |
true |
|
説明
マイゲームを開く為のサービスです。
例
画面例
呼び出すと以下の様な画面が表示されます。
mobage.ui.show() portal
| Shell App SDK for iOS 1.4.1 未満では、mobage.ui.show() の client_community（公式サークル）, my game（マイゲーム）, my page（マイページ）, portal（Mobage のトップ） は呼び出さないでください。Shell App SDK for iOS 1.4.1 未満のみこれらを呼び出さない出し分けの対応がゲーム側で必要になります。 Shell App SDK for iOS 1.4.1 以降では、これらの API の呼び出しは任意です。Shell App SDK 1.4.1 以降では、これらの API を呼び出すと Shell App SDK を用いたアプリから端末ブラウザに遷移します。 |
Mobage トップを開く為のサービスです。
構文
mobage.ui.show() でサービスを利用する際に指定する引数は以下を参照して下さい。
field |
type |
required |
description |
|---|---|---|---|
service |
string |
true |
portal を指定して下さい |
params |
object |
false |
|
params.modal |
boolean |
false |
ポップアップブロック抑制のため、リンクをモーダルで表示します。デフォルトはfalseです。 |
説明
Mobage トップを開く為のサービスです。
例
画面例
呼び出すと以下の様な画面が表示されます。
mobage.ui.show() browser_switch_guide
Facebook や Twitter など iOS 向け公式アプリケーションの UIWebView 内で JavaScript SDK で出来たタイトルが開かれた際に、Safari で開くよう促す画面を表示する為のサービスです。
構文
mobage.ui.show() でサービスを利用する際に指定する引数は以下を参照して下さい。
field |
type |
required |
description |
|---|---|---|---|
service |
string |
true |
browser_switch_guide を指定して下さい |
params |
object |
false |
|
説明
Facebook や Twitter のiOS 向け公式アプリケーションの UIWebView 内で JavaScript SDK で出来たタイトルが開かれた際に、Safari で開くよう促す画面を表示する為のサービスです。この UI サービスはクライアントアプリケーションが独自に UserAgent などを判別して呼び出すのではなく、mobage.init() の第一引数のオブジェクトの showBrowserSwitchGuide フィールドをfalse にした場合に、mobage.event.subscribe() で、platform.unsupportedBrowser イベントを受信した際に明示的に呼び出す為の物です。特にUI 上で問題が無い、または UIWebView 内で開かれた事に対して何らかの処理を挟みたいという訳では無い場合は、showBrowserSwitchGuide フィールドを true にすれば、このサービスを利用する事無く UIWebView で開かれた際にこのサービスが自動的に表示されます。
例
画面例
呼び出すと以下の様な画面が表示されます。
説明
詳細は 非対応ブラウザにてガイドを表示 をご確認ください。
mobage.ui.show() shortcut_icon
ユーザが iOS や Android 端末上のホームスクリーンにゲームへのショートカットアイコンを置けるようにする為のサービスです。
構文
mobage.ui.show() でサービスを利用する際に指定する引数は以下を参照して下さい。
field |
type |
required |
description |
|---|---|---|---|
service |
string |
true |
browser_switch_guide を指定して下さい |
params |
object |
true |
|
params.shortcutType |
string |
true |
ショートカットアイコンの識別子を指定します |
説明
ユーザが iOS や Android 端末上のホームスクリーンにゲームへのショートカットアイコンを置けるようにする為のサービスです。この機能を利用して作成したショートカットアイコンを利用すれば、事前に指定したURLに遷移できるだけでなく、ショートカット経由の起動かどうかを判定することもできます。
例
画面例
呼び出すと以下の様な画面が表示されます。
説明
詳細は ショートカットアイコン作成支援機能 をご確認ください。
mobage.ui.embed() chat
Mobage JS SDK からアプリケーションに Chat のWidgetを埋め込める機能です。
構文
mobage.ui.embed() でサービスを利用する際に指定する引数は以下を参照して下さい。
field |
type |
required |
description |
|---|---|---|---|
service |
string |
true |
chat を指定して下さい |
params |
object |
true |
|
params.targetId |
string |
true |
Chat 化するタグの id |
params.channelId |
number |
true |
Chat の生成済みチャンネル ID |
params.productName |
string |
false |
タイトル名 |
params.widgetId |
string |
false |
生成されるウィジェット要素 (iframe) への ID (DOMのid) |
params.widgetMode |
string |
false |
ゲームチャットの種類 (設定可能な値: "simple_message_list", "message_list", "preview") |
params.useStream |
boolean |
false |
リアルタイムチャット (設定可能な値: true, false) |
params.previewLimit |
number |
false |
プレビュー時に表示するメッセージの最大数 |
params.stampSize |
string |
false |
スタンプサイズ (設定可能な値: "small", "large") |
params.limit |
number |
false |
表示するメッセージの最大数 |
params.theme |
string |
false |
テーマ (設定可能な値: "dark", "light") |
params.defaultMessage |
string |
false |
入力に表示するデフォルトメッセージ |
params.successCallback |
string |
false |
メッセージ投稿が成功した場合のリダイレクト先URL |
params.showHeader |
boolean |
false |
ヘッダー部分の表示/非表示 (設定可能な値: true, false) |
params.showLink |
boolean |
false |
下部ボタン部分の表示/非表示 (設定可能な値: true, false) |
params.showPostform |
boolean |
false |
投稿の入力フォームの表示/非表示 (設定可能な値: true, false) |
params.styleSheet |
string |
false |
ゲーム独自のスタイルを定義した CSS ファイル |
説明
Mobage JS SDK からアプリケーションに Chat のWidgetを埋め込みます。投稿されたメッセージは Mobage の通常の Chat と同様に審査が行われます。
この機能を利用するには事前に RESTful API で Chat のチャンネルを生成する必要があります。
Chat Widgetについても参考にしてください。
例
また、HTMLファイルに下記のように記載しておく事で、 Widget SDervice の埋め込みを行えます。
更新履歴
- 2020/07/20
- mobage.ui.show() client_agreement_menu を追記
- 2020/05/21
- mobage.ui.open() client_configuration ならびに mobage.ui.show() commercial_transaction/portal/inquiry に渡すパラメータに modal を追記
- 2016/06/06
- mobage.ui.open() payment に渡すパラメータに zIndex を追記
- 2016/05/08
- mobage.ui.open() payment の closeTimeout に関する記述を追記
- 2015/12/22
- mobage.ui.open() payment のカスタムテーマに関する記述が無かったため追記
- 2015/08/17
- User Upgrade を使用できないケースがあったため、注意事項を追記
- 2015/08/11
- Shell App SDK for iOS では、公式サークル、マイゲーム、マイページ、Mobage のトップを呼び出すことができなかったので、注意文言を追記