Method: sdfdownloadtasks.create

एसडीएफ़ डाउनलोड करने का टास्क बनाता है. यह फ़ंक्शन Operation दिखाता है.

एसडीएफ़ डाउनलोड टास्क, लंबे समय तक चलने वाला एसिंक्रोनस प्रोसेस है. इस कार्रवाई का metadata टाइप SdfDownloadTaskMetadata है. अगर अनुरोध पूरा हो जाता है, तो response तरह की कार्रवाई SdfDownloadTask होगी. जवाब में वे डाउनलोड फ़ाइलें शामिल नहीं होंगी जिन्हें media.download के साथ वापस पाना ज़रूरी है. sdfdownloadtask.operations.get से कार्रवाई की स्थिति पता की जा सकती है.

कोई भी गड़बड़ी, error.message में देखी जा सकती है. ध्यान दें कि error.details खाली होना चाहिए.

एचटीटीपी अनुरोध

POST https://displayvideo.googleapis.com/v1/sdfdownloadtasks

यह यूआरएल gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.

अनुरोध का मुख्य भाग

अनुरोध के मुख्य हिस्से में, यहां दिए गए स्ट्रक्चर का डेटा शामिल होता है:

JSON के काेड में दिखाना 
{
  "version": enum (SdfVersion),

  // Union field root_id can be only one of the following:
  "partnerId": string,
  "advertiserId": string
  // End of list of possible types for union field root_id.

  // Union field filtering_option can be only one of the following:
  "parentEntityFilter": {
    object (ParentEntityFilter)
  },
  "idFilter": {
    object (IdFilter)
  },
  "inventorySourceFilter": {
    object (InventorySourceFilter)
  }
  // End of list of possible types for union field filtering_option.
}
फ़ील्ड
version

enum (SdfVersion)

ज़रूरी है. डाउनलोड की गई फ़ाइल का एसडीएफ़ वर्शन. अगर यह नीति SDF_VERSION_UNSPECIFIED पर सेट की जाती है, तो यह डिफ़ॉल्ट रूप से उस वर्शन पर सेट होगी जिसकी पहचान, विज्ञापन देने वाले या पार्टनर ने root_id ने की है. जब तक कोई अन्य तरीका कॉन्फ़िगर नहीं किया जाता, तब तक विज्ञापन देने वाला अपने पार्टनर से एसडीएफ़ वर्शन इनहेरिट करता है.
यूनियन फ़ील्ड root_id. ज़रूरी है. रूट आईडी, डाउनलोड अनुरोध का संदर्भ तय करता है. सिर्फ़ एक फ़ील्ड सेट करना ज़रूरी है. root_id इनमें से सिर्फ़ एक हो सकता है:
partnerId

string (int64 format)

उस पार्टनर का आईडी जिसके लिए एसडीएफ़ डाउनलोड करना है.
advertiserId

string (int64 format)

उस विज्ञापन देने वाले का आईडी जिसके लिए एसडीएफ़ डाउनलोड करना है.
यूनियन फ़ील्ड filtering_option. ज़रूरी है. ऐसे विकल्प जो डाउनलोड किए जाने वाले इकाई के टाइप और रेंज के बारे में बताते हैं. सिर्फ़ एक फ़ील्ड सेट करना ज़रूरी है. filtering_option इनमें से सिर्फ़ एक हो सकता है:
parentEntityFilter

object (ParentEntityFilter)

चुने गए फ़ाइल टाइप पर फ़िल्टर. हर फ़ाइल में मौजूद इकाइयों को, चुनी गई फ़िल्टर इकाइयों के हिसाब से फ़िल्टर किया जाता है. फ़िल्टर इकाइयां, चुने गए फ़ाइल टाइप के टाइप या उनका पैरंट टाइप होनी चाहिए.
idFilter

object (IdFilter)

इकाइयों के आईडी के हिसाब से उनके फ़िल्टर.
inventorySourceFilter

object (InventorySourceFilter)

आईडी के हिसाब से इन्वेंट्री सोर्स पर फ़िल्टर.

जवाब का मुख्य भाग

कामयाब होने पर, जवाब के मुख्य हिस्से में Operation का नया इंस्टेंस शामिल किया जाता है.

अनुमति पाने के लिंक

