YouTube Reporting API - Get Bulk Data Reports

अहम जानकारी: रोज़ जनरेट होने वाली एपीआई रिपोर्ट और बैकफ़िल रिपोर्ट, जनरेट होने के 60 दिनों तक उपलब्ध रहती हैं. पुराने डेटा की रिपोर्ट, जनरेट होने के बाद 30 दिन तक उपलब्ध रहती हैं.

यह नीति, दुनिया भर में सभी रिपोर्ट और रिपोर्टिंग जॉब पर लागू होती है. पूरी जानकारी के लिए, YouTube Reporting API के बदलाव का इतिहास देखें.

YouTube Reporting API, पहले से तैयार रिपोर्ट के साथ काम करता है. इन रिपोर्ट में, कॉन्टेंट के मालिक या चैनल के लिए YouTube Analytics का पूरा डेटा होता है. इन रिपोर्ट की मदद से, एक साथ कई डेटा सेट डाउनलोड किए जा सकते हैं. इन डेटा सेट के लिए, YouTube Analytics API या Creator Studio के Analytics सेक्शन में क्वेरी की जा सकती है.

यह एपीआई, अपने-आप जनरेट होने वाली और सिस्टम से मैनेज की जाने वाली रिपोर्ट के सेट के साथ भी काम करता है. ये रिपोर्ट, कॉन्टेंट के उन मालिकों के लिए उपलब्ध होती हैं जिनके पास रिपोर्ट मेन्यू में मौजूद उन रिपोर्ट का ऐक्सेस होता है. इन रिपोर्ट में, विज्ञापन से मिलने वाले रेवेन्यू और YouTube Premium की सदस्यता से मिलने वाले रेवेन्यू का डेटा शामिल होता है. ज़्यादा जानकारी के लिए, सिस्टम से मैनेज की जाने वाली रिपोर्ट का दस्तावेज़ देखें.

खास जानकारी

इन रिपोर्ट में मौजूद रिपोर्ट फ़ील्ड, डाइमेंशन या मेट्रिक के तौर पर दिखाए जाते हैं:

• डाइमेंशन, डेटा इकट्ठा करने के लिए इस्तेमाल की जाने वाली सामान्य शर्तें होती हैं. जैसे, कोई कार्रवाई होने की तारीख या उपयोगकर्ताओं का देश. किसी रिपोर्ट में, डेटा की हर लाइन में डाइमेंशन वैल्यू का यूनीक कॉम्बिनेशन होता है.
• मेट्रिक, उपयोगकर्ता गतिविधि, विज्ञापन की परफ़ॉर्मेंस या अनुमानित रेवेन्यू से जुड़े अलग-अलग मेज़रमेंट होते हैं. उपयोगकर्ता गतिविधि की मेट्रिक में, वीडियो के व्यू की संख्या और रेटिंग (पसंद और नापसंद) जैसी चीज़ें शामिल होती हैं.

उदाहरण के लिए, चैनलों के लिए उपयोगकर्ता गतिविधि की बुनियादी रिपोर्ट में ये डाइमेंशन शामिल होते हैं:

• day: वह तारीख जब गतिविधि हुई थी.
• channel: गतिविधि से जुड़ा YouTube चैनल.
• वीडियो: गतिविधि से जुड़ा YouTube वीडियो.
• liveOrOnDemand: यह वैल्यू बताती है कि दर्शक लाइव वीडियो स्ट्रीम देख रहे थे या नहीं.
• subscribedStatus: इस वैल्यू से पता चलता है कि दर्शकों ने चैनल की सदस्यता ली थी या नहीं.
• देश: वह देश जहां दर्शक मौजूद थे.

रिपोर्ट में कई मेट्रिक भी शामिल होती हैं, जैसे कि व्यू, पसंद, और averageViewDuration. रिपोर्ट को वापस पाने और इंपोर्ट करने के बाद, कोई ऐप्लिकेशन सामान्य डाइमेंशन वैल्यू के आधार पर कई अलग-अलग कैलकुलेशन कर सकता है.

उदाहरण के लिए, किसी खास तारीख को जर्मनी में मिले व्यू की कुल संख्या का हिसाब लगाने के लिए, उन सभी पंक्तियों के लिए व्यू मेट्रिक की वैल्यू जोड़ें जिनमें देश कॉलम की वैल्यू DE है और दिन कॉलम की वैल्यू, YYYY-MM-DD फ़ॉर्मैट में दी गई तारीख है.

YouTube Analytics की रिपोर्ट हासिल करना

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

पहला चरण: अनुमति के क्रेडेंशियल वापस पाना

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

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

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

दूसरा चरण: उस रिपोर्ट की पहचान करना जिसे वापस लाना है

चैनल या कॉन्टेंट के मालिक के लिए जनरेट की जा सकने वाली रिपोर्ट की सूची पाने के लिए, एपीआई के reportTypes.list तरीके को कॉल करें. यह तरीका, रिपोर्ट आईडी और नामों की सूची दिखाता है. आपको जिन रिपोर्ट को जनरेट करना है उनके लिए id प्रॉपर्टी की वैल्यू कैप्चर करें. उदाहरण के लिए, चैनलों के लिए उपयोगकर्ता गतिविधि की बुनियादी रिपोर्ट का आईडी channel_basic_a1 है.

आपको रिपोर्ट के नाम, उस दस्तावेज़ में भी मिल सकते हैं जिसमें चैनल रिपोर्ट और कॉन्टेंट के मालिक की रिपोर्ट के बारे में बताया गया है.

तीसरा चरण: रिपोर्टिंग जॉब बनाना

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

रिपोर्टिंग जॉब बनाने के लिए, एपीआई के jobs.create तरीके को कॉल करें. अनुरोध के मुख्य हिस्से में ये वैल्यू सेट करें:

• reportTypeId प्रॉपर्टी की वैल्यू को उस रिपोर्ट आईडी पर सेट करें जिसे आपने दूसरे चरण में वापस पाया था.
• name प्रॉपर्टी की वैल्यू को उस नाम पर सेट करें जिसे आपको रिपोर्ट से जोड़ना है.

jobs.create तरीके के लिए एपीआई रिस्पॉन्स में एक Job रिसॉर्स होता है. इसमें ID की जानकारी होती है, जो नौकरी की खास तौर पर पहचान करता है. जॉब बनाने के 48 घंटों के अंदर, रिपोर्ट को वापस पाया जा सकता है. पहली उपलब्ध रिपोर्ट उस दिन की होगी जिस दिन आपने जॉब शेड्यूल किया था.

उदाहरण के लिए, अगर आपने 1 सितंबर को कोई जॉब शेड्यूल किया है, तो 1 सितंबर की रिपोर्ट 3 सितंबर को तैयार हो जाएगी. 2 सितंबर की रिपोर्ट 4 सितंबर को पोस्ट की जाएगी.

चौथा चरण: नौकरी का आईडी पाना

ध्यान दें: अगर आपके ऐप्लिकेशन ने तीसरे चरण में दिखाया गया नौकरी का आईडी सेव किया है, तो इस चरण को छोड़ा जा सकता है.

शेड्यूल की गई जॉब की सूची देखने के लिए, jobs.list तरीके को कॉल करें. दिखाए गए हर Job संसाधन में मौजूद reportTypeId प्रॉपर्टी से पता चलता है कि वह जॉब किस तरह की रिपोर्ट जनरेट करता है. आपके ऐप्लिकेशन को अगले चरण में, उसी संसाधन से id प्रॉपर्टी की वैल्यू की ज़रूरत होगी.

पांचवां चरण: रिपोर्ट के डाउनलोड यूआरएल को वापस पाना

नौकरी के लिए बनाई गई रिपोर्ट की सूची देखने के लिए, jobs.reports.list तरीके को कॉल करें. अनुरोध में, jobId पैरामीटर को उस रिपोर्ट के जॉब आईडी पर सेट करें जिसे आपको वापस लाना है.

सलाह: createdAfter पैरामीटर का इस्तेमाल करके यह बताएं कि एपीआई को सिर्फ़ तय समय के बाद बनाई गई रिपोर्ट दिखानी चाहिए. इस पैरामीटर का इस्तेमाल करके, यह पक्का किया जा सकता है कि एपीआई सिर्फ़ ऐसी रिपोर्ट दिखाए जो पहले से प्रोसेस नहीं की गई हैं.

एपीआई के जवाब में, उस नौकरी के लिए Report संसाधनों की सूची शामिल होती है. हर संसाधन, एक ऐसी रिपोर्ट को रेफ़र करता है जिसमें 24 घंटे की किसी खास अवधि का डेटा होता है. ध्यान दें कि YouTube उन दिनों के लिए भी डाउनलोड की जा सकने वाली रिपोर्ट जनरेट करता है जिनमें कोई डेटा उपलब्ध नहीं था. उन रिपोर्ट में हेडर लाइन होती है, लेकिन कोई अन्य डेटा नहीं होता.

