Groups: list

एपीआई अनुरोध पैरामीटर से मैच करने वाले ग्रुप की सूची दिखाता है. उदाहरण के लिए, उन सभी ग्रुप को फिर से हासिल किया जा सकता है जिनके मालिकाना हक की पुष्टि पुष्टि किए गए उपयोगकर्ता के पास है. इसके अलावा, एक या एक से ज़्यादा ग्रुप के यूनीक आईडी की मदद से, ग्रुप को वापस लाया जा सकता है.

अनुरोध

एचटीटीपी अनुरोध

GET https://youtubeanalytics.googleapis.com/v2/groups

अनुमति देना

इस अनुरोध के लिए, इनमें से कम से कम एक स्कोप के साथ अनुमति की ज़रूरत है (पुष्टि और अनुमति के बारे में ज़्यादा पढ़ें).

स्कोप
https://www.googleapis.com/auth/yt-analytics.readonly अपने YouTube कॉन्टेंट के लिए YouTube Analytics रिपोर्ट देखें. इस स्कोप से, उपयोगकर्ता गतिविधि की मेट्रिक का ऐक्सेस मिलता है. जैसे, व्यू की संख्या और रेटिंग की संख्या.
https://www.googleapis.com/auth/yt-analytics-monetary.readonly अपने YouTube वीडियो से होने वाली आय की जानकारी देने वाली YouTube Analytics की रिपोर्ट देखें. इस स्कोप से उपयोगकर्ता गतिविधि की मेट्रिक, अनुमानित रेवेन्यू, और विज्ञापन की परफ़ॉर्मेंस वाली मेट्रिक को ऐक्सेस किया जा सकता है.
https://www.googleapis.com/auth/youtube अपना YouTube खाता मैनेज करें. चैनल के मालिक, YouTube Analytics API में इस दायरे का इस्तेमाल, YouTube Analytics ग्रुप और ग्रुप आइटम को मैनेज करने के लिए करते हैं.
https://www.googleapis.com/auth/youtubepartner YouTube पर YouTube ऐसेट और उससे जुड़ा कॉन्टेंट देखें और मैनेज करें. YouTube Analytics API में, कॉन्टेंट के मालिक इस स्कोप का इस्तेमाल करके, YouTube Analytics के ग्रुप और ग्रुप आइटम मैनेज करते हैं.

पैरामीटर

नीचे दी गई टेबल में उन पैरामीटर की सूची दी गई है जिनका इस्तेमाल इस क्वेरी में किया जा सकता है. सूची में दिए गए सभी पैरामीटर, क्वेरी पैरामीटर हैं.

पैरामीटर
फ़िल्टर (नीचे दिए गए पैरामीटर में से कोई एक पैरामीटर बताएं)
id string
id पैरामीटर, वापस लाए जा रहे संसाधनों के लिए, कॉमा लगाकर अलग किए गए YouTube ग्रुप आईडी की सूची दिखाता है. हर ग्रुप का मालिकाना हक, पुष्टि किए गए उपयोगकर्ता के पास होना चाहिए. group रिसॉर्स में, id प्रॉपर्टी से ग्रुप का YouTube ग्रुप आईडी पता चलता है.

ध्यान दें कि अगर आपने id पैरामीटर के लिए कोई वैल्यू नहीं दी है, तो आपको mine पैरामीटर को true पर सेट करना होगा.
mine boolean
इस पैरामीटर का इस्तेमाल, सिर्फ़ अनुमति वाले अनुरोध में ही किया जा सकता है. पुष्टि किए गए उपयोगकर्ता के मालिकाना हक वाले सभी ग्रुप वापस पाने के लिए, इस पैरामीटर की वैल्यू को true पर सेट करें.
ज़रूरी नहीं पैरामीटर
onBehalfOfContentOwner string
इस पैरामीटर का इस्तेमाल सिर्फ़ अनुमति वाले अनुरोध में किया जा सकता है. ध्यान दें: यह पैरामीटर खास तौर पर उन YouTube कॉन्टेंट पार्टनर के लिए है जो कई अलग-अलग YouTube चैनलों के मालिक हैं और उन्हें मैनेज करते हैं.

onBehalfOfContentOwner पैरामीटर से पता चलता है कि अनुरोध के ऑथराइज़ेशन क्रेडेंशियल से YouTube के ऐसे उपयोगकर्ता की पहचान होती है जो पैरामीटर वैल्यू में कॉन्टेंट के मालिक की ओर से कार्रवाई कर रहा है. इसकी मदद से, कॉन्टेंट के मालिक एक बार पुष्टि करके अपने सभी वीडियो और चैनल का डेटा ऐक्सेस कर सकते हैं. इसके लिए, उन्हें हर चैनल के लिए पुष्टि करने के क्रेडेंशियल देने की ज़रूरत नहीं होती. उपयोगकर्ता जिस खाते से पुष्टि करता है उसे YouTube कॉन्टेंट के बताए गए मालिक से लिंक होना चाहिए.
pageToken string
pageToken पैरामीटर, नतीजों के सेट में से उस पेज की पहचान करता है जिसे दिखाना है. एपीआई रिस्पॉन्स में, nextPageToken प्रॉपर्टी से उस अगले पेज की पहचान होती है जिसे वापस लाया जा सकता है.

अनुरोध का मुख्य भाग

इस तरीके को कॉल करते समय, अनुरोध बॉडी न दें.

जवाब

अगर एपीआई सही से जुड़ जाता है, तो यह तरीका इस स्ट्रक्चर के साथ रिस्पॉन्स बॉडी दिखाता है:

{
  "kind": "youtube#groupListResponse",
  "etag": etag,
  "items": [
    group Resource
  ],
  "nextPageToken": string
}

प्रॉपर्टी

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

प्रॉपर्टी
kind string
एपीआई संसाधन के टाइप की पहचान करता है. वैल्यू youtube#groupListResponse होगी.
etag etag
इस संसाधन का Etag.
items[] list
एपीआई अनुरोध पैरामीटर से मैच करने वाले ग्रुप की सूची. सूची में मौजूद हर आइटम, group संसाधन को दिखाता है.
nextPageToken string
यह टोकन, नतीजों के सेट में अगला पेज पाने के लिए, pageToken पैरामीटर की वैल्यू के तौर पर इस्तेमाल किया जा सकता है.

गड़बड़ियां

एपीआई में, गड़बड़ी के ऐसे मैसेज नहीं होते जो इस एपीआई के तरीके के लिए खास हों. हालांकि, इस तरीके से अब भी एपीआई से जुड़ी ऐसी सामान्य गड़बड़ियां दिख सकती हैं जो गड़बड़ी के मैसेज वाले दस्तावेज़ में मौजूद हैं.

इसे आज़माएं!

इस एपीआई को कॉल करने और एपीआई अनुरोध और रिस्पॉन्स देखने के लिए, APIs Explorer का इस्तेमाल करें.