liveChatBan
रिसॉर्स, YouTube के किसी उपयोगकर्ता और उस लाइव चैट की पहचान करता है जिसमें उपयोगकर्ता को हिस्सा लेने से प्रतिबंधित किया गया है.
तरीके
एपीआई, liveChatBans
संसाधनों के लिए इन तरीकों का इस्तेमाल करता है:
- शामिल करें
- किसी उपयोगकर्ता को लाइव चैट में हिस्सा लेने से रोकता है. एपीआई अनुरोध के लिए, चैनल के मालिक या पाबंदी वाली लाइव चैट के मॉडरेटर की अनुमति लेना ज़रूरी है. इसे अभी आज़माएं.
- मिटाएं
- किसी उपयोगकर्ता पर लगाया गया ऐसा प्रतिबंध हटाता है जिसकी वजह से वह लाइव चैट में हिस्सा नहीं ले पा रहा है. इससे, उपयोगकर्ता चैट में फिर से शामिल हो सकता है. एपीआई अनुरोध के लिए, चैनल के मालिक या पाबंदी वाली लाइव चैट के मॉडरेटर की अनुमति लेना ज़रूरी है. इसे अभी आज़माएं.
संसाधन का प्रतिनिधित्व
यहां दिया गया JSON स्ट्रक्चर, liveChatBans
संसाधन का फ़ॉर्मैट दिखाता है:
{ "kind": "youtube#liveChatBan", "etag": etag, "id": string, "snippet": { "liveChatId": string, "type": string, "banDurationSeconds": unsigned long, "bannedUserDetails": { "channelId": string } } }
प्रॉपर्टी
इस टेबल में, इस संसाधन में दिखने वाली प्रॉपर्टी के बारे में बताया गया है:
प्रॉपर्टी | |
---|---|
kind |
string एपीआई संसाधन के टाइप की पहचान करता है. वैल्यू youtube#liveChatBan होगी. |
etag |
etag इस संसाधन का Etag. |
id |
string YouTube, पाबंदी की खास तौर पर पहचान करने के लिए यह आईडी असाइन करता है. |
snippet |
object snippet ऑब्जेक्ट, पाबंदी वाले उपयोगकर्ता की पहचान करता है. साथ ही, इसमें पाबंदी के बारे में जानकारी होती है. |
snippet.liveChatId |
string वह लाइव चैट जिस पर पाबंदी लगी है. किसी ब्रॉडकास्ट से जुड़ा लाइव चैट आईडी, liveBroadcast रिसॉर्स की snippet.liveChatId प्रॉपर्टी में दिखता है. |
snippet.type |
string पाबंदी का टाइप. इस प्रॉपर्टी के लिए मान्य वैल्यू ये हैं:
|
snippet.banDurationSeconds |
unsigned long पाबंदी की अवधि. इस प्रॉपर्टी के लिए सिर्फ़ तब वैल्यू सेट करें, जब पाबंदी का टाइप temporary हो. डिफ़ॉल्ट वैल्यू 300 (पांच मिनट) है. |
snippet.bannedUserDetails |
object इस ऑब्जेक्ट में, पाबंदी वाले उपयोगकर्ता की पहचान करने वाली जानकारी होती है. |
snippet.bannedUserDetails.channelId |
string जिस उपयोगकर्ता पर पाबंदी लगाई गई है उसका YouTube चैनल आईडी. |