پشتیبانی از رابط برنامه‌نویسی کاربردی نمایشگر و ویدئو ۳۶۰ نسخه ۳ به پایان رسید. به نسخه ۴ مهاجرت کنید .

این صفحه به‌وسیله ‏Cloud Translation API‏ ترجمه شده است.

Method: sdfdownloadtasks.create

درخواست HTTP
درخواست بدنه
- نمایش JSON
بدنه پاسخ
دامنه‌های مجوز
فیلتر موجودیت والدین
- نمایش JSON
نوع فایل
نوع فیلتر
فیلتر شناسه
- نمایش JSON
فیلتر منبع موجودی
- نمایش JSON
امتحانش کن!

یک وظیفه دانلود SDF ایجاد می‌کند. یک Operation برمی‌گرداند.

یک SDF Download Task یک عملیات طولانی مدت و ناهمزمان است. نوع metadata این عملیات SdfDownloadTaskMetadata است. اگر درخواست موفقیت آمیز باشد، نوع response عملیات SdfDownloadTask است. پاسخ شامل فایل‌های دانلود نخواهد بود، که باید با media.download بازیابی شوند.

وضعیت عملیات را می‌توان با sdfdownloadtasks.operations.get بازیابی کرد.

هرگونه خطایی را می‌توان در error.message یافت. توجه داشته باشید که انتظار می‌رود error.details خالی باشد.

درخواست HTTP

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

این URL از سینتکس Transcoding در 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 فایل دانلود شده. اگر روی `SDF_VERSION_UNSPECIFIED` تنظیم شود، به طور پیش‌فرض روی نسخه‌ای که توسط تبلیغ‌کننده یا شریک شناسایی شده توسط `root_id` مشخص شده است، تنظیم می‌شود. یک تبلیغ‌کننده نسخه SDF خود را از شریک خود به ارث می‌برد، مگر اینکه طور دیگری پیکربندی شده باشد.
`root_id` یونیون. الزامی. شناسه ریشه، زمینه درخواست دانلود را تعیین می‌کند. دقیقاً یک فیلد باید تنظیم شود. `root_id` فقط می‌تواند یکی از موارد زیر باشد:
`partnerId`	`string ( int64 format)` شناسه‌ی شریکی که قرار است SDF برایش دانلود شود.
`advertiserId`	`string ( int64 format)` شناسه تبلیغ‌کننده‌ای که قرار است SDF را برایش دانلود کنید.
فیلد Union `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` نباشد، حداقل یک شناسه باید مشخص شود.

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`	فرمت تضمین کیفیت - مورد خطی
`FILE_TYPE_AD_GROUP_QA`	گروه تبلیغاتی یوتیوب - فرمت تضمین کیفیت.

نوع فیلتر

انواع ممکن که می‌توانند فیلتر شوند.

انوم‌ها
`FILTER_TYPE_UNSPECIFIED`	مقدار پیش‌فرض زمانی که نوع مشخص نشده باشد یا در این نسخه ناشناخته باشد.
`FILTER_TYPE_NONE`	در صورت انتخاب، هیچ فیلتری برای دانلود اعمال نخواهد شد. فقط در صورتی قابل استفاده است که یک `Advertiser` در `CreateSdfDownloadTaskRequest` مشخص شده باشد.
`FILTER_TYPE_ADVERTISER_ID`	شناسه تبلیغ‌کننده. در صورت انتخاب، همه شناسه‌های فیلتر باید شناسه‌های تبلیغ‌کننده‌ای باشند که متعلق به `Partner` مشخص‌شده در `CreateSdfDownloadTaskRequest` هستند.
`FILTER_TYPE_CAMPAIGN_ID`	شناسه کمپین. در صورت انتخاب، همه شناسه‌های فیلتر باید شناسه‌های کمپینی باشند که متعلق به `Advertiser` یا `Partner` مشخص‌شده در `CreateSdfDownloadTaskRequest` هستند.
`FILTER_TYPE_MEDIA_PRODUCT_ID`	شناسه محصول رسانه. در صورت انتخاب، تمام شناسه‌های فیلتر باید شناسه‌های محصول رسانه‌ای باشند که متعلق به `Advertiser` یا `Partner` مشخص‌شده در `CreateSdfDownloadTaskRequest` هستند. فقط برای دانلود `FILE_TYPE_MEDIA_PRODUCT` قابل استفاده است.
`FILTER_TYPE_INSERTION_ORDER_ID`	شناسه سفارش درج. در صورت انتخاب، تمام شناسه‌های فیلتر باید شناسه‌های سفارش درج باشند که متعلق به `Advertiser` یا `Partner` مشخص شده در `CreateSdfDownloadTaskRequest` هستند. فقط برای دانلود `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`	شناسه‌ی آیتم خطی. در صورت انتخاب، تمام شناسه‌های فیلتر باید شناسه‌های آیتم خطی باشند که متعلق به `Advertiser` یا `Partner` مشخص‌شده در `CreateSdfDownloadTaskRequest` هستند. فقط برای دانلود `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 ] }