Method: sdfdownloadtasks.create

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

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

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

HTTP অনুরোধ

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

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

ইউনিয়ন ক্ষেত্র root_id . প্রয়োজন। রুট আইডি ডাউনলোড অনুরোধের প্রসঙ্গ নির্ধারণ করে। ঠিক একটি ক্ষেত্র সেট করা আবশ্যক. root_id নিম্নলিখিতগুলির মধ্যে একটি হতে পারে:
partner Id

string ( int64 format)

SDF ডাউনলোড করার জন্য অংশীদারের আইডি।

advertiser Id

string ( int64 format)

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

ইউনিয়ন ফিল্ড filtering_option । প্রয়োজন। বিকল্পগুলি যা ডাউনলোড করার জন্য সত্তার ধরন এবং ব্যাপ্তিগুলি নির্দিষ্ট করে৷ ঠিক একটি ক্ষেত্র সেট করা আবশ্যক. filtering_option নিম্নলিখিতগুলির মধ্যে একটি হতে পারে:
parent Entity Filter

object ( ParentEntityFilter )

নির্বাচিত ফাইল ধরনের ফিল্টার. প্রতিটি ফাইলের সত্তা ফিল্টার সত্তার একটি নির্বাচিত সেট দ্বারা ফিল্টার করা হয়। ফিল্টার এন্টিটি অবশ্যই একই ধরনের হতে হবে, বা নির্বাচিত ফাইল প্রকারের প্যারেন্ট টাইপ।

id Filter

object ( IdFilter )

সত্তা আইডি দ্বারা সত্তার উপর ফিল্টার।

inventory Source Filter

object ( InventorySourceFilter )

তাদের আইডি দ্বারা ইনভেন্টরি উত্সগুলিতে ফিল্টার।

প্রতিক্রিয়া শরীর

সফল হলে, রেসপন্স বডিতে Operation একটি নতুন তৈরি উদাহরণ থাকে।

অনুমোদনের সুযোগ

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

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

আরও তথ্যের জন্য, OAuth 2.0 ওভারভিউ দেখুন।

ParentEntityFilter

একটি ফিল্টারিং বিকল্প যা ফিল্টার সত্তার একটি নির্বাচিত সেটের অন্তর্ভুক্ত নির্বাচিত ফাইল প্রকারগুলিতে ফিল্টার করে।

JSON প্রতিনিধিত্ব
{
  "fileType": [
    enum (FileType)
  ],
  "filterType": enum (FilterType),
  "filterIds": [
    string
  ]
}
ক্ষেত্র
file Type[]

enum ( FileType )

প্রয়োজন। ফাইলের ধরন যা ফেরত দেওয়া হবে।

filter Type

enum ( FilterType )

প্রয়োজন। ফিল্টার টাইপ ফিল্টার করার জন্য ব্যবহার করা হয়।

filter Ids[]

string ( int64 format)

নির্দিষ্ট ফিল্টার প্রকারের আইডি। এটি আনার জন্য সত্তা ফিল্টার করতে ব্যবহৃত হয়। যদি ফিল্টারের ধরন FILTER_TYPE_NONE না হয়, অন্তত একটি আইডি অবশ্যই নির্দিষ্ট করতে হবে৷

ফাইলের প্রকার

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

Enums
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 YouTube বিজ্ঞাপন গ্রুপ - QA বিন্যাস।

ফিল্টার টাইপ

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

Enums
FILTER_TYPE_UNSPECIFIED টাইপ অনির্দিষ্ট বা এই সংস্করণে অজানা হলে ডিফল্ট মান।
FILTER_TYPE_NONE নির্বাচিত হলে, ডাউনলোডে কোনো ফিল্টার প্রয়োগ করা হবে না। শুধুমাত্র CreateSdfDownloadTaskRequestAdvertiser উল্লেখ থাকলেই ব্যবহার করা যাবে।
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
  ]
}
ক্ষেত্র
campaign Ids[]

string ( int64 format)

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

media Product Ids[]

string ( int64 format)

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

insertion Order Ids[]

string ( int64 format)

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

line Item Ids[]

string ( int64 format)

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

ad Group Ids[]

string ( int64 format)

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

ad Group Ad Ids[]

string ( int64 format)

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

line Item Qa Ids[]

string ( int64 format)

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

ad Group Qa Ids[]

string ( int64 format)

ঐচ্ছিক। QA ফর্ম্যাটে ডাউনলোড করতে ID দ্বারা YouTube বিজ্ঞাপন গোষ্ঠী। সমস্ত আইডি অবশ্যই CreateSdfDownloadTaskRequest এ উল্লেখিত একই Advertiser বা Partner অন্তর্গত।

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

ইনভেন্টরি সোর্স এন্টিটি ফিল্টার করার জন্য একটি ফিল্টারিং বিকল্প।

JSON প্রতিনিধিত্ব
{
  "inventorySourceIds": [
    string
  ]
}
ক্ষেত্র
inventory Source Ids[]

string ( int64 format)

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