API Reference

YouTube Analytics API की मदद से, YouTube चैनल या कॉन्टेंट के मालिक का YouTube Analytics डेटा देखा जा सकता है. यह एपीआई, रीयल-टाइम क्वेरी के साथ काम करता है. साथ ही, एपीआई अनुरोध पैरामीटर के आधार पर रिपोर्ट जनरेट करता है.

एपीआई में दो तरह के फ़ंक्शन काम करते हैं:

  • रिपोर्ट वापस लाना – एपीआई का reports.query तरीका, YouTube Analytics की रिपोर्ट वापस लाता है.

  • YouTube Analytics ग्रुप मैनेजमेंट – YouTube Analytics ग्रुप, पसंद के मुताबिक बनाए जाने वाला एक कस्टम कलेक्शन है. इसमें ज़्यादा से ज़्यादा 500 चैनल, वीडियो, प्लेलिस्ट या एसेट शामिल हो सकते हैं. एपीआई की मदद से, YouTube Analytics ग्रुप बनाने, उन्हें वापस पाने, और अपडेट करने के कई तरीके इस्तेमाल किए जा सकते हैं. इसके बाद, चैनल और कॉन्टेंट के मालिक, reports.query तरीके का इस्तेमाल करके किसी ग्रुप में मौजूद सभी आइटम का एग्रीगेट किया गया डेटा हासिल कर सकते हैं. इससे, परफ़ॉर्मेंस का विश्लेषण करने में मदद मिलती है.

इस पेज पर, एपीआई रिसॉर्स और उन तरीकों के बारे में खास जानकारी दी गई है जिनसे इन फ़ंक्शन को चालू किया जा सकता है.

अनुमति देना

YouTube Analytics API के सभी अनुरोधों को स्वीकार किया जाना चाहिए. अनुमति से जुड़ी गाइड में, ऑथराइज़ेशन टोकन पाने के लिए OAuth 2.0 प्रोटोकॉल का इस्तेमाल करने का तरीका बताया गया है.

YouTube Analytics API के अनुरोध, अनुमति के इन दायरों का इस्तेमाल करते हैं:

स्कोप
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 के ग्रुप और ग्रुप आइटम मैनेज करते हैं.

रिपोर्ट वापस पाना

एपीआई के reports.query तरीके की मदद से, YouTube Analytics की कई अलग-अलग रिपोर्ट हासिल की जा सकती हैं. हर अनुरोध में क्वेरी पैरामीटर का इस्तेमाल करके, चैनल आईडी या कॉन्टेंट के मालिक, शुरू होने की तारीख, खत्म होने की तारीख, और कम से कम एक मेट्रिक की जानकारी दी जाती है. आपके पास क्वेरी के लिए अन्य पैरामीटर भी देने का विकल्प होता है. जैसे, डाइमेंशन, फ़िल्टर, और क्रम से लगाने के निर्देश.

तरीका एचटीटीपी अनुरोध ब्यौरा
https://youtubeanalytics.googleapis.com/v2 से जुड़े यूआरआई
query GET /reports YouTube Analytics की रिपोर्ट को वापस लाता है. हर एपीआई अनुरोध में, चैनल आईडी या कॉन्टेंट के मालिक, शुरू होने की तारीख, खत्म होने की तारीख, और कम से कम एक मेट्रिक की जानकारी देने के लिए क्वेरी पैरामीटर का इस्तेमाल किया जाता है. आपके पास क्वेरी के लिए अन्य पैरामीटर भी देने का विकल्प होता है. जैसे, डाइमेंशन, फ़िल्टर या क्रम से लगाने के निर्देश.
  • मेट्रिक, उपयोगकर्ता गतिविधि के अलग-अलग मेज़रमेंट होते हैं. जैसे, वीडियो व्यू या रेटिंग (पसंद और नापसंद).
  • डाइमेंशन, डेटा इकट्ठा करने के लिए इस्तेमाल की जाने वाली सामान्य शर्तें होती हैं. जैसे, उपयोगकर्ता गतिविधि की तारीख या वह देश जहां उपयोगकर्ता मौजूद थे. किसी रिपोर्ट में, डेटा की हर लाइन में डाइमेंशन वैल्यू का यूनीक कॉम्बिनेशन होता है.
  • फ़िल्टर, डाइमेंशन की वैल्यू होती हैं. इनसे यह तय होता है कि कौनसा डेटा वापस लाया जाएगा. उदाहरण के लिए, किसी देश, किसी वीडियो या वीडियो के ग्रुप का डेटा देखा जा सकता है.
