YouTube Hazır Oyunlar SDK referansı

ytgame

YouTube Playables SDK'sı için üst düzey ad alanı.

Bu, geçerli pencerede dünya geneli kapsamlı bir değişkendir. Bu değişkeni ÜST EÇEMEZSİNİZ.
Ad alanları
ads
🧪 PUBLIC PREVIEW API: SUBJECT TO CHANGE WITHOUT NOTICE.
engagement
Oyuncu etkileşimiyle ilgili işlevler ve özellikler.
game
Genel oyun davranışlarıyla ilgili işlevler ve özellikler.
health
Oyun sağlığıyla ilgili işlevler ve özellikler.
system
YouTube sistemiyle ilgili işlevler ve özellikler.
Listeleme
SdkErrorType
YouTube Playables SDK'sının oluşturduğu hata türleri.
Sınıflar
SdkError
YouTube Playables SDK'sının oluşturduğu hata nesnesi.
Değişkenler
IN_PLAYABLES_ENV
Oyunun Playables ortamında çalışıp çalışmadığı.
SDK_VERSION
YouTube Hazır Oyunlar SDK sürümü.
Aşağıdaki kaynakları da incelemenizi öneririz:

Listeleme

Const SdkErrorType

SdkErrorType
YouTube Playables SDK'sının oluşturduğu hata türleri.
Listeleme üyeleri
API_UNAVAILABLE
API geçici olarak kullanılamadı.

Kritik bir akışta olan oyunculardan daha sonra tekrar denemelerini isteyin.
INVALID_PARAMS
API, geçersiz parametrelerle çağrıldı.
SIZE_LIMIT_EXCEEDED
API, boyut sınırını aşan parametrelerle çağrıldı.
UNKNOWN
Hata türü bilinmiyor.

Değişkenler

Const IN_PLAYABLES_ENV

IN_PLAYABLES_ENV: boolean
Oyunun Playables ortamında çalışıp çalışmadığı. Yalnızca Hazır Oyunlar'da kullanılabilen özellikleri etkinleştirip devre dışı bırakmak için bu seçeneği kullanabilirsiniz. SDK'nın gerçekten yüklendiğinden emin olmak için bu kontrolü ytgame kontrolüyle birlikte kullanın.
Örnek
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 Hazır Oyunlar SDK sürümü.
Örnek
// Prints the SDK version to console. Do not do this in production.
console.log(ytgame.SDK_VERSION);

ytgame.SdkError

Uzatma Error
YouTube Playables SDK'sının oluşturduğu hata nesnesi.

SdkError nesnesi, Error öğesinin alt öğesidir ve ek bir alan içerir.
Markalar
constructor
Özellikler
errorType
Hatanın türü.
message
name
stack?

Özellikler

errorType

errorType: SdkErrorType
Hatanın türü.

ytgame.ads

🧪 PUBLIC PREVIEW API: SUBJECT TO CHANGE WITHOUT NOTICE.

Reklamlarla ilgili işlevler ve özellikler.
İşlevler
requestInterstitialAd
Geçiş reklamının gösterilmesini ister.

İşlevler

requestInterstitialAd

requestInterstitialAd(): Promise<void>
Experimental Bir geçiş reklamının gösterilmesini ister.

🧪 PUBLIC PREVIEW API: SUBJECT TO CHANGE WITHOUT NOTICE.

Reklamın gösterilip gösterilmediğine dair hiçbir garanti vermez.
Örnek
try {
  await ytgame.ads.requestInterstitialAd();
  // Ad request successful, do something else.
} catch (error) {
  // Handle errors, retry logic, etc.
  // Note that error may be undefined.
}
İadeler
Promise<void> Başarılı bir istekle çözülen veya başarısız bir istekle reddeden/atlayan bir söz

ytgame.engagement

Oyuncu etkileşimiyle ilgili işlevler ve özellikler.
Arayüzler
Content
Oyunun YouTube'a gönderdiği içerik nesnesi.
Score
Oyunun YouTube'a gönderdiği puan nesnesi.
İşlevler
openYTContent
YouTube'dan, sağlanan video kimliğine karşılık gelen içeriği açmasını ister.
sendScore
YouTube'a bir puan gönderir.

İşlevler

openYTContent

openYTContent(content: Content): Promise<void>
YouTube'dan, sağlanan video kimliğine karşılık gelen içeriği açmasını ister.

Genellikle bu işlem, videoyu web'de yeni bir sekmede ve mobil cihazlarda mini oynatıcıda açar.
Örnek
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.
  }
}
Parametreler
content: Content YouTube'da açılacak içeriği seçin.
İadeler
Promise<void> Başarılı olduğunda çözülen ve başarısız olduğunda ytgame.SdkError ile reddeden/atanan bir Promise.

