SuperChatEvents

superChatEvent संसाधन, YouTube लाइव स्ट्रीम के दौरान किसी प्रशंसक की ओर से खरीदे गए सुपर चैट मैसेज को दिखाता है. YouTube लाइव चैट स्ट्रीम में, सुपर चैट वाले मैसेज दो तरीकों से अन्य मैसेज से अलग दिखते हैं:

  • सुपर चैट को किसी रंग से हाइलाइट किया जाता है.
  • सुपर चैट, टिकर में एक तय समय तक पिन रहते हैं.

सुपर चैट का रंग, टिकर में पिन रहने की अवधि, और मैसेज की ज़्यादा से ज़्यादा लंबाई, यह सब कुल कीमत से तय होती है. सुपर चैट के बारे में ज़्यादा जानने के लिए, YouTube सहायता केंद्र पर जाएं.

तरीके

एपीआई में, superChatEvents संसाधनों के लिए ये तरीके इस्तेमाल किए जा सकते हैं:

list
पिछले 30 दिनों में, किसी चैनल की लाइव स्ट्रीम से सुपर चैट इवेंट की सूची बनाएं. इसे अभी आज़माएं.

संसाधन का रेप्रज़ेंटेशन

यहां दिए गए JSON स्ट्रक्चर में, superChatEvent रिसॉर्स का फ़ॉर्मैट दिखाया गया है:

{
  "kind": "youtube#superChatEvent",
  "etag": etag,
  "id": string,
  "snippet": {
    "channelId": string,
    "supporterDetails": {
      "channelId": string,
      "channelUrl": string,
      "displayName": string,
      "profileImageUrl": string
    },
    "commentText": string,
    "createdAt": datetime,
    "amountMicros": unsigned long,
    "currency": string,
    "displayString": string,
    "messageType": unsigned integer,
    "isSuperStickerEvent": boolean,
    "superStickerMetadata": {
      "stickerId": string,
      "altText": string,
      "language": string
    }
  }
}

प्रॉपर्टी

यहां दी गई टेबल में, इस संसाधन में दिखने वाली प्रॉपर्टी के बारे में बताया गया है:

प्रॉपर्टी
kind string
इससे एपीआई संसाधन के टाइप की पहचान होती है. वैल्यू youtube#superChatEvent होगी.
etag etag
इस संसाधन का ETag.
id string
YouTube, सुपर चैट इवेंट की खास तौर पर पहचान करने के लिए यह आईडी असाइन करता है.
snippet object
snippet ऑब्जेक्ट में, सुपर चैट इवेंट के बारे में बुनियादी जानकारी होती है.
snippet.channelId string
YouTube चैनल का आईडी, जिससे उस चैनल की पहचान होती है जिसने सुपर चैट इवेंट से जुड़ी लाइव स्ट्रीम को ब्रॉडकास्ट किया.
snippet.supporterDetails object
चैनल को सपोर्ट करने वाले व्यक्ति के चैनल की जानकारी.
snippet.supporterDetails.channelId string
सपोर्ट करने वाले व्यक्ति के YouTube चैनल का आईडी.
snippet.supporterDetails.channelUrl string
समर्थक के चैनल का यूआरएल.
snippet.supporterDetails.displayName string
सहायता करने वाले व्यक्ति के चैनल का डिसप्ले नेम.
snippet.supporterDetails.profileImageUrl string
यह सुविधा इस्तेमाल करने वाले व्यक्ति के चैनल के अवतार का यूआरएल.
snippet.commentText string
समर्थक की टिप्पणी का टेक्स्ट कॉन्टेंट.
snippet.createdAt datetime
सुपर चैट खरीदने की तारीख और समय. वैल्यू को ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) फ़ॉर्मैट में बताया जाता है.
snippet.amountMicros unsigned long
खरीदारी की कुल कीमत, खरीदारी की मुद्रा के माइक्रो में. उदाहरण के लिए, अगर खरीदारी की कुल कीमत एक डॉलर है, तो snippet.amountMicros प्रॉपर्टी की वैल्यू 1000000 होगी.
snippet.currency string
वह मुद्रा जिसमें खरीदारी की गई थी. वैल्यू, ISO 4217 करंसी कोड है.
snippet.displayString string
$1.00 जैसी स्ट्रिंग, जो खरीदारी की रकम और मुद्रा दिखाती है. डिसप्ले स्ट्रिंग को hl अनुरोध पैरामीटर से तय की गई भाषा के नियमों के आधार पर फ़ॉर्मैट किया जाता है. डिफ़ॉल्ट रूप से, डिसप्ले स्ट्रिंग को अंग्रेज़ी में दिखाए जाने वाले फ़ॉर्मैट में फ़ॉर्मैट किया जाता है. उदाहरण के लिए, डिफ़ॉल्ट रूप से, स्ट्रिंग को $1,00 के बजाय $1.00 के तौर पर फ़ॉर्मैट किया जाता है.
snippet.messageType unsigned integer
पैसे चुकाकर भेजे गए मैसेज का टियर. ध्यान दें कि जब liveChatMessage रिसॉर्स, सुपर चैट मैसेज की पहचान करता है, तब snippet.superChatDetails.tier प्रॉपर्टी में यह वैल्यू शामिल होती है.