• रिसॉर्स की startTime और endTime प्रॉपर्टी से, उस समयावधि की पहचान होती है जिसमें रिपोर्ट का डेटा शामिल होता है.
• रिसॉर्स की downloadUrl प्रॉपर्टी से उस यूआरएल की पहचान होती है जिससे रिपोर्ट फ़ेच की जा सकती है.
• रिसॉर्स की createTime प्रॉपर्टी से पता चलता है कि रिपोर्ट कब जनरेट हुई थी. आपके ऐप्लिकेशन को यह वैल्यू सेव करनी चाहिए और इसका इस्तेमाल यह तय करने के लिए करना चाहिए कि पहले डाउनलोड की गई रिपोर्ट में बदलाव हुए हैं या नहीं.

छठा चरण: रिपोर्ट डाउनलोड करना

रिपोर्ट वापस पाने के लिए, पांचवें चरण में मिले downloadUrl पर एचटीटीपी GET अनुरोध भेजें.

डाउनलोड के अनुरोधों पर gzip कंप्रेसन की सुविधा चालू करके, रिपोर्ट डाउनलोड करने के लिए ज़रूरी बैंडविड्थ को कम किया जा सकता है. एपीआई के जवाबों को अनकंप्रेस करने के लिए, आपके ऐप्लिकेशन को सीपीयू का ज़्यादा समय चाहिए होगा. हालांकि, आम तौर पर नेटवर्क के कम संसाधनों का इस्तेमाल करने का फ़ायदा, इस लागत से ज़्यादा होता है.

gzip से एन्कोड किया गया रिस्पॉन्स पाने के लिए, Accept-Encoding एचटीटीपी अनुरोध हेडर को gzip पर सेट करें, जैसा कि यहां दिए गए उदाहरण में दिखाया गया है:

Accept-Encoding: gzip

रिपोर्ट प्रोसेस करना

सबसे सही तरीके

YouTube Reporting API का इस्तेमाल करने वाले ऐप्लिकेशन को इन तरीकों का हमेशा पालन करना चाहिए:

• रिपोर्ट के कॉलम का क्रम तय करने के लिए, रिपोर्ट की हेडर लाइन का इस्तेमाल करें. उदाहरण के लिए, यह न मानें कि रिपोर्ट के ब्यौरे में व्यू मेट्रिक पहले दी गई है, इसलिए रिपोर्ट में भी यह मेट्रिक सबसे पहले दिखेगी. इसके बजाय, रिपोर्ट की हेडर लाइन का इस्तेमाल करके यह पता लगाएं कि उस डेटा को किस कॉलम में शामिल किया गया है.

• एक ही रिपोर्ट को बार-बार प्रोसेस करने से बचने के लिए, डाउनलोड की गई रिपोर्ट का रिकॉर्ड रखें. यहां दिए गए कुछ तरीकों से ऐसा किया जा सकता है.

  • reports.list तरीके को कॉल करते समय, createdAfter पैरामीटर का इस्तेमाल करके, सिर्फ़ किसी खास तारीख के बाद बनाई गई रिपोर्ट वापस पाएं. (रिपोर्ट को पहली बार फिर से पाने के लिए, createdAfter पैरामीटर को छोड़ दें.)

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

    किसी रिपोर्ट को वापस लाने से पहले, यह पक्का कर लें कि रिपोर्ट का आईडी आपके डेटाबेस में पहले से मौजूद न हो.

  • डाउनलोड और प्रोसेस की गई हर रिपोर्ट का आईडी सेव करें. आपके पास अतिरिक्त जानकारी को भी सेव करने का विकल्प होता है. जैसे, हर रिपोर्ट जनरेट होने की तारीख और समय या रिपोर्ट के startTime और endTime. इनसे, उस अवधि की पहचान होती है जिसके लिए रिपोर्ट में डेटा मौजूद होता है. ध्यान दें कि हर जॉब में कई रिपोर्ट हो सकती हैं, क्योंकि हर रिपोर्ट में 24 घंटे का डेटा होता है.

    रिपोर्ट आईडी का इस्तेमाल करके, उन रिपोर्ट की पहचान करें जिन्हें आपको अब भी डाउनलोड और इंपोर्ट करना है. हालांकि, अगर दो नई रिपोर्ट में startTime और endTime प्रॉपर्टी की वैल्यू एक जैसी है, तो सिर्फ़ नई createTime वैल्यू वाली रिपोर्ट इंपोर्ट करें.

• रिपोर्ट में, YouTube के संसाधनों से जुड़े आईडी शामिल होते हैं. उन संसाधनों का ज़्यादा मेटाडेटा पाने के लिए, YouTube Data API का इस्तेमाल करें. YouTube API की सेवाओं के लिए डेवलपर की नीतियां (III.E.4.b से III.E.4.d सेक्शन) के मुताबिक, एपीआई क्लाइंट को 30 दिनों के बाद, उस एपीआई से संग्रहित संसाधन का मेटाडेटा मिटाना या रीफ़्रेश करना होगा.

रिपोर्ट की विशेषताएं

एपीआई रिपोर्ट, वर्शन वाली .csv (कॉमा लगाकर अलग की गई वैल्यू) फ़ाइलें होती हैं. इनमें ये विशेषताएं होती हैं:

• हर रिपोर्ट में, पैसिफ़िक स्टैंडर्ड टाइम (यूटीसी-8) के हिसाब से रात 12:00 बजे से रात 11:59 बजे तक के 24 घंटे की अवधि का डेटा होता है. इसलिए, किसी भी रिपोर्ट में दिन डाइमेंशन की वैल्यू हमेशा एक ही होती है.

• रिपोर्ट हर दिन अपडेट की जाती हैं.

• YouTube उन दिनों के लिए डाउनलोड की जा सकने वाली रिपोर्ट जनरेट करता है जिनके लिए कोई डेटा उपलब्ध नहीं था. उन रिपोर्ट में हेडर लाइन होगी, लेकिन कोई अन्य डेटा नहीं होगा.

• एपीआई रिपोर्ट, जनरेट होने के बाद 60 दिनों तक उपलब्ध रहती हैं. हालांकि, रिपोर्टिंग के नए जॉब के लिए जनरेट किया गया पुराना डेटा उपलब्ध नहीं रहता. रिपोर्ट 60 दिनों से ज़्यादा पुरानी होने के बाद, उनका ऐक्सेस नहीं किया जा सकता.
• पुराने डेटा वाली रिपोर्ट, जनरेट होने के बाद 30 दिन तक उपलब्ध रहती हैं. पुराने डेटा वाली रिपोर्ट, 30 दिन से ज़्यादा पुरानी होने के बाद ऐक्सेस नहीं की जा सकतीं.

• रिपोर्ट का डेटा फ़िल्टर नहीं किया गया है. इसलिए, चैनल की रिपोर्ट में चैनल के वीडियो या प्लेलिस्ट का पूरा डेटा शामिल होता है. हालांकि, मिटाए गए संसाधनों के बारे में नीचे दिए गए पैराग्राफ़ में बताया गया है. इसी तरह, कॉन्टेंट के मालिक की रिपोर्ट में, उसके चैनलों (वीडियो, प्लेलिस्ट, विज्ञापन की परफ़ॉर्मेंस वगैरह) का पूरा डेटा होता है. हालांकि, इसमें ये चीज़ें शामिल नहीं होतीं.

  रिपोर्ट का डेटा फ़िल्टर नहीं किया जाता. हालांकि, रिपोर्ट में ऐसे YouTube संसाधनों का कोई रेफ़रंस नहीं होता जिन्हें रिपोर्ट जनरेट होने की तारीख से कम से कम 30 दिन पहले मिटा दिया गया था.

• रिपोर्ट का डेटा क्रम से नहीं लगाया गया है.

• रिपोर्ट में, ऐसी लाइनें शामिल नहीं की जातीं जिनमें मेट्रिक नहीं होतीं. दूसरे शब्दों में, जिन लाइनों में कोई मेट्रिक नहीं होती उन्हें रिपोर्ट में शामिल नहीं किया जाता. उदाहरण के लिए, अगर किसी दिन अल्बानिया में किसी वीडियो को कोई व्यू नहीं मिला है, तो उस दिन की रिपोर्ट में अल्बानिया के लिए कोई लाइन नहीं होगी.

