Reports

report रिसॉर्स, रिपोर्ट के खास इंस्टेंस की पहचान करता है. यह संसाधन उस समयावधि की पहचान करता है, जिसके लिए रिपोर्ट में डेटा और साथ ही वह यूआरएल शामिल होता है जिससे रिपोर्ट डाउनलोड की जा सकती है.

तरीके

इस टेबल में उन तरीकों के बारे में बताया गया है जो एपीआई के 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
नौकरी बनाने की तारीख और समय. प्रॉपर्टी की वैल्यू RFC3339 यूटीसी के "ज़ुलू" फ़ॉर्मैट में दी गई टाइमस्टैंप है. यह माइक्रोसेकंड के लिए सटीक होती है. उदाहरण: "2015-10-02T15:01:23.045678Z".

jobExpireTime timestamp
रिपोर्ट में शामिल किए गए काम की तारीख और समय खत्म हो गया है या उसकी समयसीमा खत्म हो गई है. प्रॉपर्टी की वैल्यू RFC3339 यूटीसी के "ज़ुलू" फ़ॉर्मैट में दी गई टाइमस्टैंप है. यह माइक्रोसेकंड के लिए सटीक होती है. उदाहरण: "2015-10-02T15:01:23.045678Z".

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

अगर आपके पास कोई ऐसा काम है जो खत्म होने की तारीख की पहचान करता है, तो आपको उस तारीख तक रिपोर्ट का अनुरोध बंद करने के लिए अपना सिस्टम अपडेट कर लेना चाहिए. कुछ मामलों में, रीप्लेसमेंट रिपोर्ट उपलब्ध हो सकती है.
downloadUrl string
वह यूआरएल जिससे रिपोर्ट डाउनलोड की जा सकती है. प्रॉपर्टी की वैल्यू में ज़्यादा से ज़्यादा 1,000 वर्ण हो सकते हैं.

रिपोर्ट को वापस पाने के लिए, इस यूआरएल पर एचटीटीपी GET का अनुरोध भेजें. अपने ऑथराइज़ेशन टोकन का इस्तेमाल, हेडर वैल्यू के तौर पर करके, Authorization एचटीटीपी अनुरोध के हेडर को सेट करें.

gzip का इस्तेमाल करना

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

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

Accept-Encoding: gzip