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/v1/sdfdownloadtasks

URL از دستور GRPC Transcoding استفاده می کند.

درخواست بدن

بدنه درخواست حاوی داده هایی با ساختار زیر است:

نمایندگی 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 می تواند تنها یکی از موارد زیر باشد:
partnerId

string ( int64 format)

شناسه شریک برای دانلود SDF.

advertiserId

string ( int64 format)

شناسه تبلیغ‌کننده برای دانلود SDF.

فیلد اتحادیه 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 مراجعه کنید.

ParentEntityFilter

یک گزینه فیلتر که انواع فایل های انتخاب شده متعلق به مجموعه انتخابی از موجودیت های فیلتر را فیلتر می کند.

نمایندگی JSON 
{
  "fileType": [
    enum (FileType)
  ],
  "filterType": enum (FilterType),
  "filterIds": [
    string
  ]
}
فیلدها
fileType[]

enum ( FileType )

مورد نیاز. انواع فایل هایی که برگردانده می شوند.

filterType

enum ( FilterType )

مورد نیاز. نوع فیلتری که برای فیلتر کردن موجودیت های واکشی شده استفاده می شود.

filterIds[]

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 گروه تبلیغات YouTube.
FILE_TYPE_AD تبلیغ یوتیوب.

نوع فیلتر

انواع احتمالی قابل فیلتر کردن.

Enums
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_AD_GROUP ، و FILE_TYPE_AD قابل استفاده است.
FILTER_TYPE_LINE_ITEM_ID شناسه مورد خط. در صورت انتخاب، همه شناسه‌های فیلتر باید شناسه‌های مورد خطی باشند که متعلق به Advertiser یا Partner مشخص‌شده در CreateSdfDownloadTaskRequest هستند. فقط برای دانلود FILE_TYPE_LINE_ITEM ، FILE_TYPE_AD_GROUP ، و FILE_TYPE_AD قابل استفاده است.

IDFilter

یک گزینه فیلتر که نهادها را بر اساس شناسه موجودیت آنها فیلتر می کند.

نمایندگی JSON 
{
  "campaignIds": [
    string
  ],
  "mediaProductIds": [
    string
  ],
  "insertionOrderIds": [
    string
  ],
  "lineItemIds": [
    string
  ],
  "adGroupIds": [
    string
  ],
  "adGroupAdIds": [
    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 مشخص شده است.

InventorySourceFilter

یک گزینه فیلتر برای فیلتر کردن موجودیت های منبع موجودی.

نمایندگی JSON 
{
  "inventorySourceIds": [
    string
  ]
}
فیلدها
inventorySourceIds[]

string ( int64 format)

منابع موجودی برای دانلود با شناسه. همه شناسه‌ها باید متعلق به همان Advertiser یا Partner باشند که در CreateSdfDownloadTaskRequest مشخص شده است. برای دانلود همه منابع موجودی برای تبلیغ‌کننده یا شریک انتخابی، خالی بگذارید.