YouTube Playables गेम के बारे में जानकारी

ytgame

यह YouTube Playables SDK का टॉप-लेवल नेमस्पेस है.

यह मौजूदा विंडो में ग्लोबल स्कोप वाला वैरिएबल है. आपको इस वैरिएबल को बदलना नहीं चाहिए.
नाम स्थान
ads
🧪 पब्लिक प्रीव्यू एपीआई: इसमें बिना सूचना दिए बदलाव किया जा सकता है.
engagement
खिलाड़ियों की दिलचस्पी बढ़ाने से जुड़े फ़ंक्शन और प्रॉपर्टी.
game
गेम के सामान्य व्यवहार से जुड़े फ़ंक्शन और प्रॉपर्टी.
health
गेम की परफ़ॉर्मेंस से जुड़े फ़ंक्शन और प्रॉपर्टी.
system
YouTube सिस्टम से जुड़े फ़ंक्शन और प्रॉपर्टी.
इन्यूमरेशन
SdkErrorType
YouTube Playables SDK टूल से मिलने वाली गड़बड़ियों के टाइप.
क्लास
SdkError
यह गड़बड़ी वाला ऑब्जेक्ट है, जिसे YouTube Playables SDK टूल दिखाता है.
वैरिएबल
IN_PLAYABLES_ENV
गेम, Playables एनवायरमेंट में चल रहा है या नहीं.
SDK_VERSION
YouTube Playables SDK टूल का वर्शन.
इन्हें भी देखें

इन्यूमरेशन

Const SdkErrorType

SdkErrorType
YouTube Playables SDK टूल से मिलने वाली गड़बड़ियों के टाइप.
इन्यूमरेशन के सदस्य
API_UNAVAILABLE
एपीआई कुछ समय के लिए उपलब्ध नहीं था.

अगर खिलाड़ी किसी ज़रूरी प्रोसेस में हैं, तो उन्हें बाद में फिर से कोशिश करने के लिए कहें.
INVALID_PARAMS
एपीआई को अमान्य पैरामीटर के साथ कॉल किया गया था.
SIZE_LIMIT_EXCEEDED
एपीआई को ऐसे पैरामीटर के साथ कॉल किया गया था जिनका साइज़ तय सीमा से ज़्यादा है.
UNKNOWN
गड़बड़ी के टाइप की जानकारी नहीं है.

वैरिएबल

Const IN_PLAYABLES_ENV

IN_PLAYABLES_ENV: boolean
गेम, Playables एनवायरमेंट में चल रहा है या नहीं. इसका इस्तेमाल यह तय करने के लिए किया जा सकता है कि Playables में उपलब्ध सुविधाओं को चालू या बंद करना है या नहीं. इस जांच को ytgame की जांच के साथ मिलाकर करें, ताकि यह पक्का किया जा सके कि एसडीके वाकई लोड हो गया है.
उदाहरण
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
प्रॉपर्टी
errorType
गड़बड़ी किस तरह की है.
message
name
stack?

प्रॉपर्टी

errorType

errorType: SdkErrorType
गड़बड़ी किस तरह की है.

ytgame.ads

🧪 पब्लिक प्रीव्यू एपीआई: इसमें बिना सूचना दिए बदलाव किया जा सकता है.

विज्ञापन से जुड़े फ़ंक्शन और प्रॉपर्टी.
फ़ंक्शन
requestInterstitialAd
यह अचानक दिखने वाला विज्ञापन दिखाने का अनुरोध करता है.
requestRewardedAd
यह अनुरोध करता है कि किसी खास तरह के इनाम के लिए, इनाम वाला विज्ञापन दिखाया जाए.

फ़ंक्शन

requestInterstitialAd

requestInterstitialAd(): Promise<void>
Experimental पेज पर अचानक दिखने वाले विज्ञापन को दिखाने का अनुरोध करता है.

🧪 PUBLIC PREVIEW API: SUBJECT TO CHANGE WITHOUT NOTICE.

इससे यह गारंटी नहीं मिलती कि विज्ञापन दिखाया गया था या नहीं. इस एपीआई का इस्तेमाल, खिलाड़ियों को विज्ञापन देखने के बदले इनाम देने के लिए न करें.
उदाहरण
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> यह एक प्रॉमिस है. अनुरोध पूरा होने पर यह रिज़ॉल्व हो जाता है. अनुरोध पूरा न होने पर, यह अस्वीकार हो जाता है या गड़बड़ी दिखाता है.

requestRewardedAd

requestRewardedAd(rewardId: string): Promise<boolean>
Experimental किसी खास तरह के इनाम के लिए, इनाम वाला विज्ञापन दिखाने का अनुरोध करता है.

