YouTube Playables SDK – Erste Schritte

Das YouTube Playables SDK ist ein Web-SDK, mit dem Webspiele mit der YouTube-Umgebung verbunden werden können. Das SDK bietet eine robuste API, mit der Spiele auf vielfältige Weise unterstützt werden können, um ein hervorragendes Spielerlebnis auf YouTube zu schaffen.

Playables SDK zu deinem Spiel hinzufügen

Ein Spiel sollte eine index.html-Datei im Stammverzeichnis haben. Importiere das YouTube Playables SDK, indem du diese Zeile vor deinem Spielcode hinzufügst:

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

Wichtig: Das SDK MUSS vor dem Spielcode geladen werden. Dadurch wird eine reproduzierbare Sandbox-Umgebung erstellt und bestimmte Funktionen stehen dem Spiel sofort zur Verfügung. Dies wird bei der Veröffentlichung überprüft. Du kannst der Testsuite-Anleitung folgen, um die Validierung vor dem Einreichen deines Spiels durchzuführen.

Das SDK wird als No-Op ausgeführt, wenn dein Spiel lokal bereitgestellt wird. Verwende die Testsuite-Anleitung, um die Korrektheit der SDK Integration zu überprüfen.

Mit dem Playables SDK einbinden

Es gibt mehrere erforderliche und optionale Integrationen mit dem Playables SDK.

Erforderliche Integrationen

Lies die Veröffentlichungsanforderungen insgesamt, mit Schwerpunkt auf den Integrations anforderungen. Details zur Implementierung findest du in der Playables SDK-Referenz.

Beispiele:

• 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)

Empfohlene Integrationen

Neben den erforderlichen Integrationen stehen mehrere andere Funktionen zur Verfügung, um ein ansprechendes Erlebnis zu schaffen. Beispiele:

• ytgame.system.getLanguage() : Use this to retrieve the user's current locale setting. Verwende keine anderen Funktionen und speichere die Sprache nicht in der Cloud-Speicherung, da sie sich jederzeit ändern kann.
• ytgame.engagement.sendScore({ value: newScore }) : Sende eine Bestpunktzahl an YouTube, um sie anzuzeigen.
• ytgame.engagement.openYTContent({ id: videoID }) : Öffne ein YouTube-Video.
• ytgame.health.logError() und ytgame.health.logWarning() : Melde Probleme an YouTube.

Details zur Implementierung und weitere Funktionen findest du in der Playables SDK-Referenz.

TypeScript-Typdefinitionen

Lade für Spiele, die TypeScript verwenden, Typdefinitionen herunter.

Beispielspiele

Es sind Beispiele verfügbar, die zeigen, wie die Integration mit dem YouTube Playables SDK funktioniert, einschließlich Plain JavaScript, Flutter Web, Godot und Unity.

Spiel mit der Testsuite testen

Wenn du bereit bist, kannst du deine Integration mit der Testsuite validieren. Eine Anleitung dazu findest du in der Testsuite-Anleitung.