काम करने वाली चैनल रिपोर्ट और कॉन्टेंट के मालिक की रिपोर्ट की सूचियों में, मेट्रिक, डाइमेंशन, और फ़िल्टर के मान्य कॉम्बिनेशन तय किए गए हैं.

समूह प्रबंधन

YouTube Analytics ग्रुप बनाने और उन्हें मैनेज करने के लिए, एपीआई दो संसाधन उपलब्ध कराता है:

ग्रुप

group रिसॉर्स, YouTube Analytics ग्रुप को दिखाता है. यह ज़्यादा से ज़्यादा 500 चैनलों, वीडियो, प्लेलिस्ट या एसेट का कस्टम कलेक्शन होता है.

किसी ग्रुप में मौजूद सभी आइटम एक ही तरह के रिसॉर्स होने चाहिए. उदाहरण के लिए, ऐसा ग्रुप नहीं बनाया जा सकता जिसमें 100 वीडियो और 100 प्लेलिस्ट शामिल हों.

किसी Analytics ग्रुप में सिर्फ़ ऐसे संसाधन शामिल किए जा सकते हैं जिन्हें आपने अपलोड किया है या जिन पर आपने दावा किया है. इसके अलावा, ऐसे संसाधन भी शामिल किए जा सकते हैं जो आपके मैनेज किए जा रहे चैनल से लिंक हैं. इसकी मदद से, चैनल के मालिक वीडियो और प्लेलिस्ट के ग्रुप बना सकते हैं. कॉन्टेंट के मालिक, वीडियो, प्लेलिस्ट, चैनलों या ऐसेट के ग्रुप बना सकते हैं.

इस संसाधन के बारे में ज़्यादा जानने के लिए, इसका संसाधन का प्रतिनिधित्व और प्रॉपर्टी की सूची देखें.

तरीका एचटीटीपी अनुरोध ब्यौरा
https://youtubeanalytics.googleapis.com/v2 से जुड़े यूआरआई
list GET /groups एपीआई अनुरोध पैरामीटर से मैच करने वाले ग्रुप की सूची दिखाता है. उदाहरण के लिए, पुष्टि किए गए उपयोगकर्ता के मालिकाना हक वाले सभी ग्रुप को वापस पाया जा सकता है. इसके अलावा, एक या उससे ज़्यादा ग्रुप को उनके यूनीक आईडी से वापस पाया जा सकता है.
insert POST /groups YouTube Analytics ग्रुप बनाता है. ग्रुप बनाने के बाद, उसमें आइटम जोड़ने के लिए groupItems.insert तरीके का इस्तेमाल करें.
update PUT /groups किसी ग्रुप के मेटाडेटा में बदलाव करता है. फ़िलहाल, ग्रुप का टाइटल ही अपडेट किया जा सकता है. (ग्रुप आइटम जोड़ने और हटाने के लिए, groupItems.insert और groupItems.delete का इस्तेमाल करें.)
delete DELETE /groups किसी ग्रुप को मिटाता है.

GroupItems

groupItem रिसॉर्स, YouTube Analytics ग्रुप में किसी आइटम को दिखाता है.

इस संसाधन के बारे में ज़्यादा जानने के लिए, इसका संसाधन का प्रतिनिधित्व और प्रॉपर्टी की सूची देखें.

तरीका एचटीटीपी अनुरोध ब्यौरा
https://youtubeanalytics.googleapis.com/v2 से जुड़े यूआरआई
list GET /groupItems एपीआई अनुरोध पैरामीटर से मैच करने वाले ग्रुप आइटम का कलेक्शन दिखाता है.
insert POST /groupItems ग्रुप आइटम बनाता है.
delete DELETE /groupItems किसी ग्रुप से आइटम हटाता है.