🧪 पब्लिक प्रीव्यू एपीआई: इसमें बिना सूचना दिए बदलाव किया जा सकता है.

इससे यह गारंटी नहीं मिलती कि विज्ञापन दिखाया गया था या नहीं.
उदाहरण
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.
}
पैरामीटर
rewardId: string ज़रूरी है. ऐसा आइडेंटिफ़ायर जो दावा किए जा सकने वाले इनाम के टाइप की यूनीक तरीके से पहचान करता है. आपको हर तरह के इनाम के लिए यूनीक आईडी का इस्तेमाल करना होगा. साथ ही, जब भी उस तरह का इनाम दिया जाए, तब उसी आईडी का दोबारा इस्तेमाल करना होगा. उदाहरण के लिए:
  • 21403813-2e22-4316-a8b2-7d4f52a6f6fb - "100 coins"
  • 7defcfa2-4312-4893-a13a-a84e0c47a4df - "3 lives"
  • 121b001a-0c25-4289-88f6-58e3620d938f - "Skip level"
रिटर्न
Promise<boolean> यह एक प्रॉमिस है. अनुरोध पूरा होने पर, यह प्रॉमिस पूरा हो जाता है. अगर उपयोगकर्ता ने इनाम पाने की शर्तें पूरी की हैं, तो इसकी वैल्यू true होती है. अगर उपयोगकर्ता ने इनाम पाने की शर्तें पूरी नहीं की हैं, तो इसकी वैल्यू false होती है. अनुरोध पूरा न होने पर, प्रॉमिस rejects/throws करता है.

ytgame.engagement

खिलाड़ियों की दिलचस्पी बढ़ाने से जुड़े फ़ंक्शन और प्रॉपर्टी.
इंटरफ़ेस
Score
यह स्कोर ऑब्जेक्ट है, जिसे गेम YouTube को भेजता है.
फ़ंक्शन
sendScore
यह कुकी, YouTube को स्कोर भेजती है.

फ़ंक्शन

sendScore

sendScore(score: Score): Promise<void>
यह कुकी, YouTube को स्कोर भेजती है.

स्कोर से, गेम में हुई प्रोग्रेस के किसी एक डाइमेंशन के बारे में पता चलना चाहिए. अगर कई डाइमेंशन हैं, तो डेवलपर को एक डाइमेंशन चुनना होगा, ताकि वह एक जैसा रहे. स्कोर को क्रम से लगाया जाएगा और सबसे ज़्यादा स्कोर, YouTube के यूज़र इंटरफ़ेस (यूआई) में दिखाया जाएगा. इसलिए, गेम में सबसे ज़्यादा स्कोर दिखाने वाले यूज़र इंटरफ़ेस (यूआई) को, इस एपीआई के ज़रिए भेजे जा रहे स्कोर के साथ अलाइन होना चाहिए.
उदाहरण
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.Score

यह स्कोर ऑब्जेक्ट है, जिसे गेम YouTube को भेजता है.
प्रॉपर्टी
value
स्कोर की वैल्यू, जिसे पूर्णांक के तौर पर दिखाया गया है.

प्रॉपर्टी

वैल्यू

value: number
स्कोर की वैल्यू, जिसे पूर्णांक के तौर पर दिखाया गया है. स्कोर, ज़्यादा से ज़्यादा सुरक्षित पूर्णांक से कम या उसके बराबर होना चाहिए. ऐसा न करने पर, स्कोर को अस्वीकार कर दिया जाएगा.

ytgame.game

गेम के सामान्य व्यवहार से जुड़े फ़ंक्शन और प्रॉपर्टी.
फ़ंक्शन
firstFrameReady
यह कुकी, YouTube को सूचना देती है कि गेम में फ़्रेम दिखने लगे हैं.
gameReady
इस फ़ंक्शन से YouTube को सूचना मिलती है कि गेम, खिलाड़ियों के साथ इंटरैक्ट करने के लिए तैयार है.
loadData
यह कुकी, YouTube से गेम का डेटा लोड करती है. यह डेटा, क्रम से लगाई गई स्ट्रिंग के तौर पर लोड होता है.
saveData
यह कुकी, गेम के डेटा को YouTube पर क्रम से लगाई गई स्ट्रिंग के तौर पर सेव करती है.

फ़ंक्शन

firstFrameReady

firstFrameReady(): void
इससे YouTube को सूचना मिलती है कि गेम में फ़्रेम दिखने लगे हैं.

