Method: sdfdownloadtasks.create

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

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

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

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

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

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

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

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

जेएसओएन के काेड में दिखाना 
{
  "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

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

जेएसओएन के काेड में दिखाना 
{
  "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 मीडिया प्रॉडक्ट 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[]

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

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

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

string (int64 format)

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