YouTube Hazır Oyunlar SDK referansı

ytgame

YouTube Hazır Oyunlar SDK'sının üst düzey ad alanı.

Bu, geçerli pencerede genel kapsamlı bir değişkendir. Bu değişkeni KESİNLİKLE geçersiz kılmamalısınız.

Ad alanları
`ads`	🧪 HERKESE AÇIK ÖNİZLEME API'Sİ: HABER VERİLMEKSİZİN DEĞİŞİKLİĞE TABİDİR.
`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.

Numaralandırmalar
`SdkErrorType`	YouTube Hazır Oyunlar SDK'sının verdiği hata türleri.

Sınıflar
`SdkError`	YouTube Hazır Oyunlar SDK'sının oluşturduğu hata nesnesi.

Değişkenler
`IN_PLAYABLES_ENV`	Oyunun Hazır Oyunlar ortamında çalışıp çalışmadığı.
`SDK_VERSION`	YouTube Hazır Oyunlar SDK'sı sürümü.

Aşağıdaki kaynakları da incelemenizi öneririz:

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

Numaralandırmalar

`Const` SdkErrorType

SdkErrorType

YouTube Hazır Oyunlar SDK'sının verdiği hata türleri.

Numaralandırma Üyeleri
`API_UNAVAILABLE`	API geçici olarak kullanılamıyordu. Oyuncular kritik bir akışta bulunuyorsa 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 Hazır Oyunlar ortamında çalışıp çalışmadığı. Bu özelliği, yalnızca Hazır Oyunlar'da kullanılabilen özellikleri etkinleştirip etkinleştirmeyeceğinizi belirlemek için kullanabilirsiniz. SDK'nın gerçekten yüklendiğinden emin olmak için bu kontrolü ytgame kontrolüyle birlikte yapı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ı sürümü.

Örnek

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

ytgame.SdkError

Uzatır Error

YouTube Hazır Oyunlar SDK'sının verdiği 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

🧪 HERKESE AÇIK ÖNİZLEME API'Sİ: BİLDİRİMDE BULUNULMAKSIZIN DEĞİŞİKLİĞE TABİDİR.

Reklamlarla ilgili işlevler ve özellikler.

İşlevler
`requestInterstitialAd`	Geçiş reklamının gösterilmesini ister.
`requestRewardedAd`	Belirli bir ödül türü için ödüllü reklam 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ği konusunda herhangi bir garanti vermez. Bu API'yi, oyuncuları reklam izledikleri için ödüllendirmek amacıyla kullanmayın.

Ö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 istekte çözümlenen veya başarısız bir istekte reddedilen/hata veren bir söz.

requestRewardedAd

requestRewardedAd(rewardId: string): Promise<boolean>

Experimental Belirli bir ödül türü için ödüllü reklam gösterilmesini ister.

🧪 PUBLIC PREVIEW API: SUBJECT TO CHANGE WITHOUT NOTICE.

Reklamın gösterilip gösterilmediği konusunda herhangi bir garanti vermez.

Örnek

try {
  const isRewardEarned = await ytgame.ads.requestRewardedAd("21403813-2e22-4316-a8b2-7d4f52a6f6fb");
  // Handle reward being earned or not.
} catch (error) {
  // Handle errors, retry logic, etc.
  // Note that error may be undefined.
}

Parametreler

Parametreler
`rewardId: string`	Zorunlu. Talep edilebilir ödül türünü benzersiz şekilde tanımlayan bir tanımlayıcı. Her ödül türü için benzersiz bir kimlik kullanmanız ve söz konusu ödül türü her sunulduğunda aynı kimliği tekrar kullanmanız gerekir. Örnek: 21403813-2e22-4316-a8b2-7d4f52a6f6fb - "100 coins" ("100 jeton") 7defcfa2-4312-4893-a13a-a84e0c47a4df - "3 lives" 121b001a-0c25-4289-88f6-58e3620d938f - "Seviyeyi atla"

rewardId: string

Zorunlu. Talep edilebilir ödül türünü benzersiz şekilde tanımlayan bir tanımlayıcı. Her ödül türü için benzersiz bir kimlik kullanmanız ve söz konusu ödül türü her sunulduğunda aynı kimliği tekrar kullanmanız gerekir. Örnek:

21403813-2e22-4316-a8b2-7d4f52a6f6fb - "100 coins" ("100 jeton")
7defcfa2-4312-4893-a13a-a84e0c47a4df - "3 lives"
121b001a-0c25-4289-88f6-58e3620d938f - "Seviyeyi atla"

İadeler
`Promise<boolean>`	Kullanıcı ödül alma koşullarını karşılıyorsa başarılı bir istekte true değeriyle, karşılamıyorsa false değeriyle sonuçlanan bir söz. Promise, başarısız bir istekte reddedilir/hata verir.

ytgame.engagement

Oyuncu etkileşimiyle ilgili işlevler ve özellikler.

Arayüzler
`Score`	Oyunun YouTube'a gönderdiği puan nesnesi.

İşlevler
`sendScore`	YouTube'a bir puan gönderir.

İşlevler

sendScore

sendScore(score: Score): Promise<void>

YouTube'a puan gönderir.

Puan, oyundaki ilerlemenin bir boyutunu temsil etmelidir. Birden fazla boyut varsa geliştirici, tutarlılık için bir boyut seçmelidir. Puanlar sıralanır ve en yüksek puan YouTube kullanıcı arayüzünde gösterilir. Bu nedenle, oyun içi rekor kullanıcı arayüzü, bu API aracılığıyla gönderilenlerle uyumlu olmalıdır.

Ö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 skor.

İadeler
`Promise<void>`	Başarılı olduğunda çözümlenen, başarısız olduğunda ise `ytgame.SdkError` ile reddedilen/atılan bir Promise.

ytgame.engagement.Score

Oyunun YouTube'a gönderdiği puan nesnesi.

Özellikler
`value`	Puan değeri tam sayı olarak ifade edilir.

Özellikler

value

value: number

Puan değeri tam sayı olarak ifade edilir. Puan, maksimum güvenli tam sayıdan küçük veya bu değere eşit olmalıdır. Aksi takdirde skor reddedilir.

ytgame.game

Genel oyun davranışlarıyla ilgili işlevler ve özellikler.

İşlevler
`firstFrameReady`	YouTube'a oyunun kare göstermeye başladığını bildirir.
`gameReady`	YouTube'a oyunun oyuncuların etkileşimine hazır olduğunu bildirir.
`loadData`	YouTube'dan oyun verilerini seri hale getirilmiş bir dize biçiminde yükler.
`saveData`	Oyun verilerini, serileştirilmiş bir dize biçiminde YouTube'a kaydeder.

İşlevler

firstFrameReady

firstFrameReady(): void

Oyunun kare göstermeye başladığını YouTube'a bildirir.

Oyunun bu API'yi çağırması ZORUNLUDUR. Aksi takdirde oyun, kullanıcılara gösterilmez. firstFrameReady(), gameReady()'den önce KESİNLİKLE çağrılmalıdır.

Örnek

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

gameReady

gameReady(): void

YouTube'a oyunun oyuncuların etkileşim kurmasına hazır olduğunu bildirir.

Oyun, etkileşim kurulabilir olduğunda bu API'yi ÇAĞIRMALIDIR. Oyun, yükleme ekranı hâlâ gösterilirken bu API'yi KESİNLİKLE çağırmamalıdır. Aksi takdirde oyun, YouTube sertifika sürecini geçemez.

Örnek

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

loadData

loadData(): Promise<string>

YouTube'dan oyun verilerini seri hale getirilmiş bir dize biçiminde yükler.

Oyun, dize ile dahili biçim arasındaki tüm ayrıştırma işlemlerini 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 reddedilen bir Promise.

saveData

saveData(data: string): Promise<void>

Oyun verilerini, seri hale getirilmiş bir dize şeklinde YouTube'a kaydeder.

Dize, geçerli ve iyi biçimlendirilmiş bir UTF-16 dizesi olmalıdır ve en fazla 3 MiB olmalıdır. Oyun, dize ile dahili biçim arasındaki ayrıştırma işlemlerini yapmalıdır. Gerekirse dizenin iyi biçimlendirilmiş olup olmadığını 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ümlenen, başarısız olduğunda ise `ytgame.SdkError` ile reddedilen bir Promise.

ytgame.health

Oyun sağlığıyla ilgili işlevler ve özellikler.

İşlevler
`logError`	YouTube'a bir hata kaydeder.
`logWarning`	YouTube'a uyarı kaydeder.

İşlevler

logError

logError(): void

YouTube'da bir hata günlüğe kaydedilir.

Not: Bu API, en iyi çaba prensibiyle çalışır ve hız sınırlaması uygulanı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ırlaması uygulanı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 belirlenen dili BCP-47 dil etiketi biçiminde döndürür.
`isAudioEnabled`	Oyun sesinin YouTube ayarlarında etkin olup olmadığını döndürür.
`onAudioEnabledChange`	Ses ayarları değiştirme etkinliği YouTube'dan tetiklendiğinde tetiklenecek bir geri çağırma ayarlar.
`onPause`	YouTube'dan bir duraklatma oyunu etkinliği tetiklendiğinde geri çağırma işleminin tetiklenmesini sağlar.
`onResume`	YouTube'dan bir oyuna devam etme etkinliği tetiklendiğinde geri çağırma işlevinin tetiklenmesini sağlar.

İşlevler

getLanguage

getLanguage(): Promise<string>

Kullanıcının YouTube ayarlarında belirlenen 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 bulut kaydında depolamak için başka işlevler kullanmayın. Bunun yerine, YouTube genelinde tutarlı bir kullanıcı deneyimi 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 alma işlemi başarılı olduğunda tamamlanan ve başarısız olduğunda `ytgame.SdkError` ile reddedilen bir Promise.

isAudioEnabled

isAudioEnabled(): boolean

YouTube ayarlarında oyun sesinin etkin olup olmadığını döndürür.

Oyun, oyun sesi durumunu başlatmak için bunu KULLANMALIDIR.

Örnek

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

İadeler
`boolean`	Sesin etkin olup olmadığını gösteren bir boole değeri.

onAudioEnabledChange

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

YouTube'dan ses ayarları değişikliği etkinliği tetiklendiğinde geri çağırma işleminin tetiklenmesini sağlar.

Oyunun, oyunun ses durumunu güncellemek için bu API'yi kullanması ZORUNLUDUR.

Ö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ğırmayı ayarlamayan bir işlev.

onPause

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

YouTube'dan bir duraklatma oyunu etkinliği tetiklendiğinde geri çağırma işleminin tetiklenmesini sağlar. Oyunun, çıkarılmadan önce herhangi bir durumu kaydetmek için kısa bir süresi vardır.onPause, kullanıcı oyundan çıktığında dahil olmak üzere tüm duraklatma türleri için çağrılır.

Oyunun devam edeceğine dair garanti verilmez.

Ö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ğırmayı ayarlamayan bir işlev.

onResume

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

YouTube'dan bir oyuna devam etme etkinliği tetiklendiğinde geri çağırma işleminin tetiklenmesini sağlar.

Oyunun duraklatıldıktan sonra devam etmesi 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ğırmayı ayarlamayan bir işlev.

YouTube Hazır Oyunlar SDK referansı Koleksiyonlar ile düzeninizi koruyun İçeriği tercihlerinize göre kaydedin ve kategorilere ayırın.

ytgame

Numaralandırmalar

Const SdkErrorType

Değişkenler

Const IN_PLAYABLES_ENV

Const SDK_VERSION

ytgame.SdkError

Özellikler

errorType

ytgame.ads

İşlevler

requestInterstitialAd

requestRewardedAd

ytgame.engagement

İşlevler

sendScore

ytgame.engagement.Score

Özellikler

value

ytgame.game

İşlevler

firstFrameReady

gameReady

loadData

saveData

ytgame.health

İşlevler

logError

logWarning

ytgame.system

İşlevler

getLanguage

isAudioEnabled

onAudioEnabledChange

onPause

onResume

YouTube Hazır Oyunlar SDK referansı

`Const` SdkErrorType

`Const` IN_PLAYABLES_ENV

`Const` SDK_VERSION