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

URL ใช้ไวยากรณ์การแปลงรหัส 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 จากพาร์ทเนอร์ เว้นแต่จะกำหนดค่าไว้เป็นอย่างอื่น
ต้องระบุ รหัสรูทจะกำหนดบริบทของคำขอดาวน์โหลด ต้องตั้งค่าช่องเดียวเท่านั้น ต่อไปนี้คือรายการช่องที่แยกกันโดยสิ้นเชิง ระบบจะตั้งค่าช่องอย่างน้อย 1 ช่องในการตอบกลับ ดังนี้
partnerId

string (int64 format)

รหัสของพาร์ทเนอร์ที่จะดาวน์โหลด SDF
advertiserId

string (int64 format)

รหัสของผู้ลงโฆษณาที่จะดาวน์โหลด SDF
สิ้นสุดฟิลด์ที่แยกกัน
ต้องระบุ ตัวเลือกที่ระบุประเภทเอนทิตีและช่วงที่จะดาวน์โหลด ต้องตั้งค่าช่องเดียวเท่านั้น ต่อไปนี้คือรายการช่องที่แยกกันโดยสิ้นเชิง ระบบจะตั้งค่าช่องอย่างน้อย 1 ช่องในการตอบกลับ ดังนี้
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 เว้นว่างไว้เพื่อดาวน์โหลดแหล่งที่มาของพื้นที่โฆษณาทั้งหมดสำหรับผู้ลงโฆษณาหรือพาร์ทเนอร์ที่เลือก