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इस संसाधन का एटैग. | 
| id | stringवह आईडी जिसे YouTube, किसी सुपर चैट इवेंट की खास तौर पर पहचान करने के लिए असाइन करता है. | 
| snippet | objectsnippetऑब्जेक्ट में, सुपर चैट इवेंट के बारे में बुनियादी जानकारी होती है. | 
| snippet.channelId | stringYouTube चैनल आईडी, जिससे उस चैनल की पहचान होती है जिसने सुपर चैट इवेंट से जुड़ी लाइव स्ट्रीम को ब्रॉडकास्ट किया था. | 
| 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 | stringsnippet.superStickerMetadata.altTextप्रॉपर्टी की वैल्यू की भाषा. अगर सुपर स्टिकर किसी टेक्स्ट को दिखाता है, तो वह टेक्स्ट भी इस भाषा में होगा. |