liveChatMessage
संसाधन, YouTube पर लाइव चैट में चैट मैसेज को दिखाता है. इस संसाधन में, कई तरह के मैसेज की जानकारी शामिल हो सकती है. जैसे, हाल ही में पोस्ट किया गया मैसेज या फ़ैन फ़ंडिंग इवेंट.
लाइव चैट की सुविधा, लाइव ब्रॉडकास्ट के लिए डिफ़ॉल्ट रूप से चालू रहती है. यह सुविधा, लाइव इवेंट के दौरान इस्तेमाल की जाती है. (इवेंट खत्म होने के बाद, उस इवेंट के लिए लाइव चैट की सुविधा उपलब्ध नहीं है.)
तरीके
एपीआई, liveChatMessages
संसाधनों के लिए इन तरीकों के साथ काम करता है:
- list
- किसी चुनिंदा चैट के लाइव चैट मैसेज की सूची दिखाता है. इसे अभी आज़माएं.
- डालें
- लाइव चैट में मैसेज या पोल जोड़ता है. इसे अभी आज़माएं.
- ट्रांज़िशन
- लाइव मैसेज की स्थिति को बदल देता है. इसे अभी आज़माएं.
- मिटाएं
- चैट के मैसेज को मिटा देता है. एपीआई अनुरोध की अनुमति, चैनल के मालिक या लाइव चैट के मॉडरेटर के पास होनी चाहिए. इसे अभी आज़माएं.
संसाधन दिखाने का तरीका
यहां दिए गए 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 }, "messageDeletedDetails": { "deletedMessageId": 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, "questionText": string, }, "status": enum }, }, "membershipGiftingDetails": { "giftMembershipsCount": integer, "giftMembershipsLevelName": string }, "giftMembershipReceivedDetails": { "memberLevelName": string, "gifterChannelId": string, "associatedMembershipGiftingMessageId": string }, }, "authorDetails": { "channelId": string, "channelUrl": string, "displayName": string, "profileImageUrl": string, "isVerified": boolean, "isChatOwner": boolean, "isChatSponsor": boolean, "isChatModerator": boolean }, }
प्रॉपर्टी
नीचे दी गई टेबल में, इस संसाधन में मौजूद प्रॉपर्टी के बारे में बताया गया है:
प्रॉपर्टी | |
---|---|
kind |
string यह एपीआई संसाधन के टाइप की पहचान करता है. वैल्यू youtube#liveChatMessage होगी. |
etag |
etag इस संसाधन का इटैग. |
id |
string वह आईडी जिसे YouTube, मैसेज की खास तरह से पहचान करने के लिए असाइन करता है. |
snippet |
object snippet ऑब्जेक्ट में, चैट मैसेज की मुख्य जानकारी होती है. |
snippet.type |
string मैसेज का टाइप. यह प्रॉपर्टी हमेशा मौजूद होती है और इसकी वैल्यू से तय होता है कि रिसॉर्स में कौनसे फ़ील्ड मौजूद हैं. इस प्रॉपर्टी की मान्य वैल्यू ये हैं:
|
snippet.liveChatId |
string यह आईडी, उस लाइव चैट की खास तौर पर पहचान करता है जिससे मैसेज जुड़ा है. किसी ब्रॉडकास्ट से जुड़ा लाइव चैट आईडी, liveBroadcast संसाधन की snippet.liveChatId प्रॉपर्टी में दिखाया जाता है. |
snippet.authorChannelId |
string मैसेज लिखने वाले व्यक्ति का आईडी. यह फ़ील्ड सिर्फ़ नीचे दिए गए मैसेज टाइप के लिए भरा जाता है:
|
snippet.publishedAt |
datetime वह तारीख और समय जब मैसेज को असल में पब्लिश किया गया था. इसका मान ISO 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.messageDeletedDetails |
object इस ऑब्जेक्ट में उस मैसेज की जानकारी है जिसे चैट मॉडरेटर या लाइव ब्रॉडकास्ट चैनल के मालिक ने मिटा दिया है. यह सिर्फ़ तब होता है, जब मैसेज का टाइप messageDeletedEvent हो. |
snippet.messageDeletedDetails.deletedMessageId |
string वह आईडी जो मिटाए गए मैसेज की खास तौर पर पहचान करता है. यह वैल्यू, ओरिजनल मैसेज में दी गई id प्रॉपर्टी की वैल्यू के बराबर है. उदाहरण के लिए, अगर किसी textMessageEvent में id प्रॉपर्टी की वैल्यू 123 है और उस मैसेज को मिटा दिया जाता है, तो उस मैसेज के लिए snippet.messageDeletedDetails.deletedMessageId की वैल्यू 123 होगी.अगर चैट मैसेज को वापस पाने के बाद कैश मेमोरी में सेव किया जाता है, तो इस प्रॉपर्टी की वैल्यू का इस्तेमाल करके उस मैसेज की पहचान करें जिसे अब नहीं दिखाया जाना चाहिए. |
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 |
string snippet.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.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 है. |
authorDetails |
object authorDetails ऑब्जेक्ट में, यह मैसेज पोस्ट करने वाले उपयोगकर्ता के बारे में अतिरिक्त जानकारी मौजूद है. |
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 इस वैल्यू से पता चलता है कि लेखक, लाइव चैट का मॉडरेटर है या नहीं. |