Extend SDK サンプル CLI アプリ
注釈:本資料はAI技術を用いて翻訳されています。
Overview
Extend SDK サンプル CLI アプリは、AccelByte Extend SDK の利用方法を示すリファレンスとして開発者に提供されるコマンドラインアプリケーションです。ご自身のプロジェクトで SDK を実装する方法を示すもので、SDK 自体と同様に、対応するいくつかのプログラミング言語で提供されています。
Goals
- ソースからサンプル CLI アプリをビルドする
- サンプル CLI アプリを使用して AccelByte Gaming Services (AGS) のエンドポイントを呼び出す
Prerequisites
- C#
- Go
- Java
- Python
- AccelByte Gaming Services (AGS) へのアクセス:
AB_BASE_URL環境変数には<your environment's domain URL>を使用します。- AGS Public Cloud のお客様の例:
https://spaceshooter.prod.gamingservices.accelbyte.io - AGS Private Cloud のお客様の例:
https://dev.customer.accelbyte.io
- AGS Public Cloud のお客様の例:
- クライアントタイプ Confidential の OAuth クライアントを作成します。
- Client ID の値を
AB_CLIENT_ID環境変数に使用します。 - Client Secret の値を
AB_CLIENT_SECRET環境変数に使用します。
- Client ID の値を
- 以下のツールへのアクセス:
- Git
- .NET SDK 6.0
- C# IDE
- AccelByte Gaming Services (AGS) へのアクセス:
AB_BASE_URL環境変数には<your environment's domain URL>を使用します。- AGS Public Cloud のお客様の例:
https://spaceshooter.prod.gamingservices.accelbyte.io - AGS Private Cloud のお客様の例:
https://dev.customer.accelbyte.io
- AGS Public Cloud のお客様の例:
- クライアントタイプ Confidential の OAuth クライアントを作成します。
- Client ID の値を
AB_CLIENT_ID環境変数に使用します。 - Client Secret の値を
AB_CLIENT_SECRET環境変数に使用します。
- Client ID の値を
- 以下のツールへのアクセス:
- Git
- Go 1.18 以降
- Go IDE
- AccelByte Gaming Services (AGS) へのアクセス:
AB_BASE_URL環境変数には<your environment's domain URL>を使用します。- AGS Public Cloud のお客様の例:
https://spaceshooter.prod.gamingservices.accelbyte.io - AGS Private Cloud のお客様の例:
https://dev.customer.accelbyte.io
- AGS Public Cloud のお客様の例:
- クライアントタイプ Confidential の OAuth クライアントを作成します。
- Client ID の値を
AB_CLIENT_ID環境変数に使用します。 - Client Secret の値を
AB_CLIENT_SECRET環境変数に使用します。
- Client ID の値を
- 以下のツールへのアクセス:
- Git
- Java Development Kit (JDK) 8
- Gradle 7
- Java IDE
- AccelByte Gaming Services (AGS) へのアクセス:
AB_BASE_URL環境変数には<your environment's domain URL>を使用します。- AGS Public Cloud のお客様の例:
https://spaceshooter.prod.gamingservices.accelbyte.io - AGS Private Cloud のお客様の例:
https://dev.customer.accelbyte.io
- AGS Public Cloud のお客様の例:
- クライアントタイプ Confidential の OAuth クライアントを作成します。
- Client ID の値を
AB_CLIENT_ID環境変数に使用します。 - Client Secret の値を
AB_CLIENT_SECRET環境変数に使用します。
- Client ID の値を
- 以下のツールへのアクセス:
- Git
- Python 3.10
- Python IDE
Building
- C#
- Go
- Java
- Python
- AccelByte C# Extend SDK リポジトリをクローンします。
samples/AccelByte.Sdk.Sample.Cliに移動します。dotnet buildを実行してアプリケーションをビルドします。
- AccelByte Go Extend SDK リポジトリをクローンします。
samples/cliに移動します。go buildを実行してアプリケーションをビルドします。
- AccelByte Java Extend SDK リポジトリをクローンします。
samples/cliに移動します。bash gradlew installDistを実行してアプリケーションをビルドします。
- AccelByte Python Extend SDK リポジトリをクローンします。
samples/cliに移動します。
Python 版はビルドする必要がなく、そのまま実行できます。
Usage
Setting up
- Linux
- Windows
- macOS
export AB_BASE_URL="https://<environment>.accelbyte.io"
export AB_CLIENT_ID=<value>
export AB_CLIENT_SECRET=<value>
# Python Extend SDK サンプル CLI アプリのみ(--login-as user)
export AB_USERNAME=<value>
export AB_PASSWORD=<value>
setx AB_BASE_URL "https://<environment>.accelbyte.io"
setx AB_CLIENT_ID "<value>"
setx AB_CLIENT_SECRET "<value>"
rem Python Extend SDK サンプル CLI アプリのみ(--login-as user)
setx AB_USERNAME "<value>"
setx AB_PASSWORD "<value>"
export AB_BASE_URL="https://<environment>.accelbyte.io"
export AB_CLIENT_ID=<value>
export AB_CLIENT_SECRET=<value>
# Python Extend SDK サンプル CLI アプリのみ(--login-as user)
export AB_USERNAME=<value>
export AB_PASSWORD=<value>
Logging in
- C#
- Go
- Java
- Python
OAuth クライアントを使用したログイン
AccelByte.Sdk.Sample.Cli.exe --op login --lt client
ユーザー名とパスワードを使用したログイン
AccelByte.Sdk.Sample.Cli.exe --op login --user <username> --pass <password>
OAuth クライアントを使用したログイン
sample-apps loginClient
ユーザー名とパスワードを使用したログイン
sample-apps login -u <username> -p <password>
OAuth クライアントを使用したログイン
build/install/cli/bin/cli loginClient
ユーザー名とパスワードを使用したログイン
build/install/cli/bin/cli login -u <username> -p <password>
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 版には専用のログインコマンドはありません。ログインは、エンドポイントを呼び出す際に実行されます。
Calling an endpoint
例として、IAM の Get Country Location V3 エンドポイントを呼び出します。
- C#
- Go
- Java
- Python
AccelByte.Sdk.Sample.Cli.exe --sn iam --op GetCountryLocationV3
sample-apps Iam getCountryLocationV3
build/install/cli/bin/cli iam getCountryLocationV3
python -m accelbyte_py_sdk_cli iam-get-country-location-v3 --login_as user
Help
- C#
- Go
- Java
- Python
利用可能なサービスコマンド(HTTP エンドポイント)を確認するには:
sample-apps -h
サービスコマンドの利用可能なエンドポイント(HTTP エンドポイント)を確認するには:
sample-apps <ServiceName-command> -h
特定のコマンドの利用可能なオプション(HTTP エンドポイント)を確認するには:
sample-apps <ServiceName-command> <methodName-command> -h
詳細については、サンプル CLI アプリの README を参照してください。
一般的なヘルプを確認するには:
build/install/cli/bin/cli -h
iam サービスの特定のヘルプを確認するには:
build/install/cli/bin/cli iam -h
詳細については、サンプル CLI アプリの README を参照してください。
一般的なヘルプを確認するには:
$ 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 を参照してください。