- एचटीटीपी अनुरोध
- अनुरोध का मुख्य हिस्सा
- जवाब का मुख्य हिस्सा
- अनुमति पाने के लिंक
- ParentEntityFilter
- FileType
- FilterType
- IdFilter
- InventorySourceFilter
- इसे आज़माएं!
SDF डाउनलोड टास्क बनाता है. Operation
दिखाता है.
एसडीएफ़ डाउनलोड टास्क, लंबे समय तक चलने वाला और एसिंक्रोनस ऑपरेशन है. इस ऑपरेशन का metadata
टाइप SdfDownloadTaskMetadata
है. अगर अनुरोध पूरा हो जाता है, तो response
कार्रवाई का टाइप SdfDownloadTask
होता है. जवाब में, डाउनलोड की गई फ़ाइलें शामिल नहीं होंगी. इन्हें media.download
की मदद से वापस पाया जा सकता है. sdfdownloadtask.operations.get
की मदद से, ऑपरेशन की स्थिति देखी जा सकती है.
error.message
में कोई भी गड़बड़ी देखी जा सकती है. ध्यान दें कि error.details
की वैल्यू खाली होनी चाहिए.
एचटीटीपी अनुरोध
POST https://displayvideo.googleapis.com/v3/sdfdownloadtasks
यूआरएल में gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल किया गया है.
अनुरोध का मुख्य भाग
अनुरोध के मुख्य भाग में, नीचे दिए गए स्ट्रक्चर वाला डेटा होता है:
JSON के काेड में दिखाना |
---|
{ "version": enum ( |
फ़ील्ड | |
---|---|
version |
ज़रूरी है. डाउनलोड की गई फ़ाइल का SDF वर्शन. अगर इसे |
यूनियन फ़ील्ड root_id . ज़रूरी है. रूट आईडी से, वीडियो डाउनलोड करने के अनुरोध का कॉन्टेक्स्ट तय होता है. एक फ़ील्ड सेट होना चाहिए. root_id इनमें से कोई एक हो सकता है: |
|
partnerId |
SDF डाउनलोड करने के लिए पार्टनर का आईडी. |
advertiserId |
विज्ञापन देने वाले उस व्यक्ति या कंपनी का आईडी जिसके लिए एसडीएफ़ डाउनलोड करना है. |
यूनियन फ़ील्ड filtering_option . ज़रूरी है. डाउनलोड करने के लिए इकाई के टाइप और रेंज तय करने वाले विकल्प. एक फ़ील्ड सेट होना चाहिए. filtering_option इनमें से कोई एक हो सकता है: |
|
parentEntityFilter |
चुने गए फ़ाइल टाइप के हिसाब से फ़िल्टर करता है. हर फ़ाइल में मौजूद इकाइयों को, फ़िल्टर की गई इकाइयों के चुने गए सेट के हिसाब से फ़िल्टर किया जाता है. फ़िल्टर की इकाइयां, चुने गए फ़ाइल टाइप के टाइप या पैरंट टाइप की होनी चाहिए. |
idFilter |
इकाइयों को उनके इकाई आईडी के हिसाब से फ़िल्टर करता है. |
inventorySourceFilter |
इन्वेंट्री सोर्स को उनके आईडी के हिसाब से फ़िल्टर करता है. |
जवाब का मुख्य भाग
कामयाब रहने पर, जवाब के मुख्य हिस्से में Operation
का नया इंस्टेंस शामिल किया जाता है.
अनुमति के दायरे
नीचे दिए गए OAuth के लिंक की ज़रूरत हाेती है:
https://www.googleapis.com/auth/display-video
ज़्यादा जानकारी के लिए, OAuth 2.0 Overview देखें.
ParentEntityFilter
फ़िल्टर करने का एक विकल्प, जो फ़िल्टर की गई इकाइयों के चुने गए सेट से जुड़े चुने गए फ़ाइल टाइप पर फ़िल्टर करता है.
JSON के काेड में दिखाना |
---|
{ "fileType": [ enum ( |
फ़ील्ड | |
---|---|
fileType[] |
ज़रूरी है. फ़ाइल के टाइप, जो वापस किए जाएंगे. |
filterType |
ज़रूरी है. फ़ेच की गई इकाइयों को फ़िल्टर करने के लिए इस्तेमाल किया जाने वाला फ़िल्टर टाइप. |
filterIds[] |
तय किए गए फ़िल्टर टाइप के आईडी. इसका इस्तेमाल, फ़ेच की जाने वाली इकाइयों को फ़िल्टर करने के लिए किया जाता है. अगर फ़िल्टर टाइप |
FileType
डाउनलोड की जा सकने वाली फ़ाइलों के टाइप.
Enums | |
---|---|
FILE_TYPE_UNSPECIFIED |
इस वर्शन में टाइप की जानकारी न होने या अज्ञात होने पर डिफ़ॉल्ट वैल्यू. |
FILE_TYPE_CAMPAIGN |
कैंपेन. |
FILE_TYPE_MEDIA_PRODUCT |
मीडिया प्रॉडक्ट. |
FILE_TYPE_INSERTION_ORDER |
इंसर्शन ऑर्डर. |
FILE_TYPE_LINE_ITEM |
लाइन आइटम. |
FILE_TYPE_AD_GROUP |
YouTube विज्ञापन ग्रुप. |
FILE_TYPE_AD |
YouTube विज्ञापन. |
FILE_TYPE_LINE_ITEM_QA |
लाइन आइटम - क्वालिटी जांच का फ़ॉर्मैट. |
FILE_TYPE_AD_GROUP_QA |
YouTube विज्ञापन ग्रुप - सवाल-जवाब का फ़ॉर्मैट. |
FilterType
ऐसे संभावित टाइप जिन्हें फ़िल्टर किया जा सकता है.
Enums | |
---|---|
FILTER_TYPE_UNSPECIFIED |
इस वर्शन में टाइप की जानकारी न होने या अज्ञात होने पर डिफ़ॉल्ट वैल्यू. |
FILTER_TYPE_NONE |
अगर यह विकल्प चुना जाता है, तो डाउनलोड किए गए डेटा पर कोई फ़िल्टर लागू नहीं होगा. इसका इस्तेमाल सिर्फ़ तब किया जा सकता है, जब CreateSdfDownloadTaskRequest में कोई Advertiser तय किया गया हो. |
FILTER_TYPE_ADVERTISER_ID |
विज्ञापन देने वाले का आईडी. अगर यह विकल्प चुना जाता है, तो सभी फ़िल्टर आईडी, विज्ञापन देने वाले के ऐसे आईडी होने चाहिए जो CreateSdfDownloadTaskRequest में बताए गए Partner से जुड़े हों. |
FILTER_TYPE_CAMPAIGN_ID |
कैंपेन आईडी. अगर यह विकल्प चुना जाता है, तो सभी फ़िल्टर आईडी, कैंपेन आईडी होने चाहिए. ये आईडी, CreateSdfDownloadTaskRequest में बताए गए Advertiser या Partner से जुड़े होने चाहिए. |
FILTER_TYPE_MEDIA_PRODUCT_ID |
मीडिया प्रॉडक्ट आईडी. अगर यह विकल्प चुना जाता है, तो सभी फ़िल्टर आईडी, मीडिया प्रॉडक्ट आईडी होने चाहिए. ये आईडी, CreateSdfDownloadTaskRequest में बताए गए Advertiser या Partner से जुड़े होने चाहिए. इसका इस्तेमाल सिर्फ़ FILE_TYPE_MEDIA_PRODUCT डाउनलोड करने के लिए किया जा सकता है. |
FILTER_TYPE_INSERTION_ORDER_ID |
इंसर्शन ऑर्डर आईडी. अगर यह विकल्प चुना जाता है, तो सभी फ़िल्टर आईडी, इंसर्शन ऑर्डर आईडी होने चाहिए. ये आईडी, CreateSdfDownloadTaskRequest में बताए गए Advertiser या Partner से जुड़े होने चाहिए. इसका इस्तेमाल सिर्फ़ FILE_TYPE_INSERTION_ORDER , FILE_TYPE_LINE_ITEM , FILE_TYPE_LINE_ITEM_QA , FILE_TYPE_AD_GROUP , FILE_TYPE_AD_GROUP_QA , और FILE_TYPE_AD भाषा डाउनलोड करने के लिए किया जा सकता है. |
FILTER_TYPE_LINE_ITEM_ID |
लाइन आइटम आईडी. अगर यह विकल्प चुना जाता है, तो सभी फ़िल्टर आईडी, CreateSdfDownloadTaskRequest में बताए गए Advertiser या Partner से जुड़े लाइन आइटम आईडी होने चाहिए. इसका इस्तेमाल सिर्फ़ FILE_TYPE_LINE_ITEM , FILE_TYPE_LINE_ITEM_QA ,FILE_TYPE_AD_GROUP , FILE_TYPE_AD_GROUP_QA , और FILE_TYPE_AD डाउनलोड करने के लिए किया जा सकता है. |
IdFilter
इकाइयों को उनके इकाई आईडी के हिसाब से फ़िल्टर करने वाला विकल्प.
JSON के काेड में दिखाना |
---|
{ "campaignIds": [ string ], "mediaProductIds": [ string ], "insertionOrderIds": [ string ], "lineItemIds": [ string ], "adGroupIds": [ string ], "adGroupAdIds": [ string ], "lineItemQaIds": [ string ], "adGroupQaIds": [ string ] } |
फ़ील्ड | |
---|---|
campaignIds[] |
आईडी के हिसाब से डाउनलोड किए जाने वाले कैंपेन. सभी आईडी, |
mediaProductIds[] |
आईडी के हिसाब से डाउनलोड किए जाने वाले मीडिया प्रॉडक्ट. सभी आईडी, |
insertionOrderIds[] |
आईडी के हिसाब से डाउनलोड किए जाने वाले इंसर्शन ऑर्डर. सभी आईडी, |
lineItemIds[] |
आईडी के हिसाब से डाउनलोड किए जाने वाले लाइन आइटम. सभी आईडी, |
adGroupIds[] |
आईडी के हिसाब से डाउनलोड किए जाने वाले YouTube विज्ञापन ग्रुप. सभी आईडी, |
adGroupAdIds[] |
आईडी के हिसाब से डाउनलोड किए जाने वाले YouTube विज्ञापन. सभी आईडी, |
lineItemQaIds[] |
ज़रूरी नहीं. आईडी के हिसाब से लाइन आइटम, जिन्हें क्वालिटी जांच वाले फ़ॉर्मैट में डाउनलोड करना है. सभी आईडी, |
adGroupQaIds[] |
ज़रूरी नहीं. YouTube विज्ञापन ग्रुप, आईडी के हिसाब से, क्वालिटी एश्योरेंस (क्यूए) फ़ॉर्मैट में डाउनलोड करने के लिए. सभी आईडी, |
InventorySourceFilter
इन्वेंट्री सोर्स इकाइयों को फ़िल्टर करने के लिए फ़िल्टर करने का विकल्प.
JSON के काेड में दिखाना |
---|
{ "inventorySourceIds": [ string ] } |
फ़ील्ड | |
---|---|
inventorySourceIds[] |
आईडी के हिसाब से डाउनलोड किए जाने वाले इन्वेंट्री सोर्स. सभी आईडी, |