sendScore

sendScore(score: Score): Promise<void>
YouTube'a bir puan gönderir.

Puan, oyundaki ilerlemenin bir boyutunu temsil etmelidir. Birden fazla boyut varsa geliştiricinin tutarlı olması için bir boyut seçmesi gerekir. Puanlar sıralanır ve en yüksek puan YouTube kullanıcı arayüzünde gösterilir. Böylece oyun içi yüksek puan kullanıcı arayüzü, bu API üzerinden gönderilen puanla uyumlu olur.
Örnek
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.
  }
}
Parametreler
score: Score YouTube'a gönderilecek puan.
İadeler
Promise<void> Başarılı olduğunda çözülen ve başarısız olduğunda ytgame.SdkError ile reddeden/atanan bir Promise.

ytgame.engagement.Content

Oyunun YouTube'a gönderdiği içerik nesnesi.
Özellikler
id
Açmak istediğimiz videonun kimliği.

Özellikler

id

id: string
Açmak istediğimiz videonun kimliği.

ytgame.engagement.Score

Oyunun YouTube'a gönderdiği puan nesnesi.
Özellikler
value
Tam sayı olarak ifade edilen puan değeri.

Özellikler

value

value: number
Tam sayı olarak ifade edilen puan değeri. Puan, maksimum güvenli tam sayı değerinden küçük veya bu değere eşit olmalıdır. Aksi takdirde puan reddedilir.

ytgame.game

Genel oyun davranışlarıyla ilgili işlevler ve özellikler.
İşlevler
firstFrameReady
YouTube'u, oyunun kare göstermeye başladığı konusunda bilgilendirir.
gameReady
Oyunun, oyuncuların etkileşime geçebileceği şekilde hazır olduğunu YouTube'a bildirir.
loadData
YouTube'daki oyun verilerini serileştirilmiş dize biçiminde yükler.
saveData
Oyun verilerini YouTube'a serileştirilmiş dize biçiminde kaydeder.

İşlevler

firstFrameReady

firstFrameReady(): void
Oyunun kare göstermeye başladığını YouTube'a bildirir.

Oyun bu API'yi MUST. Aksi takdirde oyun kullanıcılara gösterilmez. firstFrameReady(), gameReady()'den önce MUST.
Örnek
function onGameInitialized() {
  ytgame.game.firstFrameReady();
}

gameReady

gameReady(): void
Oyunun, oyuncuların etkileşime geçebileceği duruma geldiğini YouTube'a bildirir.

Oyun, etkileşime geçilebilir olduğunda bu API'yi MUST. Oyun, yükleme ekranı hâlâ gösterilirken bu API'yi ÇAĞIRMAMALISDIR. Aksi takdirde oyun, YouTube sertifikasyon sürecini geçemez.
Örnek
function onGameInteractable() {
  ytgame.game.gameReady();
}

loadData

loadData(): Promise<string>
YouTube'dan oyun verilerini serileştirilmiş dize biçiminde yükler.

Dize ile dahili biçim arasındaki tüm ayrıştırma işlemlerini oyun yapmalıdır.
Örnek
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.
  }
}
İadeler
Promise<string> Yükleme başarılı olduğunda tamamlanan ve başarısız olduğunda ytgame.SdkError ile reddeden bir Promise.

saveData

saveData(data: string): Promise<void>
Oyun verilerini YouTube'a serileştirilmiş dize biçiminde kaydeder.

Dize, geçerli ve iyi biçimlendirilmiş bir UTF-16 dizesi olmalıdır ve en fazla 3 MiB olabilir. Oyun, dize ile dahili biçim arasındaki tüm ayrıştırma işlemlerini yapmalıdır. Gerekirse dizenin doğru biçimlendirilip biçimlendirilmediğini kontrol etmek için String.isWellFormed() kullanın.
Örnek
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.
  }
}
Parametreler
data: string
İadeler
Promise<void> Kaydetme işlemi başarılı olduğunda çözülmesini ve başarısız olduğunda ytgame.SdkError ile reddetmesini sağlayan bir Promise.

ytgame.health

Oyun sağlığıyla ilgili işlevler ve özellikler.
İşlevler
logError
YouTube'a hata kaydeder.
logWarning
YouTube'a uyarı kaydeder.

İşlevler

logError

logError(): void
YouTube'da hata günlüğe kaydedilir.

Not: Bu API, en iyi çaba gösterilerek sunulur ve hız sınırlıdır. Bu durum veri kaybına neden olabilir.
Örnek
function onError() {
  ytgame.health.logError();
}

