About openPlayerInviter
This page is not available in English.
Please select another language.
はじめに
このページでは、Mobage Native / Unity SDK （以下 Mobage SDK）に搭載されている openPlayerInviter API を使ったユーザー招待、およびバルーン招待について解説します。
 | Mobage Native / Unity SDK 1.4.7 以降、openFriendPicker API は削除されました。同じ機能を持つ openPlayerInviter API へ置き換えて下さい。 2014/06/12 に変更された友達招待の仕様に対応しています。 |
ユーザを招待する
招待文の指定
openPlayerInviter の第一引数に指定した招待文が表示され、ユーザーに送信することができます。第一引数に nil や null を指定すると Mobage デフォルトの招待メッセージが表示されます。
招待 ID 等を招待文に埋め込む際にも利用できます。
招待文に設定する画像の指定
openPlayerInviter の第二引数 imageURL (iOS) もしくは invitationPictureUrl (Android) に招待文に設定する画像の URL を指定できます。指定された画像は width = 200 px に固定されます。URL が指定されていない場合は、Mobage Developers に指定されたゲームのロゴが表示されます。
招待トップ画面（ユーザ選択画面）
Mobage SDK の openPlayerInviter を使用したアプリの場合はパーシャルビュー（アプリ画面の半分ほどのWebView）が表示されます。
このリストから招待するユーザを選択します。リストに表示されるのは、次の条件に合致したユーザです。
- モバ友または親しいユーザー（ゲームや Mobage プラットフォームでのコミュニケーションログから、結びつきが強いと判定されたユーザ）
- 該当ゲームをインストールしていないユーザー
- 招待をまだ送っていない、または前回の招待送信から一定期間経過している
- 受信者から見て、該当ゲームへの招待数が 1 週間で 10 通以下
表示順は、モバ友・非モバ友含め親しい順です。「つながり」の表示領域には、その招待元ユーザと招待先ユーザのつながりが強かった場所（ゲームやMobage プラットフォーム）が表示されます。ファーストビューで 5 ユーザ、「もっと招待する」を押すと最大 21 ユーザ表示されます。
 | ページ領域による制約のため、ファーストビューでは 5 ユーザのみ。 |
| 2014/06 リリースでは、次の制限があります。
|
条件に合致するユーザがいない場合も、後述のバルーン招待は利用できますが、リスト部には grade 別の画面が表示されます。
招待先確認、招待文編集画面
選択ユーザの確認、招待文の編集、規約の確認を行うための画面です。
編集可能なユーザ
招待文を編集できるのは、メールアドレスが Mobage プラットフォーム上で確認できるユーザー、かつ電話番号認証も通っている通常会員のみです。ただし、送信先のユーザーがかんたん会員・未成年ユーザーの場合は、招待文を編集していても定型文が送信されます。
編集不可能なユーザ
編集可能な条件に当てはまらないユーザーの場合、フォームが表示されますが、以下のように修正不可状態になります。
招待完了画面
「招待状を送信する」ボタンを押すと、招待チャットが送信され、以下の完了画面が表示されます。パーシャルビューの右上部の「×」ボタンで画面を閉じます。
上記画面が表示された段階で、openPlayerInviter メソッドに設定した onInviteSent コールバックに、招待を送信したユーザーの User ID が通知されます。送信のみでもインセンティブを付与する場合は、ここで付与して下さい。
| インセンティブ付与を行ったことをダイアログ等で通知するためには、onInviteSent コールバックで受け取った User ID に対してインセンティブ付与と、この時点で User ID をメモリ上に保持しておき、onDismiss コールバックで通知するようにすると自然です。ただし、onInviteSent は onDismiss が呼ばれるまでに複数回呼ばれる可能性がありますので、複数回呼ばれることを考慮した実装をお願いします。 |
ユーザからの招待を受ける
招待受信画面（招待トップ）
招待の受信通知は Mobage チャットなどでも行われますが、openPlayerInviter を再度開いたときにも通知されます。「確認」ボタンを押すと、ブラウザが起動しチャットのゲーム招待受信画面が開きます。
ゲーム招待受信画面（チャット）
チャット受信画面に以下のように表示されます。
バルーン招待について
不特定のユーザを招待できる、バルーン招待について解説していきます。
バルーンを飛ばす
招待トップ画面
ユーザ招待画面の下部に、バルーンを飛ばすことのできるボタンが表示されます。
ユーザーは、1 ゲームに 1 つだけバルーンを持っています。バルーンを飛ばすと、そのゲーム内でのバルーン在庫がなくなりますが、他のユーザーからのバルーンを受け取ることで再度バルーンを投げられるようになります。
バルーンを飛ばせる条件は次のとおりです。
- そのゲームで初めてバルーン飛ばす、または前回そのゲームでバルーンを飛ばしてから 23 時間以上経過している
- バルーンの在庫がある（バルーンを飛ばした後、他者からのバルーンを受け取っている）
| 招待トップには、ユーザ招待とバルーン招待が 1 画面内に表示されます。ファーストビューで両方を確認できるようデザインされています。 |
| バルーンを飛ばした時点では、onInviteSent コールバックは呼ばれません。 |
招待完了画面
「招待する」ボタンを押すと、完了画面が表示されます。パーシャルビューの右上部の「×」ボタンで画面を閉じます。
通常のユーザ招待と異なり、この時点では誰に届くか決定しておらず、チャットも送信されません。チャットの送信は、バルーンの経路が決定した後（非同期）、ユーザが招待トップ画面へ再訪問したときに行われます（後述）。
バルーン招待チャットを送信する
飛ばしたバルーンの着地先が確定した後、openPlayerInviter メソッドを再度実行して画面を開くと、以下のようにバルーンが届いた旨が表示され、招待チャットが送信されます。具体的に誰に届いたかは、送信ユーザは知ることはできません。
自動的に画面がリロードされ、ポップアップが閉じます。
| このポップアップが閉じた段階で onInviteSent コールバックが呼ばれます。 |
バルーン招待を受け取る
招待受信画面（招待トップ）
バルーン招待の受信通知は Mobage チャットなどでも行われますが、openPlayerInviter を開いたときにも通知されます。
上図の「確認」ボタンを押すと、ブラウザが起動しチャットのゲーム招待受信画面が開きます。他のユーザー招待と同列で表示されます。送信ユーザからのチャットではなく、特設ユーザ「バルーン」からの招待として送られてきます。
openPlayerInviter の第二引数 imageURL (iOS) もしくは invitationPictureUrl (Android) に招待文に設定する画像の URL を指定できます。指定された画像は width = 200 px に固定されます。URL が指定されていない場合は、Mobage Developers に指定されたゲームのロゴ画像が採用されます。
アバターを登録していないユーザからのバルーンの場合、アバターを見せない以下のデザインになります。
バルーンの受け取りが無い場合、Mobage の特設ユーザからのバルーンを受け取ることがあります。このバルーンも、受け取ればバルーンの在庫が補充され、再度バルーンを飛ばせるようになります。
更新履歴
- 2014/08/20
- Mobage Native SDK 1.4.7 リリースに伴い、openFriendPicker を openPlayerInviter に置き換えました。
- openPlayerInviter の使用方法を追記しました。
- 2014/06/12
- 新規作成