Display & Video 360 API v3 अब काम नहीं करता. v4 पर माइग्रेट करें.

इस पेज का अनुवाद Cloud Translation API से किया गया है.

Method: sdfdownloadtasks.create

एचटीटीपी अनुरोध
अनुरोध का मुख्य हिस्सा
- JSON काेड में दिखाना
जवाब का मुख्य हिस्सा
अनुमति पाने के लिंक
ParentEntityFilter
- JSON काेड में दिखाना
FileType
FilterType
IdFilter
- JSON काेड में दिखाना
InventorySourceFilter
- JSON काेड में दिखाना
इसे आज़माएं!

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

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

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

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

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

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

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

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

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

JSON के काेड में दिखाना

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),

  // 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 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[]

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 ] }

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)` ज़रूरी नहीं. क्वालिटी जांच वाले फ़ॉर्मैट में डाउनलोड करने के लिए, आईडी के हिसाब से लाइन आइटम. सभी आईडी, `CreateSdfDownloadTaskRequest` में बताए गए `Advertiser` या `Partner` से मेल खाने चाहिए.
`adGroupQaIds[]`	`string (int64 format)` ज़रूरी नहीं. YouTube विज्ञापन ग्रुप, आईडी के हिसाब से, QA फ़ॉर्मैट में डाउनलोड करने के लिए. सभी आईडी, `CreateSdfDownloadTaskRequest` में बताए गए `Advertiser` या `Partner` से मेल खाने चाहिए.

InventorySourceFilter

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

JSON के काेड में दिखाना
{ "inventorySourceIds": [ string ] }

फ़ील्ड

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

inventorySourceIds[]

string (int64 format)

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