टियर, मैसेज खरीदने के लिए खर्च की गई रकम पर आधारित होता है. इससे यह भी तय होता है कि लाइव चैट के यूज़र इंटरफ़ेस (यूआई) में मैसेज को हाइलाइट करने के लिए कौनसा रंग इस्तेमाल किया जाएगा, मैसेज में ज़्यादा से ज़्यादा कितने वर्ण इस्तेमाल किए जा सकते हैं, और मैसेज को टिकर पर कितनी देर तक पिन किया जाएगा.

सुपर चैट के टियर के बारे में जानकारी, YouTube सहायता केंद्र पर दी गई है. (सुपर चैट खरीदने के बारे में जानकारी देने वाला सेक्शन देखें, जिसे बड़ा करके देखा जा सकता है.) उस सूची में, सबसे कम खरीदारी राशि वाला टीयर, टीयर 1 होता है. इसके बाद, अगली सबसे कम राशि वाला टीयर, टीयर 2 होता है. इसी तरह, बाकी टीयर भी होते हैं.
snippet.isSuperStickerEvent boolean
इससे पता चलता है कि संसाधन, सुपर स्टिकर है या नहीं. सुपर स्टिकर, सुपर चैट मैसेज का एक खास टाइप होता है. इसमें एक इमेज जुड़ी होती है. अगर इस फ़ील्ड की वैल्यू true है, तो superStickerMetadata फ़ील्ड में ऐसी जानकारी होगी जिसका इस्तेमाल इमेज दिखाने के लिए किया जा सकता है.
snippet.superStickerMetadata object
सुपर स्टिकर के बारे में जानकारी. यह ऑब्जेक्ट सिर्फ़ तब दिखता है, जब snippet.isSuperStickerEvent फ़ील्ड की वैल्यू true हो.
snippet.superStickerMetadata.stickerId string
एक यूनीक आईडी, जिससे स्टिकर की इमेज की पहचान की जाती है. ध्यान दें कि जब उपयोगकर्ता YouTube पर चैट विंडो देखते हैं, तब इमेज सिर्फ़ सुपर स्टिकर मैसेज के हिस्से के तौर पर दिखती है. हालांकि, एपीआई के ज़रिए इमेज का यूआरएल उपलब्ध नहीं है. सिर्फ़ रेफ़रंस के लिए, इस CSV फ़ाइल में जाकर देखा जा सकता है कि कौनसे स्टिकर आईडी, किन सुपर स्टिकर से जुड़े हैं.
snippet.superStickerMetadata.altText string
टेक्स्ट स्ट्रिंग, जिसमें स्टिकर के बारे में बताया गया हो. snippet.superStickerMetadata.language फ़ील्ड से, टेक्स्ट की भाषा की पहचान होती है. superChatEvents.list तरीके को कॉल करते समय, hl पैरामीटर की वैल्यू को टेक्स्ट के लिए अपनी पसंद की भाषा पर सेट करें.
snippet.superStickerMetadata.language string
snippet.superStickerMetadata.altText प्रॉपर्टी की वैल्यू की भाषा. अगर सुपर स्टिकर में कोई टेक्स्ट भी दिखता है, तो वह टेक्स्ट भी इसी भाषा में होता है.