mixiアプリ » 技術仕様(RESTful API方式) » ゲストプレイ API仕様
ゲストプレイ API仕様
この資料はmixiアプリ、ゲストプレイのRESTful API方式で作成されたmixiアプリ用の資料となります。Graph API方式で作成されたアプリには適用されません。
ゲストプレイユーザを対象としたRESTful API
2-legged OAuth でアクセスするAPIのゲストプレイによる変更箇所となります。
下記に記載された内容以外のAPIには変更はありません。
People API os/0.8/people
http://developer.mixi.co.jp/appli/spec/pc/restful-api-for-pc/restful-api-details/
追加されるプロフィール情報
ゲストであるかどうかにかかわらず以下の情報が取得できるようになります
フィールド名 | 内容 | フォーマット |
---|---|---|
isGuest | ゲストプレイユーザであるかどうか。 ゲストプレイユーザの場合trueとなります。 |
xs:boolean |
取得するにはfieldsパラメータにisGuestを追加してください。
ゲストプレイユーザのプロフィール情報
ゲストプレイのユーザはプロフィール情報を入力しないため下記の内容が仮のプロフィールとして設定されます。
フィールド名 | 設定値 |
---|---|
nickname | プレイヤー |
profileUrl | mixi指定画像URL |
thumbnailUrl | mixi指定画像URL |
bloodType | 未設定 |
addresses | 東京都のaddress Element |
birthday | 1990-01-01 |
gender | male |
Persistence API os/0.8/appdata
http://developer.mixi.co.jp/appli/spec/mob/mobile_api_detail/
ゲストプレイユーザではPersistence APIはご利用になれません。
ゲストプレイユーザが指定された場合エラーコード 400 (BAD_REQUEST)が返されます。
ゲストプレイユーザを対象としたJavascript API PC版
RESTful API方式のjavascript APIのゲストプレイでの変更箇所となります。
下記に記載された内容以外のAPIには変更はありません。
プロフィール情報・友人情報を使ってみよう People API
http://developer.mixi.co.jp/appli/spec/pc/get_mymixi_info/
Javascript API: opensocial.DataRequest.newFetchPersonRequest
追加されるプロフィール情報
フィールド名 | 内容 | フォーマット |
---|---|---|
mixi.PersonField.IS_GUEST | ゲストプレイユーザであるかどうか ゲストプレイユーザの場合trueとなります。 | xs:boolean |
opensocial.DataRequest.PeopleRequestFields.PROFILE_DETAILSに上記フィールドを設定することでゲストプレイユーザであるか取得できるようになります。
ゲストプレイユーザのプロフィール情報
フィールド名 | 設定値 |
---|---|
opensocial.Person.Field.NICKNAME | プレイヤー |
opensocial.Person.Field.PROFILE_URL | mixi指定画像URL |
opensocial.Person.Field.THUMBNAIL_URL | mixi指定画像URL |
mixi.PersonField.BLOOD_TYPE | 未設定 |
opensocial.Person.Field.ADDRESSES | 東京都のaddress Element |
opensocial.Person.Field.DATE_OF_BIRTH | 1990-01-01 |
opensocial.Person.Field.GENDER | male |
Javascript API: opensocial.DataRequest.newFetchPeopleRequest
opensocial.DataRequest.newFetchPersonRequestと同様にmixi.PersonField.IS_GUESTが利用できます。
プロフィール情報も同様にゲスプレイユーザのプロフィール情報が取得されます。
アクティビティを送信してみよう Activity API
http://developer.mixi.co.jp/appli/spec/pc/send_activity/
Javascript API: opensocial.requestCreateActivity
ゲストプレイユーザはアクティビティの送信を利用できないため、会員登録等を促すダイアログボックスが表示されます。
ゲストプレイユーザがダイアログボックスを閉じると下記のopensocial.ResponseItemが返却されます。
opensocial.ResponseItem.getErrorCode | opensocial.ResponseItem.getErrorMessage |
---|---|
403 | User cancelled. |
情報を共有してみよう Persistence API
http://developer.mixi.co.jp/appli/spec/pc/share_info/
ゲストプレイユーザはPersistence APIを利用できません。
Javascript API: opensocial.DataRequest.newFetchPersonAppDataRequest
Javascript API: opensocial.DataRequest.newUpdatePersonAppDataRequest
Javascript API: opensocial.DataRequest.newRemovePersonAppDataRequest
上記API群は下記のopensocial.ResponseItemが返却されます。
opensocial.ResponseItem.getErrorCode | opensocial.ResponseItem.getErrorMessage |
---|---|
400 | badRequest |
友人を招待しよう Request
http://developer.mixi.co.jp/appli/spec/pc/invite_appli/
Javascript API: opensocial.requestShareApp
ゲストプレイユーザは友人の招待を利用できないため、会員登録等を促すダイアログボックスが表示されます。
ゲストプレイユーザがダイアログボックスを閉じた場合、opensocial.ResponseItemにエラーは設定されずにダイアログボックスが閉じられて終了します。
リクエストAPIを使ってみよう Request
http://developer.mixi.co.jp/appli/spec/pc/use_request_api/
Javascript API: opensocial.requestShareApp
ゲストプレイユーザはリクエストの送信を利用できないため、会員登録等を促すダイアログボックスが表示されます。
ゲストプレイユーザがダイアログボックスを閉じた場合、opensocial.ResponseItemにエラーは設定されずにダイアログボックスが閉じられて終了します。
ユーザにメッセージを送信してみよう Message
http://developer.mixi.co.jp/appli/spec/pc/send_message/
Javascript API: opensocial.requestSendMessage
ゲストプレイユーザはメッセージの送信を利用できないため、会員登録等を促すダイアログボックスが表示されます。
ゲストプレイユーザがダイアログボックスを閉じた場合、opensocial.ResponseItemにエラーは設定されずにダイアログボックスが閉じられて終了します。
異なるビューに遷移してみよう
http://developer.mixi.co.jp/appli/spec/pc/change_view_flow/
Javascript API: gadgets.views.requestNavigateTo
ゲストプレイユーザはviewの内容を閲覧できないためログイン画面が表示されます
mixiボイスを投稿してみよう mixiボイス
http://developer.mixi.co.jp/appli/spec/pc/send_voice/
Javascript API: mixi.requestUpdateStatus
ゲストプレイユーザはmixiボイスを投稿を利用できないため、会員登録等を促すダイアログボックスが表示されます。
ゲストプレイユーザがダイアログボックスを閉じると下記のopensocial.ResponseItemが返却されます。
opensocial.ResponseItem.getErrorCode | opensocial.ResponseItem.getErrorMessage |
---|---|
403 | User cancelled. |
写真をフォトアルバムにアップロードしてみよう
http://developer.mixi.co.jp/appli/spec/pc/photo_upload_api/
Javascript API: mixi.requestUploadMediaItem
ゲストプレイユーザはフォトアルバムにアップロードを利用できないため、会員登録等を促すダイアログボックスが表示されます。
ゲストプレイユーザがダイアログボックスを閉じると下記のopensocial.ResponseItemが返却されます。
opensocial.ResponseItem.getErrorCode | opensocial.ResponseItem.getErrorMessage |
---|---|
403 | User cancelled. |
課金API(mixiポイント決済)
http://developer.mixi.co.jp/appli/spec/pc/payment_api/
Javascript API: opensocial.requestPayment
ゲストプレイユーザは課金APIを利用できないため、会員登録等を促すダイアログボックスが表示されます。
ゲストプレイユーザがダイアログボックスを閉じると下記のopensocial.ResponseItemが返却されます。
opensocial.ResponseItem.getErrorCode | opensocial.ResponseItem.getErrorMessage |
---|---|
opensocial.Payment.ResponseCode.USER_CANCELLED | user canceled |
ゲストプレイユーザを対象としたJavascript API Touch版
Invite(友人を招待する)
http://developer.mixi.co.jp/appli/spec/touch/using_userflow_api/invite_friends/
Javascript API: opensocial.requestShareApp
ゲストプレイユーザは友人の招待を利用できないため、会員登録等を促す画面が表示されます。
ゲストプレイユーザが該当の画面を閉じた場合、opensocial.ResponseItemにエラーは設定されずに画面が閉じられて終了します。
Communication Feed(コミュニケーションフィード)
http://developer.mixi.co.jp/appli/spec/touch/using_userflow_api/communication_feed/
Javascript API: opensocial.requestCreateActivity
ゲストプレイユーザはアクティビティの送信を利用できないため、会員登録等を促す画面が表示されます。
ゲストプレイユーザが該当の画面を閉じると下記のopensocial.ResponseItemが返却されます。
opensocial.ResponseItem.getErrorCode | opensocial.ResponseItem.getErrorMessage |
---|---|
403 | User cancelled. |
Request(リクエスト)
http://developer.mixi.co.jp/appli/spec/touch/using_userflow_api/request_api/
Javascript API: opensocial.requestShareApp
ゲストプレイユーザはリクエストの送信を利用できないため、会員登録等を促す画面が表示されます。
ゲストプレイユーザが該当の画面を閉じた場合、opensocial.ResponseItemにエラーは設定されずに画面が閉じられて終了します。
Message(メッセージ送信)
http://developer.mixi.co.jp/appli/spec/touch/using_userflow_api/send_message/
Javascript API: opensocial.requestSendMessage
ゲストプレイユーザはメッセージの送信を利用できないため、会員登録等を促す画面が表示されます。
ゲストプレイユーザが該当の画面を閉じた場合、opensocial.ResponseItemにエラーは設定されずに画面が閉じられて終了します。
Status(ボイス投稿)
http://developer.mixi.co.jp/appli/spec/touch/using_userflow_api/voice/
Javascript API: mixi.requestUpdateStatus
ゲストプレイユーザはボイスの投稿を利用できないため、会員登録等を促す画面が表示されます。
ゲストプレイユーザが該当の画面を閉じると下記のopensocial.ResponseItemが返却されます。
opensocial.ResponseItem.getErrorCode | opensocial.ResponseItem.getErrorMessage |
---|---|
403 | User cancelled. |
課金API(mixiポイント決済)
http://developer.mixi.co.jp/appli/spec/touch/payment_api/
Javascript API: opensocial.requestPayment
ゲストプレイユーザは課金APIを利用できないため、会員登録等を促す画面が表示されます。
ゲストプレイユーザが該当の画面を閉じると下記のopensocial.ResponseItemが返却されます。
opensocial.ResponseItem.getErrorCode | opensocial.ResponseItem.getErrorMessage |
---|---|
opensocial.Payment.ResponseCode.USER_CANCELLED | user canceled |
ライフサイクルイベントについて
ゲストプレイユーザはライフサイクルイベントの通知は行われません。
ゲストプレイユーザが正式会員になったときライフサイクルイベントが通知されます。