- คำขอ HTTP
- เนื้อความของคำขอ
- เนื้อหาการตอบกลับ
- ขอบเขตการให้สิทธิ์
- ParentEntityFilter
- FileType
- FilterType
- IdFilter
- InventorySourceFilter
- ลองใช้งาน
สร้างงานการดาวน์โหลด SDF แสดงผล Operation
งานการดาวน์โหลด SDF เป็นการดำเนินการแบบอะซิงโครนัสที่ใช้เวลานาน ประเภท metadata
ของการดำเนินการนี้คือ SdfDownloadTaskMetadata
หากคำขอประสบความสำเร็จ ประเภท response
ของการดำเนินการจะเป็น SdfDownloadTask
การตอบกลับจะไม่รวมไฟล์ดาวน์โหลด ซึ่งจะต้องดึงออกมาด้วย media.download
คุณจะเรียกดูสถานะการดำเนินการได้ด้วย sdfdownloadtask.operations.get
โดยพบข้อผิดพลาดใน error.message
โปรดทราบว่า error.details
ต้องไม่ว่างเปล่า
คำขอ HTTP
POST https://displayvideo.googleapis.com/v1/sdfdownloadtasks
URL ใช้ไวยากรณ์การแปลง gRPC
เนื้อหาของคำขอ
เนื้อหาของคำขอมีข้อมูลที่มีโครงสร้างต่อไปนี้
การแสดง JSON |
---|
{ "version": enum ( |
ช่อง | |
---|---|
version |
ต้องระบุ เวอร์ชัน SDF ของไฟล์ที่ดาวน์โหลด หากตั้งค่าเป็น |
ฟิลด์การรวม root_id ต้องระบุ รหัสรูทจะเป็นตัวกำหนดบริบทของคำขอดาวน์โหลด ต้องตั้งค่าฟิลด์เพียงหนึ่งฟิลด์ root_id ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
partnerId |
รหัสของพาร์ทเนอร์ที่ต้องการดาวน์โหลด SDF |
advertiserId |
รหัสของผู้ลงโฆษณาที่จะดาวน์โหลด SDF |
ฟิลด์การรวม filtering_option ต้องระบุ ตัวเลือกที่ระบุประเภทและช่วงของเอนทิตีที่จะดาวน์โหลด ต้องตั้งค่าฟิลด์เพียงหนึ่งฟิลด์ filtering_option ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
parentEntityFilter |
ตัวกรองเกี่ยวกับประเภทไฟล์ที่เลือก เอนทิตีในแต่ละไฟล์จะกรองตามชุดเอนทิตีตัวกรองที่เลือก เอนทิตีตัวกรองต้องเป็นประเภทเดียวกันหรือประเภทหลักของไฟล์ที่เลือก |
idFilter |
กรองเอนทิตีตามรหัสเอนทิตี |
inventorySourceFilter |
ตัวกรองแหล่งที่มาของพื้นที่โฆษณาตามรหัส |
เนื้อหาการตอบกลับ
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีอินสแตนซ์ Operation
ที่สร้างขึ้นใหม่
ขอบเขตการให้สิทธิ์
ต้องใช้ขอบเขต OAuth ต่อไปนี้
https://www.googleapis.com/auth/display-video
ดูข้อมูลเพิ่มเติมได้ที่ภาพรวมของ OAuth 2.0
ParentEntityFilter
ตัวเลือกการกรองที่กรองประเภทไฟล์ที่เลือกซึ่งเป็นของชุดเอนทิตีตัวกรองที่เลือก
การแสดง JSON |
---|
{ "fileType": [ enum ( |
ช่อง | |
---|---|
fileType[] |
ต้องระบุ ประเภทไฟล์ที่จะแสดงกลับมา |
filterType |
ต้องระบุ ประเภทตัวกรองที่ใช้กรองเอนทิตีที่ดึงข้อมูล |
filterIds[] |
รหัสของประเภทตัวกรองที่ระบุ ข้อมูลนี้ใช้เพื่อกรองเอนทิตีที่จะดึงข้อมูล หากประเภทตัวกรองไม่ใช่ |
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[] |
แคมเปญที่จะดาวน์โหลดตามรหัส รหัสทั้งหมดต้องเป็นของ |
mediaProductIds[] |
ผลิตภัณฑ์สื่อที่จะดาวน์โหลดตามรหัส รหัสทั้งหมดต้องเป็นของ |
insertionOrderIds[] |
ใบสั่งซื้อการใส่โฆษณาที่จะดาวน์โหลดตามรหัส รหัสทั้งหมดต้องเป็นของ |
lineItemIds[] |
รายการโฆษณาที่จะดาวน์โหลดตามรหัส รหัสทั้งหมดต้องเป็นของ |
adGroupIds[] |
กลุ่มโฆษณา YouTube ที่จะดาวน์โหลดตามรหัส รหัสทั้งหมดต้องเป็นของ |
adGroupAdIds[] |
โฆษณา YouTube เพื่อดาวน์โหลดตามรหัส รหัสทั้งหมดต้องเป็นของ |
InventorySourceFilter
ตัวเลือกการกรองสำหรับการกรองเอนทิตีแหล่งที่มาของพื้นที่โฆษณา
การแสดง JSON |
---|
{ "inventorySourceIds": [ string ] } |
ช่อง | |
---|---|
inventorySourceIds[] |
แหล่งที่มาของพื้นที่โฆษณาที่จะดาวน์โหลดตามรหัส รหัสทั้งหมดต้องเป็นของ |