Cloud Saveバリデータのカスタマイズを始める

Last updated on February 4, 2026

注釈：本資料はAI技術を用いて翻訳されています。

概要​

AccelByte Gaming Services（AGS）では、レコードを保存またはアクセスできるかどうかを判断するカスタムクラウドセーブバリデータを実装できます。

この記事では、Extend Overrideアプリテンプレートを例として、カスタムクラウドセーブバリデータロジックをセットアップするプロセスを説明します。

前提条件​

  1. 以下のツールがインストールされたWindows 11 WSL2/Linux Ubuntu 22.04またはmacOS 14+：

    a. Bash

    • Windows WSL2またはLinux Ubuntuの場合：

      bash --version

      GNU bash, version 5.1.16(1)-release (x86_64-pc-linux-gnu)
      ...

    • macOSの場合：

      bash --version

      GNU bash, version 3.2.57(1)-release (arm64-apple-darwin23)
      ...

    b. Make

    • Windows WSL2またはLinux Ubuntuの場合：

      Ubuntuリポジトリからインストールするには、sudo apt update && sudo apt install makeを実行します。

      make --version

      GNU Make 4.3
      ...

    • macOSの場合：

      make --version

      GNU Make 3.81
      ...

    c. Docker（Docker Desktop 4.30+/Docker Engine v23.0+）

    • Linux Ubuntuの場合：

      1. Ubuntuリポジトリからインストールするには、sudo apt update && sudo apt install docker.io docker-buildx docker-compose-v2を実行します。
      2. ユーザーをdockerグループに追加します：sudo usermod -aG docker $USER。
      3. ログアウトして再度ログインし、変更を有効にします。

    • WindowsまたはmacOSの場合：

      WindowsまたはmacOSへのDocker Desktopのインストールに関するDockerのドキュメントに従ってください。

      docker version

      ...
      Server: Docker Desktop
         Engine:
         Version:          24.0.5
      ...

    d. .NET 8 SDK

    • Linux Ubuntuの場合：

      Ubuntuリポジトリからインストールするには、sudo apt-get update && sudo apt-get install -y dotnet-sdk-8.0を実行します。

    • WindowsまたはmacOSの場合：

      WindowsまたはmacOSへの.NETのインストールに関するMicrosoftのドキュメントに従ってください。

      dotnet --version

      8.0.119

    e. Postman

    • Postmanから利用可能なバイナリを使用してください。

    f. extend-helper-cli

    g. TCP転送機能を持つローカルトンネルサービス、例えば：

  1. AGS Admin Portal環境へのアクセス。
    • ベースURL：<環境のドメインURL>
      • AGS Shared Cloudのお客様の例：https://spaceshooter.prod.gamingservices.accelbyte.io
      • AGS Private Cloudのお客様の例：https://dev.customer.accelbyte.io
    • まだない場合は、ゲームネームスペースを作成してください。ネームスペースIDをメモしてください。
    • confidentialクライアントタイプでOAuthクライアントを作成します。Client IDとClient Secretを保管してください。

アプリテンプレートのクローン​

git clone https://github.com/AccelByte/cloudsave-validator-grpc-plugin-server-csharp.git

Extendアプリのセットアップ、実行、テスト​

このセクションでは、Extendアプリのセットアップ、ビルド、実行、テストの方法について説明します。

Extendアプリのセットアップ​

このアプリを実行できるようにするには、以下のセットアップ手順に従ってください：

  1. .env.templateファイルの内容をコピーして、docker compose .envファイルを作成します。

    注記

    ホストOSの環境変数は.envファイルの変数よりも優先されます。.envファイルの変数が正しく反映されない場合は、同じ名前のホストOS環境変数が存在しないか確認してください。詳細については、docker compose環境変数の優先順位に関するDockerのドキュメントを参照してください。

  2. 以下のように、.envファイルに必要な環境変数を入力します：

    AB_BASE_URL=https://test.accelbyte.io     # AGS環境のベースURL
    AB_CLIENT_ID='xxxxxxxxxx'                 # 前提条件セクションのClient ID
    AB_CLIENT_SECRET='xxxxxxxxxx'             # 前提条件セクションのClient Secret
    AB_NAMESPACE='xxxxxxxxxx'                 # 前提条件セクションのNamespace ID
    PLUGIN_GRPC_SERVER_AUTH_ENABLED=true      # アクセストークン検証の有効化または無効化
    注記

    このアプリでは、PLUGIN_GRPC_SERVER_AUTH_ENABLEDはデフォルトでtrueです。falseに設定すると、gRPCサーバーはAccelByte Gaming Servicesアクセストークンなしで呼び出すことができます。このオプションは開発目的でのみ提供されています。本番環境ではgRPCサーバーのアクセストークン検証を有効にすることを推奨します。

