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

  // 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 সংস্করণ উত্তরাধিকারসূত্রে পান।

Union ফিল্ড root_id । প্রয়োজনীয়। রুট আইডি ডাউনলোড অনুরোধের প্রেক্ষাপট নির্ধারণ করে। ঠিক একটি ফিল্ড সেট করতে হবে। root_id নিম্নলিখিতগুলির মধ্যে কেবল একটি হতে পারে:
partnerId

string ( int64 format)

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

advertiserId

string ( int64 format)

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

Union field 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 .

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

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

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 YouTube বিজ্ঞাপন গ্রুপ - 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)

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

adGroupAdIds[]

string ( int64 format)

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

lineItemQaIds[]

string ( int64 format)

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

adGroupQaIds[]

string ( int64 format)

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

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

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

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

string ( int64 format)

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