Method: sdfdownloadtasks.create

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

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

कार्रवाई की स्थिति को sdfdownloadtasks.operations.get से वापस पाया जा सकता है.

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

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

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

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

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

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

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

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "partnerId": string,
  "advertiserId": string
  // End of mutually exclusive fields.

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "parentEntityFilter": {
    object (ParentEntityFilter)
  },
  "idFilter": {
    object (IdFilter)
  },
  "inventorySourceFilter": {
    object (InventorySourceFilter)
  }
  // End of mutually exclusive fields.
}
फ़ील्ड
version

enum (SdfVersion)

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

string (int64 format)

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

string (int64 format)

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

object (ParentEntityFilter)

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

object (IdFilter)

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

object (InventorySourceFilter)

इन्वेंट्री सोर्स को उनके आईडी के हिसाब से फ़िल्टर करता है.
एक-दूसरे से अलग फ़ील्ड का आखिरी हिस्सा.

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

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

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

नीचे दिए गए OAuth अनुमति की ज़रूरत हाेती है:

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

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

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 विज्ञापन.
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[]

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 से जुड़े होने चाहिए.
lineItemQaIds[]

string (int64 format)

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

string (int64 format)

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

InventorySourceFilter

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

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

string (int64 format)

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