Extend SDK sample CLI app

Last updated on February 4, 2026

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

概要

Extend SDK サンプル CLI アプリは、AccelByte Extend SDK の使用方法のリファレンスとして開発者に提供されるコマンドラインアプリケーションです。SDK 自体と同様に、独自のプロジェクトで SDK を実装する方法を示し、いくつかの選択されたプログラミング言語で利用できます。

目標

• サンプル CLI アプリをソースからビルドする
• サンプル CLI アプリを使用して AccelByte Gaming Services (AGS) エンドポイントを呼び出す

前提条件

C#

• AccelByte Gaming Services (AGS) へのアクセス:
  • AB_BASE_URL 環境変数には <your environment's domain URL> を使用します。
    • AGS Shared Cloud のお客様の例: https://spaceshooter.prod.gamingservices.accelbyte.io
    • AGS Private Cloud のお客様の例: https://dev.customer.accelbyte.io
  • クライアントタイプが Confidential の Oauth Client を作成します。
    • AB_CLIENT_ID 環境変数には Client ID の値を使用します。
    • AB_CLIENT_SECRET 環境変数には Client Secret の値を使用します。
• 以下のツールへのアクセス:
  • Git
  • .NET SDK 6.0
  • C# IDE

Go

• AccelByte Gaming Services (AGS) へのアクセス:
  • AB_BASE_URL 環境変数には <your environment's domain URL> を使用します。
    • AGS Shared Cloud のお客様の例: https://spaceshooter.prod.gamingservices.accelbyte.io
    • AGS Private Cloud のお客様の例: https://dev.customer.accelbyte.io
  • クライアントタイプが Confidential の Oauth Client を作成します。
    • AB_CLIENT_ID 環境変数には Client ID の値を使用します。
    • AB_CLIENT_SECRET 環境変数には Client Secret の値を使用します。
• 以下のツールへのアクセス:
  • Git
  • Go 1.18 以降
  • Go IDE

Java

• AccelByte Gaming Services (AGS) へのアクセス:
  • AB_BASE_URL 環境変数には <your environment's domain URL> を使用します。
    • AGS Shared Cloud のお客様の例: https://spaceshooter.prod.gamingservices.accelbyte.io
    • AGS Private Cloud のお客様の例: https://dev.customer.accelbyte.io
  • クライアントタイプが Confidential の Oauth Client を作成します。
    • AB_CLIENT_ID 環境変数には Client ID の値を使用します。
    • AB_CLIENT_SECRET 環境変数には Client Secret の値を使用します。
• 以下のツールへのアクセス:
  • Git
  • Java Development Kit (JDK) 8
  • Gradle 7
  • Java IDE

Python

• AccelByte Gaming Services (AGS) へのアクセス:
  • AB_BASE_URL 環境変数には <your environment's domain URL> を使用します。
    • AGS Shared Cloud のお客様の例: https://spaceshooter.prod.gamingservices.accelbyte.io
    • AGS Private Cloud のお客様の例: https://dev.customer.accelbyte.io
  • クライアントタイプが Confidential の OAuth Client を作成します。
    • AB_CLIENT_ID 環境変数には Client ID の値を使用します。
    • AB_CLIENT_SECRET 環境変数には Client Secret の値を使用します。
• 以下のツールへのアクセス:
  • Git
  • Python 3.10
  • Python IDE

ビルド

C#

1. AccelByte C# Extend SDK リポジトリをクローンします。
2. samples/AccelByte.Sdk.Sample.Cli に移動します。
3. dotnet build を実行してアプリケーションをビルドします。

Go

1. AccelByte Go Extend SDK リポジトリをクローンします。
2. samples/cli に移動します。
3. go build を実行してアプリケーションをビルドします。

Java

1. AccelByte Java Extend SDK リポジトリをクローンします。
2. samples/cli に移動します。
3. bash gradlew installDist を実行してアプリケーションをビルドします。

Python

1. AccelByte Python Extend SDK リポジトリをクローンします。
2. samples/cli に移動します。

注記

Python バージョンはビルドする必要がなく、直接実行できます。

使用方法

セットアップ

Linux

export AB_BASE_URL="https://<environment>.accelbyte.io"
export AB_CLIENT_ID=<value>
export AB_CLIENT_SECRET=<value>

# For Python Extend SDK sample CLI app only (--login-as user)
export AB_USERNAME=<value>
export AB_PASSWORD=<value>

Windows

setx AB_BASE_URL "https://<environment>.accelbyte.io"
setx AB_CLIENT_ID "<value>"
setx AB_CLIENT_SECRET "<value>"

