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