Extendアプリのビルド​

このアプリをビルドするには、以下のコマンドを実行します：

make build

Extendアプリの実行​

このアプリをコンテナで（ビルドして）実行するには、以下のコマンドを実行します：

docker compose up --build

Extendアプリのテスト​

Extendアプリはローカル開発環境またはAGSでテストできます。

ローカル開発環境でのテスト​

important

テストする前に、PLUGIN_GRPC_SERVER_AUTH_ENABLEDがfalseに設定されていることを確認してください。そうでない場合、gRPCリクエストはgRPCサーバーによって拒否されます。

このアプリのカスタム関数は、Postmanを使用してローカルでテストできます。Postmanを使用してExtendアプリをテストするには、以下の手順に従ってください：

  1. 以下のコマンドを使用してこのアプリを実行します：

    docker compose up --build

  2. Postmanで新しいgRPCリクエストを作成し、サーバーURLとしてlocalhost:6565を入力します。詳細については、gRPCのサポートに関するPostmanのガイドを参照してください。

  3. CloudsaveValidatorService/BeforeWritePlayerRecordメソッドを選択し、以下のサンプルメッセージで呼び出します：

    a. 有効なpayloadの場合

    {
        "createdAt": {
            "nanos": 10,
            "seconds": "1693468029"
        },
        "isPublic": true,
        "key": "favorite_weapon",
        "namespace": "mynamespace",
        "payload": "eyJ1c2VySWQiOiAiMWUwNzZiY2VlNmQxNGM4NDlmZmIxMjFjMGUwMTM1YmUiLCAiZmF2b3VyaXRlV2VhcG9uVHlwZSI6ICJTV09SRCIsICJmYXZvdXJpdGVXZWFwb24iOiAiZXhjYWxpYnVyIn0=",  // {"userId": "1e076bcee6d14c849ffb121c0e0135be", "favoriteWeaponType": "SWORD", "favoriteWeapon": "excalibur"} をbase64エンコード
        "setBy": "SERVER",
        "updatedAt": {
            "nanos": 10,
            "seconds": "1693468275"
        },
        "userId": "1e076bcee6d14c849ffb121c0e0135be"
    }

    レスポンスには以下のようにisSuccess: trueが含まれます：

    {
        "isSuccess": true,
        "key": "favorite_weapon",
        "userId": "1e076bcee6d14c849ffb121c0e0135be"
    }

    b. 無効なpayloadの場合

    {
        "createdAt": {
            "nanos": 10,
            "seconds": "1693468029"
        },
        "isPublic": true,
        "key": "favorite_weapon",
        "namespace": "mynamespace",
        "payload": "eyJmb28iOiJiYXIifQ==",  // {"foo":"bar"} をbase64エンコード
        "setBy": "SERVER",
        "updatedAt": {
            "nanos": 10,
            "seconds": "1693468275"
        },
        "userId": "1e076bcee6d14c849ffb121c0e0135be"
    }

    レスポンスには以下のようにisSuccess: falseが含まれます：

    {
        "isSuccess": false,
        "key": "favorite_weapon",
        "userId": "1e076bcee6d14c849ffb121c0e0135be",
        "error": {
            "errorCode": 1,
            "errorMessage": "favorite weapon cannot be empty; favorite weapon type cannot be empty; user ID cannot be empty"
        }
    }

AGSでのテスト​

