処理フローの概要

Gadget XML の取得とレンダリング

  1. ユーザーが Gadget サーバーへリクエスト
  2. Gadget サーバーがゲームサーバーへ Gadget XML の取得リクエスト
  3. ゲームサーバーが Gadget サーバーに Gadget XML を返す
  4. Gadget サーバーが Gadget XML を HTML にレンダリングしてユーザーにレスポンスを返す

パートナーはアプリケーションを Gadget XML として記述してゲームサーバーに配置します。この Gadget XML はユーザーのブラウザから Gadget サーバーを経由して呼び出されます。呼び出された Gadget XML は Gadget サーバーにより HTML にレンダリングされ、ユーザーのブラウザにロードされ、アプリケーションとして実行されます。

JS API の実行

  5. JS API を通じてアプリケーションが API サーバーに API リクエスト
  6. API サーバーがリクエストに応じたレスポンスをアプリケーションに返す

ユーザーのブラウザに返された HTML には JS API を呼び出すための JavaScript ライブラリが含まれており、アプリケーションが JS API を通じて API を呼び出すことができます。

RESTful API の実行

  7. ゲームサーバーが API サーバーに RESTful API を通じて API リクエスト
  8. API サーバーがリクエストに応じたレスポンスをゲームサーバーに返す

また、Server-to-Server の API として RESTful API も用意されており、ゲームサーバーからこれを利用することもできます。

Cookieを利用したアプリのセッション管理について

Cookieを利用してアプリのセッション管理を行っている場合、正常に動作しない可能性があります。3rd party cookieの利用 (iframeの中でのcookie利用が可能である状態) を前提としたセッション管理はお控えください。

エラーメッセージについて

Gadget サーバーが Gadget XML 取得に失敗した場合には下記メッセージがアプリに表示されます。

表示

内容

ご迷惑をお掛けしております。不明なエラーが発生しました。

Gadget XML の構成要素が正しく取得できず構文エラーが発生している

ご迷惑をお掛けしております。ただいまメンテナンス中です。

Gadget XML 取得時に ReadTimeout や ConnectionTimeout などが発生しメンテナンスモードに移行している

 

更新履歴

  • 2015/07/27

    • エラーメッセージについて追記
  • 2013/08/12
    • cookieセッション管理について追記
  • 2012/03/15
    • ドキュメント移行

PREVIOUS

アプリケーション作成方法

NEXT

Sandbox スタートガイド