• रिपोर्ट में ऐसी लाइनें नहीं होतीं जिनमें मेट्रिक के लिए खास जानकारी वाला डेटा होता है. जैसे, चैनल के सभी वीडियो के व्यू की कुल संख्या. रिपोर्ट में मौजूद वैल्यू के जोड़ के तौर पर, उन कुल वैल्यू का हिसाब लगाया जा सकता है. हालांकि, हो सकता है कि उस जोड़ में मिटाए गए वीडियो की मेट्रिक शामिल न हों, जैसा कि ऊपर बताया गया है. कुल संख्या पाने के लिए, YouTube Analytics API का भी इस्तेमाल किया जा सकता है. YouTube Analytics API, कुल वैल्यू दिखाता है. इनमें मिटाए गए संसाधनों की मेट्रिक भी शामिल होती हैं. भले ही, एपीआई के जवाबों में उन संसाधनों का साफ़ तौर पर रेफ़रंस न दिया गया हो.

डेटा बैकफ़िल करना

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

अगर YouTube के पास बैकफ़िल किया गया डेटा है, तो वह नए रिपोर्ट आईडी के साथ एक नई रिपोर्ट जनरेट करता है. ऐसे में, रिपोर्ट की startTime और endTime प्रॉपर्टी की वैल्यू, पहले से उपलब्ध किसी रिपोर्ट के शुरू और खत्म होने के समय से मेल खाएंगी. हो सकता है कि आपने पहले ही वह रिपोर्ट डाउनलोड कर ली हो.

बैकफ़िल रिपोर्ट में, YouTube के उन संसाधनों का कोई रेफ़रंस नहीं होता जिन्हें रिपोर्ट जनरेट होने की तारीख से कम से कम 30 दिन पहले मिटा दिया गया था.

पुराना डेटा

रिपोर्टिंग जॉब शेड्यूल करने पर, YouTube उस दिन से पुरानी रिपोर्ट जनरेट करता है. साथ ही, जॉब बनाने से पहले के 30 दिनों की रिपोर्ट भी जनरेट करता है. इसलिए, इस दस्तावेज़ में पुराना डेटा से ऐसी रिपोर्ट का मतलब है जिसमें रिपोर्टिंग जॉब के शेड्यूल होने से पहले की समयावधि का डेटा शामिल होता है.

पुरानी रिपोर्ट उपलब्ध होने पर, उन्हें पोस्ट कर दिया जाता है. आम तौर पर, किसी नौकरी का पूरा पुराना डेटा कुछ दिनों में पोस्ट कर दिया जाता है. रिपोर्ट की विशेषताएं सेक्शन में बताया गया है कि पुराना डेटा दिखाने वाली रिपोर्ट, जनरेट होने के बाद 30 दिनों तक उपलब्ध रहती हैं. जिन रिपोर्ट में पुराना डेटा नहीं होता वे 60 दिनों तक उपलब्ध रहती हैं.

डेटा की पहचान छिपाना

YouTube दर्शकों की पहचान ज़ाहिर न हो, इसके लिए कुछ डाइमेंशन की वैल्यू सिर्फ़ तब दिखाई जाती हैं, जब उसी लाइन में मौजूद कोई मेट्रिक तय थ्रेशोल्ड को पूरा करती हो.

उदाहरण के लिए, चैनलों के लिए वीडियो के ट्रैफ़िक सोर्स की रिपोर्ट में, हर लाइन में कई डाइमेंशन होते हैं. इनमें trafficSourceType और trafficSourceDetail शामिल हैं. हर लाइन में व्यू के साथ-साथ कई मेट्रिक भी शामिल होती हैं. YouTube पर खोज के नतीजों से आने वाले ट्रैफ़िक की जानकारी देने वाली लाइनों में, trafficSourceDetail डाइमेंशन उस खोज के लिए इस्तेमाल हुए शब्द की पहचान करता है जिससे ट्रैफ़िक आया है.

इस उदाहरण में, ये नियम लागू होते हैं:

• ट्रैफ़िक सोर्स रिपोर्ट में क्वेरी के लिए इस्तेमाल हुए शब्द (trafficSourceDetail) की पहचान सिर्फ़ तब की जाती है, जब किसी खास दिन किसी खास वीडियो को कम से कम तय व्यू मिले हों. इस मामले में, व्यू मेट्रिक है, वीडियो एग्रीगेट करने वाला डाइमेंशन है, और trafficSourceDetail पहचान छिपाने वाला डाइमेंशन है.

• रिपोर्ट में एक अतिरिक्त लाइन शामिल होती है, जो व्यू की संख्या के थ्रेशोल्ड को पूरा न करने वाली सभी trafficSourceDetail वैल्यू के लिए मेट्रिक इकट्ठा करती है. उस लाइन में, क्वेरी के लिए इस्तेमाल हुए शब्दों से जुड़े व्यू की कुल संख्या की जानकारी होती है. हालांकि, उसमें शब्दों की पहचान नहीं की जाती.

इन नियमों के बारे में नीचे दी गई टेबल में बताया गया है. पहली टेबल में रॉ डेटा का एक सैंपल सेट होता है. YouTube इसका इस्तेमाल, ट्रैफ़िक सोर्स की रिपोर्ट जनरेट करने के लिए करता है. दूसरी टेबल में रिपोर्ट होती है. इस उदाहरण में, व्यू की संख्या का थ्रेशोल्ड 10 है. इसका मतलब है कि रिपोर्ट में किसी खोज के लिए इस्तेमाल हुए शब्द की पहचान सिर्फ़ तब की जाती है, जब किसी खास दिन किसी खास वीडियो को कम से कम 10 व्यू मिले हों. (असल थ्रेशोल्ड में बदलाव हो सकता है.)

किसी वीडियो के लिए, YouTube पर खोज के नतीजों से मिलने वाले ट्रैफ़िक का रॉ डेटा

मान लें कि नीचे दिए गए डेटा में, किसी खास दिन किसी खास वीडियो पर YouTube Search से मिले ट्रैफ़िक के बारे में बताया गया है.

खोज के लिए शब्द	व्यू	वीडियो देखने के अनुमानित मिनट
gangnam style	100	200
psy	15	25
psy gangnam	9	15
oppa gangnam	5	8
घोड़े पर डांस	2	5

ट्रैफ़िक सोर्स की रिपोर्ट का सैंपल

नीचे दी गई टेबल में, ट्रैफ़िक सोर्स रिपोर्ट का एक हिस्सा दिखाया गया है. YouTube, पिछले सेक्शन में मौजूद रॉ डेटा के लिए यह रिपोर्ट जनरेट करेगा. (असल रिपोर्ट में ज़्यादा डाइमेंशन और मेट्रिक होंगी.) इस उदाहरण में, रिपोर्ट में खोज के लिए इस्तेमाल हुए उन शब्दों की पहचान की गई है जिनसे कम से कम 10 व्यू मिले. थ्रेशोल्ड की असल वैल्यू में बदलाव हो सकता है.

रिपोर्ट की तीसरी लाइन में, trafficSourceDetail डाइमेंशन की वैल्यू NULL है. views और estimatedMinutesWatched मेट्रिक में, खोज के लिए इस्तेमाल हुए उन तीन शब्दों के लिए व्यू और देखे गए मिनट की कुल संख्या शामिल होती है जिनसे 10 से कम व्यू मिले.

trafficSourceDetail	व्यू	estimatedMinutesWatched
gangnam style	100	200
psy	15	25
शून्य	16	28

पहचान छिपाने की सुविधा वाले डाइमेंशन

नीचे दी गई टेबल में, उन डाइमेंशन वैल्यू की पहचान की गई है जिन्हें पहचान छिपाकर दिखाया जाता है. ऐसा तब होता है, जब उनसे जुड़ी मेट्रिक वैल्यू किसी थ्रेशोल्ड को पूरा नहीं करती हैं. हर मामले में, मेट्रिक की वैल्यू को किसी दूसरे डाइमेंशन के हिसाब से एग्रीगेट किया जाता है. उदाहरण के लिए, अगर मेट्रिक व्यू है और एग्रीगेट करने वाला डाइमेंशन वीडियो है, तो डाइमेंशन की वैल्यू को तब तक छिपाकर रखा जाता है, जब तक वीडियो को तय संख्या में व्यू नहीं मिल जाते.

मेट्रिक	डाइमेंशन को एग्रीगेट करना	पहचान छिपाने वाला डाइमेंशन	पहचान छिपाकर दिखाई गई वैल्यू
subscribersGained	channel	country	ZZ
subscribersGained	channel	province	US-ZZ
subscribersLost	channel	country	ZZ
subscribersLost	channel	province	US-ZZ
comments	वीडियो	country	ZZ
comments	वीडियो	province	US-ZZ
पसंद करना	वीडियो	country	ZZ
पसंद करना	वीडियो	province	US-ZZ
नापसंद किए गए	वीडियो	country	ZZ
नापसंद किए गए	वीडियो	province	US-ZZ
व्यू	वीडियो	ageGroup	NULL
व्यू	वीडियो	gender	NULL
व्यू	video और trafficSourceDetail	trafficSourceDetail	NULL
चैनल के सदस्यों की संख्या	channel	subscribedStatus	NULL

