ytgame
YouTube Playables SDK टूल के लिए टॉप-लेवल नेमस्पेस.
यह मौजूदा विंडो में, दुनिया भर में इस्तेमाल होने वाला वैरिएबल है. आपको इस वैरिएबल को बदलना नहीं चाहिए.
यह मौजूदा विंडो में, दुनिया भर में इस्तेमाल होने वाला वैरिएबल है. आपको इस वैरिएबल को बदलना नहीं चाहिए.
नाम स्थान | |
---|---|
ads
|
🧪 PUBLIC PREVIEW API: इसमें बिना सूचना दिए बदलाव किए जा सकते हैं. |
engagement
|
खिलाड़ी की दिलचस्पी से जुड़े फ़ंक्शन और प्रॉपर्टी. |
game
|
गेम के सामान्य व्यवहार से जुड़े फ़ंक्शन और प्रॉपर्टी. |
health
|
गेम की परफ़ॉर्मेंस से जुड़े फ़ंक्शन और प्रॉपर्टी. |
system
|
YouTube सिस्टम से जुड़े फ़ंक्शन और प्रॉपर्टी. |
एनुमरेशन | |
---|---|
Sdk
|
YouTube Playables SDK से मिलने वाली गड़बड़ियों के टाइप. |
क्लास | |
---|---|
Sdk
|
गड़बड़ी का वह ऑब्जेक्ट जिसे YouTube Playables SDK टूल दिखाता है. |
वैरिएबल | |
---|---|
IN_
|
गेम, Playables एनवायरमेंट में चल रहा है या नहीं. |
SDK_
|
YouTube Playables SDK टूल का वर्शन. |
- इन्हें भी देखें
एनुमरेशन
Const
SdkErrorType
SdkErrorType
वैरिएबल
Const
IN_PLAYABLES_ENV
IN_PLAYABLES_ENV: boolean
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
- उदाहरण
-
// 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
|
गड़बड़ी का टाइप. |
message
|
|
name
|
|
stack
|
प्रॉपर्टी
errorType
errorType:
SdkErrorType
ytgame.ads
🧪 PUBLIC PREVIEW API: SUBJECT TO CHANGE WITHOUT NOTICE.
The functions and properties related to ads.
The functions and properties related to ads.
फ़ंक्शन | |
---|---|
request
|
अचानक दिखने वाले विज्ञापन दिखाने का अनुरोध करता है. |
फ़ंक्शन
requestInterstitialAd
requestInterstitialAd(): Promise<void>
Experimental
पेज पर अचानक दिखने वाले विज्ञापन दिखाने का अनुरोध करता है.🧪 पब्लिक रीव्यू एपीआई: इसमें बिना सूचना के बदलाव किए जा सकते हैं.
इससे यह गारंटी नहीं मिलती कि विज्ञापन दिखाया गया है या नहीं.
- उदाहरण
-
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.engagement
खिलाड़ी की दिलचस्पी से जुड़े फ़ंक्शन और प्रॉपर्टी.
इंटरफ़ेस | |
---|---|
Content
|
गेम से YouTube को भेजा जाने वाला कॉन्टेंट ऑब्जेक्ट. |
Score
|
स्कोर ऑब्जेक्ट, जो गेम YouTube को भेजता है. |
फ़ंक्शन | |
---|---|
open
|
YouTube से, दिए गए वीडियो आईडी से जुड़ा कॉन्टेंट खोलने का अनुरोध करता है.
|
send
|
YouTube को स्कोर भेजता है. |
फ़ंक्शन
openYTContent
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>
|
ऐसा Promise जो काम पूरा होने पर रिज़ॉल्व हो जाता है और काम पूरा न होने पर, ytgame.SdkError के साथ अस्वीकार कर दिया जाता है/थ्रो कर दिया जाता है.
|
sendScore
sendScore(score: Score): Promise<void>
YouTube को स्कोर भेजता है.
इस स्कोर से, गेम में आपकी प्रगति के बारे में पता चलना चाहिए. अगर एक से ज़्यादा डाइमेंशन हैं, तो डेवलपर को एक डाइमेंशन चुनना होगा. स्कोर को क्रम से लगाया जाएगा और सबसे ज़्यादा स्कोर, 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>
|
ऐसा Promise जो काम पूरा होने पर रिज़ॉल्व हो जाता है और काम पूरा न होने पर, ytgame.SdkError के साथ अस्वीकार कर दिया जाता है/थ्रो कर दिया जाता है.
|
ytgame.engagement.Content
गेम से YouTube को भेजा जाने वाला कॉन्टेंट ऑब्जेक्ट.
प्रॉपर्टी | |
---|---|
id
|
उस वीडियो का आईडी जिसे हमें खोलना है. |
प्रॉपर्टी
id
id: string
ytgame.engagement.Score
स्कोर ऑब्जेक्ट, जो गेम YouTube को भेजता है.
प्रॉपर्टी | |
---|---|
value
|
स्कोर की वैल्यू, जो पूर्णांक के तौर पर दी गई है. |
प्रॉपर्टी
वैल्यू
value: number
ytgame.game
गेम के सामान्य व्यवहार से जुड़े फ़ंक्शन और प्रॉपर्टी.
फ़ंक्शन | |
---|---|
first
|
YouTube को सूचना देती है कि गेम फ़्रेम दिखाना शुरू कर दिया है. |
game
|
YouTube को यह सूचना देता है कि गेम, खिलाड़ियों के इंटरैक्शन के लिए तैयार है.
|
load
|
YouTube से गेम का डेटा, सीरियलाइज़ की गई स्ट्रिंग के तौर पर लोड करता है. |
save
|
गेम का डेटा, YouTube पर सीरियलाइज़ की गई स्ट्रिंग के तौर पर सेव करता है. |
फ़ंक्शन
firstFrameReady
firstFrameReady(): void
YouTube को यह सूचना देता है कि गेम फ़्रेम दिखाना शुरू कर दिया है.
गेम को इस एपीआई को कॉल करना MUST. ऐसा न करने पर, गेम लोगों को नहीं दिखता.
गेम को इस एपीआई को कॉल करना MUST. ऐसा न करने पर, गेम लोगों को नहीं दिखता.
gameReady()
से पहले, firstFrameReady()
को MUST.
- उदाहरण
-
function onGameInitialized() { ytgame.game.firstFrameReady(); }
gameReady
gameReady(): void
YouTube को यह सूचना देता है कि गेम, खिलाड़ियों के इंटरैक्शन के लिए तैयार है.
गेम में इंटरैक्ट करने की सुविधा उपलब्ध होने पर, उसे इस एपीआई को MUST ज़रूरी है. अगर लोडिंग स्क्रीन अब भी दिख रही है, तो गेम को इस एपीआई को कॉल नहीं करना चाहिए. ऐसा न करने पर, गेम को YouTube से सर्टिफ़िकेट नहीं मिलेगा.
गेम में इंटरैक्ट करने की सुविधा उपलब्ध होने पर, उसे इस एपीआई को MUST ज़रूरी है. अगर लोडिंग स्क्रीन अब भी दिख रही है, तो गेम को इस एपीआई को कॉल नहीं करना चाहिए. ऐसा न करने पर, गेम को 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 स्ट्रिंग होनी चाहिए. साथ ही, इसकी साइज़ ज़्यादा से ज़्यादा तीन एमबी होनी चाहिए. गेम को स्ट्रिंग और किसी इंटरनल फ़ॉर्मैट के बीच की किसी भी पार्सिंग को मैनेज करना ज़रूरी है. अगर ज़रूरी हो, तो
स्ट्रिंग, मान्य और सही तरीके से बनाई गई UTF-16 स्ट्रिंग होनी चाहिए. साथ ही, इसकी साइज़ ज़्यादा से ज़्यादा तीन एमबी होनी चाहिए. गेम को स्ट्रिंग और किसी इंटरनल फ़ॉर्मैट के बीच की किसी भी पार्सिंग को मैनेज करना ज़रूरी है. अगर ज़रूरी हो, तो
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
गेम की परफ़ॉर्मेंस से जुड़े फ़ंक्शन और प्रॉपर्टी.
फ़ंक्शन | |
---|---|
log
|
YouTube पर गड़बड़ी की जानकारी लॉग करता है. |
log
|
YouTube को चेतावनी भेजता है. |
फ़ंक्शन
logError
logError(): void
YouTube पर गड़बड़ी को लॉग करता है.
ध्यान दें: यह एपीआई, पूरी कोशिश करता है और डेटा को सीमित दर से भेजता है. इस वजह से, डेटा का कुछ हिस्सा मिट सकता है.
ध्यान दें: यह एपीआई, पूरी कोशिश करता है और डेटा को सीमित दर से भेजता है. इस वजह से, डेटा का कुछ हिस्सा मिट सकता है.
- उदाहरण
-
function onError() { ytgame.health.logError(); }
logWarning
logWarning(): void
YouTube को चेतावनी भेजता है.
ध्यान दें: यह API, पूरी कोशिश करता है और डेटा को जितनी जल्दी हो सके उतनी जल्दी भेजता है. हालांकि, इसकी दर सीमित होती है. इस वजह से, डेटा का कुछ हिस्सा मिट सकता है.
ध्यान दें: यह API, पूरी कोशिश करता है और डेटा को जितनी जल्दी हो सके उतनी जल्दी भेजता है. हालांकि, इसकी दर सीमित होती है. इस वजह से, डेटा का कुछ हिस्सा मिट सकता है.
- उदाहरण
-
function onWarning() { ytgame.health.logWarning(); }
ytgame.system
YouTube सिस्टम से जुड़े फ़ंक्शन और प्रॉपर्टी.
फ़ंक्शन | |
---|---|
get
|
उपयोगकर्ता की YouTube सेटिंग में सेट की गई भाषा को BCP-47 भाषा टैग के तौर पर दिखाता है.
|
is
|
इससे पता चलता है कि YouTube की सेटिंग में गेम का ऑडियो चालू है या नहीं. |
on
|
YouTube से ऑडियो सेटिंग में बदलाव होने पर ट्रिगर होने वाला कॉलबैक सेट करता है.
|
on
|
YouTube से गेम रोकने का इवेंट ट्रिगर होने पर, ट्रिगर होने के लिए कॉलबैक सेट करता है.
|
on
|
YouTube से गेम फिर से शुरू करने का इवेंट ट्रिगर होने पर, ट्रिगर होने के लिए कॉलबैक सेट करता है.
|
फ़ंक्शन
getLanguage
getLanguage(): Promise<string>
उपयोगकर्ता की YouTube सेटिंग में सेट की गई भाषा को BCP-47 भाषा टैग के तौर पर दिखाता है.
उपयोगकर्ता की भाषा या भाषा के हिसाब से तय किए गए स्थान की जानकारी का पता लगाने के लिए, अन्य फ़ंक्शन का इस्तेमाल न करें. इसके अलावा, क्लाउड सेव में उपयोगकर्ता की भाषा की प्राथमिकता सेव न करें. इसके बजाय, इस फ़ंक्शन का इस्तेमाल करके पक्का करें कि YouTube पर सभी लोगों को एक जैसा अनुभव मिले.
उपयोगकर्ता की भाषा या भाषा के हिसाब से तय किए गए स्थान की जानकारी का पता लगाने के लिए, अन्य फ़ंक्शन का इस्तेमाल न करें. इसके अलावा, क्लाउड सेव में उपयोगकर्ता की भाषा की प्राथमिकता सेव न करें. इसके बजाय, इस फ़ंक्शन का इस्तेमाल करके पक्का करें कि 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 से ऑडियो सेटिंग में बदलाव होने का इवेंट ट्रिगर होने पर, ट्रिगर होने के लिए कॉलबैक सेट करता है.
गेम के ऑडियो की स्थिति अपडेट करने के लिए, गेम को इस एपीआई का MUST ज़रूरी है.
गेम के ऑडियो की स्थिति अपडेट करने के लिए, गेम को इस एपीआई का MUST ज़रूरी है.
- उदाहरण
-
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 को सभी तरह के रोके जाने के लिए कॉल किया जाता है. इसमें, उपयोगकर्ता के गेम से बाहर निकलने पर भी इसे कॉल किया जाता है. इस बात की कोई गारंटी नहीं है कि गेम फिर से शुरू हो जाएगा.
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)
|
कॉलबैक को अनसेट करने वाला फ़ंक्शन, जिसका आम तौर पर इस्तेमाल नहीं किया जाता. |