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/v5/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 দেখুন।

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 Ad Group - QA format.

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)

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

mediaProductIds[]

string (int64 format)

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

insertionOrderIds[]

string (int64 format)

আইডি অনুযায়ী ডাউনলোড করার জন্য ইনসার্শন অর্ডার। সব আইডি একই Advertiser বা Partner-এর হতে হবে যা CreateSdfDownloadTaskRequest-এ উল্লেখ করা আছে।

lineItemIds[]

string (int64 format)

আইডি অনুযায়ী ডাউনলোড করার জন্য লাইন আইটেম। সব আইডি একই Advertiser বা Partner-এর হতে হবে যা CreateSdfDownloadTaskRequest-এ উল্লেখ করা আছে।

adGroupIds[]

string (int64 format)

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

adGroupAdIds[]

string (int64 format)

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

lineItemQaIds[]

string (int64 format)

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

adGroupQaIds[]

string (int64 format)

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

InventorySourceFilter

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

JSON উপস্থাপনা
{
  "inventorySourceIds": [
    string
  ]
}
ফিল্ড
inventorySourceIds[]

string (int64 format)

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