O SDK Playables do YouTube é um SDK da Web para conectar jogos da Web ao ambiente do YouTube. O SDK oferece uma API robusta para oferecer suporte a jogos de várias maneiras para criar uma excelente experiência de jogo no YouTube.
Adicionar o SDK Playables ao jogo
Um jogo precisa ter um arquivo index.html no diretório raiz. Importe o
SDK Playables do YouTube adicionando esta linha antes de qualquer código do jogo:
<script src="https://www.youtube.com/game_api/v1"></script>
O SDK é executado como uma operação nula quando o jogo é veiculado localmente. Para verificar a correção da integração do SDK, use o guia do pacote de testes.
Integrar com o SDK Playables
Há várias integrações obrigatórias e opcionais com o SDK Playables.
Integrações obrigatórias
Leia os requisitos de publicação em geral, com foco nos requisitos de integração. Consulte a referência do SDK do Playables para saber mais sobre a implementação.
Por exemplo:
ytgame.game.firstFrameReady()ytgame.game.gameReady()ytgame.IN_PLAYABLES_ENVytgame.system.isAudioEnabled()ytgame.system.onAudioEnabledChange((isAudioEnabled) => {})ytgame.system.onPause(() => {})ytgame.system.onResume(() => {})ytgame.game.loadData()ytgame.game.saveData(data)
Integrações recomendadas
Além das integrações necessárias, várias outras funções estão disponíveis para criar uma experiência altamente envolvente. Por exemplo:
ytgame.system.getLanguage(): use para extrair a configuração de localidade atual do usuário. Não use outras funções nem armazene o idioma no salvamento na nuvem, porque ele pode mudar a qualquer momento.ytgame.engagement.sendScore({ value: newScore }): envia uma melhor pontuação para ser exibida no YouTube.ytgame.engagement.openYTContent({ id: videoID }): abrir um vídeo do YouTube.ytgame.health.logError()eytgame.health.logWarning(): registre problemas no YouTube.
Consulte a referência do SDK do Playables para conferir detalhes de implementação e outras funções.
Definições de tipo do TypeScript
Para jogos que usam TypeScript, faça o download das definições de tipo.
Exemplos de jogos
Há exemplos disponíveis que demonstram como fazer a integração com o SDK Playables do YouTube, incluindo JavaScript simples, Flutter Web, Godot e Unity.
Testar seu jogo com o pacote de testes
Quando estiver tudo pronto, você poderá validar sua integração usando o pacote de testes. Para aprender a fazer isso, siga o guia do pacote de testes.