跳到主要内容

ライフサイクルイベントの通知リクエスト

概要​

ライフサイクルイベントとは、アプリケーションに対して発生したイベントをパートナーサーバーに通知するための仕組みです。 現在提供しているイベントは以下の通りです。

イベント説明
addappアプリケーションをインストールした
removeappアプリケーションをアンインストールした
joingroupゲームの公式サークルに参加した
leavegroupゲームの公式サークルを退会した
postdiaryゲームに関する日記を書いた

導入方法​

Gadget XMLへの記述の追加​

イベントの通知を受け取りを行うパートナーサーバ側の設定を記述します。

属性値
relイベント種類 (event.addapp
hrefパートナーサーバで通知を受けるためのURL = エンドポイントURL
methodエンドポイントURLへのリクエストの種類 (GET
<?xml version="1.0" encoding="UTF-8" ?>
<Module>
<ModulePrefs title="Sample Application">
<Link rel="event.addapp" href="http://www.example.com/addapp" method="POST" />
<Link rel="event.removeapp" href="http://www.example.com/removeapp" method="GET" />
<Link rel="event.joingroup" href="http://www.example.com/joingroup" method="GET" />
<Link rel="event.leavegroup" href="http://www.example.com/leavegroup" method="GET" />
<Link rel="event.postdiary" href="http://www.example.com/postdiary" method="GET" />
</ModulePrefs>
<Content view="touch" type="url" href="http://www.example.com/index.html" />
</Module>

通知リクエスト​

リクエストの種類​

addapp​
  • アプリケーションを追加した際に発生するイベントです。

    パラメータ名説明
    eventtypeイベントの種類 (event.addapp)
    opensocial_app_idアプリケーション ID
    idインストールしたユーザーのユーザID
    mbga_invite_from招待もとユーザのユーザID
    mbga_is_introduced外部友達紹介機能経由のインストールされたフラグ
    mbga_is_shellappShell App Framework か否かのフラグ 固定値 1
removeapp​
  • アプリケーションをアンインストールした際のイベントです。

    パラメータ名説明
    eventtypeイベントの種類 (event.removeapp)
    opensocial_app_idアプリケーション ID
    idアンインストールしたユーザーのユーザID
joingroup​
  • ゲームの公式サークルに参加した際のイベントです。

    パラメータ名説明
    eventtypeイベントの種類 "event.joingroup"
    opensocial_app_idアプリケーション ID
    idゲーム公式サークルに参加したユーザーのユーザID
leavegroup​
  • ゲームの公式サークルから退会した際のイベントです。

    パラメータ名説明
    eventtypeイベントの種類 "event.leavegroup"
    opensocial_app_idアプリケーション ID
    idゲーム公式サークルから退会したユーザーのユーザID
postdiary​
  • ゲームに関する日記を書いた際のイベントです。

    パラメータ名説明
    eventtypeイベントの種類 "event.postdiary"
    opensocial_app_idアプリケーション ID
    mbga_diary_id日記ID
    idゲームに関する日記を書いたユーザーのユーザID

リクエストの形式​

  • id:101さんに招待されて102さんがアプリケーションAをインストールしたとき

    http://www.example.com/addapp?opensocial_app_id=A&eventtype=event.addapp&id=102&mbga_invite_from=101&mbga_is_shellapp=1
  • id:101さん、id:102さん、id:103さんがアプリケーションAをインストールし、通知が同じタイミングのとき

    http://www.example.com/addapp?opensocial_app_id=A&eventtype=event.addapp&id=101&id=102&id=103&mbga_is_shellapp=1
  • id:101さんとid:102さんがアプリケーションAの公式サークルに参加した

    http://www.example.com/joingroup?opensocial_app_id=A&eventtype=event.joingroup&id=101&id=102
  • id:101さんがアプリケーションAに関する日記を書いたとき

    http://www.example.com/postdiary?opensocial_app_id=A&eventtype=event.postdiary&id=101&mbga_diary_id=10001

リクエストは OAuth による署名が適用されます。必ずAuthorizationリクエストヘッダの妥当性の確認を行ってください。

レスポンス​

Status: 200
Content-Type: text/plain

OK

これ以外のレスポンスを返した場合はエラーが起きたとみなして、次回の通知時に再送します。また、リクエストの送信を始めてからレスポンスを返すまでに 10秒以上かかった場合にもエラーと見なされます。通知エラーの発生回数が一定回数となった場合には、その通知は破棄されます。

通知頻度​

エンドポイントへのイベント通知はユーザアクションからリアルタイムに行われるものではなくタイムラグが発生いたします。
通常は本番、Sandboxともに数分程度で通知されますが、システム負荷により送信遅延が発生いたします。
エンドポイントでは必ず受信成功のステータスコードとして200を返却するように実装をお願いいたします。

制限事項​

現在、ライフサイクルイベントには以下の制限があります。

  • ユーザが、未インストール、もしくは、アンインストール状態の際の joingroup, leavegroup, postdiary は通知されません。
  • 外部友達紹介 mbga_is_introduced パラメータは Mobile と SmartPhoneWeb のみの機能となります。

参考資料​

OpenSocial v1.0 Lifecycle Events
OpenSocial v0.9 Lifecycle Events

更新履歴​

  • 2012/12/11
    • 新規作成