liveChatMessage संसाधन, YouTube लाइव चैट में चैट मैसेज को दिखाता है. इस संसाधन में कई तरह के मैसेज की जानकारी हो सकती है. जैसे, हाल ही में पोस्ट किया गया कोई टेक्स्ट मैसेज या फ़ैन फ़ंडिंग इवेंट.
लाइव ब्रॉडकास्ट के लिए, लाइव चैट की सुविधा डिफ़ॉल्ट रूप से चालू होती है. यह सुविधा, लाइव इवेंट के दौरान उपलब्ध रहती है. (इवेंट खत्म होने के बाद, उस इवेंट के लिए लाइव चैट की सुविधा उपलब्ध नहीं होती.)
तरीके
एपीआई में, liveChatMessages संसाधनों के लिए ये तरीके इस्तेमाल किए जा सकते हैं:
- list
- किसी चैट के लिए, लाइव चैट के मैसेज की सूची दिखाता है. इसे अभी आज़माएं.
- streamList
- यह कुकी, सर्वर-स्ट्रीमिंग कनेक्शन चालू करती है. इससे कम समय में किसी चैट के लाइव चैट मैसेज मिल पाते हैं. इसे अभी आज़माएं.
- शामिल करें
- लाइव चैट में कोई मैसेज या पोल जोड़ता है. इसे अभी आज़माएं.
- transition
- लाइव मैसेज की स्थिति बदलता है. इसे अभी आज़माएं.
- मिटाएं
- इस तरीके का इस्तेमाल करके, चैट मैसेज मिटाया जाता है. एपीआई अनुरोध को चैनल के मालिक या लाइव चैट के मॉडरेटर से अनुमति मिलनी चाहिए. इसे अभी आज़माएं.
संसाधन का रेप्रज़ेंटेशन
यहां दिए गए JSON स्ट्रक्चर में, liveChatMessages रिसॉर्स का फ़ॉर्मैट दिखाया गया है:
{
"kind": "youtube#liveChatMessage",
"etag": etag,
"id": string,
"snippet": {
"type": string,
"liveChatId": string,
"authorChannelId": string,
"publishedAt": datetime,
"hasDisplayContent": boolean,
"displayMessage": string,
"fanFundingEventDetails": {
"amountMicros": unsigned long,
"currency": string,
"amountDisplayString": string,
"userComment": string
},
"textMessageDetails": {
"messageText": string
},
"userBannedDetails": {
"bannedUserDetails": {
"channelId": string,
"channelUrl": string,
"displayName": string,
"profileImageUrl": string
},
"banType": string,
"banDurationSeconds": unsigned long
},
"memberMilestoneChatDetails": {
"userComment": string,
"memberMonth": unsigned integer,
"memberLevelName": string
},
"newSponsorDetails": {
"memberLevelName": string,
"isUpgrade": bool
},
"superChatDetails": {
"amountMicros": unsigned long,
"currency": string,
"amountDisplayString": string,
"userComment": string,
"tier": unsigned integer
},
"superStickerDetails": {
"superStickerMetadata": {
"stickerId": string,
"altText": string,
"language": string
},
"amountMicros": unsigned long,
"currency": string,
"amountDisplayString": string,
"tier": unsigned integer
},
"pollDetails": {
"metadata": {
"options": {
"optionText": string,
"tally": string,
},
"questionText": string,
"status": enum
},
},
"membershipGiftingDetails": {
"giftMembershipsCount": integer,
"giftMembershipsLevelName": string
},
"giftMembershipReceivedDetails": {
"memberLevelName": string,
"gifterChannelId": string,
"associatedMembershipGiftingMessageId": string
},
"giftDetails": {
"jewelsAmount": integer,
"giftName": string,
"giftUrl": string,
"giftDuration": object,
"seconds": integer,
"nanos": integer,
"hasVisualEffect": boolean,
"comboCount": integer,
"altText": string,
"language": string
},
},
"authorDetails": {
"channelId": string,
"channelUrl": string,
"displayName": string,
"profileImageUrl": string,
"isVerified": boolean,
"isChatOwner": boolean,
"isChatSponsor": boolean,
"isChatModerator": boolean
},
}प्रॉपर्टी
यहां दी गई टेबल में, इस संसाधन में दिखने वाली प्रॉपर्टी के बारे में बताया गया है:
| प्रॉपर्टी | |
|---|---|
kind |
stringइससे एपीआई संसाधन के टाइप की पहचान होती है. वैल्यू youtube#liveChatMessage होगी. |
etag |
etagइस संसाधन का ETag. |
id |
stringयह वह आईडी है जो YouTube, मैसेज की यूनीक तरीके से पहचान करने के लिए असाइन करता है. ध्यान दें: giftEvents के लिए, कॉम्बो की संख्या को अपडेट करने के लिए, एक ही आईडी का दोबारा इस्तेमाल किया जा सकता है. |
snippet |
objectsnippet ऑब्जेक्ट में चैट मैसेज के बारे में मुख्य जानकारी होती है. |
snippet.type |
stringमैसेज का टाइप. यह प्रॉपर्टी हमेशा मौजूद रहती है. इसकी वैल्यू से यह तय होता है कि संसाधन में कौनसे फ़ील्ड मौजूद हैं. इस प्रॉपर्टी के लिए मान्य वैल्यू ये हैं:
|
snippet.liveChatId |
stringवह आईडी जो उस लाइव चैट की खास तौर पर पहचान करता है जिससे मैसेज जुड़ा है. ब्रॉडकास्ट से जुड़ा लाइव चैट आईडी, liveBroadcast संसाधन की snippet.liveChatId प्रॉपर्टी में दिखता है. |
snippet.authorChannelId |
stringमैसेज लिखने वाले उपयोगकर्ता का आईडी. यह फ़ील्ड सिर्फ़ इन मैसेज टाइप के लिए भरा जाता है:
|
snippet.publishedAt |
datetimeवह तारीख और समय जब मैसेज को पहली बार पब्लिश किया गया था. वैल्यू, आईएसओ 8601 ( YYYY-MM-DDThh:mm:ss.sZ) फ़ॉर्मैट में दी गई है. |
snippet.hasDisplayContent |
booleanइससे पता चलता है कि मैसेज में ऐसा कॉन्टेंट है या नहीं जो उपयोगकर्ताओं को दिखाया जाना चाहिए. |
snippet.displayMessage |
stringइसमें एक ऐसी स्ट्रिंग होती है जो लोगों को दिखती है. अगर मैसेज टाइप chatEndedEvent या tombstone है, तो यह फ़ील्ड मौजूद नहीं होता. |
snippet.fanFundingEventDetails |
objectध्यान दें: इस ऑब्जेक्ट और इसकी चाइल्ड प्रॉपर्टी का इस्तेमाल अब नहीं किया जा सकेगा. 28 फ़रवरी, 2017 से, liveChatMessage संसाधन, फ़ैन फ़ंडिंग इवेंट की जानकारी नहीं दिखाएंगे.इस ऑब्जेक्ट में, फ़ंडिंग इवेंट की जानकारी होती है. यह सिर्फ़ तब मौजूद होता है, जब मैसेज का टाइप fanFundingEvent हो. |
snippet.fanFundingEventDetails.amountMicros |
unsigned longध्यान दें: इस प्रॉपर्टी का इस्तेमाल अब नहीं किया जा सकेगा. फ़ंड की रकम. |
snippet.fanFundingEventDetails.currency |
stringध्यान दें: यह प्रॉपर्टी अब काम नहीं करती. वह मुद्रा जिसमें फ़ंड बनाया गया था. |
snippet.fanFundingEventDetails.amountDisplayString |
stringध्यान दें: इस प्रॉपर्टी को बंद कर दिया गया है. यह एक रेंडर की गई स्ट्रिंग है. इसमें उपयोगकर्ता को फ़ंड की रकम और मुद्रा दिखती है. |
snippet.fanFundingEventDetails.userComment |
stringध्यान दें: इस प्रॉपर्टी का इस्तेमाल अब नहीं किया जाता. फ़ैन फ़ंडिंग वाले इस इवेंट में, उपयोगकर्ता की जोड़ी गई टिप्पणी. |
snippet.textMessageDetails |
objectइस ऑब्जेक्ट में, मैसेज के बारे में जानकारी होती है. यह पैरामीटर सिर्फ़ तब मौजूद होता है, जब मैसेज टाइप textMessageEvent हो. |
snippet.textMessageDetails.messageText |
stringउपयोगकर्ता का मैसेज. |
snippet.userBannedDetails |
objectइस ऑब्जेक्ट में, चैट करने पर पाबंदी लगाए गए उपयोगकर्ता की जानकारी होती है. इसमें पाबंदी के बारे में भी जानकारी होती है. उपयोगकर्ताओं को चैट से हमेशा के लिए या कुछ समय के लिए प्रतिबंधित किया जा सकता है. |
snippet.userBannedDetails.bannedUserDetails |
objectइस ऑब्जेक्ट में, प्रतिबंधित उपयोगकर्ता के बारे में जानकारी होती है. |
snippet.userBannedDetails.bannedUserDetails.channelId |
stringब्लॉक किए गए उपयोगकर्ता के YouTube चैनल का आईडी. |
snippet.userBannedDetails.bannedUserDetails.channelUrl |
stringप्रतिबंधित किए गए उपयोगकर्ता के YouTube चैनल का यूआरएल. |
snippet.userBannedDetails.bannedUserDetails.displayName |
stringब्लॉक किए गए उपयोगकर्ता के YouTube चैनल का डिसप्ले नेम. |
snippet.userBannedDetails.bannedUserDetails.profileImageUrl |
stringब्लॉक किए गए उपयोगकर्ता के YouTube चैनल का अवतार. |
snippet.userBannedDetails.banType |
stringपाबंदी का टाइप. इस प्रॉपर्टी के लिए मान्य वैल्यू ये हैं:
|
snippet.userBannedDetails.banDurationSeconds |
unsigned longपाबंदी की अवधि. यह प्रॉपर्टी सिर्फ़ तब मौजूद होती है, जब snippet.userBannedDetails.banType प्रॉपर्टी की वैल्यू temporary हो. |
snippet.memberMilestoneChatDetails |
objectइस ऑब्जेक्ट में, पैसे चुकाकर बने सदस्यों के माइलस्टोन इवेंट के बारे में जानकारी होती है. यह सिर्फ़ तब मौजूद होता है, जब मैसेज टाइप memberMilestoneChatEvent हो. |
snippet.memberMilestoneChatDetails.userComment |
stringसदस्य ने सदस्य के लॉयल्टी मैसेज को लाइव चैट में भेजने की सुविधा में यह टिप्पणी जोड़ी है. अगर सदस्य ने कोई टिप्पणी नहीं की है, तो यह फ़ील्ड खाली रहेगा. |
snippet.memberMilestoneChatDetails.memberMonth |
unsigned integerमहीनों की कुल संख्या (राउंड अप की गई), जिसके लिए दर्शक ने सदस्यता ली है. इस सदस्यता की वजह से, उसे सदस्य के लॉयल्टी मैसेज को लाइव चैट में भेजने की सुविधा मिली है. यह महीनों की वही संख्या है जो YouTube के उपयोगकर्ताओं को दिखती है. |
snippet.memberMilestoneChatDetails.memberLevelName |
stringउस लेवल का नाम जिस पर दर्शक ने सदस्यता ली है. सदस्यता के लेवल के नाम, सदस्यता की सुविधा देने वाले YouTube चैनल तय करता है. कुछ मामलों में, यह फ़ील्ड नहीं भरा जाता. |
snippet.newSponsorDetails |
objectइस ऑब्जेक्ट में, नए सदस्य के शामिल होने की सूचना देने वाले इवेंट के बारे में जानकारी होती है. यह सिर्फ़ तब सेट किया जाता है, जब टाइप newSponsorEvent हो. "सदस्य" शब्द का इस्तेमाल, "प्रायोजक" के लिए किया जाता है.
|
snippet.newSponsorDetails.memberLevelName |
stringउस लेवल का नाम जिस पर दर्शक ने सदस्यता ली है. सदस्यता के लेवल के नाम, सदस्यता की सुविधा देने वाले YouTube चैनल तय करता है. कुछ मामलों में, यह फ़ील्ड नहीं भरा जाता. |
snippet.newSponsorDetails.isUpgrade |
boolइससे पता चलता है कि दर्शक ने अभी-अभी किसी निचले लेवल से अपग्रेड किया है या नहीं. खरीदारी के समय जो दर्शक सदस्य नहीं थे उनके लिए, फ़ील्ड की वैल्यू false है.
|
snippet.superChatDetails |
objectइस ऑब्जेक्ट में, सुपर चैट इवेंट के बारे में जानकारी होती है. यह सिर्फ़ तब मौजूद होता है, जब मैसेज टाइप superChatEvent हो. |
snippet.superChatDetails.amountMicros |
unsigned longखरीदारी की कुल कीमत, खरीदारी की मुद्रा के माइक्रो में. उदाहरण के लिए, अगर खरीदारी की कुल कीमत एक डॉलर है, तो snippet.amountMicros प्रॉपर्टी की वैल्यू 1000000 होगी. |
snippet.superChatDetails.currency |
stringवह मुद्रा जिसमें खरीदारी की गई थी. यह वैल्यू, ISO 4217 करंसी कोड है. |
snippet.superChatDetails.amountDisplayString |
string$1.00 जैसी स्ट्रिंग, जिसमें खरीदारी की कुल कीमत और मुद्रा शामिल होती है. स्ट्रिंग को उपयोगकर्ता को दिखाने के लिए डिज़ाइन किया गया है. |
snippet.superChatDetails.userComment |
stringइस सुपर चैट इवेंट में, उपयोगकर्ता की जोड़ी गई टिप्पणी. |
snippet.superChatDetails.tier |
unsigned integerपैसे चुकाकर भेजे गए मैसेज का टियर. ध्यान दें कि superChatEvent संसाधन में, snippet.messageType प्रॉपर्टी में यह वैल्यू शामिल होती है.टियर, मैसेज खरीदने के लिए खर्च किए गए पैसे के हिसाब से तय होता है. इससे यह भी तय होता है कि लाइव चैट के यूज़र इंटरफ़ेस (यूआई) में मैसेज को हाइलाइट करने के लिए कौनसा रंग इस्तेमाल किया जाएगा, मैसेज में ज़्यादा से ज़्यादा कितने वर्ण इस्तेमाल किए जा सकते हैं, और मैसेज को टिकर पर कितनी देर तक पिन किया जाएगा. सुपर चैट के टियर के बारे में जानकारी, YouTube सहायता केंद्र पर दी गई है. (सुपर चैट खरीदने के बारे में जानकारी देने वाला सेक्शन देखें, जिसे बड़ा करके देखा जा सकता है.) उस सूची में, खरीदारी के लिए सबसे कम कीमत वाला टियर 1 है. इसके बाद, टियर 2 की कीमत सबसे कम है. इसी तरह, अन्य टियर की कीमतें तय की जाती हैं. |
snippet.superStickerDetails |
objectइस ऑब्जेक्ट में, सुपर स्टिकर इवेंट के बारे में जानकारी होती है. यह पैरामीटर सिर्फ़ तब मौजूद होता है, जब मैसेज टाइप superStickerEvent हो. |
snippet.superStickerDetails.superStickerMetadata |
objectसुपर स्टिकर के बारे में जानकारी. |
snippet.superStickerDetails.superStickerMetadata.stickerId |
stringएक यूनीक आईडी, जिससे स्टिकर की इमेज की पहचान की जाती है. ध्यान दें कि यह इमेज, सुपर स्टिकर मैसेज के साथ सिर्फ़ तब दिखती है, जब लोग YouTube पर चैट विंडो देखते हैं. हालांकि, एपीआई का इस्तेमाल करके इमेज का यूआरएल नहीं मिलता. सिर्फ़ रेफ़रंस के लिए, इस CSV फ़ाइल में जाकर देखा जा सकता है कि कौनसे स्टिकर आईडी, किन सुपर स्टिकर से जुड़े हैं. |
snippet.superStickerDetails.superStickerMetadata.altText |
stringटेक्स्ट स्ट्रिंग, जिसमें स्टिकर के बारे में बताया गया हो. snippet.superStickerDetails.superStickerMetadata.language फ़ील्ड से, टेक्स्ट की भाषा की पहचान होती है. liveChatMessages.list तरीके को कॉल करते समय, hl पैरामीटर की वैल्यू को टेक्स्ट के लिए चुनी गई भाषा पर सेट करें. |
snippet.superStickerDetails.superStickerMetadata.language |
stringsnippet.superStickerDetails.superStickerMetadata.altText प्रॉपर्टी की वैल्यू की भाषा. |
snippet.superStickerDetails.amountMicros |
unsigned longखरीदारी की कुल कीमत, खरीदारी की मुद्रा के माइक्रो में. उदाहरण के लिए, अगर खरीदारी की कुल कीमत एक डॉलर है, तो snippet.amountMicros प्रॉपर्टी की वैल्यू 1000000 होगी. |
snippet.superStickerDetails.currency |
stringवह मुद्रा जिसमें खरीदारी की गई थी. यह वैल्यू, ISO 4217 करंसी कोड है. |
snippet.superStickerDetails.amountDisplayString |
string$1.00 जैसी स्ट्रिंग, जिसमें खरीदारी की कुल कीमत और मुद्रा शामिल होती है. इस स्ट्रिंग को उपयोगकर्ता को दिखाने के लिए बनाया गया है. |
snippet.superStickerDetails.tier |
unsigned integerपैसे चुकाकर भेजे गए मैसेज का टियर. ध्यान दें कि superChatEvent संसाधन में, snippet.messageType प्रॉपर्टी में यह वैल्यू शामिल होती है.टियर, मैसेज खरीदने के लिए खर्च किए गए पैसे के हिसाब से तय होता है. इससे यह भी तय होता है कि लाइव चैट के यूज़र इंटरफ़ेस (यूआई) में मैसेज को हाइलाइट करने के लिए कौनसा रंग इस्तेमाल किया जाएगा, मैसेज में ज़्यादा से ज़्यादा कितने वर्ण इस्तेमाल किए जा सकते हैं, और मैसेज को टिकर में कितनी देर तक पिन करके रखा जाएगा. सुपर चैट के टियर में सुपर स्टिकर्स भी शामिल हैं. इनके बारे में YouTube के सहायता केंद्र में बताया गया है. (सुपर चैट खरीदने के बारे में जानकारी देने वाला सेक्शन बड़ा करके देखें.) उस सूची में, सबसे कम खरीदारी राशि वाला टीयर, टीयर 1 होता है. इसके बाद, अगली सबसे कम राशि वाला टीयर, टीयर 2 होता है. इसी तरह, बाकी टीयर भी होते हैं. |
snippet.pollDetails |
objectइस ऑब्जेक्ट में, पोल इवेंट के बारे में जानकारी होती है. यह सिर्फ़ तब मौजूद होता है, जब मैसेज टाइप pollEvent हो. |
snippet.pollDetails.metadata |
objectपोल इवेंट के बारे में जानकारी. |
snippet.pollDetails.metadata.options |
objectलाइव पोल में मौजूद विकल्प. |
snippet.pollDetails.metadata.options.optionText |
stringलाइव पोल के विकल्प का टेक्स्ट. |
snippet.pollDetails.metadata.options.tally |
stringलाइव पोल के विकल्प की गिनती. यह टैली सिर्फ़ तब मौजूद होती है, जब चैनल का मालिक एपीआई अनुरोध को अनुमति देता है. |
snippet.pollDetails.metadata.questionText |
stringलाइव पोल के सवाल का टेक्स्ट. |
snippet.pollDetails.metadata.status |
enumलाइव पोल इवेंट की स्थिति. इस प्रॉपर्टी के लिए मान्य वैल्यू ये हैं:
|
snippet.membershipGiftingDetails |
objectइस ऑब्जेक्ट में, पैसे चुकाकर ली जाने वाली सदस्यता को उपहार में देने से जुड़े इवेंट की जानकारी होती है. यह सिर्फ़ तब मौजूद होता है, जब message type, membershipGiftingEvent हो. |
snippet.membershipGiftingDetails.giftMembershipsCount |
integerउपयोगकर्ता ने उपहार में दी जाने वाली सदस्यताओं को कितनी बार खरीदा है. |
snippet.membershipGiftingDetails.giftMembershipsLevelName |
stringउपयोगकर्ता ने उपहार में दी जाने वाली सदस्यता के जिस लेवल को खरीदा है उसका नाम. लेवल के नाम, पैसे चुकाकर ली जाने वाली सदस्यता की सुविधा देने वाले YouTube चैनल तय करते हैं. कुछ मामलों में, यह फ़ील्ड नहीं भरा जाता. |
snippet.giftMembershipReceivedDetails |
objectइस ऑब्जेक्ट में, उपहार में मिली सदस्यता मिलने वाले इवेंट के बारे में जानकारी होती है. यह सिर्फ़ तब मौजूद होता है, जब message type, giftMembershipReceivedEvent हो. |
snippet.giftMembershipReceivedDetails.memberLevelName |
stringउस लेवल का नाम जिस पर दर्शक ने सदस्यता ली है. यह सदस्यता का उपहार देने से जुड़े मैसेज के snippet.membershipGiftingDetails.giftMembershipsLevelName से मैच करता है. पैसे चुकाकर ली जाने वाली सदस्यता के लेवल के नाम, YouTube चैनल तय करता है. कुछ मामलों में, यह फ़ील्ड नहीं भरा जाता. |
snippet.giftMembershipReceivedDetails.gifterChannelId |
stringसदस्यता का उपहार खरीदने वाले उपयोगकर्ता का आईडी. यह सदस्यता का उपहार देने से जुड़े मैसेज के snippet.authorChannelId से मैच करता है. |
snippet.giftMembershipReceivedDetails.associatedMembershipGiftingMessageId |
stringउपहार में मिली इस सदस्यता से जुड़े, सदस्यता उपहार में देने के मैसेज का आईडी. यह आईडी हमेशा उस मैसेज को रेफ़र करेगा जिसका type, membershipGiftingEvent है. |
snippet.giftDetails |
objectइस ऑब्जेक्ट में, उपहार देने से जुड़े इवेंट की जानकारी होती है. यह सिर्फ़ तब मौजूद होता है, जब message type, giftEvent हो. |
snippet.giftDetails.jewelsAmount |
integerतोहफ़े के लिए रिडीम किए गए Jewels की संख्या. |
snippet.giftDetails.giftName |
stringउपहार का नाम. |
snippet.giftDetails.giftUrl |
stringतोहफ़े की ऐसेट का यूआरएल. |
snippet.giftDetails.giftDuration |
objectउपहार का यूआरएल दिखाने की अवधि. |
snippet.giftDetails.giftDuration.seconds |
integerयह विकल्प, उपहार के यूआरएल को दिखाने के लिए सेकंड की संख्या तय करता है. |
snippet.giftDetails.giftDuration.nanos |
integerगिफ़्ट यूआरएल को दिखाने के लिए नैनोसेकंड की संख्या. |
snippet.giftDetails.hasVisualEffect |
booleanक्या तोहफ़े में विज़ुअल इफ़ेक्ट है. |
snippet.giftDetails.comboCount |
integerगिफ़्ट का कॉम्बो काउंट. अगर गिफ़्ट कॉम्बो नहीं है, तो 0. |
snippet.giftDetails.altText |
stringएक टेक्स्ट स्ट्रिंग, जिसमें उपहार के बारे में बताया गया हो. |
snippet.giftDetails.language |
stringaltText प्रॉपर्टी की वैल्यू की भाषा. |
authorDetails |
objectauthorDetails ऑब्जेक्ट में, मैसेज पोस्ट करने वाले उपयोगकर्ता के बारे में ज़्यादा जानकारी होती है. |
authorDetails.channelId |
stringकॉन्टेंट बनाने वाले व्यक्ति के YouTube चैनल का आईडी. |
authorDetails.channelUrl |
stringलेखक के YouTube चैनल का यूआरएल. |
authorDetails.displayName |
stringलेखक के YouTube चैनल का डिसप्ले नेम. |
authorDetails.profileImageUrl |
stringलेखक के YouTube चैनल के अवतार का यूआरएल. |
authorDetails.isVerified |
booleanइस वैल्यू से पता चलता है कि YouTube ने लेखक की पहचान की पुष्टि की है या नहीं. |
authorDetails.isChatOwner |
booleanइस वैल्यू से पता चलता है कि मैसेज भेजने वाला व्यक्ति, लाइव चैट का मालिक है या नहीं. |
authorDetails.isChatSponsor |
booleanइस वैल्यू से पता चलता है कि लेखक, लाइव चैट का स्पॉन्सर है या नहीं. |
authorDetails.isChatModerator |
booleanइस वैल्यू से पता चलता है कि टिप्पणी करने वाला व्यक्ति, लाइव चैट का मॉडरेटर है या नहीं. |