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

YouTube 游戏大本营 SDK 是一种用于将网页游戏与 YouTube 环境相关联的 Web SDK。该 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 报告问题。
  • ytgame.ads.requestInterstitialAd()requestRewardedAd(rewardId: string) - 将广告功能集成到游戏中。

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

TypeScript 类型定义

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

示例游戏

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

使用测试套件测试游戏

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