YouTube Playables SDK — это веб-SDK для соединения веб-игр со средой YouTube. SDK имеет надежный API для поддержки игр различными способами, чтобы создать отличный игровой опыт на YouTube.
Добавьте Playables SDK в свою игру
Игра должна иметь файл index.html в корневом каталоге. Импортируйте YouTube Playables SDK, добавив эту строку перед любым кодом вашей игры:
<script src="https://www.youtube.com/game_api/v1"></script>
SDK работает как no-op, когда ваша игра обслуживается локально. Чтобы проверить правильность интеграции 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.
Протестируйте свою игру с помощью тестового набора
Когда вы будете готовы, вы можете проверить свою интеграцию с помощью тестового набора. Чтобы узнать, как это сделать, следуйте руководству по тестовому набору .