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, um ein hervorragendes Spielerlebnis auf YouTube zu ermöglichen.

Playables SDK zu Ihrem Spiel hinzufügen

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

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

Wichtig: Das SDK MUSS vor Ihrem gesamten Gamecode geladen werden. So wird eine reproduzierbare, sandboxartige Umgebung geschaffen und bestimmte Funktionen werden dem Spiel sofort zur Verfügung gestellt. Dieser wird bei der Veröffentlichung überprüft. Sie können den Leitfaden zur Testsuite befolgen, um die Validierung vor dem Einreichen Ihres Spiels durchzuführen.

Das SDK wird als No-Op ausgeführt, wenn Ihr Spiel lokal bereitgestellt wird. Informationen zur Überprüfung der korrekten SDK-Integration findest du im Leitfaden zur Testsuite.

Playables SDK einbinden

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

Erforderliche Integrationen

Lesen Sie sich die Veröffentlichungsanforderungen insgesamt durch, wobei Sie sich auf die Integrationsanforderungen konzentrieren sollten. Einzelheiten 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 sind noch weitere Funktionen verfügbar, um eine ansprechende Umgebung zu schaffen. Beispiele:

• ytgame.system.getLanguage(): Damit wird die aktuelle Spracheneinstellung des Nutzers abgerufen. Verwenden Sie keine anderen Funktionen und speichern Sie die Sprache nicht in der Cloud, da sich dies jederzeit ändern kann.
• ytgame.engagement.sendScore({ value: newScore }) – Sendet eine Bestpunktzahl an YouTube, die angezeigt werden soll.
• ytgame.engagement.openYTContent({ id: videoID }) – Öffnet ein YouTube-Video.
• ytgame.health.logError() und ytgame.health.logWarning(): Probleme in YouTube protokollieren

In der Playables SDK-Referenz findest du Implementierungsdetails und zusätzliche Funktionen.

TypeScript-Typdefinitionen

Für Spiele, die TypeScript verwenden, laden Sie die Typdefinitionen herunter.

Beispielspiele

Es gibt Beispiele, die zeigen, wie du das YouTube Playables SDK in JavaScript, Flutter Web, Godot und Unity einbinden kannst.

Spiel mit der Test-Suite testen

Sobald Sie bereit sind, können Sie die Integration mit der Testsuite validieren. Weitere Informationen finden Sie im Leitfaden zur Testsuite.