report संसाधन, रिपोर्ट के खास इंस्टेंस की पहचान करता है. संसाधन उस समयावधि की पहचान करता है जिसके लिए रिपोर्ट में डेटा होता है और साथ ही वह URL भी होता है, जिससे रिपोर्ट डाउनलोड की जा सकती है.
तरीके
इस टेबल में उन तरीकों के बारे में बताया गया है जो एपीआई, report संसाधनों के लिए इस्तेमाल करता है.
| तरीके | |
|---|---|
get |
किसी खास रिपोर्ट के लिए मेटाडेटा हासिल करता है. |
list |
यह डायलॉग बॉक्स बताए गए रिपोर्टिंग जॉब के लिए जनरेट हुई रिपोर्ट की सूची बनाता है. |
JSON संसाधन का प्रतिनिधित्व
नीचे दिया गया JSON स्ट्रक्चर, report संसाधन का फ़ॉर्मैट दिखाता है:
{
"id": string,
"jobId": string,
"startTime": timestamp,
"endTime": timestamp,
"createTime": timestamp,
"jobExpireTime": timestamp,
"downloadUrl": string
}प्रॉपर्टी
नीचे दी गई टेबल में, इस संसाधन में मौजूद प्रॉपर्टी के बारे में बताया गया है:
| प्रॉपर्टी | |
|---|---|
id |
string
वह आईडी जिसे YouTube, किसी रिपोर्ट की पहचान करने के लिए असाइन करता है. हर रिपोर्ट एक जॉब से जुड़ी होती है. हालांकि, कोई जॉब कई रिपोर्ट आईडी से जुड़ा हो सकता है. |
jobId |
string
उस जॉब का आईडी जिसने यह रिपोर्ट बनाई. |
startTime |
timestamp
रिपोर्ट में रिपोर्ट में शामिल किए गए समय का शुरुआती हिस्सा. शामिल की गई वैल्यू, आरएफ़सी3339 यूटीसी "ज़ुलु" में एक टाइमस्टैंप होती है फ़ॉर्मैट, माइक्रोसेकंड में सटीक. उदाहरण: "2015-10-02T15:01:23.045678Z". |
endTime |
timestamp
रिपोर्ट में दी गई समयावधि का खत्म होना. खास वैल्यू, आरएफ़सी3339 यूटीसी "ज़ुलु" में एक टाइमस्टैंप होती है फ़ॉर्मैट, माइक्रोसेकंड में सटीक. उदाहरण: "2015-10-02T15:01:23.045678Z". |
createTime |
timestamp
जॉब बनाने की तारीख और समय. प्रॉपर्टी की वैल्यू, आरएफ़सी3339 यूटीसी "ज़ुलु" में टाइमस्टैंप होती है फ़ॉर्मैट, माइक्रोसेकंड में सटीक. उदाहरण: "2015-10-02T15:01:23.045678Z". |
jobExpireTime |
timestamp
रिपोर्ट से जुड़ी जॉब की तारीख और समय या तो खत्म हो गया है या उसकी समयसीमा खत्म हो जाएगी. प्रॉपर्टी की वैल्यू, आरएफ़सी3339 यूटीसी "ज़ुलु" में टाइमस्टैंप होती है फ़ॉर्मैट, माइक्रोसेकंड में सटीक. उदाहरण: "2015-10-02T15:01:23.045678Z".इस प्रॉपर्टी की वैल्यू तब होती है, जब रिपोर्ट के जॉब से जुड़ा रिपोर्ट टाइप अब काम नहीं करता या उस जॉब के लिए जनरेट की गई रिपोर्ट लंबे समय से डाउनलोड नहीं की गई हों. इस वैल्यू में वह तारीख होती है जिसके बाद YouTube, इस जॉब के लिए नई रिपोर्ट जनरेट नहीं करेगा. अगर आपके पास कोई ऐसा जॉब है जो खत्म होने की तारीख के बारे में है, तो आपको अपने सिस्टम को अपडेट करना चाहिए. इससे आपको उस तारीख तक रिपोर्ट का अनुरोध नहीं करना चाहिए. कुछ मामलों में, बदलाव की रिपोर्ट उपलब्ध हो सकती है. |
downloadUrl |
string
वह यूआरएल जहां से रिपोर्ट डाउनलोड की जा सकती है. प्रॉपर्टी की वैल्यू, ज़्यादा से ज़्यादा 1,000 वर्णों की हो सकती है.रिपोर्ट फिर से पाने के लिए, इस यूआरएल को एचटीटीपी GET का अनुरोध भेजें. अनुरोध में, हेडर वैल्यू के तौर पर अनुमति वाले टोकन का इस्तेमाल करके, Authorization एचटीटीपी अनुरोध का हेडर सेट करें.
gzip का इस्तेमाल करना डाउनलोड के अनुरोधों पर gzip कंप्रेशन चालू करके, रिपोर्ट डाउनलोड करने के लिए ज़रूरी बैंडविड्थ को कम किया जा सकता है. हालांकि, आपके ऐप्लिकेशन को एपीआई के रिस्पॉन्स को कंप्रेस करने के लिए ज़्यादा सीपीयू समय की ज़रूरत होगी. हालांकि, कम नेटवर्क संसाधनों के इस्तेमाल का फ़ायदा, आम तौर पर इस लागत से ज़्यादा होता है. gzip-कोड में बदला गया जवाब पाने के लिए, Accept-Encoding: gzip |