Method: sdfdownloadtasks.create

สร้างงานดาวน์โหลด SDF แสดงผล Operation

งานดาวน์โหลด SDF เป็นการดำเนินการแบบไม่พร้อมกันที่ใช้เวลานาน metadata ประเภทของการดำเนินการนี้คือ SdfDownloadTaskMetadata หากคำขอสำเร็จ ประเภทการดำเนินการจะเป็น SdfDownloadTaskresponse การตอบกลับจะไม่มีไฟล์ดาวน์โหลด ซึ่งต้องดึงข้อมูลด้วย media.download คุณเรียกข้อมูลสถานะการดำเนินการได้ด้วย sdfdownloadtask.operations.get

คุณดูข้อผิดพลาดได้ใน error.message โปรดทราบว่า error.details ควรว่างเปล่า

คำขอ HTTP

POST https://displayvideo.googleapis.com/v3/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 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

ParentEntityFilter

ตัวเลือกการกรองที่กรองตามประเภทไฟล์ที่เลือกซึ่งอยู่ในชุดเอนทิตีตัวกรองที่เลือก

การแสดง JSON 
{
  "fileType": [
    enum (FileType)
  ],
  "filterType": enum (FilterType),
  "filterIds": [
    string
  ]
}
ช่อง
fileType[]

enum (FileType)

ต้องระบุ ประเภทไฟล์ที่จะแสดง
filterType

enum (FilterType)

ต้องระบุ ประเภทตัวกรองที่ใช้กรองเอนทิตีที่ดึงข้อมูล
filterIds[]

string (int64 format)

รหัสของประเภทตัวกรองที่ระบุ ใช้เพื่อกรองเอนทิตีที่จะดึงข้อมูล หากประเภทตัวกรองไม่ใช่ FILTER_TYPE_NONE คุณต้องระบุรหัสอย่างน้อย 1 รายการ

FileType

ประเภทไฟล์ที่ดาวน์โหลดได้

Enum
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 รายการโฆษณา - รูปแบบ QA
FILE_TYPE_AD_GROUP_QA กลุ่มโฆษณา YouTube - รูปแบบ QA

FilterType

ประเภทที่เป็นไปได้ซึ่งกรองได้

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

ไม่บังคับ รายการโฆษณาตามรหัสเพื่อดาวน์โหลดในรูปแบบ QA รหัสทั้งหมดต้องเป็นของ Advertiser หรือ Partner เดียวกันที่ระบุไว้ใน CreateSdfDownloadTaskRequest
adGroupQaIds[]

string (int64 format)

ไม่บังคับ กลุ่มโฆษณา YouTube ตามรหัสเพื่อดาวน์โหลดในรูปแบบ QA รหัสทั้งหมดต้องเป็นของ Advertiser หรือ Partner เดียวกันที่ระบุไว้ใน CreateSdfDownloadTaskRequest

InventorySourceFilter

ตัวเลือกการกรองสำหรับการกรองเอนทิตีแหล่งที่มาของพื้นที่โฆษณา

การแสดง JSON 
{
  "inventorySourceIds": [
    string
  ]
}
ช่อง
inventorySourceIds[]

string (int64 format)

แหล่งที่มาของพื้นที่โฆษณาที่จะดาวน์โหลดตามรหัส รหัสทั้งหมดต้องเป็นของ Advertiser หรือ Partner เดียวกันที่ระบุไว้ใน CreateSdfDownloadTaskRequest เว้นว่างไว้เพื่อดาวน์โหลดแหล่งที่มาของพื้นที่โฆษณาทั้งหมดสําหรับผู้ลงโฆษณาหรือพาร์ทเนอร์ที่เลือก