YouTube 游戏大本营 SDK - 使用入门

YouTube Playables SDK 是一个 Web SDK，用于将 Web 游戏与 YouTube 环境相关联。该 SDK 提供强大的 API，可通过多种方式支持游戏，从而在 YouTube 上打造出色的游戏体验。

将 Playables SDK 添加到您的游戏

游戏的根目录中应有一个 index.html 文件。在任何游戏代码之前添加以下代码，以导入 YouTube Playables SDK：

<script src="https://www.youtube.com/game_api/v1"></script>

在本地分发游戏时，SDK 会作为无操作运行。如需验证 SDK 集成是否正确，请使用测试套件指南。

与 Playables SDK 集成

与 Playables SDK 有多个必需和可选集成。

集成要求

全面查看发布要求，重点关注集成要求。如需了解实现详情，请参阅 Playables SDK 参考文档。

例如：

  • ytgame.game.firstFrameReady()
  • ytgame.game.gameReady()
  • ytgame.IN_PLAYABLES_ENV
  • ytgame.system.isAudioEnabled()
  • ytgame.system.onAudioEnabledChange((isAudioEnabled) => {})
  • ytgame.system.onPause(() => {})
  • ytgame.system.onResume(() => {})
  • ytgame.game.loadData()
  • ytgame.game.saveData(data)

除了必需的集成之外，您还可以使用其他一些功能来打造极具吸引力的体验。例如：

  • ytgame.system.getLanguage() - 用于检索用户的当前语言区域设置。请勿使用其他函数或将语言存储在云端保存中，因为语言可能会随时更改。
  • ytgame.engagement.sendScore({ value: newScore }) - 将最佳得分发送到 YouTube 以进行显示。
  • ytgame.engagement.openYTContent({ id: videoID }) - 打开 YouTube 视频。
  • ytgame.health.logError() 和 ytgame.health.logWarning() - 将问题记录到 YouTube。

如需了解实现详情和其他函数，请参阅 Playables SDK 参考文档。

TypeScript 类型定义

对于使用 TypeScript 的游戏，请下载类型定义。

示例游戏

我们提供了一些示例，演示了如何与 YouTube Playables SDK 集成，包括纯 JavaScript、Flutter Web、Godot 和 Unity。

使用测试套件测试游戏

准备就绪后，您可以使用测试套件验证集成。如需了解具体方法，请参阅测试套件指南。