Ta strona została przetłumaczona przez Cloud Translation API.

Dokumentacja pakietu SDK Pokoju gier w YouTube

ytgame

Najwyższa przestrzeń nazw dla pakietu SDK YouTube Playables.

Zmienna o zasięgu globalnym w bieżącym oknie. NIE MOŻESZ zastąpić tej zmiennej.

Przestrzenie nazw
`ads`	🧪 INTERFEJS PUBLIC PREVIEW API: MOŻE ULEC ZMIANIE BEZ POWIADOMIENIA.
`engagement`	Funkcje i właściwości związane z zaangażowaniem gracza.
`game`	Funkcje i właściwości związane z ogólnymi zachowaniami w grze.
`health`	Funkcje i właściwości związane ze zdrowiem gry.
`system`	Funkcje i właściwości związane z systemem YouTube.

Wyliczenia
`SdkErrorType`	Rodzaje błędów, które może wywołać pakiet SDK YouTube Playables.

Zajęcia
`SdkError`	Obiekt błędu zwracany przez pakiet SDK YouTube Playables.

Zmienne
`IN_PLAYABLES_ENV`	Czy gra działa w środowisku Playables.
`SDK_VERSION`	Wersja pakietu SDK Pokoju gier w YouTube.

Zobacz też

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

Wyliczenia

`Const` SdkErrorType

SdkErrorType

Rodzaje błędów, które może wywołać pakiet SDK YouTube Playables.

Wyliczenie członków
`API_UNAVAILABLE`	Interfejs API był tymczasowo niedostępny. Poproś graczy, aby spróbowali ponownie później, jeśli są w krytycznym miejscu rozgrywki.
`INVALID_PARAMS`	Interfejs API został wywołany z nieprawidłowymi parametrami.
`SIZE_LIMIT_EXCEEDED`	Interfejs API został wywołany z parametrami przekraczającymi limit rozmiaru.
`UNKNOWN`	Typ błędu jest nieznany.

Zmienne

`Const` IN_PLAYABLES_ENV

IN_PLAYABLES_ENV: boolean

Czy gra działa w środowisku Playables. Możesz na przykład określić, czy włączyć czy wyłączyć funkcje dostępne tylko w Pokojach gier. Połącz to sprawdzenie z sprawdzeniem wartości ytgame, aby upewnić się, że pakiet SDK został faktycznie załadowany.

Przykład

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

Wersja pakietu SDK Pokoju gier w YouTube.

Przykład

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

ytgame.SdkError

Przedłuża Error

Obiekt błędu zwracany przez YouTube Playables SDK.

Obiekt SdkError jest elementem podrzędnym obiektu Errori zawiera dodatkowe pole.

Zespoły
`constructor`

Właściwości
`errorType`	Typ błędu.
`message`
`name`
`stack?`

Właściwości

errorType

errorType:
                  SdkErrorType

Typ błędu.

ytgame.ads

🧪 INTERFEJSA PUBLICZNEGO PREVIEWU API: MOŻE ULEC ZMIANIE BEZ POWIADOMIENIA.

Funkcje i właściwości związane z reklamami.

Funkcje
`requestInterstitialAd`	Żądanie wyświetlenia reklamy pełnoekranowej.

Funkcje

requestInterstitialAd

requestInterstitialAd(): Promise<void>

ExperimentalWysyła żądanie wyświetlenia reklamy pełnoekranowej.

🧪INTERFEJS PUBLICZNY: MOŻE ULEC ZMIANIE BEZ POWIADOMIENIA.

Nie gwarantuje, że reklama zostanie wyświetlona.

Przykład

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

Zwroty
`Promise<void>`	obietnicę, która zwraca wartość w przypadku udanego żądania lub odrzuca lub odrzuca żądanie w przypadku żądania nieudanego.

ytgame.engagement

Funkcje i właściwości związane z zaangażowaniem gracza.

Interfejsy
`Content`	Obiekt treści wysyłany przez grę do YouTube.
`Score`	Obiekt wyniku wysyłany przez grę do YouTube.

Funkcje
`openYTContent`	Prośba o otwarcie treści odpowiadających podanemu identyfikatorowi filmu.
`sendScore`	Wysyła wynik do YouTube.

Funkcje

openYTContent

openYTContent(content: Content): Promise<void>

Wysyła prośbę do YouTube o otwarcie treści odpowiadających podanemu identyfikatorowi filmu.

Zazwyczaj powoduje to otwarcie filmu w nowej karcie w przeglądarce i w miniodtwarzaczu na urządzeniu mobilnym.

Przykład

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.
  }
}

Parametry
`content: Content`	treści, które mają się otwierać w YouTube.

