Python クイックスタート

[アーティクル]
07/12/2023

このクイックスタートは、Python 3 で最初の API 呼び出しを行うのに役立つように設計されています。

ネイティブ Python プロジェクトは、次のいくつかの方法を使用できます。

ゲームを管理するためのスタンドアロンコンソール管理ツールとして。
既存の Python ベースのゲームエンジンへの統合。
- Python ゲームエンジンのリストについては、python.org Webサイトの PythonGameLibraries を参照してください。

前提条件

PlayFab 開発者アカウント。
Python 3 はシステムにインストールされています。
- また、要求モジュールがインストールされている必要があります。

注意

このPython SDK のベータリリースは同期 API 呼び出しのみをサポートしており、PlayFab API 呼び出しの実行がゲームループによってブロックされる可能性があります。この問題を回避するため、独自の非同期/スレッドモデルを作成する必要が生じることがあります。

問題のデバッグが困難で、エラー情報の情報が不十分な場合は、PlayFabフォーラムにアクセスしてください。

Python プロジェクトのセットアップ

コマンドプロンプトで、次のコマンドを使用して PlayFab パッケージをインストールします。

pip install playfab

pip がパスにない場合は、代わりに次のコマンドを使用してください。

python -m pip install playfab

プロジェクトディレクトリに、playfab_test.py という Python スクリプトを作成します。

最初の API 呼び出しのセットアップ

このクイックスタートは、GUI や画面上のフィードバックなしで、最初の PlayFab API 呼び出しを行うための最小限の手順を提供します。確認はコンソールの印刷ステートメントで行われます。

playfab_test.py ファイルの内容を以下に示す内容に置き換えます。

from playfab import PlayFabClientAPI, PlayFabSettings

PlayFabSettings.TitleId = "144"

request = {
    "CustomId": "GettingStartedGuide",
    "CreateAccount": True
}

def callback(success, failure):
    if success:
        print("Congratulations, you made your first successful API call!")
    else:
        print("Something went wrong with your first API call.  :(")
        if failure:
            print("Here's some debug information:")
            print(failure.GenerateErrorReport())
PlayFabClientAPI.LoginWithCustomID(request, callback)

完成と実行

以下に示すコマンドを使用して Python スクリプトを実行します。

python playfab_test.py

完了すると、「おめでとうございます。最初のAPI呼び出しが成功しました！」というテキストが表示されます。

この時点で、他のAPI呼び出しを行い、ゲームのビルドを開始できます。利用可能なすべてのクライアント API 呼び出しの一覧については、PlayFab API リファレンスドキュメントをご覧ください。

素敵なコーディングになりますように。

コードを分解する

このオプションの最後のセクションでは、playfab_test.py の各部分について詳しく説明します。

インポート
- PlayFab をインポートすると、API にアクセスできます。
PlayFabSettings.TitleId = "144"
- すべての PlayFab 開発者は、ゲームマネージャーでタイトルを作成します。ゲームを公開するとき、ゲームにそのタイトル ID をコードで記述する必要があります。これにより、クライアントは PlayFab 内で適切なデータにアクセスする方法を知ることができます。ほとんどのユーザーにとって、これは PlayFab が機能するための必須の手順です。
request
- ほとんどの PlayFab API メソッドには入力パラメーターが必要であり、それらの入力パラメーターはディクショナリオブジェクトにパックされています。
  - LoginWithCustomIDRequest は、プレーヤーを一意に識別して関連するエンティティトークンを返す CustomId の必須パラメーターと、この呼び出しで新しいアカウントを作成できる CreateAccount を受け取ります。
  - ログイン時、ほとんどの開発者は適切なログイン方法を使うことを希望します。
    - すべてのログイン方法と入力パラメーターの一覧については、PlayFab ログインドキュメントをご覧ください。一般的な選択肢は次のとおりです。
Callback
- 成功
  - API呼び出しが成功した場合、成功には要求された情報が含まれ、失敗はNoneになります。
  - ログイン要求の場合、成功にはプレイヤーに関するいくつかの基本的な情報が含めらますが、ほとんどのユーザーの場合、ログインは他の API を呼び出す前の必須の手順です。
- 失敗です
  - API呼び出しが成功しなかった場合、失敗にはいくつかのエラー情報が含まれ、成功はNoneになります。
  - API 呼び出しはさまざまな理由で失敗する可能性があるため、常に失敗の処理を試みる必要があります。
  - API 呼び出しが失敗する理由 (可能性が高い順)
    - PlayFabSettings.TitleId は設定されていません。タイトルにtitleIdを設定しなかった場合、何も機能しません。
    - 要求パラメーター。特定の API 呼び出しの正しい情報や必要な情報が指定されていない場合は失敗します。
    - デバイス接続の問題。携帯電話の接続が絶えず失われて再取得されるため、API 呼び出しが常にランダムに失敗し、その後すぐに機能する可能性があります。トンネルに入ると完全に切断される可能性があります。
    - PlayFab サーバーの問題。すべてのソフトウェアと同様、問題が生じる可能性があります。最新情報については、リリースノートをご覧ください。
    - インターネットの信頼性は 100% ではありません。メッセージが破損したり、PlayFab サーバーに到達できないことがあります。
PlayFabClientAPI.LoginWithCustomID
- API 呼び出しを同期的にトリガーします。完了すると、コールバックが呼び出されます。

次の方法で共有