SDK YouTube Playables – Начало работы

YouTube Playables SDK — это веб-SDK для интеграции веб-игр с средой YouTube. SDK обладает мощным API для поддержки игр различными способами, что позволяет создать превосходный игровой опыт на YouTube.

Добавьте Playables SDK в свою игру.

В корневом каталоге игры должен находиться файл index.html . Для импорта SDK YouTube Playables добавьте следующую строку перед любым кодом вашей игры:

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

SDK работает в фоновом режиме, не выполняя никаких действий, когда ваша игра запущена локально. Для проверки корректности интеграции SDK используйте руководство по набору тестов .

Интеграция с Playables SDK

Для работы с Playables SDK предусмотрено несколько обязательных и дополнительных интеграций.

Необходимые интеграции

Ознакомьтесь с общими требованиями к публикации , уделяя особое внимание требованиям к интеграции . Для получения подробной информации о реализации обратитесь к справочнику Playables SDK .

Примеры включают:

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

Помимо необходимых интеграций, доступны и другие функции, позволяющие создать максимально привлекательный пользовательский опыт. Примеры включают:

  • ytgame.system.getLanguage() — Используйте эту функцию для получения текущих языковых настроек пользователя. Не используйте другие функции и не сохраняйте язык в облачном хранилище, так как он может измениться в любой момент.
  • ytgame.engagement.sendScore({ value: newScore }) - Отправляет лучший результат на YouTube для отображения.
  • ytgame.engagement.openYTContent({ id: videoID }) — открыть видео на YouTube.
  • ytgame.health.logError() и ytgame.health.logWarning() — Сообщайте о проблемах на YouTube.

Для получения подробной информации о реализации и дополнительных функциях ознакомьтесь со справочником Playables SDK .

Определения типов TypeScript

Для игр, использующих TypeScript, загрузите определения типов .

Примеры игр

Доступны примеры , демонстрирующие интеграцию с YouTube Playables SDK, включая чистый JavaScript, Flutter web, Godot и Unity.

Проверьте свою игру с помощью набора тестов.

Когда будете готовы, вы можете проверить интеграцию с помощью набора тестов. Чтобы узнать, как это сделать, следуйте руководству по набору тестов .