Python 快速入门

04/20/2019

本文内容

此快速入门旨在帮助你在 Python 3 中进行第一个 API 调用。

必须具有PlayFab 开发人员帐户，才能调用任何 PlayFab API。

可通过以下几种方式使用本机 Python 项目：

作为维护你的游戏的独立控制台管理员工具。

Python SDK 相当于独立的 Python 计划。

集成到现有的基于 Python 的游戏引擎中。

如果您有任何问题，请在论坛上告知我们。

备注

Python SDK 的 beta 版本仅支持同步 API 调用，并且你的游戏循环可能会阻止执行 PlayFab API 调用。 您可能需要创建自己的异步/线程模型以避免此问题。

Python 项目设置

请确保系统上已安装 " Python 3 "。

使用下面显示的命令安装PlayFab 程序包。

pip install playfab

如果pip路径中不是，请改用下面所示的命令。

python -m pip install playfab

在名playfab_test.py为的所需目录中创建新的 python 脚本。

设置您的第一个 API 调用

此快速入门提供使你的第一个 PlayFab API 调用不需要任何 GUI 或屏幕反馈的最少步骤。 通过控制台 print 语句完成确认。

若要开始，请将内容playfab_test.py替换为如下所示的内容。

from playfab import PlayFabClientAPI, PlayFabSettings

PlayFabSettings.TitleId = "144"

request = {

"CustomId": "GettingStartedGuide",

"CreateAccount": True,

"LoginTitlePlayerAccountEntity": 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 参考文档。

祝你编码愉快！

Deconstruct 代码

此可选playfab_test.py的最后一节详细介绍了每个部分。

导入

PlayFab 导入使你可以访问 Api。

PlayFabSettings.TitleId = "144"

每个 PlayFab 开发人员在游戏管理器中创建标题。 发布游戏时，必须将 titleId 编码为你的游戏。 这使客户知道如何在 PlayFab 内访问正确的数据。 对于大多数用户，只需将其视为使 PlayFab 工作的强制步骤。

请求

大多数 PlayFab API 方法都需要输入参数，这些输入参数将打包到 dictionary 对象中。

对于LoginWithCustomIDRequest CustomId，有一个必需的参数，它唯一地标识玩家， LoginTitlePlayerAccountEntity它会自动记录玩家的title_player_account输入并返回关联的实体令牌， CreateAccount从而允许通过此呼叫创建新帐户。

回调

成功

如果 API 调用成功，则成功将包含所请求的信息，否则将失败None。

对于登录请求，成功将包含有关播放机的基本信息，但对于大多数用户，登录之前只需执行一步操作，然后再调用其他 Api。

失败

如果 API 调用不成功，则失败将包含一些错误消息，并且成功将None是。

API 调用可能失败的原因有多种，并且应始终尝试处理失败。

API 调用失败的原因(按可能性顺序)

PlayFabSettings.TitleId 未设置。 如果你忘记设置titleId为你的标题，则任何内容都不起作用。

请求参数。 如果你未提供有关特定 API 调用的正确或必需的信息，则它将失败。

设备连接问题。 蜂窝电话经常丢失/重新获得连接，因此任何时候都可能会随机失败，然后立即工作。 进入隧道可完全断开连接。

PlayFab 服务器问题。 与所有软件一样，可能存在问题。 请参阅我们的发行说明了解更新。

互联网不是100% 的可靠性。 有时，邮件已损坏或无法访问 PlayFab 服务器。

如果您在调试问题方面遇到困难，并且错误信息中的信息不够，请访问我们的论坛。

PlayFabClientAPI.LoginWithCustomID

同步触发 API 调用。 完成后，将调用回调。