कोड सैंपल

यहां दिए गए कोड सैंपल में, रिपोर्टिंग जॉब बनाने और फिर उस जॉब के लिए रिपोर्ट पाने के लिए, एपीआई का इस्तेमाल करने का तरीका बताया गया है. हर भाषा के लिए दो कोड सैंपल दिए गए हैं:

1. पहले कोड सैंपल में, उपलब्ध रिपोर्ट टाइप की सूची को फिर से पाने और फिर नई रिपोर्टिंग जॉब बनाने का तरीका बताया गया है.

2. दूसरे कोड सैंपल में, किसी खास नौकरी के लिए रिपोर्ट को वापस पाने का तरीका बताया गया है. जॉब बनाने के 48 घंटों के अंदर, रिपोर्ट वापस पाना शुरू किया जा सकता है.

ध्यान दें: ऐसा हो सकता है कि नीचे दिए गए कोड के सैंपल में, इसके साथ काम करने वाली सभी प्रोग्रामिंग भाषाएं न दिखाई गई हों. इस्तेमाल की जा सकने वाली भाषाओं की सूची के लिए, क्लाइंट लाइब्रेरी देखें.

Java

यहां दिए गए सैंपल में Java क्लाइंट लाइब्रेरी का इस्तेमाल किया गया है:

• उदाहरण 1: रिपोर्टिंग जॉब बनाना
• उदाहरण 2: रिपोर्ट वापस लाना

उदाहरण 1: रिपोर्टिंग जॉब बनाना

यहां दिया गया कोड सैंपल, उपलब्ध रिपोर्ट टाइप की सूची पाने के लिए reportTypes.list तरीके को कॉल करता है. इसके बाद, यह नई रिपोर्टिंग जॉब बनाने के लिए jobs.create तरीके को कॉल करता है.

/*
 * Copyright (c) 2015 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing permissions and limitations under
 * the License.
 */

package com.google.api.services.samples.youtube.cmdline.reporting;

import com.google.api.client.auth.oauth2.Credential;
import com.google.api.client.googleapis.json.GoogleJsonResponseException;
import com.google.api.services.samples.youtube.cmdline.Auth;
import com.google.api.services.youtubereporting.YouTubeReporting;
import com.google.api.services.youtubereporting.model.Job;
import com.google.api.services.youtubereporting.model.ListReportTypesResponse;
import com.google.api.services.youtubereporting.model.ReportType;
import com.google.common.collect.Lists;

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.util.List;

/**
 * This sample creates a reporting job by:
 *
 * 1. Listing the available report types using the "reportTypes.list" method.
 * 2. Creating a reporting job using the "jobs.create" method.
 *
 * @author Ibrahim Ulukaya
 */
public class CreateReportingJob {

    /**
     * Define a global instance of a YouTube Reporting object, which will be used to make
     * YouTube Reporting API requests.
     */
    private static YouTubeReporting youtubeReporting;


    /**
     * Create a reporting job.
     *
     * @param args command line args (not used).
     */
    public static void main(String[] args) {

        /*
         * This OAuth 2.0 access scope allows for read access to the YouTube Analytics monetary reports for
         * authenticated user's account. Any request that retrieves earnings or ad performance metrics must
         * use this scope.
         */
        List<String> scopes = Lists.newArrayList("https://www.googleapis.com/auth/yt-analytics-monetary.readonly");

        try {
            // Authorize the request.
            Credential credential = Auth.authorize(scopes, "createreportingjob");

            // This object is used to make YouTube Reporting API requests.
            youtubeReporting = new YouTubeReporting.Builder(Auth.HTTP_TRANSPORT, Auth.JSON_FACTORY, credential)
                    .setApplicationName("youtube-cmdline-createreportingjob-sample").build();

            // Prompt the user to specify the name of the job to be created.
            String name = getNameFromUser();

            if (listReportTypes()) {
              createReportingJob(getReportTypeIdFromUser(), name);
            }
        } catch (GoogleJsonResponseException e) {
            System.err.println("GoogleJsonResponseException code: " + e.getDetails().getCode()
                    + " : " + e.getDetails().getMessage());
            e.printStackTrace();

        } catch (IOException e) {
            System.err.println("IOException: " + e.getMessage());
            e.printStackTrace();
        } catch (Throwable t) {
            System.err.println("Throwable: " + t.getMessage());
            t.printStackTrace();
        }
    }

    /**
     * Lists report types. (reportTypes.listReportTypes)
     * @return true if at least one report type exists
     * @throws IOException
     */
    private static boolean listReportTypes() throws IOException {
        // Call the YouTube Reporting API's reportTypes.list method to retrieve report types.
        ListReportTypesResponse reportTypesListResponse = youtubeReporting.reportTypes().list()
            .execute();
        List<ReportType> reportTypeList = reportTypesListResponse.getReportTypes();

        if (reportTypeList == null || reportTypeList.isEmpty()) {
          System.out.println("No report types found.");
          return false;
        } else {
            // Print information from the API response.
            System.out.println("\n================== Report Types ==================\n");
            for (ReportType reportType : reportTypeList) {
                System.out.println("  - Id: " + reportType.getId());
                System.out.println("  - Name: " + reportType.getName());
                System.out.println("\n-------------------------------------------------------------\n");
           }
        }
        return true;
    }

    /**
     * Creates a reporting job. (jobs.create)
     *
     * @param reportTypeId Id of the job's report type.
     * @param name name of the job.
     * @throws IOException
     */
    private static void createReportingJob(String reportTypeId, String name)
        throws IOException {
        // Create a reporting job with a name and a report type id.
        Job job = new Job();
        job.setReportTypeId(reportTypeId);
        job.setName(name);

        // Call the YouTube Reporting API's jobs.create method to create a job.
        Job createdJob = youtubeReporting.jobs().create(job).execute();

        // Print information from the API response.
        System.out.println("\n================== Created reporting job ==================\n");
        System.out.println("  - ID: " + createdJob.getId());
        System.out.println("  - Name: " + createdJob.getName());
        System.out.println("  - Report Type Id: " + createdJob.getReportTypeId());
        System.out.println("  - Create Time: " + createdJob.getCreateTime());
        System.out.println("\n-------------------------------------------------------------\n");
    }

    /*
     * Prompt the user to enter a name for the job. Then return the name.
     */
    private static String getNameFromUser() throws IOException {

        String name = "";

        System.out.print("Please enter the name for the job [javaTestJob]: ");
        BufferedReader bReader = new BufferedReader(new InputStreamReader(System.in));
        name = bReader.readLine();

        if (name.length() < 1) {
            // If nothing is entered, defaults to "javaTestJob".
          name = "javaTestJob";
        }

        System.out.println("You chose " + name + " as the name for the job.");
        return name;
    }

    /*
     * Prompt the user to enter a report type id for the job. Then return the id.
     */
    private static String getReportTypeIdFromUser() throws IOException {

        String id = "";

        System.out.print("Please enter the reportTypeId for the job: ");
        BufferedReader bReader = new BufferedReader(new InputStreamReader(System.in));
        id = bReader.readLine();

        System.out.println("You chose " + id + " as the report type Id for the job.");
        return id;
    }
}
CreateReportingJob.java

उदाहरण 2: रिपोर्ट वापस लाना

कोड सैंपल, रिपोर्टिंग जॉब की सूची वापस पाने के लिए jobs.list तरीके को कॉल करता है. इसके बाद, यह reports.list पैरामीटर को किसी खास जॉब आईडी पर सेट करके, jobId तरीके को कॉल करता है. इससे उस जॉब से बनाई गई रिपोर्ट वापस मिलती हैं. आखिर में, सैंपल हर रिपोर्ट के लिए डाउनलोड यूआरएल प्रिंट करता है.

/*
 * Copyright (c) 2015 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing permissions and limitations under
 * the License.
 */

package com.google.api.services.samples.youtube.cmdline.reporting;

import com.google.api.client.auth.oauth2.Credential;
import com.google.api.client.googleapis.json.GoogleJsonResponseException;
import com.google.api.client.http.GenericUrl;
import com.google.api.services.samples.youtube.cmdline.Auth;
import com.google.api.services.youtubereporting.YouTubeReporting;
import com.google.api.services.youtubereporting.YouTubeReporting.Media.Download;
import com.google.api.services.youtubereporting.model.Job;
import com.google.api.services.youtubereporting.model.ListJobsResponse;
import com.google.api.services.youtubereporting.model.ListReportsResponse;
import com.google.api.services.youtubereporting.model.Report;

import com.google.common.collect.Lists;

import java.io.BufferedReader;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStreamReader;
import java.util.List;

