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, "tally": 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 इस संसाधन का 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 होता है. इसके बाद, खरीदारी की रकम जितनी कम होगी टीयर उतना ही कम होगा. |
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 होता है. इसके बाद, खरीदारी की रकम जितनी कम होगी टीयर उतना ही कम होगा. |
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 है. |
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 इस वैल्यू से पता चलता है कि लेखक, लाइव चैट का मॉडरेटर है या नहीं. |