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

نشانی وب از نحو تراتبدیل 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

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

شمارشی‌ها
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 Line Item - QA format.
FILE_TYPE_AD_GROUP_QA YouTube Ad Group - QA format.

FilterType

انواع ممکن که می‌توان براساس آن‌ها فیلتر کرد.

شمارشی‌ها
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 قابل‌استفاده است.

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)

اختیاری. موردهای سطری، براساس شناسه، برای بارگیری در قالب تضمین کیفیت. همه شناسه‌ها باید متعلق به همان Advertiser یا Partner مشخص‌شده در CreateSdfDownloadTaskRequest باشند.
adGroupQaIds[]

string (int64 format)

اختیاری. گروه‌های آگهی YouTube، براساس شناسه، برای بارگیری در قالب QA. همه شناسه‌ها باید متعلق به همان Advertiser یا Partner مشخص‌شده در CreateSdfDownloadTaskRequest باشند.

InventorySourceFilter

گزینه فیلتر کردن برای فیلتر کردن براساس نهادهای «منبع فضای آگهی».

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

string (int64 format)

«منابع فضای آگهی» برای بارگیری براساس شناسه. همه شناسه‌ها باید متعلق به همان Advertiser یا Partner مشخص‌شده در CreateSdfDownloadTaskRequest باشند. برای بارگیری همه «منابع فضای آگهی» برای «تبلیغ‌کننده» یا «شریک» انتخاب‌شده، خالی بگذارید.