SDK Jeux intégrés YouTube : premiers pas

Le SDK YouTube Playables est un SDK Web permettant de connecter les jeux Web à l'environnement YouTube. Le SDK dispose d'une API robuste qui prend en charge les jeux de différentes manières pour créer une excellente expérience de jeu sur YouTube.

Ajouter le SDK Playables à votre jeu

Un jeu doit disposer d'un fichier index.html dans le répertoire racine. Importez le SDK YouTube Playables en ajoutant cette ligne avant tout code de jeu :

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

Le SDK s'exécute comme une opération sans effet lorsque votre jeu est diffusé en local. Pour vérifier la justesse de l'intégration du SDK, consultez le guide de la suite de tests.

Intégrer le SDK Playables

Plusieurs intégrations obligatoires et facultatives sont requises avec le SDK Playables.

Intégrations requises

Consultez les exigences de publication dans leur ensemble, en particulier les exigences d'intégration. Pour en savoir plus sur l'implémentation, consultez la documentation de référence du SDK Playables.

Voici quelques exemples :

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

En plus des intégrations requises, plusieurs autres fonctions sont disponibles pour créer une expérience très attrayante. Voici quelques exemples :

  • ytgame.system.getLanguage() : utilisez cette valeur pour récupérer les paramètres régionaux actuels de l'utilisateur. N'utilisez pas d'autres fonctions ni ne stockez la langue dans l'enregistrement dans le cloud, car elle peut changer à tout moment.
  • ytgame.engagement.sendScore({ value: newScore }) : envoie un meilleur score à YouTube pour l'afficher.
  • ytgame.engagement.openYTContent({ id: videoID }) : ouvre une vidéo YouTube.
  • ytgame.health.logError() et ytgame.health.logWarning() : enregistre les problèmes dans YouTube.

Consultez la documentation de référence du SDK Playables pour en savoir plus sur l'implémentation et les fonctions supplémentaires.

Définitions de types TypeScript

Pour les jeux utilisant TypeScript, téléchargez les définitions de type.

Exemples de jeux

Des exemples sont disponibles pour vous montrer comment intégrer le SDK YouTube Playables, y compris en JavaScript simple, Flutter Web, Godot et Unity.

Tester votre jeu avec la suite de tests

Lorsque vous êtes prêt, vous pouvez valider votre intégration à l'aide de la suite de tests. Pour savoir comment procéder, consultez le guide de la suite de tests.