- एचटीटीपी अनुरोध
- अनुरोध का मुख्य हिस्सा
- जवाब का मुख्य हिस्सा
- अनुमति पाने के लिंक
- ParentEntityFilter
- FileType
- FilterType
- IdFilter
- InventorySourceFilter
- इसे आज़माएं!
यह फ़ंक्शन, एसडीएफ़ डाउनलोड करने का टास्क बनाता है. यह 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 |
ज़रूरी है. डाउनलोड की गई फ़ाइल का एसडीएफ़ वर्शन. अगर इसे |
यूनियन फ़ील्ड 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 |
लाइन आइटम - क्वालिटी जांच वाला फ़ॉर्मैट. |
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[] |
ज़रूरी नहीं. क्वालिटी जांच वाले फ़ॉर्मैट में डाउनलोड करने के लिए, आईडी के हिसाब से लाइन आइटम. सभी आईडी, |
adGroupQaIds[] |
ज़रूरी नहीं. YouTube विज्ञापन ग्रुप, आईडी के हिसाब से, QA फ़ॉर्मैट में डाउनलोड करने के लिए. सभी आईडी, |
InventorySourceFilter
इन्वेंट्री सोर्स की इकाइयों को फ़िल्टर करने का विकल्प.
JSON के काेड में दिखाना |
---|
{ "inventorySourceIds": [ string ] } |
फ़ील्ड | |
---|---|
inventorySourceIds[] |
आईडी के हिसाब से डाउनलोड करने के लिए इन्वेंट्री के सोर्स. सभी आईडी, |