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

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

ゲームに Playables SDK を追加する

ゲームには、ルート ディレクトリに index.html ファイルが必要です。ゲームコードの前に次の行を追加して、YouTube Playables 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 を統合する方法を示したサンプルが用意されています。

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

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