Zwroty
`Promise<void>`	obietnicę, która zwraca wartość w przypadku powodzenia i odrzuca lub zgłasza błąd `ytgame.SdkError` w przypadku niepowodzenia;

sendScore

sendScore(score: Score): Promise<void>

Wysyła wynik do YouTube.

Wynik powinien reprezentować jeden z wymiarów postępu w grze. Jeśli jest kilka wymiarów, deweloper musi wybrać jeden, aby zachować spójność. Wyniki zostaną posortowane, a najwyższy z nich wyświetli się w interfejsie YouTube. Oznacza to, że interfejs najwyższego wyniku w grze powinien być zgodny z tym, co jest wysyłane przez ten interfejs API.

Przykład

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.
  }
}

Parametry
`score: Score`	wynik do wysłania do YouTube.

Zwroty
`Promise<void>`	obietnicę, która zwraca wartość w przypadku powodzenia i odrzuca lub zgłasza błąd `ytgame.SdkError` w przypadku niepowodzenia;

ytgame.engagement.Content

Obiekt treści wysyłany przez grę do YouTube.

Właściwości
`id`	Identyfikator filmu, który chcemy otworzyć.

Właściwości

id

id: string

Identyfikator filmu, który chcemy otworzyć.

ytgame.engagement.Score

Obiekt wyniku wysyłany przez grę do YouTube.

Właściwości
`value`	Wartość wyniku wyrażona jako liczba całkowita.

Właściwości

value

value: number

Wartość wyniku wyrażona jako liczba całkowita. Wynik musi być mniejszy lub równy maksymalnie bezpiecznej liczbie całkowitej. W przeciwnym razie wynik zostanie odrzucony.

ytgame.game

Funkcje i właściwości związane z ogólnymi zachowaniami w grze.

Funkcje
`firstFrameReady`	powiadamia YouTube, że gra zaczęła wyświetlać klatki;
`gameReady`	Powiadomienie YouTube, że gra jest gotowa do interakcji z graczami.
`loadData`	Ładuje dane gry z YouTube w postaci serializowanego ciągu znaków.
`saveData`	Zapisuje dane gry w YouTube w postaci serializowanego ciągu znaków.

Funkcje

firstFrameReady

firstFrameReady(): void

powiadamia YouTube, że gra zaczęła wyświetlać klatki.

Gra MUST wywoływać ten interfejs API. W przeciwnym razie gra nie będzie widoczna dla użytkowników. Funkcję firstFrameReady() MUST zostać wywołana przed funkcją gameReady().

Przykład

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

gameReady

gameReady(): void

Informuje YouTube, że gra jest gotowa do interakcji z graczami.

Gdy gra jest gotowa do interakcji, MUST wywoływać ten interfejs API. Gra NIE MOŻE wywoływać tego interfejsu API, gdy nadal wyświetlany jest ekran wczytywania. W przeciwnym razie gra nie przejdzie procesu certyfikacji w YouTube.

Przykład

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

loadData

loadData(): Promise<string>

Ładuje dane gry z YouTube w postaci serializowanego ciągu.

Gra musi obsłużyć parsowanie między ciągiem a formatem wewnętrznym.

Przykład

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.
  }
}

Zwroty
`Promise<string>`	obietnicę, która jest wykonywana po pomyślnym wczytaniu i odrzucana z wartością `ytgame.SdkError` w przypadku niepowodzenia;

saveData

saveData(data: string): Promise<void>

Zapisuje dane gry w YouTube w postaci serializowanego ciągu znaków.

Ciąg znaków musi być prawidłowym, poprawnie sformatowanym ciągiem znaków UTF-16 o maksymalnej długości 3 MiB. Gra musi obsługiwać parsowanie między ciągiem znaków a formatem wewnętrznym. W razie potrzeby użyj funkcji String.isWellFormed(), aby sprawdzić, czy ciąg znaków jest poprawny.

Przykład

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.
  }
}

Parametry
`data: string`

Zwroty
`Promise<void>`	obietnicę, która jest spełniana, gdy zapisanie się powiedzie, i odrzucana z wiadomością `ytgame.SdkError`, gdy się nie powiedzie;

ytgame.health

Funkcje i właściwości związane ze zdrowiem gry.

Funkcje
`logError`	Zapisywanie błędu w YouTube.
`logWarning`	Zapisywanie ostrzeżenia w YouTube.

Funkcje

logError

logError(): void

Zapisuje błąd w YouTube.

Uwaga: ten interfejs API działa w najlepszy możliwy sposób i jest ograniczony pod względem szybkości, co może spowodować utratę danych.

Przykład

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

logWarning

logWarning(): void

Zapisuje ostrzeżenie w YouTube.

