L'SDK YouTube Playables è un SDK web per collegare i giochi web all'ambiente YouTube. L'SDK include un'API solida per supportare i giochi in vari modi e creare un'esperienza di gioco eccellente su YouTube.
Aggiungere l'SDK Playables al gioco
Un gioco deve avere un file index.html
nella directory principale. Importa
l'SDK YouTube Playables aggiungendo questa riga prima del codice del gioco:
<script src="https://www.youtube.com/game_api/v1"></script>
L'SDK viene eseguito come no-op quando il gioco viene pubblicato localmente. Per verificare la correttezza dell'integrazione dell'SDK, utilizza la guida alla suite di test.
Eseguire l'integrazione con l'SDK Playables
Esistono diverse integrazioni obbligatorie e facoltative con l'SDK Playables.
Integrazioni richieste
Esamina i requisiti di pubblicazione nel complesso, concentrandoti sui requisiti di integrazione. Per i dettagli sull'implementazione, consulta la documentazione di riferimento dell'SDK Playables.
Ecco alcuni esempi:
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)
Integrazioni consigliate
Oltre alle integrazioni richieste, sono disponibili diverse altre funzioni per creare un'esperienza altamente coinvolgente. Ecco alcuni esempi:
ytgame.system.getLanguage()
: da utilizzare per recuperare l'impostazione locale corrente dell'utente. Non utilizzare altre funzioni o memorizzare la lingua nel salvataggio cloud, in quanto potrebbe cambiare in qualsiasi momento.ytgame.engagement.sendScore({ value: newScore })
: invia a YouTube il miglior punteggio da visualizzare.ytgame.engagement.openYTContent({ id: videoID })
: apri un video di YouTube.ytgame.health.logError()
eytgame.health.logWarning()
: registra i problemi su YouTube.
Consulta la documentazione di riferimento dell'SDK Playables per dettagli sull'implementazione e funzioni aggiuntive.
Definizioni dei tipi di TypeScript
Per i giochi che utilizzano TypeScript, scarica le definizioni dei tipi.
Giochi di Samples
Sono disponibili esempi che mostrano come eseguire l'integrazione con l'SDK YouTube Playables, tra cui JavaScript, Flutter web, Godot e Unity.
Testare il gioco con la suite di test
Quando è tutto pronto, puoi convalidare l'integrazione utilizzando la suite di test. Per scoprire come, consulta la guida alla suite di test.