Эта страница переведена с помощью Cloud Translation API.

Справочник по SDK YouTube Playables

ytgame

Пространство имен верхнего уровня для YouTube Playables SDK.

Это глобальная переменная в текущем окне. Вы НЕ ДОЛЖНЫ переопределять эту переменную.

Пространства имен
`ads`	🧪 API ПУБЛИЧНОЙ ПРЕДВАРИТЕЛЬНОЙ ВЕРСИИ: МОГУТ БЫТЬ ИЗМЕНЕНЫ БЕЗ УВЕДОМЛЕНИЯ.
`engagement`	Функции и свойства, связанные с вовлечением игроков.
`game`	Функции и свойства, связанные с общим игровым поведением.
`health`	Функции и свойства, связанные со здоровьем игры.
`system`	Функции и свойства, связанные с системой YouTube.

Перечисления
`Sdk Error Type`	Типы ошибок, которые выдает YouTube Playables SDK.

Классы
`Sdk Error`	Объект ошибки, который выдает YouTube Playables SDK.

Переменные
`IN_ PLAYABLES_ ENV`	Работает ли игра в среде Playables.
`SDK_ VERSION`	Версия YouTube Playables SDK.

Смотрите также

https://developers.google.com/youtube/gaming/playables

Перечисления

`Const` SdkErrorType

SdkErrorType

Типы ошибок, которые выдает YouTube Playables SDK.

Перечисление членов
`API_ UNAVAILABLE`	API был временно недоступен. Попросите игроков повторить попытку позже, если у них возникнут критические трудности.
`INVALID_ PARAMS`	API был вызван с недопустимыми параметрами.
`SIZE_ LIMIT_ EXCEEDED`	API был вызван с параметрами, превышающими ограничение по размеру.
`UNKNOWN`	Тип ошибки неизвестен.

Переменные

`Const` IN_PLAYABLES_ENV

IN_PLAYABLES_ENV : boolean

Работает ли игра в среде Playables. Вы можете использовать это, чтобы определить, следует ли включать или отключать функции, доступные только внутри Playables. Объедините эту проверку с проверкой ytgame , чтобы убедиться, что SDK действительно загружен.

Пример

const inPlayablesEnv = typeof ytgame !== "undefined" && ytgame.IN_PLAYABLES_ENV;

// An example of where you may want to fork behavior for saving data.
if (ytgame?.IN_PLAYABLES_ENV) {
  ytgame.game.saveData(dataStr);
} else {
  window.localStorage.setItem("SAVE_DATA", dataStr);
}

`Const` SDK_VERSION

SDK_VERSION : string

Версия YouTube Playables SDK.

Пример

// Prints the SDK version to console. Do not do this in production.
console.log(ytgame.SDK_VERSION);

ytgame.SdkError

Расширяет Error

Объект ошибки, который выдает YouTube Playables SDK.

Объект SdkError является дочерним объектом Error и содержит дополнительное поле.

Конструкторы
`constructor`

Характеристики
`error Type`	Тип ошибки.
`message`
`name`
`stack ?`

Характеристики

errorType

errorType : SdkErrorType

Тип ошибки.

ytgame.ads

🧪 API ПУБЛИЧНОЙ ПРЕДВАРИТЕЛЬНОЙ ВЕРСИИ: МОГУТ БЫТЬ ИЗМЕНЕНЫ БЕЗ УВЕДОМЛЕНИЯ.

Функции и свойства, связанные с рекламой.

Функции
`request Interstitial Ad`	Запрашивает показ промежуточной рекламы.

Функции

запросInterstitialAd

requestInterstitialAd ( ) : Promise < void >

Experimental Запрашивает показ промежуточной рекламы.

🧪 API ПУБЛИЧНОЙ ПРЕДВАРИТЕЛЬНОЙ ВЕРСИИ: МОГУТ БЫТЬ ИЗМЕНЕНЫ БЕЗ УВЕДОМЛЕНИЯ.

Не дает никаких гарантий относительно того, было ли показано объявление.

Пример

try {
  await ytgame.ads.requestInterstitialAd();
  // Ad request successful, do something else.
} catch (error) {
  // Handle errors, retry logic, etc.
  // Note that error may be undefined.
}

Возвраты
`Promise < void >`	обещание, которое разрешается при успешном запросе или отклоняется/выбрасывается при неудачном запросе.

ytgame.вовлеченность

Функции и свойства, связанные с вовлечением игроков.

Интерфейсы
`Content`	Объект контента, который игра отправляет на YouTube.
`Score`	Объект счета, который игра отправляет на YouTube.

Функции
`open YTContent`	Запрашивает у YouTube открытие контента, соответствующего предоставленному идентификатору видео.
`send Score`	Отправляет оценку на YouTube.

Функции

открытыйYTContent

openYTContent ( content : Content ) : Promise < void >

Запрашивает у YouTube открытие контента, соответствующего предоставленному идентификатору видео.

Как правило, это открывает видео в новой вкладке на веб-сайте и в мини-плеере на мобильном устройстве.

