- एचटीटीपी अनुरोध
- अनुरोध का मुख्य हिस्सा
- जवाब का मुख्य हिस्सा
- अनुमति पाने के लिंक
- ParentEntityFilter
- FileType
- FilterType
- IdFilter
- InventorySourceFilter
- इसे आज़माएं!
एसडीएफ़ डाउनलोड करने का टास्क बनाता है. यह फ़ंक्शन Operation
दिखाता है.
एसडीएफ़ डाउनलोड टास्क, लंबे समय तक चलने वाला एसिंक्रोनस प्रोसेस है. इस कार्रवाई का metadata
टाइप SdfDownloadTaskMetadata
है. अगर अनुरोध पूरा हो जाता है, तो response
तरह की कार्रवाई SdfDownloadTask
होगी. जवाब में वे डाउनलोड फ़ाइलें शामिल नहीं होंगी जिन्हें media.download
के साथ वापस पाना ज़रूरी है.
sdfdownloadtasks.operations.get
से कार्रवाई की स्थिति का पता लगाया जा सकता है.
कोई भी गड़बड़ी, error.message
में देखी जा सकती है. ध्यान दें कि error.details
खाली होना चाहिए.
एचटीटीपी अनुरोध
POST https://displayvideo.googleapis.com/v4/sdfdownloadtasks
यूआरएल में gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल किया गया है.
अनुरोध का मुख्य भाग
अनुरोध के मुख्य भाग में, नीचे दिए गए स्ट्रक्चर वाला डेटा होता है:
JSON के काेड में दिखाना |
---|
{ "version": enum ( |
फ़ील्ड | |
---|---|
version |
ज़रूरी है. डाउनलोड की गई फ़ाइल का एसडीएफ़ वर्शन. अगर यह नीति |
यूनियन फ़ील्ड root_id . ज़रूरी है. रूट आईडी, डाउनलोड अनुरोध का संदर्भ तय करता है. सिर्फ़ एक फ़ील्ड सेट करना ज़रूरी है. root_id इनमें से कोई एक हो सकता है: |
|
partnerId |
उस पार्टनर का आईडी जिसके लिए एसडीएफ़ डाउनलोड करना है. |
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 |
लाइन आइटम - QA फ़ॉर्मैट. |
FILE_TYPE_AD_GROUP_QA |
YouTube विज्ञापन ग्रुप - QA फ़ॉर्मैट. |
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[] |
ज़रूरी नहीं. QA फ़ॉर्मैट में डाउनलोड करने के लिए, आईडी के हिसाब से लाइन आइटम. सभी आईडी, |
adGroupQaIds[] |
ज़रूरी नहीं. QA फ़ॉर्मैट में डाउनलोड करने के लिए, आईडी के हिसाब से YouTube विज्ञापन ग्रुप. सभी आईडी, |
InventorySourceFilter
इन्वेंट्री सोर्स की इकाइयों को फ़िल्टर करने के लिए, फ़िल्टर करने का एक विकल्प.
JSON के काेड में दिखाना |
---|
{ "inventorySourceIds": [ string ] } |
फ़ील्ड | |
---|---|
inventorySourceIds[] |
आईडी के हिसाब से डाउनलोड करने के लिए, इन्वेंट्री सोर्स. सभी आईडी, |