YouTube ゲームルーム SDK - スタートガイド

YouTube ゲームルーム SDK は、ウェブゲームを YouTube 環境に接続するためのウェブ SDK です。この SDK には、YouTube で優れたゲーム エクスペリエンスを実現するために、さまざまな方法でゲームをサポートする堅牢な API が用意されています。

ゲームに Playables SDK を追加する

ゲームのルート ディレクトリに index.html ファイルが必要です。ゲームコードの前に次の行を追加して、YouTube ゲームルーム SDK をインポートします。

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

ゲームがローカルで提供される場合、SDK は no-op として実行されます。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 を使用するゲームの場合は、型定義をダウンロードします。

サンプルゲーム

プレーンな JavaScript、Flutter ウェブ、Godot、Unity など、YouTube Playables SDK との統合方法を示すサンプルが用意されています。

テストスイートでゲームをテストする

準備ができたら、テストスイートを使用して統合を検証できます。方法については、テストスイート ガイドをご覧ください。