Uwaga: ten interfejs API działa w najlepszy możliwy sposób i jest ograniczony pod względem szybkości, co może spowodować utratę danych.

Przykład

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

ytgame.system

Funkcje i właściwości związane z systemem YouTube.

Funkcje
`getLanguage`	Zwraca język ustawiony w ustawieniach YouTube użytkownika w postaci tagu języka BCP-47.
`isAudioEnabled`	Zwraca informację, czy dźwięk z gry jest włączony w ustawieniach YouTube.
`onAudioEnabledChange`	Określa wywołanie zwrotne, które ma być wywoływane, gdy zdarzenie zmiany ustawień dźwięku zostanie wywołane z YouTube.
`onPause`	Określa wywołanie zwrotne, które ma być wywoływane, gdy zdarzenie wstrzymania gry zostanie wywołane z YouTube.
`onResume`	Określa wywołanie zwrotne, które ma być wywoływane, gdy z YouTube zostanie wywołane zdarzenie wznowienia gry.

Funkcje

getLanguage

getLanguage(): Promise<string>

Zwraca język ustawiony w ustawieniach YouTube użytkownika w formie tagu języka BCP-47.

Nie używaj innych funkcji do określania języka ani lokalizacji użytkownika ani nie przechowuj jego preferencji językowych w zapisie w chmurze. Zamiast tego używaj tej funkcji, aby zapewnić spójne wrażenia użytkowników w YouTube.

Przykład

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

Zwroty
`Promise<string>`	obietnicę, która jest wypełniana, gdy pobieranie języka się powiedzie, a odrzucana z wartością `ytgame.SdkError`, gdy się nie powiedzie;

isAudioEnabled

isAudioEnabled(): boolean

Zwraca informację, czy dźwięk w grze jest włączony w ustawieniach YouTube.

Gra POWINNA użyć tej funkcji, aby zainicjować stan dźwięku w grze.

Przykład

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

Zwroty
`boolean`	wartość logiczna określająca, czy dźwięk jest włączony;

onAudioEnabledChange

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

Określa wywołanie zwrotne, które zostanie wywołane, gdy zdarzenie zmiany ustawień dźwięku zostanie wywołane z YouTube.

Aby zaktualizować stan dźwięku w grze, MUST użyć tego interfejsu API.

Przykład

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

Parametry
`callback: ((isAudioEnabled: boolean) => void)`	funkcję wywołania zwrotnego, która ma zostać wywołana.

Zwroty
`(() => void)`	funkcję do anulowania wywołania zwrotnego, która zwykle nie jest używana.

onPause

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

Określa wywołanie zwrotne, które ma być wywoływane, gdy zdarzenie wstrzymania gry zostanie wywołane z YouTube. Gra ma krótki czas na zapisanie stanu, zanim zostanie usunięty.

onPause jest wywoływany we wszystkich typach przerw, w tym gdy użytkownik zamyka grę. Nie możemy zagwarantować, że gra będzie działać.

Przykład

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

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

Parametry
`callback: (() => void)`	funkcję wywołania zwrotnego, która ma zostać wywołana.

Zwroty
`(() => void)`	funkcję do anulowania wywołania zwrotnego, która zwykle nie jest używana.

onResume

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

Ustawia wywołanie zwrotne, które zostanie wywołane, gdy zdarzenie wznowienia gry zostanie wygenerowane przez YouTube.

Po wstrzymaniu gry nie ma gwarancji, że zostanie ona wznowiona.

Przykład

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

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

Parametry
`callback: (() => void)`	funkcję wywołania zwrotnego, która ma zostać wywołana.

Zwroty
`(() => void)`	funkcję do anulowania wywołania zwrotnego, która zwykle nie jest używana.

Dokumentacja pakietu SDK Pokoju gier w YouTube Zadbaj o dobrą organizację dzięki kolekcji Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.

ytgame

Wyliczenia

Const SdkErrorType

Zmienne

Const IN_PLAYABLES_ENV

Const SDK_VERSION

ytgame.SdkError

Właściwości

errorType

ytgame.ads

Funkcje

requestInterstitialAd

ytgame.engagement

Funkcje

openYTContent

sendScore

ytgame.engagement.Content

Właściwości

id

ytgame.engagement.Score

Właściwości

value

ytgame.game

Funkcje

firstFrameReady

gameReady

loadData

saveData

ytgame.health

Funkcje

logError

logWarning

ytgame.system

Funkcje

getLanguage

isAudioEnabled

onAudioEnabledChange

onPause

onResume

Dokumentacja pakietu SDK Pokoju gier w YouTube

`Const` SdkErrorType

`Const` IN_PLAYABLES_ENV

`Const` SDK_VERSION