rem For Python Extend SDK sample CLI app only (--login-as user)
setx AB_USERNAME "<value>"
setx AB_PASSWORD "<value>"

macOS

export AB_BASE_URL="https://<environment>.accelbyte.io"
export AB_CLIENT_ID=<value>
export AB_CLIENT_SECRET=<value>

# For Python Extend SDK sample CLI app only (--login-as user)
export AB_USERNAME=<value>
export AB_PASSWORD=<value>

ログイン

C#

OAuth クライアントを使用してログイン

AccelByte.Sdk.Sample.Cli.exe --op login --lt client

ユーザー名とパスワードを使用してログイン

AccelByte.Sdk.Sample.Cli.exe --op login --user <username> --pass <password>

Go

OAuth クライアントを使用してログイン

sample-apps loginClient

ユーザー名とパスワードを使用してログイン

sample-apps login -u <username> -p <password>

Java

OAuth クライアントを使用してログイン

build/install/cli/bin/cli loginClient

ユーザー名とパスワードを使用してログイン

build/install/cli/bin/cli login -u <username> -p <password>

Python

OAuth クライアントを使用してログイン

例えば、OAuth クライアント (--login_as client) を使用して iam-public-create-user-v3 エンドポイントを呼び出します。

python -m accelbyte_py_sdk_cli iam-public-create-user-v3 eagerhamster6800 vi7xUuNc4j@fakemail.com 2000-09-23 US "****" --login_as client

ユーザー名とパスワードを使用してログイン

例えば、OAuth クライアント (--login_as user) を使用して iam-get-bans-type エンドポイントを呼び出します。

python -m accelbyte_py_sdk_cli iam-get-bans-type --login_as user

注記

Python バージョンには専用のログインコマンドがありません。エンドポイントを呼び出す際にログインが実行されます。

エンドポイントの呼び出し

例えば、IAM get country location v3 エンドポイントを呼び出します。

C#

AccelByte.Sdk.Sample.Cli.exe --sn iam --op GetCountryLocationV3

Go

sample-apps Iam getCountryLocationV3

Java

build/install/cli/bin/cli iam getCountryLocationV3

Python

python -m accelbyte_py_sdk_cli iam-get-country-location-v3 --login_as user

ヘルプ

C#

使用方法のヘルプを表示するには:

AccelByte.Sdk.Sample.Cli.exe

詳細については、サンプル CLI アプリの README を参照してください。

Go

利用可能なサービスコマンド (HTTP エンドポイント) を表示するには:

sample-apps -h

サービスコマンドの利用可能なエンドポイント (HTTP エンドポイント) を表示するには:

sample-apps <ServiceName-command> -h

特定のコマンドの利用可能なオプション (HTTP エンドポイント) を表示するには:

sample-apps <ServiceName-command> <methodName-command> -h

詳細については、サンプル CLI アプリの README を参照してください。

Java

一般的なヘルプを表示するには:

build/install/cli/bin/cli -h

iam サービスの特定のヘルプを表示するには:

build/install/cli/bin/cli iam -h

詳細については、サンプル CLI アプリの README を参照してください。

Python

一般的なヘルプを表示するには:

$ python -m accelbyte_py_sdk_cli --help

Usage: python -m accelbyte_py_sdk_cli [OPTIONS] COMMAND [ARGS]...

Options:
  --help  Show this message and exit.

Commands:
  ...
  iam-auth-code-request-v3
  iam-authorization
  iam-authorize-v3
  iam-ban-user
  iam-create-client
  iam-create-client-by-namespace
  iam-create-role
  iam-disable-user
  iam-disable-user-ban
  iam-enable-user
  iam-enable-user-ban
  iam-forgot-password
  iam-get-bans-type
  iam-get-client
  iam-get-clients
  iam-get-country-location-v3
  iam-get-jwks
  iam-get-jwksv3
  iam-get-list-ban-reason
  iam-get-user-ban-history
  iam-get-user-by-login-id
  iam-get-user-by-platform-user-id
  iam-get-user-by-user-id
  iam-get-user-information
  iam-get-user-platform-accounts
  iam-get-user-verification-code
  iam-get-users-by-login-ids
  ...

次の構文を使用して、各コマンドの詳細情報を取得できます:

$ python -m accelbyte_py_sdk_cli COMMAND --help

例えば:

$ python3 -m accelbyte_py_sdk_cli iam-get-bans-type --help

Usage: python -m accelbyte_py_sdk_cli iam-get-bans-type [OPTIONS]

Options:
  --login_as [client|user]
  --help                    Show this message and exit.

詳細については、サンプル CLI アプリの README を参照してください。