import javax.print.attribute.standard.Media;

/**
 * This sample retrieves reports created by a specific job by:
 *
 * 1. Listing the jobs using the "jobs.list" method.
 * 2. Retrieving reports using the "reports.list" method.
 *
 * @author Ibrahim Ulukaya
 */
public class RetrieveReports {

    /**
     * Define a global instance of a YouTube Reporting object, which will be used to make
     * YouTube Reporting API requests.
     */
    private static YouTubeReporting youtubeReporting;


    /**
     * Retrieve reports.
     *
     * @param args command line args (not used).
     */
    public static void main(String[] args) {

        /*
         * This OAuth 2.0 access scope allows for read access to the YouTube Analytics monetary reports for
         * authenticated user's account. Any request that retrieves earnings or ad performance metrics must
         * use this scope.
         */
        List<String> scopes = Lists.newArrayList("https://www.googleapis.com/auth/yt-analytics-monetary.readonly");

        try {
            // Authorize the request.
            Credential credential = Auth.authorize(scopes, "retrievereports");

            // This object is used to make YouTube Reporting API requests.
            youtubeReporting = new YouTubeReporting.Builder(Auth.HTTP_TRANSPORT, Auth.JSON_FACTORY, credential)
                    .setApplicationName("youtube-cmdline-retrievereports-sample").build();

            if (listReportingJobs()) {
              if(retrieveReports(getJobIdFromUser())) {
                downloadReport(getReportUrlFromUser());
              }
            }
        } catch (GoogleJsonResponseException e) {
            System.err.println("GoogleJsonResponseException code: " + e.getDetails().getCode()
                    + " : " + e.getDetails().getMessage());
            e.printStackTrace();

        } catch (IOException e) {
            System.err.println("IOException: " + e.getMessage());
            e.printStackTrace();
        } catch (Throwable t) {
            System.err.println("Throwable: " + t.getMessage());
            t.printStackTrace();
        }
    }

    /**
     * Lists reporting jobs. (jobs.listJobs)
     * @return true if at least one reporting job exists
     * @throws IOException
     */
    private static boolean listReportingJobs() throws IOException {
        // Call the YouTube Reporting API's jobs.list method to retrieve reporting jobs.
        ListJobsResponse jobsListResponse = youtubeReporting.jobs().list().execute();
        List<Job> jobsList = jobsListResponse.getJobs();

        if (jobsList == null || jobsList.isEmpty()) {
          System.out.println("No jobs found.");
          return false;
        } else {
            // Print information from the API response.
            System.out.println("\n================== Reporting Jobs ==================\n");
            for (Job job : jobsList) {
                System.out.println("  - Id: " + job.getId());
                System.out.println("  - Name: " + job.getName());
                System.out.println("  - Report Type Id: " + job.getReportTypeId());
                System.out.println("\n-------------------------------------------------------------\n");
            }
        }
        return true;
    }

    /**
     * Lists reports created by a specific job. (reports.listJobsReports)
     *
     * @param jobId The ID of the job.
     * @throws IOException
     */
    private static boolean retrieveReports(String jobId)
        throws IOException {
        // Call the YouTube Reporting API's reports.list method
        // to retrieve reports created by a job.
        ListReportsResponse reportsListResponse = youtubeReporting.jobs().reports().list(jobId).execute();
        List<Report> reportslist = reportsListResponse.getReports();

        if (reportslist == null || reportslist.isEmpty()) {
            System.out.println("No reports found.");
            return false;
        } else {
            // Print information from the API response.
            System.out.println("\n============= Reports for the job " + jobId + " =============\n");
            for (Report report : reportslist) {
                System.out.println("  - Id: " + report.getId());
                System.out.println("  - From: " + report.getStartTime());
                System.out.println("  - To: " + report.getEndTime());
                System.out.println("  - Download Url: " + report.getDownloadUrl());
                System.out.println("\n-------------------------------------------------------------\n");
            }
        }
        return true;
    }

    /**
     * Download the report specified by the URL. (media.download)
     *
     * @param reportUrl The URL of the report to be downloaded.
     * @throws IOException
     */
    private static boolean downloadReport(String reportUrl)
        throws IOException {
        // Call the YouTube Reporting API's media.download method to download a report.
        Download request = youtubeReporting.media().download("");
        FileOutputStream fop = new FileOutputStream(new File("report"));
        request.getMediaHttpDownloader().download(new GenericUrl(reportUrl), fop);
        return true;
    }

    /*
     * Prompt the user to enter a job id for report retrieval. Then return the id.
     */
    private static String getJobIdFromUser() throws IOException {

        String id = "";

        System.out.print("Please enter the job id for the report retrieval: ");
        BufferedReader bReader = new BufferedReader(new InputStreamReader(System.in));
        id = bReader.readLine();

        System.out.println("You chose " + id + " as the job Id for the report retrieval.");
        return id;
    }

    /*
     * Prompt the user to enter a URL for report download. Then return the URL.
     */
    private static String getReportUrlFromUser() throws IOException {

        String url = "";

        System.out.print("Please enter the report URL to download: ");
        BufferedReader bReader = new BufferedReader(new InputStreamReader(System.in));
        url = bReader.readLine();

        System.out.println("You chose " + url + " as the URL to download.");
        return url;
    }}

RetrieveReports.java

PHP

यहां दिए गए सैंपल में PHP क्लाइंट लाइब्रेरी का इस्तेमाल किया गया है.

• उदाहरण 1: रिपोर्टिंग जॉब बनाना
• उदाहरण 2: रिपोर्ट वापस पाना

उदाहरण 1: रिपोर्टिंग जॉब बनाना

यहां दिया गया कोड सैंपल, उपलब्ध रिपोर्ट टाइप की सूची पाने के लिए reportTypes.list तरीके को कॉल करता है. इसके बाद, यह नई रिपोर्टिंग जॉब बनाने के लिए jobs.create तरीके को कॉल करता है.

<?php

/**
 * This sample creates a reporting job by:
 *
 * 1. Listing the available report types using the "reportTypes.list" method.
 * 2. Creating a reporting job using the "jobs.create" method.
 *
 * @author Ibrahim Ulukaya
 */

/**
 * Library Requirements
 *
 * 1. Install composer (https://getcomposer.org)
 * 2. On the command line, change to this directory (api-samples/php)
 * 3. Require the google/apiclient library
 *    $ composer require google/apiclient:~2.0
 */
if (!file_exists(__DIR__ . '/vendor/autoload.php')) {
  throw new \Exception('please run "composer require google/apiclient:~2.0" in "' . __DIR__ .'"');
}

require_once __DIR__ . '/vendor/autoload.php';
session_start();

/*
 * You can acquire an OAuth 2.0 client ID and client secret from the
 * {{ Google Cloud Console }} <{{ https://cloud.google.com/console }}>
 * For more information about using OAuth 2.0 to access Google APIs, please see:
 * <https://developers.google.com/youtube/v3/guides/authentication>
 * Please ensure that you have enabled the YouTube Data API for your project.
 */
$OAUTH2_CLIENT_ID = 'REPLACE_ME';
$OAUTH2_CLIENT_SECRET = 'REPLACE_ME';

$client = new Google_Client();
$client->setClientId($OAUTH2_CLIENT_ID);
$client->setClientSecret($OAUTH2_CLIENT_SECRET);

/*
 * This OAuth 2.0 access scope allows for read access to the YouTube Analytics monetary reports for
 * authenticated user's account. Any request that retrieves earnings or ad performance metrics must
 * use this scope.
 */
$client->setScopes('https://www.googleapis.com/auth/yt-analytics-monetary.readonly');
$redirect = filter_var('http://' . $_SERVER['HTTP_HOST'] . $_SERVER['PHP_SELF'],
    FILTER_SANITIZE_URL);
$client->setRedirectUri($redirect);

// YouTube Reporting object used to make YouTube Reporting API requests.
$youtubeReporting = new Google_Service_YouTubeReporting($client);

// Check if an auth token exists for the required scopes
$tokenSessionKey = 'token-' . $client->prepareScopes();
if (isset($_GET['code'])) {
  if (strval($_SESSION['state']) !== strval($_GET['state'])) {
    die('The session state did not match.');
  }

  $client->authenticate($_GET['code']);
  $_SESSION[$tokenSessionKey] = $client->getAccessToken();
  header('Location: ' . $redirect);
}

if (isset($_SESSION[$tokenSessionKey])) {
  $client->setAccessToken($_SESSION[$tokenSessionKey]);
}

