Method: sdfdownloadtasks.create

একটি SDF ডাউনলোড টাস্ক তৈরি করে। একটি Operation ফেরত দেয়।

একটি SDF ডাউনলোড টাস্ক হলো একটি দীর্ঘ-চলমান, অ্যাসিঙ্ক্রোনাস অপারেশন। এই অপারেশনের metadata টাইপ হলো SdfDownloadTaskMetadata । অনুরোধটি সফল হলে, অপারেশনটির response টাইপ হয় SdfDownloadTask । রেসপন্সে ডাউনলোড ফাইলগুলো অন্তর্ভুক্ত থাকবে না, যেগুলো media.download ব্যবহার করে সংগ্রহ করতে হবে।

sdfdownloadtasks.operations.get এর মাধ্যমে অপারেশনের অবস্থা জানা যায়।

যেকোনো ত্রুটি error.message এ পাওয়া যাবে। মনে রাখবেন, error.details খালি থাকার কথা।

HTTP অনুরোধ

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

URL-টিতে 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 সংস্করণ। যদি এটি SDF_VERSION_UNSPECIFIED এ সেট করা হয়, তাহলে এটি ডিফল্টরূপে root_id দ্বারা চিহ্নিত বিজ্ঞাপনদাতা বা অংশীদারের নির্দিষ্ট করা সংস্করণটি ব্যবহার করবে। অন্যভাবে কনফিগার করা না থাকলে, একজন বিজ্ঞাপনদাতা তার অংশীদারের কাছ থেকে নিজের SDF সংস্করণটি গ্রহণ করে।

আবশ্যক। রুট আইডি ডাউনলোড অনুরোধের প্রেক্ষাপট নির্ধারণ করে। ঠিক একটি ফিল্ড অবশ্যই সেট করতে হবে। নিচে পারস্পরিকভাবে বর্জনীয় ফিল্ডগুলোর একটি তালিকা দেওয়া হলো। একটি রেসপন্সে এই ফিল্ডগুলো থেকে সর্বাধিক একটি সেট করা হবে:
partnerId

string ( int64 format)

যে পার্টনারের জন্য SDF ডাউনলোড করতে হবে, তার আইডি।

advertiserId

string ( int64 format)

যে বিজ্ঞাপনদাতার জন্য SDF ডাউনলোড করতে হবে, তার আইডি।

পারস্পরিকভাবে বর্জনশীল ক্ষেত্রসমূহের সমাপ্তি।
আবশ্যক। যে অপশনগুলো ডাউনলোড করার জন্য এনটিটি টাইপ এবং রেঞ্জ নির্দিষ্ট করে। ঠিক একটি ফিল্ড অবশ্যই সেট করতে হবে। নিচে পারস্পরিকভাবে বর্জনীয় ফিল্ডগুলোর একটি তালিকা দেওয়া হলো। একটি রেসপন্সে এই ফিল্ডগুলোর মধ্যে থেকে সর্বাধিক একটি সেট করা হবে:
parentEntityFilter

object ( ParentEntityFilter )

নির্বাচিত ফাইলের প্রকারের উপর ফিল্টার। প্রতিটি ফাইলের সত্তাগুলোকে এক সেট নির্বাচিত ফিল্টার সত্তা দ্বারা ফিল্টার করা হয়। ফিল্টার সত্তাগুলোকে অবশ্যই নির্বাচিত ফাইলের প্রকারের মতো একই প্রকারের বা তার প্যারেন্ট টাইপের হতে হবে।

idFilter

object ( IdFilter )

এনটিটি আইডি ব্যবহার করে এনটিটিগুলোকে ফিল্টার করা হয়।

inventorySourceFilter

object ( InventorySourceFilter )

ইনভেন্টরি সোর্সগুলোকে তাদের আইডি অনুযায়ী ফিল্টার করা হয়।

পারস্পরিকভাবে বর্জনশীল ক্ষেত্রসমূহের সমাপ্তি।

প্রতিক্রিয়া সংস্থা

সফল হলে, রেসপন্স বডিতে Operation এর একটি নতুন তৈরি হওয়া ইনস্ট্যান্স থাকে।

অনুমোদনের পরিধি

নিম্নলিখিত OAuth স্কোপ প্রয়োজন:

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

আরও তথ্যের জন্য, দেখুনOAuth 2.0 Overview .

প্যারেন্টএন্টিটিফিল্টার

একটি ফিল্টারিং অপশন যা নির্বাচিত ফিল্টার এনটিটি সেটের অন্তর্গত নির্দিষ্ট ফাইল টাইপগুলোর উপর ফিল্টার করে।

