mixiアプリ » 技術仕様（Graph API方式） » PC » 友人を招待しよう
友人を招待しよう
使っていてとても楽しいmixiアプリは、友人に勧めたくなります。そして、利用を勧められたユーザが同じことを思い、他の友人に利用を勧めます。この連鎖が起きれば起きるほど、mixiアプリの広がる速度が速くなります。
OpenSocialでは、他のユーザにアプリケーションを勧めるための招待機能を定めています。mixiアプリにおいても、友人にmixiアプリの利用を勧めるために、この招待機能を提供しています。
招待API利用の事前準備
招待APIを利用するには、以下の事前準備をしておく必要があります。
- JavaScript API で提供されていますので、JavaScript API の利用準備を行っておく必要があります
-
利用には mixi_apps2 スコープのユーザ認可を取得しておく必要があります
ユーザ認可の方法についてはユーザ認可についてをご参照ください
友人を招待する
mixiアプリから招待機能を利用するためには、opensocial.requestShareApp()関数を利用します。この関数を呼び出すことによって、このmixiアプリを利用していないユーザに対して利用を勧めることが可能です。
opensocial.requestShareApp("VIEWER_FRIENDS", null, function(response) {
if (response.hadError()) {
var errCode = response.getErrorCode();
// do something...
} else {
// do something...
}
});
requestShareApp()関数の引数は、以下となります。
- 第１引数は、”VIEWER_FRIENDS”を指定します。
- 第２引数は、nullを指定します（何を渡しても無視されます）。
- 第３引数は、招待が行われた後に呼び出されるコールバック関数を指定します。
requestShareApp()関数を呼び出すと、ユーザに以下のようなポップアップ画面が表示されます。
ユーザがこのポップアップ画面を利用して友人を選択し、メッセージを入力して[招待する]ボタンを押すことで、選択された友人にmixiアプリに利用を勧める招待が行われます。この段階では友人は対象のmixiアプリをインストールしている状態にはなりません。
ポップアップ画面が閉じた後に、第３引数で渡したコールバック関数が呼び出されます。このコールバック関数内で、招待に対する後処理を行うことが可能です。
招待したユーザの取得について
mixiアプリによっては、ユーザが実際に誰を招待したのかを知りたくなることでしょう。requestShareApp()関数に指定したコールバック引数から、ユーザが選択し招待を行った友人のIDを知ることができます。
opensocial.requestShareApp("VIEWER_FRIENDS", null, function(response) {
if (response.hadError()){
// エラー時の処理
var code = response.getErrorCode();
var msg = response.getErrorMessage();
}
else {
// 成功時の処理
var data = response.getData();
var recipientIds = data["recipientIds"];
}
});
コールバック関数に渡される引数はopensocial.ResponseItemオブジェクトとなります。getData()関数を呼び出し、その結果が持つ”recipientIds”プロパティ値が、ユーザが選択し招待を行った友人のユーザIDの配列となります。
エラーが発生した場合にはhadError()関数、およびgetErrorCode()関数でエラー情報を取得することができます。以下に発生する可能性のあるエラーコードを示します。
| エラーコード | エラーメッセージ | 発生する状況 |
|---|---|---|
| 401 | Insufficient scope | mixi_apps2 スコープのユーザ認可を取得していない |