// Check to ensure that the access token was successfully acquired.
if ($client->getAccessToken()) {
  // This code executes if the user enters a name in the form
  // and submits the form. Otherwise, the page displays the form above.
  try {
    if (empty(listReportTypes($youtubeReporting, $htmlBody))) {
      $htmlBody .= sprintf('<p>No report types found.</p>');
    } else if ($_GET['reportTypeId']){
      createReportingJob($youtubeReporting, $_GET['reportTypeId'], $_GET['jobName'], $htmlBody);
    }
  } catch (Google_Service_Exception $e) {
    $htmlBody = sprintf('<p>A service error occurred: <code>%s</code></p>',
        htmlspecialchars($e->getMessage()));
  } catch (Google_Exception $e) {
    $htmlBody = sprintf('<p>An client error occurred: <code>%s</code></p>',
        htmlspecialchars($e->getMessage()));
  }
  $_SESSION[$tokenSessionKey] = $client->getAccessToken();
} elseif ($OAUTH2_CLIENT_ID == 'REPLACE_ME') {
  $htmlBody = <<<END
  <h3>Client Credentials Required</h3>
  <p>
    You need to set <code>\$OAUTH2_CLIENT_ID</code> and
    <code>\$OAUTH2_CLIENT_ID</code> before proceeding.
  <p>
END;
} else {
  // If the user hasn't authorized the app, initiate the OAuth flow
  $state = mt_rand();
  $client->setState($state);
  $_SESSION['state'] = $state;

  $authUrl = $client->createAuthUrl();
  $htmlBody = <<<END
  <h3>Authorization Required</h3>
  <p>You need to <a href="$authUrl">authorize access</a> before proceeding.<p>
END;
}


/**
 * Creates a reporting job. (jobs.create)
 *
 * @param Google_Service_YouTubereporting $youtubeReporting YouTube Reporting service object.
 * @param string $reportTypeId Id of the job's report type.
 * @param string $name name of the job.
 * @param $htmlBody - html body.
 */
function createReportingJob(Google_Service_YouTubeReporting $youtubeReporting, $reportTypeId,
    $name, &$htmlBody) {
  # Create a reporting job with a name and a report type id.
  $reportingJob = new Google_Service_YouTubeReporting_Job();
  $reportingJob->setReportTypeId($reportTypeId);
  $reportingJob->setName($name);

  // Call the YouTube Reporting API's jobs.create method to create a job.
  $jobCreateResponse = $youtubeReporting->jobs->create($reportingJob);

  $htmlBody .= "<h2>Created reporting job</h2><ul>";
  $htmlBody .= sprintf('<li>"%s" for reporting type "%s" at "%s"</li>',
      $jobCreateResponse['name'], $jobCreateResponse['reportTypeId'], $jobCreateResponse['createTime']);
  $htmlBody .= '</ul>';
}


/**
 * Returns a list of report types. (reportTypes.listReportTypes)
 *
 * @param Google_Service_YouTubereporting $youtubeReporting YouTube Reporting service object.
 * @param $htmlBody - html body.
 */
function listReportTypes(Google_Service_YouTubeReporting $youtubeReporting, &$htmlBody) {
  // Call the YouTube Reporting API's reportTypes.list method to retrieve report types.
  $reportTypes = $youtubeReporting->reportTypes->listReportTypes();

  $htmlBody .= "<h3>Report Types</h3><ul>";
  foreach ($reportTypes as $reportType) {
    $htmlBody .= sprintf('<li>id: "%s", name: "%s"</li>', $reportType['id'], $reportType['name']);
  }
  $htmlBody .= '</ul>';

  return $reportTypes;
}
?>

<!doctype html>
<html>
<head>
<title>Create a reporting job</title>
</head>
<body>
  <form method="GET">
    <div>
      Job Name: <input type="text" id="jobName" name="jobName" placeholder="Enter Job Name">
    </div>
    <br>
    <div>
      Report Type Id: <input type="text" id="reportTypeId" name="reportTypeId" placeholder="Enter Report Type Id">
    </div>
    <br>
    <input type="submit" value="Create!">
  </form>
  <?=$htmlBody?>
</body>
</html>
create_reporting_job.php

उदाहरण 2: रिपोर्ट वापस लाना

कोड सैंपल, रिपोर्टिंग जॉब की सूची वापस पाने के लिए jobs.list तरीके को कॉल करता है. इसके बाद, यह reports.list पैरामीटर को किसी खास जॉब आईडी पर सेट करके, jobId तरीके को कॉल करता है. इससे उस जॉब से बनाई गई रिपोर्ट वापस मिलती हैं. आखिर में, सैंपल हर रिपोर्ट के लिए डाउनलोड यूआरएल प्रिंट करता है.

<?php

/**
 * This sample supports the following use cases:
 *
 * 1. Retrieve reporting jobs by content owner:
 *    Ex: php retrieve_reports.php  --contentOwner=="CONTENT_OWNER_ID"
 *    Ex: php retrieve_reports.php  --contentOwner=="CONTENT_OWNER_ID" --includeSystemManaged==True
 * 2. Retrieving list of downloadable reports for a particular job:
 *    Ex: php retrieve_reports.php  --contentOwner=="CONTENT_OWNER_ID" --jobId="JOB_ID"
 * 3. Download a report:
 *    Ex: php retrieve_reports.php  --contentOwner=="CONTENT_OWNER_ID" --downloadUrl="DOWNLOAD_URL" --outputFile="report.txt"
 */

/**
 * Library Requirements
 *
 * 1. Install composer (https://getcomposer.org)
 * 2. On the command line, change to this directory (api-samples/php)
 * 3. Require the google/apiclient library
 *    $ composer require google/apiclient:~2.0
 */
if (!file_exists(__DIR__ . '/vendor/autoload.php')) {
  throw new \Exception('please run "composer require google/apiclient:~2.2.0" in "' . __DIR__ .'"');
}

require_once __DIR__ . '/vendor/autoload.php';
session_start();


define('CREDENTIALS_PATH', '~/.credentials/youtube-php.json');

$longOptions = array(
  'contentOwner::',
  'downloadUrl::',
  'includeSystemManaged::',
  'jobId::',
  'outputFile::',
);

$options = getopt('', $longOptions);

$CONTENT_OWNER_ID = ($options['contentOwner'] ? $options['contentOwner'] : '');
$DOWNLOAD_URL = (array_key_exists('downloadUrl', $options) ?
                 $options['downloadUrl'] : '');
$INCLUDE_SYSTEM_MANAGED = (array_key_exists('includeSystemManaged', $options) ?
                           $options['includeSystemManaged'] : '');
$JOB_ID = (array_key_exists('jobId', $options) ? $options['jobId'] : '');
$OUTPUT_FILE = (array_key_exists('outputFile', $options) ?
                $options['outputFile'] : '');

/*
 * You can obtain an OAuth 2.0 client ID and client secret from the
 * {{ Google Cloud Console }} <{{ https://cloud.google.com/console }}>
 * For more information about using OAuth 2.0 to access Google APIs, please see:
 * <https://developers.google.com/youtube/v3/guides/authentication>
 * Please ensure that you have enabled the YouTube Data API for your project.
 */
function getClient() {
  $client = new Google_Client();
  $client->setAuthConfigFile('client_secrets_php.json');
  $client->addScope(
      'https://www.googleapis.com/auth/yt-analytics-monetary.readonly');
  $client->setRedirectUri('urn:ietf:wg:oauth:2.0:oob');
  $client->setAccessType('offline');

  // Load previously authorized credentials from a file.
  $credentialsPath = expandHomeDirectory(CREDENTIALS_PATH);
  if (file_exists($credentialsPath)) {
    $accessToken = json_decode(file_get_contents($credentialsPath), true);
  } else {
    // Request authorization from the user.
    $authUrl = $client->createAuthUrl();
    printf('Open the following link in your browser:\n%s\n', $authUrl);
    print 'Enter verification code: ';
    $authCode = trim(fgets(STDIN));

    // Exchange authorization code for an access token.
    $accessToken = $client->authenticate($authCode);
    $refreshToken = $client->getRefreshToken();

    // Store the credentials to disk.
    if(!file_exists(dirname($credentialsPath))) {
      mkdir(dirname($credentialsPath), 0700, true);
    }
    file_put_contents($credentialsPath, json_encode($accessToken));
    printf('Credentials saved to %s\n', $credentialsPath);

    //fclose($fp);
  }
  $client->setAccessToken($accessToken);

  // Refresh the token if it's expired.
  if ($client->isAccessTokenExpired()) {
    $client->fetchAccessTokenWithRefreshToken($client->getRefreshToken());
    file_put_contents($credentialsPath, json_encode($client->getAccessToken()));
  }

  return $client;
}

/**
 * Expands the home directory alias '~' to the full path.
 * @param string $path the path to expand.
 * @return string the expanded path.
 */
function expandHomeDirectory($path) {
  $homeDirectory = getenv('HOME');
  if (empty($homeDirectory)) {
    $homeDirectory = getenv('HOMEDRIVE') . getenv('HOMEPATH');
  }
  return str_replace('~', realpath($homeDirectory), $path);
}

