- एचटीटीपी अनुरोध
- अनुरोध का मुख्य हिस्सा
- जवाब का मुख्य हिस्सा
- अनुमति पाने के लिंक
- ParentEntityFilter
- FileType
- FilterType
- IdFilter
- InventorySourceFilter
- इसे आज़माएं!
एसडीएफ़ डाउनलोड करने का टास्क बनाता है. Operation
लौटाता है.
एसडीएफ़ डाउनलोड टास्क, लंबे समय तक चलने वाला एसिंक्रोनस ऑपरेशन है. इस कार्रवाई का metadata
टाइप SdfDownloadTaskMetadata
है. अगर अनुरोध पूरा हो जाता है, तो कार्रवाई का response
टाइप SdfDownloadTask
होगा. जवाब में, डाउनलोड की गई वे फ़ाइलें शामिल नहीं होंगी जिन्हें media.download
के साथ वापस पाना ज़रूरी है. कार्रवाई की स्थिति को sdfdownloadtask.operations.get
की मदद से फिर से हासिल किया जा सकता है.
error.message
में जाकर, कोई भी गड़बड़ी देखी जा सकती है. ध्यान दें कि error.details
खाली होना चाहिए.
एचटीटीपी अनुरोध
POST https://displayvideo.googleapis.com/v1/sdfdownloadtasks
यूआरएल, gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.
अनुरोध का मुख्य भाग
अनुरोध के मुख्य हिस्से में इस तरह का डेटा शामिल होता है:
जेएसओएन के काेड में दिखाना |
---|
{ "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 की खास जानकारी देखें.
ParentEntityFilter
फ़िल्टर करने का यह विकल्प, फ़िल्टर इकाइयों के चुने गए सेट से जुड़ी चुनी गई फ़ाइल टाइप को फ़िल्टर करता है.
जेएसओएन के काेड में दिखाना |
---|
{ "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 विज्ञापन. |
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_AD_GROUP , और FILE_TYPE_AD को डाउनलोड करने के लिए किया जा सकता है. |
FILTER_TYPE_LINE_ITEM_ID |
लाइन आइटम आईडी. अगर चुना गया है, तो सभी फ़िल्टर आईडी, लाइन आइटम के ऐसे आईडी होने चाहिए जो CreateSdfDownloadTaskRequest में दिए गए Advertiser या Partner से जुड़े हों. इसका इस्तेमाल सिर्फ़ FILE_TYPE_LINE_ITEM , FILE_TYPE_AD_GROUP , और FILE_TYPE_AD डाउनलोड करने के लिए किया जा सकता है. |
IdFilter
यह फ़िल्टर करने का एक विकल्प है, जो इकाइयों को उनके इकाई आईडी के हिसाब से फ़िल्टर करता है.
जेएसओएन के काेड में दिखाना |
---|
{ "campaignIds": [ string ], "mediaProductIds": [ string ], "insertionOrderIds": [ string ], "lineItemIds": [ string ], "adGroupIds": [ string ], "adGroupAdIds": [ string ] } |
फ़ील्ड | |
---|---|
campaignIds[] |
आईडी के हिसाब से डाउनलोड करने के लिए कैंपेन. सभी आईडी, |
mediaProductIds[] |
आईडी के हिसाब से डाउनलोड करने के लिए मीडिया प्रॉडक्ट. सभी आईडी, |
insertionOrderIds[] |
आईडी से डाउनलोड करने के लिए इंसर्शन ऑर्डर. सभी आईडी, |
lineItemIds[] |
आईडी से डाउनलोड करने के लिए लाइन आइटम. सभी आईडी, |
adGroupIds[] |
आईडी से डाउनलोड करने के लिए, YouTube विज्ञापन ग्रुप. सभी आईडी, |
adGroupAdIds[] |
आईडी के हिसाब से डाउनलोड करने के लिए, YouTube विज्ञापन. सभी आईडी, |
InventorySourceFilter
इन्वेंट्री सोर्स इकाइयों के हिसाब से फ़िल्टर करने का विकल्प.
जेएसओएन के काेड में दिखाना |
---|
{ "inventorySourceIds": [ string ] } |
फ़ील्ड | |
---|---|
inventorySourceIds[] |
आईडी के हिसाब से डाउनलोड किए जाने वाले इन्वेंट्री सोर्स. सभी आईडी, |