नीचे दिए गए OAuth के लिंक की ज़रूरत हाेती है:

  • https://www.googleapis.com/auth/display-video

ज़्यादा जानकारी के लिए, OAuth 2.0 की खास जानकारी देखें.

ParentEntityFilter

फ़िल्टर करने का एक विकल्प, जो चुनी गई फ़िल्टर इकाइयों से जुड़े चुने गए फ़ाइल टाइप को फ़िल्टर करता है.

JSON के काेड में दिखाना 
{
  "fileType": [
    enum (FileType)
  ],
  "filterType": enum (FilterType),
  "filterIds": [
    string
  ]
}
फ़ील्ड
fileType[]

enum (FileType)

ज़रूरी है. लौटाए जाने वाले फ़ाइल टाइप.
filterType

enum (FilterType)

ज़रूरी है. फ़ेच की गई इकाइयों को फ़िल्टर करने के लिए, फ़िल्टर का टाइप इस्तेमाल किया जाता है.
filterIds[]

string (int64 format)

तय किए गए फ़िल्टर टाइप के आईडी. इसका इस्तेमाल इकाइयों को फ़ेच करने के लिए किया जाता है. अगर फ़िल्टर टाइप FILTER_TYPE_NONE नहीं है, तो कम से कम एक आईडी ज़रूर तय करें.

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

यह फ़िल्टर करने का एक विकल्प है, जो इकाइयों को उनके आईडी के हिसाब से फ़िल्टर करता है.

JSON के काेड में दिखाना 
{
  "campaignIds": [
    string
  ],
  "mediaProductIds": [
    string
  ],
  "insertionOrderIds": [
    string
  ],
  "lineItemIds": [
    string
  ],
  "adGroupIds": [
    string
  ],
  "adGroupAdIds": [
    string
  ]
}
फ़ील्ड
campaignIds[]

string (int64 format)

आईडी के हिसाब से डाउनलोड किए जाने वाले कैंपेन. सभी आईडी, CreateSdfDownloadTaskRequest में बताए गए एक ही Advertiser या Partner से जुड़े होने चाहिए.
mediaProductIds[]

string (int64 format)

आईडी से डाउनलोड करने के लिए मीडिया प्रॉडक्ट. सभी आईडी, CreateSdfDownloadTaskRequest में बताए गए एक ही Advertiser या Partner से जुड़े होने चाहिए.
insertionOrderIds[]

string (int64 format)

आईडी से डाउनलोड करने के लिए इंसर्शन ऑर्डर. सभी आईडी, CreateSdfDownloadTaskRequest में बताए गए एक ही Advertiser या Partner से जुड़े होने चाहिए.
lineItemIds[]

string (int64 format)

आईडी के हिसाब से डाउनलोड करने के लिए, लाइन आइटम. सभी आईडी, CreateSdfDownloadTaskRequest में बताए गए एक ही Advertiser या Partner से जुड़े होने चाहिए.
adGroupIds[]

string (int64 format)

आईडी के हिसाब से डाउनलोड करने के लिए, YouTube विज्ञापन ग्रुप. सभी आईडी, CreateSdfDownloadTaskRequest में बताए गए एक ही Advertiser या Partner से जुड़े होने चाहिए.
adGroupAdIds[]

string (int64 format)

आईडी से डाउनलोड करने के लिए, YouTube विज्ञापन. सभी आईडी, CreateSdfDownloadTaskRequest में बताए गए एक ही Advertiser या Partner से जुड़े होने चाहिए.

InventorySourceFilter

इन्वेंट्री सोर्स की इकाइयों को फ़िल्टर करने के लिए, फ़िल्टर करने का एक विकल्प.

JSON के काेड में दिखाना 
{
  "inventorySourceIds": [
    string
  ]
}
फ़ील्ड
inventorySourceIds[]

string (int64 format)

आईडी के हिसाब से डाउनलोड करने के लिए, इन्वेंट्री सोर्स. सभी आईडी, CreateSdfDownloadTaskRequest में बताए गए एक ही Advertiser या Partner से जुड़े होने चाहिए. चुने गए विज्ञापन देने वाले या पार्टनर के सभी इन्वेंट्री सोर्स डाउनलोड करने के लिए, फ़ील्ड को खाली छोड़ें.