गेम को इस एपीआई को कॉल करना ज़रूरी है. ऐसा न करने पर, गेम को उपयोगकर्ताओं को नहीं दिखाया जाता. gameReady() को कॉल करने से पहले, firstFrameReady() को कॉल करना ज़रूरी है.
उदाहरण
function onGameInitialized() {
  ytgame.game.firstFrameReady();
}

gameReady

gameReady(): void
इससे YouTube को सूचना मिलती है कि गेम, खिलाड़ियों के साथ इंटरैक्ट करने के लिए तैयार है.

गेम को इंटरैक्टिव होने पर, इस एपीआई को ज़रूर कॉल करना चाहिए. गेम को, लोडिंग स्क्रीन दिखते समय इस एपीआई को कॉल नहीं करना चाहिए. ऐसा न होने पर, गेम को 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

saveData(data: string): Promise<void>
यह कुकी, गेम के डेटा को YouTube पर सेव करती है. यह डेटा, क्रम से लगाई गई स्ट्रिंग के तौर पर सेव होता है.

स्ट्रिंग, मान्य और सही फ़ॉर्मैट वाली UTF-16 स्ट्रिंग होनी चाहिए. साथ ही, इसका साइज़ ज़्यादा से ज़्यादा 3 MiB होना चाहिए. गेम को स्ट्रिंग और इंटरनल फ़ॉर्मैट के बीच पार्सिंग को ज़रूर हैंडल करना चाहिए. अगर ज़रूरी हो, तो 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.health

गेम की परफ़ॉर्मेंस से जुड़े फ़ंक्शन और प्रॉपर्टी.
फ़ंक्शन
logError
यह कुकी, YouTube को गड़बड़ी की जानकारी भेजती है.
logWarning
यह कुकी, YouTube को चेतावनी लॉग करती है.

फ़ंक्शन

logError

logError(): void
यह फ़ंक्शन, YouTube को गड़बड़ी की जानकारी भेजता है.

ध्यान दें: यह एपीआई, सबसे सही तरीके से काम करने की कोशिश करता है. साथ ही, इस पर दर से जुड़ी सीमाएं लागू होती हैं. इस वजह से, डेटा का नुकसान हो सकता है.
उदाहरण
function onError() {
  ytgame.health.logError();
}

logWarning

logWarning(): void
यह कुकी, YouTube को चेतावनी लॉग करती है.

ध्यान दें: यह एपीआई, सबसे सही कोशिश करता है और इसकी दर सीमित होती है. इसलिए, इससे डेटा का नुकसान हो सकता है.
उदाहरण
function onWarning() {
  ytgame.health.logWarning();
}

ytgame.system

YouTube सिस्टम से जुड़े फ़ंक्शन और प्रॉपर्टी.
फ़ंक्शन
getLanguage
यह फ़ंक्शन, उपयोगकर्ता की YouTube सेटिंग में सेट की गई भाषा को BCP-47 भाषा टैग के तौर पर दिखाता है.
isAudioEnabled
इससे यह पता चलता है कि YouTube की सेटिंग में गेम का ऑडियो चालू है या नहीं.
onAudioEnabledChange
यह फ़ंक्शन, एक कॉलबैक सेट करता है. यह कॉलबैक तब ट्रिगर होता है, जब YouTube से ऑडियो सेटिंग बदलने का इवेंट ट्रिगर होता है.
onPause
यह एक कॉलबैक सेट करता है, जिसे YouTube से गेम को रोकने का इवेंट ट्रिगर होने पर चालू किया जाता है.
onResume
यह फ़ंक्शन, एक कॉलबैक सेट करता है. यह कॉलबैक तब ट्रिगर होता है, जब YouTube से 'गेम फिर से शुरू करें' इवेंट ट्रिगर होता है.

फ़ंक्शन

getLanguage

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 से ऑडियो सेटिंग बदलने का इवेंट ट्रिगर होता है.

गेम को, गेम के ऑडियो की स्थिति को अपडेट करने के लिए, इस एपीआई का इस्तेमाल ज़रूर करना चाहिए.
उदाहरण
ytgame.system.onAudioEnabledChange((isAudioEnabled) => {
  if (isAudioEnabled) {
    // Enable game audio.
  } else {
    // Disable game audio.
  }
});
पैरामीटर
callback: ((isAudioEnabled: boolean) => void) ट्रिगर किया जाने वाला कॉलबैक फ़ंक्शन.
रिटर्न
(() => void) कॉलबैक को अनसेट करने का फ़ंक्शन, जिसका इस्तेमाल आम तौर पर नहीं किया जाता.

onPause

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) कॉलबैक को अनसेट करने का फ़ंक्शन, जिसका इस्तेमाल आम तौर पर नहीं किया जाता.