SDK Generator クイックスタート

  • [アーティクル]

SDK Generator は、PlayFab API の JSON の記述を受け取り、それを使って、最新の状態に保つ必要があるあらゆる SDK を生成する node.js ベースのプログラムです。 SDK Generator のプロジェクトには、すべてのプラットフォームのすべての PlayFab SDK のソースも含まれています。 SDK に変更を加える場合、ここで変更を加えます。

PlayFab API を呼び出すには、PlayFab 開発者アカウントが必要です。

前提条件

  1. 最新の MS Windows オペレーティング システム。
  2. Node.js をインストールしている必要があります: https://nodejs.org/
    • node.exe の場所は、PATH 環境変数で設定する必要があります。 既定値: C:\Program Files (x86)\nodejs\
    • Node.js tools for Visual Studio をインストールすることを強くお勧めします:https://beta.visualstudio.com/vs/node-js/。
  3. SdkGenerator には、SdkGenerator の兄弟フォルダーとして、ローカル コンピューターにクローン作成された PlayFab リポジトリがいくつか必要です。
    • <parent-folder>/SdkGenerator = <https://github.com/PlayFab/SDKGenerator>(参照中)
    • <parent-folder>/sdks/<targetSDK> - 生成する SDK ごとに、まず "sdks" サブフォルダーをターゲットとする PlayFab リポジトリの git クローンを実行する必要があります。 多くの場合、生成されない必須のファイルがリポジトリにあります。
  4. SdkGenerator は、SdkGenerator の兄弟フォルダーとして、ローカル コンピューターにクローン作成された他の PlayFab リポジトリから読み取りを行うように構成できます。
    • <parent-folder>/API_Specs = <https://github.com/PlayFab/api_specs>

使用手順

Node.js ツールをインストールした場合、Visual Studio ソリューションから既存の SDK をビルドできます: https://github.com/PlayFab/SDKGenerator/blob/master/SDKGenerator.sln

  • ソリューションを開きます。
  • プロジェクト構成を設定し、ビルドする SDK に合わせます。
  • Build - >Build Solution。

各 SDK を自動的にビルドできる自動ビルド スクリプトが多数あります: https://github.com/PlayFab/SDKGenerator/tree/master/SDKBuildScripts

  • ビルドする SDK と一致するスクリプトを見つけます (EX unity_build.bat)。
  • そのファイルをダブルクリックします。

新しい SDK をビルドする場合、次のセクションの手順に従って新しい .bat ファイルを作成する必要が生じることがあります。

最後に、生成するターゲットの一覧と、それらの生成先のディレクトリを指定する必要があります。

ジェネレーターを手動で呼び出すには、プロジェクトのルートでコマンド ラインを開き、ターゲットを入力します。 各ターゲットは以下の形式になります。

<targetName>=<targetOutputLocation>

ここで、<targetName> はサポートされている SDK ターゲットのいずれかで、<targetOutputLocation> は SDK を生成するディレクトリへのパスです。

注意

引数と等号間にスペースがないことを確認します。

API 仕様の場所

  • 必要に応じて、API スペック情報を読み取るための場所を 1 つだけ定義できます。
    • -apiSpecPath []
      • -apiSpecPath スイッチがパスなしで定義されている場合、既定値は ../API_Specs です (相対パス。SdkGenerator リポジトリの場所と兄弟)。
    • -apiSpecGitUrl []
      • -apiSpecGitUrl スイッチが URL なしで定義されている場合、既定値は <https://raw.githubusercontent.com/PlayFab/API_Specs/master/> になります
      • GitHub リポジトリから API_Specs 仕様を直接読み取ります。
    • -apiSpecPfUrl []
      • -apiSpecPfUrl スイッチが URL なしで定義されている場合、既定値は <https://www.playfabapi.com/apispec/> になります
      • PlayFab API サーバーから直接 API_Specs を読み取ります。

フラグは省略可能であり、コンソール API を生成するために使用できます。

新しい SDK をビルドする

SdkGenerator での新しいターゲットのセットアップはかなり簡単です。 この例は、参照用に SdkGenerator に追加されました: https://github.com/PlayFab/SDKGenerator/tree/master/targets/newTarget。

  • SdkGenerator/Targets に新しいサブフォルダーを追加します。
  • 新しいターゲットに "make.js" ファイルを追加します。
    • NewTarget の例 に示すように、ファイルで makeClientAPI2、makeServerAPI、makeCombinedAPI を実装します。
    • 必要に応じて、NewTarget の例の説明に従ってテンプレート ファイルとソース ファイルを使用できます。
  • 新しい bat ファイルを追加し、SdkGenerator/SDKBuildScripts で sdk を生成します。

PlayFab は、新しい SDK の送信を受け入れることがあります。 このプロセスが広範囲で実行され、自動ビルドおよびテスト システムと統合する必要があります。 詳しくは、フォーラムでお問い合わせください。

トラブルシューティング

使用可能な API の詳しい一覧については API リファレンスを確認してください。

お問い合わせ

当社は、デベロッパー コミュニティーからのご意見をお待ちしています。 製品やサービスの向上に役立つアイデアをお寄せください。

Developer Success Team は、皆さんからのご質問に答えるだけでなく、PlayFab サービスに関して寄せられたフィードバックを取り扱います。

フォーラム、サポート、サポート技術情報