JSON উপস্থাপনা 
{
  "fileType": [
    enum (FileType)
  ],
  "filterType": enum (FilterType),
  "filterIds": [
    string
  ]
}
ক্ষেত্র
fileType[]

enum ( FileType )

আবশ্যক। যে ফাইল প্রকারগুলি ফেরত দেওয়া হবে।

filterType

enum ( FilterType )

আবশ্যক। প্রাপ্ত সত্তাগুলো ফিল্টার করতে ব্যবহৃত ফিল্টার প্রকার।

filterIds[]

string ( int64 format)

নির্দিষ্ট ফিল্টার টাইপের আইডিগুলো। এটি ফেচ করার জন্য এনটিটি ফিল্টার করতে ব্যবহৃত হয়। যদি ফিল্টার টাইপ FILTER_TYPE_NONE না হয়, তবে অন্তত একটি আইডি অবশ্যই উল্লেখ করতে হবে।

ফাইলের ধরণ

ডাউনলোড করা যেতে পারে এমন ফাইলের সম্ভাব্য প্রকারভেদ।

এনাম
FILE_TYPE_UNSPECIFIED এই সংস্করণে টাইপ অনির্দিষ্ট বা অজানা থাকলে এটিই ডিফল্ট মান।
FILE_TYPE_CAMPAIGN প্রচারণা।
FILE_TYPE_MEDIA_PRODUCT মিডিয়া পণ্য।
FILE_TYPE_INSERTION_ORDER সন্নিবেশের ক্রম।
FILE_TYPE_LINE_ITEM লাইন আইটেম।
FILE_TYPE_AD_GROUP ইউটিউব বিজ্ঞাপন গ্রুপ।
FILE_TYPE_AD ইউটিউব বিজ্ঞাপন।
FILE_TYPE_LINE_ITEM_QA লাইন আইটেম - QA ফরম্যাট।
FILE_TYPE_AD_GROUP_QA ইউটিউব বিজ্ঞাপন গ্রুপ - প্রশ্নোত্তর ফরম্যাট।

ফিল্টার টাইপ

যেসব সম্ভাব্য প্রকারের উপর ভিত্তি করে ফিল্টার করা যেতে পারে।

এনাম
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 ডাউনলোড করার জন্য ব্যবহার করা যাবে।

আইডিফিল্টার

একটি ফিল্টারিং অপশন যা এনটিটিগুলোকে তাদের এনটিটি আইডি অনুসারে ফিল্টার করে।

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)

আইডি দ্বারা ইউটিউব অ্যাড গ্রুপ ডাউনলোড করুন। সমস্ত আইডি অবশ্যই CreateSdfDownloadTaskRequest এ উল্লেখিত একই Advertiser বা Partner হতে হবে।

adGroupAdIds[]

string ( int64 format)

আইডি দ্বারা ইউটিউব বিজ্ঞাপন ডাউনলোড করুন। সমস্ত আইডি অবশ্যই CreateSdfDownloadTaskRequest এ উল্লেখিত একই Advertiser বা Partner হতে হবে।

lineItemQaIds[]

string ( int64 format)

ঐচ্ছিক। আইডি অনুসারে লাইন আইটেমগুলো QA ফরম্যাটে ডাউনলোড করতে হবে। সমস্ত আইডি অবশ্যই CreateSdfDownloadTaskRequest এ উল্লেখিত একই Advertiser বা Partner হতে হবে।

adGroupQaIds[]

string ( int64 format)

ঐচ্ছিক। আইডি অনুযায়ী ইউটিউব অ্যাড গ্রুপগুলো QA ফরম্যাটে ডাউনলোড করুন। সমস্ত আইডি অবশ্যই CreateSdfDownloadTaskRequest এ উল্লেখিত একই Advertiser বা Partner হতে হবে।

ইনভেন্টরিসোর্সফিল্টার

ইনভেন্টরি সোর্স এনটিটিগুলোর উপর ফিল্টার করার জন্য একটি ফিল্টারিং অপশন।

JSON উপস্থাপনা 
{
  "inventorySourceIds": [
    string
  ]
}
ক্ষেত্র
inventorySourceIds[]

string ( int64 format)

আইডি দ্বারা ডাউনলোড করার জন্য ইনভেন্টরি সোর্সসমূহ। সমস্ত আইডি অবশ্যই CreateSdfDownloadTaskRequest এ উল্লেখিত একই Advertiser বা Partner হতে হবে। নির্বাচিত বিজ্ঞাপনদাতা বা অংশীদারের জন্য সমস্ত ইনভেন্টরি সোর্স ডাউনলোড করতে এটি খালি রাখুন।