/**
 * Returns a list of reporting jobs. (jobs.listJobs)
 *
 * @param Google_Service_YouTubereporting $youtubeReporting YouTube Reporting service object.
 * @param string $onBehalfOfContentOwner A content owner ID.
 */
function listReportingJobs(Google_Service_YouTubeReporting $youtubeReporting,
    $onBehalfOfContentOwner = '', $includeSystemManaged = False) {
  $reportingJobs = $youtubeReporting->jobs->listJobs(
      array('onBehalfOfContentOwner' => $onBehalfOfContentOwner,
            'includeSystemManaged' => $includeSystemManaged));
  print ('REPORTING JOBS' . PHP_EOL . '**************' . PHP_EOL);
  foreach ($reportingJobs as $job) {
    print($job['reportTypeId'] . ':' . $job['id'] . PHP_EOL);
  }
  print(PHP_EOL);
}

/**
 * Lists reports created by a specific job. (reports.listJobsReports)
 *
 * @param Google_Service_YouTubereporting $youtubeReporting YouTube Reporting service object.
 * @param string $jobId The ID of the job.
 * @param string $onBehalfOfContentOwner A content owner ID.
 */
function listReportsForJob(Google_Service_YouTubeReporting $youtubeReporting,
    $jobId, $onBehalfOfContentOwner = '') {
  $reports = $youtubeReporting->jobs_reports->listJobsReports($jobId,
      array('onBehalfOfContentOwner' => $onBehalfOfContentOwner));
  print ('DOWNLOADABLE REPORTS' . PHP_EOL . '********************' . PHP_EOL);
  foreach ($reports['reports'] as $report) {
    print('Created: ' . date('d M Y', strtotime($report['createTime'])) .
          ' (' . date('d M Y', strtotime($report['startTime'])) .
          ' to ' . date('d M Y', strtotime($report['endTime'])) . ')' .
          PHP_EOL .  '    ' . $report['downloadUrl'] . PHP_EOL . PHP_EOL);
  }
}

/**
 * Download the report specified by the URL. (media.download)
 *
 * @param Google_Service_YouTubereporting $youtubeReporting YouTube Reporting service object.
 * @param string $reportUrl The URL of the report to be downloaded.
 * @param string $outputFile The file to write the report to locally.
 * @param $htmlBody - html body.
 */
function downloadReport(Google_Service_YouTubeReporting $youtubeReporting,
    $reportUrl, $outputFile) {
  $client = $youtubeReporting->getClient();
  // Setting the defer flag to true tells the client to return a request that
  // can be called with ->execute(); instead of making the API call immediately.
  $client->setDefer(true);

  // Call YouTube Reporting API's media.download method to download a report.
  $request = $youtubeReporting->media->download('', array('alt' => 'media'));
  $request = $request->withUri(new \GuzzleHttp\Psr7\Uri($reportUrl));
  $responseBody = '';
  try {
    $response = $client->execute($request);
    $responseBody = $response->getBody();
  } catch (Google_Service_Exception $e) {
    $responseBody = $e->getTrace()[0]['args'][0]->getResponseBody();
  }
  file_put_contents($outputFile, $responseBody);
  $client->setDefer(false);
}

// Define an object that will be used to make all API requests.
$client = getClient();
// YouTube Reporting object used to make YouTube Reporting API requests.
$youtubeReporting = new Google_Service_YouTubeReporting($client);

if ($CONTENT_OWNER_ID) {
  if (!$DOWNLOAD_URL && !$JOB_ID) {
    listReportingJobs($youtubeReporting, $CONTENT_OWNER_ID,
                      $INCLUDE_SYSTEM_MANAGED);
  } else if ($JOB_ID) {
    listReportsForJob($youtubeReporting, $JOB_ID, $CONTENT_OWNER_ID);
  } else if ($DOWNLOAD_URL && $OUTPUT_FILE) {
    downloadReport($youtubeReporting, $DOWNLOAD_URL, $OUTPUT_FILE);
  }
}

?>
retrieve_reports.php

Python

यहां दिए गए सैंपल में, Python क्लाइंट लाइब्रेरी का इस्तेमाल किया गया है.

• उदाहरण 1: रिपोर्टिंग जॉब बनाना
• उदाहरण 2: रिपोर्ट वापस लाना

उदाहरण 1: रिपोर्टिंग जॉब बनाना

यहां दिया गया कोड सैंपल, उपलब्ध रिपोर्ट टाइप की सूची पाने के लिए reportTypes.list तरीके को कॉल करता है. इसके बाद, यह नई रिपोर्टिंग जॉब बनाने के लिए jobs.create तरीके को कॉल करता है.

#!/usr/bin/python

# Create a reporting job for the authenticated user's channel or
# for a content owner that the user's account is linked to.
# Usage example:
# python create_reporting_job.py --name='<name>'
# python create_reporting_job.py --content-owner='<CONTENT OWNER ID>'
# python create_reporting_job.py --content-owner='<CONTENT_OWNER_ID>' --report-type='<REPORT_TYPE_ID>' --name='<REPORT_NAME>'

import argparse
import os

import google.oauth2.credentials
import google_auth_oauthlib.flow
from googleapiclient.discovery import build
from googleapiclient.errors import HttpError
from google_auth_oauthlib.flow import InstalledAppFlow


# The CLIENT_SECRETS_FILE variable specifies the name of a file that contains

# the OAuth 2.0 information for this application, including its client_id and
# client_secret. You can acquire an OAuth 2.0 client ID and client secret from
# the {{ Google Cloud Console }} at
# {{ https://cloud.google.com/console }}.
# Please ensure that you have enabled the YouTube Data API for your project.
# For more information about using OAuth2 to access the YouTube Data API, see:
#   https://developers.google.com/youtube/v3/guides/authentication
# For more information about the client_secrets.json file format, see:
#   https://developers.google.com/api-client-library/python/guide/aaa_client_secrets
CLIENT_SECRETS_FILE = 'client_secret.json'

# This OAuth 2.0 access scope allows for read access to the YouTube Analytics monetary reports for
# authenticated user's account. Any request that retrieves earnings or ad performance metrics must
# use this scope.
SCOPES = ['https://www.googleapis.com/auth/yt-analytics-monetary.readonly']
API_SERVICE_NAME = 'youtubereporting'
API_VERSION = 'v1'

# Authorize the request and store authorization credentials.
def get_authenticated_service():
  flow = InstalledAppFlow.from_client_secrets_file(CLIENT_SECRETS_FILE, SCOPES)
  credentials = flow.run_console()
  return build(API_SERVICE_NAME, API_VERSION, credentials = credentials)

# Remove keyword arguments that are not set.
def remove_empty_kwargs(**kwargs):
  good_kwargs = {}
  if kwargs is not None:
    for key, value in kwargs.iteritems():
      if value:
        good_kwargs[key] = value
  return good_kwargs

# Call the YouTube Reporting API's reportTypes.list method to retrieve report types.
def list_report_types(youtube_reporting, **kwargs):
  # Provide keyword arguments that have values as request parameters.
  kwargs = remove_empty_kwargs(**kwargs)
  results = youtube_reporting.reportTypes().list(**kwargs).execute()
  reportTypes = results['reportTypes']

  if 'reportTypes' in results and results['reportTypes']:
    reportTypes = results['reportTypes']
    for reportType in reportTypes:
      print 'Report type id: %s\n name: %s\n' % (reportType['id'], reportType['name'])
  else:
    print 'No report types found'
    return False

  return True


# Call the YouTube Reporting API's jobs.create method to create a job.
def create_reporting_job(youtube_reporting, report_type_id, **kwargs):
  # Provide keyword arguments that have values as request parameters.
  kwargs = remove_empty_kwargs(**kwargs)

  reporting_job = youtube_reporting.jobs().create(
    body=dict(
      reportTypeId=args.report_type,
      name=args.name
    ),
    **kwargs
  ).execute()

  print ('Reporting job "%s" created for reporting type "%s" at "%s"'
         % (reporting_job['name'], reporting_job['reportTypeId'],
             reporting_job['createTime']))


# Prompt the user to enter a report type id for the job. Then return the id.
def get_report_type_id_from_user():
  report_type_id = raw_input('Please enter the reportTypeId for the job: ')
  print ('You chose "%s" as the report type Id for the job.' % report_type_id)
  return report_type_id

# Prompt the user to set a job name
def prompt_user_to_set_job_name():
  job_name = raw_input('Please set a name for the job: ')
  print ('Great! "%s" is a memorable name for this job.' % job_name)
  return job_name