logWarning

logWarning(): void
YouTube'a uyarı kaydeder.

Not: Bu API, en iyi çabayı gösterir ve hız sınırlıdır. Bu durum veri kaybına neden olabilir.
Örnek
function onWarning() {
  ytgame.health.logWarning();
}

ytgame.system

YouTube sistemiyle ilgili işlevler ve özellikler.
İşlevler
getLanguage
Kullanıcının YouTube ayarlarında ayarlanan dili BCP-47 dil etiketi biçiminde döndürür.
isAudioEnabled
YouTube ayarlarında oyun sesinin etkin olup olmadığını döndürür.
onAudioEnabledChange
YouTube'dan ses ayarları değişikliği etkinliği tetiklendiğinde tetiklenecek bir geri çağırma belirler.
onPause
YouTube'dan bir oyun duraklatma etkinliği tetiklendiğinde tetiklenecek bir geri çağırma işlevi ayarlar.
onResume
YouTube'dan bir oyuna devam etme etkinliği tetiklendiğinde tetiklenecek bir geri çağırma işlevi ayarlar.

İşlevler

getLanguage

getLanguage(): Promise<string>
Kullanıcının YouTube ayarlarında ayarlanan dili BCP-47 dil etiketi biçiminde döndürür.

Kullanıcının dilini veya yerel ayarını belirlemek ya da dil tercihini bulutta depolamak için başka işlevler kullanmayın. Bunun yerine, kullanıcı deneyiminin YouTube'da tutarlı olmasını sağlamak için bu işlevi kullanın.
Örnek
const localeTag = await ytgame.system.getLanguage();
// `localeTag` is now set to something like "en-US" or "es-419".
İadeler
Promise<string> Dil başarıyla alındığında tamamlanan ve başarısız olduğunda ytgame.SdkError ile reddeden bir Promise.

isAudioEnabled

isAudioEnabled(): boolean
Oyun sesinin YouTube ayarlarında etkin olup olmadığını döndürür.

Oyun, ses durumunu başlatmak için bunu KULLANMALIDIR.
Örnek
function initGameSound() {
  if (ytgame.system.isAudioEnabled()) {
    // Enable game audio.
  } else {
    // Disable game audio.
  }
}
İadeler
boolean Ses özelliğinin etkin olup olmadığını belirten bir boole değeri.

onAudioEnabledChange

onAudioEnabledChange(callback: ((isAudioEnabled: boolean) => void)): (() => void)
Ses ayarları değişikliği etkinliği YouTube'dan tetiklendiğinde tetiklenecek bir geri çağırma işlevi belirler.

Oyun ses durumunu güncellemek için bu API'yi MUST.
Örnek
ytgame.system.onAudioEnabledChange((isAudioEnabled) => {
  if (isAudioEnabled) {
    // Enable game audio.
  } else {
    // Disable game audio.
  }
});
Parametreler
callback: ((isAudioEnabled: boolean) => void) Tetiklenecek geri çağırma işlevi.
İadeler
(() => void) Genellikle kullanılmayan geri çağırma işlevinin ayarını kaldırmak için kullanılan bir işlev.

onPause

onPause(callback: (() => void)): (() => void)
YouTube'dan bir oyun duraklatma etkinliği tetiklendiğinde tetiklenecek bir geri çağırma işlevi ayarlar. Oyunun, kullanımdan kaldırılmadan önce tüm durumları kaydetmesi için kısa bir süresi vardır.

onPause, kullanıcının oyundan çıktığı durumlar da dahil olmak üzere tüm duraklatma türleri için çağrılır. Oyunun devam edeceğini garanti edemeyiz.
Örnek
ytgame.system.onPause(() => {
  pauseGame();
});

function pauseGame() {
  // Logic to pause game state.
}
Parametreler
callback: (() => void) Tetiklenecek geri çağırma işlevi.
İadeler
(() => void) Genellikle kullanılmayan geri çağırma işlevinin ayarını kaldırmak için kullanılan bir işlev.

onResume

onResume(callback: (() => void)): (() => void)
YouTube'dan oyuna devam etme etkinliği tetiklendiğinde tetiklenecek bir geri çağırma işlevi ayarlar.

Oyunun duraklatıldıktan sonra devam edeceği garanti edilmez.
Örnek
ytgame.system.onResume(() => {
  resumeGame();
});

function resumeGame() {
  // Logic to resume game state.
}
Parametreler
callback: (() => void) Tetiklenecek geri çağırma işlevi.
İadeler
(() => void) Genellikle kullanılmayan geri çağırma işlevinin ayarını kaldırmak için kullanılan bir işlev.