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 }, "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 टियर 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 टियर 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 इस वैल्यू से पता चलता है कि लेखक लाइव चैट का मॉडरेटर है या नहीं. |