if __name__ == '__main__':
  parser = argparse.ArgumentParser()
  # The 'name' option specifies the name that will be used for the reporting job.
  parser.add_argument('--content-owner', default='',
      help='ID of content owner for which you are retrieving jobs and reports.')
  parser.add_argument('--include-system-managed', default=False,
      help='Whether the API response should include system-managed reports')
  parser.add_argument('--name', default='',
    help='Name for the reporting job. The script prompts you to set a name ' +
         'for the job if you do not provide one using this argument.')
  parser.add_argument('--report-type', default=None,
    help='The type of report for which you are creating a job.')
  args = parser.parse_args()

  youtube_reporting = get_authenticated_service()

  try:
    # Prompt user to select report type if they didn't set one on command line.
    if not args.report_type:
      if list_report_types(youtube_reporting,
                           onBehalfOfContentOwner=args.content_owner,
                           includeSystemManaged=args.include_system_managed):
        args.report_type = get_report_type_id_from_user()
    # Prompt user to set job name if not set on command line.
    if not args.name:
      args.name = prompt_user_to_set_job_name()
    # Create the job.
    if args.report_type:
      create_reporting_job(youtube_reporting,
                           args,
                           onBehalfOfContentOwner=args.content_owner)
  except HttpError, e:
    print 'An HTTP error %d occurred:\n%s' % (e.resp.status, e.content)
create_reporting_job.py

उदाहरण 2: रिपोर्ट वापस लाना

कोड सैंपल, रिपोर्टिंग जॉब की सूची वापस पाने के लिए jobs.list तरीके को कॉल करता है. इसके बाद, यह reports.list पैरामीटर को किसी खास जॉब आईडी पर सेट करके, jobId तरीके को कॉल करता है. इससे उस जॉब से बनाई गई रिपोर्ट वापस मिलती हैं. आखिर में, सैंपल हर रिपोर्ट के लिए डाउनलोड यूआरएल प्रिंट करता है.

#!/usr/bin/python

###
#
# This script retrieves YouTube Reporting API reports. Use cases:
# 1. If you specify a report URL, the script downloads that report.
# 2. Otherwise, if you specify a job ID, the script retrieves a list of
#    available reports for that job and prompts you to select a report.
#    Then it retrieves that report as in case 1.
# 3. Otherwise, the list retrieves a list of jobs for the user or,
#    if specified, the content owner that the user is acting on behalf of.
#    Then it prompts the user to select a job, and then executes case 2 and
#    then case 1.
# Usage examples:
# python retrieve_reports.py --content_owner_id=<CONTENT_OWNER_ID> --local_file=<LOCAL_FILE>
# python retrieve_reports.py --content_owner_id=<CONTENT_OWNER_ID> --job_id=<JOB_ID> --local_file=<LOCAL_FILE>
# python retrieve_reports.py --content_owner_id=<CONTENT_OWNER_ID> --report_url=<REPORT_URL> --local_file=<LOCAL_FILE>
#
###

import argparse
import os

import google.oauth2.credentials
import google_auth_oauthlib.flow
from googleapiclient.discovery import build
from googleapiclient.errors import HttpError
from googleapiclient.http import MediaIoBaseDownload
from google_auth_oauthlib.flow import InstalledAppFlow
from io import FileIO


# The CLIENT_SECRETS_FILE variable specifies the name of a file that contains
# the OAuth 2.0 information for this application, including its client_id and
# client_secret. You can acquire an OAuth 2.0 client ID and client secret from
# the {{ Google Cloud Console }} at
# {{ https://cloud.google.com/console }}.
# Please ensure that you have enabled the YouTube Data API for your project.
# For more information about using OAuth2 to access the YouTube Data API, see:
#   https://developers.google.com/youtube/v3/guides/authentication
# For more information about the client_secrets.json file format, see:
#   https://developers.google.com/api-client-library/python/guide/aaa_client_secrets
CLIENT_SECRETS_FILE = 'client_secret.json'

# This OAuth 2.0 access scope allows for read access to YouTube Analytics
# monetary reports for the authenticated user's account. Any request that
# retrieves earnings or ad performance metrics must use this scope.
SCOPES = ['https://www.googleapis.com/auth/yt-analytics-monetary.readonly']
API_SERVICE_NAME = 'youtubereporting'
API_VERSION = 'v1'

# Authorize the request and store authorization credentials.
def get_authenticated_service():
  flow = InstalledAppFlow.from_client_secrets_file(CLIENT_SECRETS_FILE, SCOPES)
  credentials = flow.run_console()
  return build(API_SERVICE_NAME, API_VERSION, credentials = credentials)

# Remove keyword arguments that are not set.
def remove_empty_kwargs(**kwargs):
  good_kwargs = {}
  if kwargs is not None:
    for key, value in kwargs.iteritems():
      if value:
        good_kwargs[key] = value
  return good_kwargs

# Call the YouTube Reporting API's jobs.list method to retrieve reporting jobs.
def list_reporting_jobs(youtube_reporting, **kwargs):
  # Only include the onBehalfOfContentOwner keyword argument if the user
  # set a value for the --content_owner argument.
  kwargs = remove_empty_kwargs(**kwargs)

  # Retrieve the reporting jobs for the user (or content owner).
  results = youtube_reporting.jobs().list(**kwargs).execute()

  if 'jobs' in results and results['jobs']:
    jobs = results['jobs']
    for job in jobs:
      print ('Reporting job id: %s\n name: %s\n for reporting type: %s\n'
        % (job['id'], job['name'], job['reportTypeId']))
  else:
    print 'No jobs found'
    return False

  return True

# Call the YouTube Reporting API's reports.list method to retrieve reports created by a job.
def retrieve_reports(youtube_reporting, **kwargs):
  # Only include the onBehalfOfContentOwner keyword argument if the user
  # set a value for the --content_owner argument.
  kwargs = remove_empty_kwargs(**kwargs)

  # Retrieve available reports for the selected job.
  results = youtube_reporting.jobs().reports().list(
    **kwargs
  ).execute()

  if 'reports' in results and results['reports']:
    reports = results['reports']
    for report in reports:
      print ('Report dates: %s to %s\n       download URL: %s\n'
        % (report['startTime'], report['endTime'], report['downloadUrl']))


# Call the YouTube Reporting API's media.download method to download the report.
def download_report(youtube_reporting, report_url, local_file):
  request = youtube_reporting.media().download(
    resourceName=' '
  )
  request.uri = report_url
  fh = FileIO(local_file, mode='wb')
  # Stream/download the report in a single request.
  downloader = MediaIoBaseDownload(fh, request, chunksize=-1)

  done = False
  while done is False:
    status, done = downloader.next_chunk()
    if status:
      print 'Download %d%%.' % int(status.progress() * 100)
  print 'Download Complete!'


# Prompt the user to select a job and return the specified ID.
def get_job_id_from_user():
  job_id = raw_input('Please enter the job id for the report retrieval: ')
  print ('You chose "%s" as the job Id for the report retrieval.' % job_id)
  return job_id

# Prompt the user to select a report URL and return the specified URL.
def get_report_url_from_user():
  report_url = raw_input('Please enter the report URL to download: ')
  print ('You chose "%s" to download.' % report_url)
  return report_url

if __name__ == '__main__':
  parser = argparse.ArgumentParser()
  parser.add_argument('--content_owner', default='',
      help='ID of content owner for which you are retrieving jobs and reports')
  parser.add_argument('--job_id', default=None,
      help='ID of the job for which you are retrieving reports. If not ' +
           'provided AND report_url is also not provided, then the script ' +
           'calls jobs.list() to retrieve a list of jobs.')
  parser.add_argument('--report_url', default=None,
      help='URL of the report to retrieve. If not specified, the script ' +
           'calls reports.list() to retrieve a list of reports for the ' +
           'selected job.')
  parser.add_argument('--local_file', default='yt_report.txt',
      help='The name of the local file where the downloaded report will be written.')
  args = parser.parse_args()

  youtube_reporting = get_authenticated_service()
  try:
    # If the user has not specified a job ID or report URL, retrieve a list
    # of available jobs and prompt the user to select one.
    if not args.job_id and not args.report_url:
      if list_reporting_jobs(youtube_reporting,
                             onBehalfOfContentOwner=args.content_owner):
        args.job_id = get_job_id_from_user()

    # If the user has not specified a report URL, retrieve a list of reports
    # available for the specified job and prompt the user to select one.
    if args.job_id and not args.report_url:
      retrieve_reports(youtube_reporting,
                       jobId=args.job_id,
                       onBehalfOfContentOwner=args.content_owner)
      args.report_url = get_report_url_from_user()

    # Download the selected report.
    if args.report_url:
      download_report(youtube_reporting, args.report_url, args.local_file)
  except HttpError, e:
    print 'An HTTP error %d occurred:\n%s' % (e.resp.status, e.content)
retrieve_reports.py