Пример

async function showVideo(videoID: string) {
  try {
    await ytgame.engagement.openYTContent({ id: videoID });
    // Request successful, do something else.
  } catch (error) {
    // Handle errors, retry logic, etc.
    // Note that error may be undefined.
  }
}

Параметры
`content : Content`	контент для открытия на YouTube.

Возвраты
`Promise < void >`	Обещание, которое разрешается в случае успеха и отклоняется/выдает исключение `ytgame.SdkError` в случае неудачи.

sendScore

sendScore ( score : Score ) : Promise < void >

Отправляет оценку на YouTube.

Оценка должна представлять одно измерение прогресса в игре. Если есть несколько измерений, разработчик должен выбрать одно измерение, чтобы обеспечить последовательность. Оценки будут отсортированы, и наивысшая оценка будет отображена в пользовательском интерфейсе YouTube, поэтому любой игровой пользовательский интерфейс с высокими оценками должен соответствовать тому, что отправляется через этот API.

Пример

async function onScoreAwarded(score: number) {
  try {
    await ytgame.engagement.sendScore({ value: score });
    // Score sent successfully, do something else.
  } catch (error) {
    // Handle errors, retry logic, etc.
    // Note that error may be undefined.
  }
}

Параметры
`score : Score`	оценка для отправки на YouTube.

Возвраты
`Promise < void >`	Обещание, которое разрешается в случае успеха и отклоняется/выдает исключение `ytgame.SdkError` в случае неудачи.

ytgame.engagement.Content

Объект контента, который игра отправляет на YouTube.

Характеристики
`id`	Идентификатор видео, которое мы хотим открыть.

Характеристики

идентификатор

id : string

Идентификатор видео, которое мы хотим открыть.

ytgame.engagement.Оценка

Объект счета, который игра отправляет на YouTube.

Характеристики
`value`	Значение оценки выражается целым числом.

Характеристики

ценить

value : number

Значение оценки, выраженное целым числом. Оценка должна быть меньше или равна максимальному безопасному целому числу . В противном случае оценка будет отклонена.

ytgame.игра

Функции и свойства, связанные с общим игровым поведением.

Функции
`first Frame Ready`	Уведомляет YouTube о том, что игра начала показывать кадры.
`game Ready`	Уведомляет YouTube о том, что игра готова к взаимодействию с игроками.
`load Data`	Загружает игровые данные с YouTube в виде сериализованной строки.
`save Data`	Сохраняет данные игры на YouTube в виде сериализованной строки.

Функции

firstFrameReady

firstFrameReady ( ) : void

Уведомляет YouTube о том, что игра начала показывать кадры.

Игра ДОЛЖНА вызывать этот API. В противном случае игра не будет показана пользователям. firstFrameReady() ДОЛЖЕН быть вызван перед gameReady() .

Пример

function onGameInitialized() {
  ytgame.game.firstFrameReady();
}

gameReady

gameReady ( ) : void

Уведомляет YouTube о том, что игра готова к взаимодействию с игроками.

Игра ДОЛЖНА вызывать этот API, когда она интерактивна. Игра НЕ ДОЛЖНА вызывать этот API, когда экран загрузки все еще отображается. В противном случае игра не проходит процесс сертификации YouTube.

Пример

function onGameInteractable() {
  ytgame.game.gameReady();
}

loadData

loadData ( ) : Promise < string >

Загружает игровые данные с YouTube в виде сериализованной строки.

Игра должна обрабатывать любой синтаксический анализ между строкой и внутренним форматом.

Пример

async function gameSetup() {
  try {
    const data = await ytgame.game.loadData();
    // Load succeeded, do something with data.
  } catch (error) {
    // Handle errors, retry logic, etc.
    // Note that error may be undefined.
  }
}

Возвраты
`Promise < string >`	Обещание, которое завершается при успешной загрузке и отклоняется с `ytgame.SdkError` в случае неудачи.

сохранитьДанные

saveData ( data : string ) : Promise < void >

Сохраняет данные игры на YouTube в виде сериализованной строки.

Строка должна быть допустимой, правильно сформированной строкой UTF-16 и иметь размер не более 3 МБ. Игра должна обрабатывать любой синтаксический анализ между строкой и внутренним форматом. При необходимости используйте String.isWellFormed() чтобы проверить, правильно ли сформирована строка.

Пример

async function saveGame() {
  try {
    ytgame.game.saveData(JSON.stringify(gameSave));
    // Save succeeded.
  } catch (error) {
    // Handle errors, retry logic, etc.
    // Note that error may be undefined.
  }
}

Параметры
`data : string`

Возвраты
`Promise < void >`	Обещание, которое разрешается при успешном сохранении и отклоняется с `ytgame.SdkError` в случае неудачи.

ytgame.здоровье

Функции и свойства, связанные со здоровьем игры.

Функции
`log Error`	Регистрирует ошибку на YouTube.
`log Warning`	Регистрирует предупреждение на YouTube.