ローカルで実行されているアプリをAGSでテストするには、gRPCサーバーをインターネットに接続する必要があります。パブリックIPを必要とせずにこれを行うには、ローカルトンネルサービスを使用できます。

  1. 以下のコマンドを使用してこのアプリを実行します：

    docker compose up --build

  2. ローカル開発環境のgRPCサーバーTCPポート6565をインターネットに公開します。最も簡単な方法は、ローカルトンネルサービスプロバイダーを使用することです。

    • ngrokにサインインし、ngrokダッシュボードからauthtokenを取得してローカル環境に設定します。 そして、gRPCサーバーを公開するには以下のコマンドを使用します：

      ngrok tcp 6565

    • または、pinggyを使用して、sshコマンドラインのみで簡単なトンネルをセットアップすることもできます。 gRPCサーバーを公開するには以下のコマンドを使用します：

      ssh -p 443 -o StrictHostKeyChecking=no -o ServerAliveInterval=30 -R0:127.0.0.1:6565 tcp@a.pinggy.io

    トンネル転送URL（例：http://0.tcp.ap.ngrok.io:xxxxxまたはtcp://xxxxx-xxx-xxx-xxx-xxx.a.free.pinggy.link:xxxxx）をメモしてください。

    備考

    他のローカルトンネルサービスや異なる方法を使用して、gRPCサーバーポート（TCP）をインターネットに公開することもできます。

  3. Admin Portalで、この設定の正しいネームスペースに移動し、以下を実行します：

    1. サイドバーメニューで、Progression & Inventory > Cloud Save > Customizationに移動します。

    2. まだ追加していない場合は、Add Configurationをクリックします。

    3. Locally hosted for testing purposeオプションを選択します。前のステップのトンネル転送URLを入力し、Saveをクリックします。

      Image shows the modal for adding Cloud Save overridable configuration

  4. 以下の権限を含むconfidentialクライアントタイプでOAuthクライアントを作成します：

    • AGS Private Cloudのお客様の場合：
      • ADMIN:NAMESPACE:{namespace}:CLOUDSAVE:PLUGINS [CREATE,READ,UPDATE,DELETE]
      • ADMIN:NAMESPACE:{namespace}:USER:*:CLOUDSAVE:RECORD [CREATE,READ,UPDATE,DELETE]
      • ADMIN:NAMESPACE:{namespace}:CLOUDSAVE:RECORD [CREATE,READ,UPDATE,DELETE]
      • NAMESPACE:{namespace}:CLOUDSAVE:RECORD [CREATE,READ,UPDATE,DELETE]
      • ADMIN:NAMESPACE:{namespace}:INFORMATION:USER:* [DELETE]
    • AGS Shared Cloudのお客様の場合：
      • Cloud Save > Custom Configuration (Read, Create, Update, Delete)
      • Cloud Save > Game Records (Read, Create, Update, Delete)
      • Cloud Save > Player Records (Read, Create, Update, Delete)
      • IAM > Users (Delete)
    important
    • Client IDとClient Secretのコピーを保管してください。
    • このステップで作成されたOauthクライアントは、前提条件セクションで言及されたものとは異なります。次のステップのCLIデモアプリに必要です。

  5. Extendアプリのフローをシミュレートするために、Postmanコレクション（demo/cloudsave-validator-demo.postman_collection.json）をインポートします。Extendアプリのフローが実行されているときは、このアプリのコンソールログに注意してください。コレクション内のすべてのリクエストを実行すると、少なくとも1つのgRPCサーバーメソッドが呼び出されるはずです。

    important
    • 前のステップで作成したClient IDとClient Secretを含む、Postman Collection Overview（および/またはGlobal Environment）で必要な環境変数を設定することを忘れないでください。
    • ローカルトンネルサービスを使用してローカルでホストされているExtendアプリを公開している場合は、環境変数GRPC_SERVER_URL（例：9.tcp.ap.ngrok.io:99999またはxxxxx-xxx-xxx-xxx-xxx.a.free.pinggy.link:xxxxx）を設定する必要があります。ExtendアプリをAccelByte Gaming Servicesにデプロイした場合は、EXTEND_APP_NAMEを設定してください。

AGSへのデプロイ​

AGSでExtendアプリをデプロイするには、Admin Portalで以下の手順を実行します：

  1. Extendアプリを作成。
  2. Extendアプリをアップロード。
  3. Extendアプリを設定。
  4. Extendアプリをデプロイ。
  5. AGSでExtendアプリを使用するように設定。

Extendアプリの作成​

  1. AGS Admin Portalで、Extend Overrideアプリを作成したいネームスペースに移動します。
  2. サイドバーメニューのADD-ONSの下で、Extend > Overrideに移動します。
  3. Overridable Featureページで、+ Create Newボタンをクリックします。
  4. Create Appフォームで、Extendアプリの名前と説明（オプション）を入力します。
  5. Createをクリックします。新しいExtendアプリがOverridable Featureアプリリストに追加されます。

