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