Функции

logError

logError ( ) : void

Регистрирует ошибку на YouTube.

Примечание: этот API работает по принципу «лучшее из возможного» и имеет ограничения по скорости, что может привести к потере данных.

Пример

function onError() {
  ytgame.health.logError();
}

logWarning

logWarning ( ) : void

Регистрирует предупреждение на YouTube.

Примечание: этот API работает по принципу «лучшее из возможного» и имеет ограничения по скорости, что может привести к потере данных.

Пример

function onWarning() {
  ytgame.health.logWarning();
}

ytgame.система

Функции и свойства, связанные с системой YouTube.

Функции
`get Language`	Возвращает язык, установленный в настройках YouTube пользователя, в виде языкового тега BCP-47 .
`is Audio Enabled`	Возвращает информацию о том, включен ли игровой звук в настройках YouTube.
`on Audio Enabled Change`	Устанавливает обратный вызов, который будет запущен при возникновении события изменения настроек звука на YouTube.
`on Pause`	Устанавливает обратный вызов, который будет запущен при возникновении события паузы в игре на YouTube.
`on Resume`	Устанавливает обратный вызов, который будет запущен при запуске события возобновления игры с YouTube.

Функции

получитьЯзык

getLanguage ( ) : Promise < string >

Возвращает язык, установленный в настройках YouTube пользователя, в виде языкового тега BCP-47 .

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

Пример

const localeTag = await ytgame.system.getLanguage();
// `localeTag` is now set to something like "en-US" or "es-419".

Возвраты
`Promise < string >`	Обещание, которое завершается при успешном получении языка и отклоняется с `ytgame.SdkError` в случае неудачи.

isAudioEnabled

isAudioEnabled ( ) : boolean

Возвращает информацию о том, включен ли игровой звук в настройках YouTube.

Игра ДОЛЖНА использовать это для инициализации звукового состояния игры.

Пример

function initGameSound() {
  if (ytgame.system.isAudioEnabled()) {
    // Enable game audio.
  } else {
    // Disable game audio.
  }
}

Возвраты
`boolean`	логическое значение, указывающее, включен ли звук.

onAudioEnabledChange

onAudioEnabledChange ( callback : ( ( isAudioEnabled : boolean ) => void ) ) : ( ( ) => void )

Устанавливает обратный вызов, который будет запущен при возникновении события изменения настроек звука на YouTube.

Игра ДОЛЖНА использовать этот API для обновления состояния звука в игре.

Пример

ytgame.system.onAudioEnabledChange((isAudioEnabled) => {
  if (isAudioEnabled) {
    // Enable game audio.
  } else {
    // Disable game audio.
  }
});

Параметры
`callback : ( ( isAudioEnabled : boolean ) => void )`	функция обратного вызова, которая будет запущена.

Возвраты
`( ( ) => void )`	функция для сброса обратного вызова, который обычно не используется.

наПаузе

onPause ( callback : ( ( ) => void ) ) : ( ( ) => void )

Устанавливает обратный вызов, который будет запущен при запуске события паузы игры с YouTube. В игре есть короткое окно для сохранения любого состояния перед его вытеснением.

onPause вызывается для всех типов пауз, включая выход пользователя из игры. Нет гарантии, что игра возобновится.

Пример

ytgame.system.onPause(() => {
  pauseGame();
});

function pauseGame() {
  // Logic to pause game state.
}

Параметры
`callback : ( ( ) => void )`	функция обратного вызова, которая будет запущена.

Возвраты
`( ( ) => void )`	функция для сброса обратного вызова, который обычно не используется.

onResume

onResume ( callback : ( ( ) => void ) ) : ( ( ) => void )

Устанавливает обратный вызов, который будет запущен при запуске события возобновления игры с YouTube.

После приостановки возобновление игры не гарантируется.

Пример

ytgame.system.onResume(() => {
  resumeGame();
});

function resumeGame() {
  // Logic to resume game state.
}

Параметры
`callback : ( ( ) => void )`	функция обратного вызова, которая будет запущена.

Возвраты
`( ( ) => void )`	функция для сброса обратного вызова, который обычно не используется.

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

ytgame

Перечисления

Const SdkErrorType

Переменные

Const IN_PLAYABLES_ENV

Const SDK_VERSION

ytgame.SdkError

Характеристики

errorType

ytgame.ads

Функции

запросInterstitialAd

ytgame.вовлеченность

Функции

открытыйYTContent

sendScore

ytgame.engagement.Content

Характеристики

идентификатор

ytgame.engagement.Оценка

Характеристики

ценить

ytgame.игра

Функции

firstFrameReady

gameReady

loadData

сохранитьДанные

ytgame.здоровье

Функции

logError

logWarning

ytgame.система

Функции

получитьЯзык

isAudioEnabled

onAudioEnabledChange

наПаузе

onResume

Справочник по SDK YouTube Playables

`Const` SdkErrorType

`Const` IN_PLAYABLES_ENV

`Const` SDK_VERSION