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/v2/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 จากพาร์ทเนอร์ เว้นแต่จะกำหนดค่าเป็นอย่างอื่น
ฟิลด์สหภาพ 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 คุณต้องระบุรหัสอย่างน้อย 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

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_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 เว้นว่างไว้เพื่อดาวน์โหลดแหล่งที่มาของพื้นที่โฆษณาทั้งหมดสำหรับผู้ลงโฆษณาหรือพาร์ทเนอร์ที่เลือก