mixiアプリ » 技術仕様（Graph API方式） » スマートフォン » 友人招待機能について
友人招待機能について
mixiアプリでは、友人にアプリの利用を勧めるための招待機能（招待API）を提供しています。
招待API利用の事前準備
招待APIを利用するには、以下の事前準備をしておく必要があります。
- JavaScript API で提供されていますので、JavaScript API の利用準備を行っておく必要があります
-
利用には mixi_apps2 スコープのユーザ認可を取得しておく必要があります
ユーザ認可の方法についてはユーザ認可についてをご参照ください
友人を招待する
招待機能を利用するためには、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()関数を呼び出すと、ユーザに以下のようなダイアログが表示されます。
エラーが発生した場合には、コールバック関数に渡される引数から hadError()関数、およびgetErrorCode()関数でエラー情報を取得することができます。以下に発生する可能性のあるエラーコードを示します。
| エラーコード | 発生する状況 |
|---|---|
| 401 | mixi_apps2スコープのユーザ認可を取得していない |
| 403 |
ユーザがキャンセルした
ユーザがアプリを利用していない
|
| 500 | mixiサーバでの内部エラー |
mixiアプリによっては、ユーザが実際に誰を招待したのかを知りたくなることがありますが、requestShareApp()関数に指定したコールバック引数から、ユーザが選択し招待を行った友人のIDを知ることができます。
opensocial.requestShareApp("VIEWER_FRIENDS", null, function(response) {
var recipientIds = response.getData()["recipientIds"];
// do something...
});
コールバック関数に渡される引数から、getData()関数を呼び出し、その結果が持つ"recipientIds"プロパティ値を取得します。この値は、ユーザが選択し招待を行った友人のユーザIDの配列となります。