Extendアプリのアップロード​

  1. extend-helper-cli用のIAMクライアントをセットアップします。クライアントタイプconfidentialでIAMクライアントを作成し、以下にリストされている必要な権限を割り当てます。Client IDとClient Secretのコピーを保管してください。

    • AGS Private Cloudのお客様の場合：
      • ADMIN:NAMESPACE:{namespace}:EXTEND:REPOCREDENTIALS [READ]
      • ADMIN:NAMESPACE:{namespace}:EXTEND:APP [READ]
    • AGS Shared Cloudのお客様の場合：
      • Extend > Extend app image repository access (Read)
      • Extend > App (Read)

  2. 必要な環境変数をエクスポートし、extend-helper-cliを使用してExtendアプリコンテナイメージをビルドしてAGSにアップロードします。

    • <project-dir>がExtendアプリプロジェクトディレクトリを指していることを確認してください
    • <namespace>と<app-name>の値は、ExtendアプリのApp Detailページで確認できます
    • 適切なイメージタグ（例：v0.0.1）を使用してください
    # AGS環境のベースURL、例：https://spaceshooter.prod.gamingservices.accelbyte.io、https://dev.accelbyte.io など
    export AB_BASE_URL='https://xxxxxxxxxx'
    # extend-helper-cli用のOAuthクライアントのClient ID（ステップ1から）
    export AB_CLIENT_ID='xxxxxxxxxx'     
    # extend-helper-cli用のOAuthクライアントのClient Secret（ステップ1から）
    export AB_CLIENT_SECRET='xxxxxxxxxx'

    ./extend-helper-cli-linux_amd64 image-upload --login --work-dir <project-dir> --namespace <namespace> --app <app-name> --image-tag v0.0.1
    important
    • 上記のコマンドは、Extendアプリプロジェクトとは異なる作業ディレクトリから、別のターミナルで実行することをお勧めします。これにより、extend-helper-cliがExtendアプリ用の環境変数を誤って使用することを防ぎます。
    • 以下のエラーが発生した場合は、解決手順についてトラブルシューティング：Dockerログインが失敗するを参照してください。 
      Error saving credentials: error storing credentials - err: exit status 1, out: `error storing credentials - err: exit status 1, out: `The stub received bad data.`

    イメージが正常にアップロードされると、Image Version Historyページにバージョンv0.0.1のイメージが表示されます。

    image history in AGS Admin Portal

Extendアプリの設定​

アップロードしたExtendアプリをデプロイする前に、Extendアプリに必要な環境変数を設定する必要があります。アプリの詳細ページで、Extendアプリをローカルで実行およびテストするために使用したのと同じ値で、以下の環境変数を設定します。

  • AB_CLIENT_ID
  • AB_CLIENT_SECRET
warning

Extend Overrideアプリがリリースv2024.02.13より前のテンプレートに基づいている場合は、PLUGIN_GRPC_SERVER_AUTH_ENABLED環境変数をtrueに設定してください。そうしないと、Extendアプリのアクセストークン検証が無効になり、有効なアクセストークンなしでExtendアプリにアクセスされる可能性があります。

リリースv2024.02.13以降、Extend OverrideアプリテンプレートのPLUGIN_GRPC_SERVER_AUTH_ENABLEDはデフォルトでtrueに設定されています。アクセストークン検証は、PLUGIN_GRPC_SERVER_AUTH_ENABLEDが明示的にfalseに設定されている場合にのみ無効にできます。これに合わせて、Admin Portalを通じて作成されたすべての新しいExtendアプリには、デフォルトでPLUGIN_GRPC_SERVER_AUTH_ENABLED環境変数が設定されません。以前は、Admin Portalを通じて作成されたすべての新しいExtendアプリにPLUGIN_GRPC_SERVER_AUTH_ENABLED=falseが追加されていました。

Extendアプリのデプロイ​

Extendアプリをデプロイするには、Deploy Latest Imageをクリックします。アプリのステータスがRUNNINGに更新されるまで待ちます。これは、Extendアプリが正常にデプロイされたことを示します。

AGSでExtendアプリを使用するように設定​

Admin Portalで、Cloud Saveのカスタマイズを更新します。Overridden byセクションに移動して、既存の設定を編集します。

Image shows the Extend App details page with the overridden detail

AccelByte hostedオプションを選択し、Extendアプリの1つを選択します。Saveをクリックして完了します。

Image shows the edit app configuration modal

次のステップ​

独自のカスタムロジックを実装するために、Extend Overrideアプリテンプレートを変更して進めてください。詳細については、こちらを参照してください。

に最終更新
On this page