API แบบสดสำหรับพ็อดการแทรกโฆษณาแบบไดนามิก

Dynamic Ad Insertion API ช่วยให้คุณขอและติดตามสตรีมแบบสดของ DAI ได้

บริการ: dai.google.com

URI ทั้งหมดจะเกี่ยวข้องกับ https://dai.google.com

วิธีการ: สตรีม

เมธอด
stream POST /ssai/pods/api/v1/network/{network_code}/custom_asset/{custom_asset_key}/stream

ลงทะเบียนเซสชันสตรีมแบบสดของ DAI Pod Serving

คำขอ HTTP

POST https://dai.google.com/ssai/pods/api/v1/network/{network_code}/custom_asset/{custom_asset_key}/stream

พารามิเตอร์เส้นทาง

พารามิเตอร์
network_code string

รหัสเครือข่าย Google Ad Manager ของผู้เผยแพร่โฆษณา

custom_asset_key string

ตัวระบุที่กําหนดเองซึ่งเชื่อมโยงเหตุการณ์นี้ใน Google Ad Manager

เนื้อหาของคำขอ

เนื้อหาของคําขอเป็นประเภท application/x-www-form-urlencoded และมีพารามิเตอร์ต่อไปนี้

พารามิเตอร์
พารามิเตอร์การกําหนดเป้าหมาย DFP ไม่บังคับ พารามิเตอร์การกําหนดเป้าหมายเพิ่มเติม
ลบล้างพารามิเตอร์ของสตรีม ไม่บังคับ ลบล้างค่าเริ่มต้นของพารามิเตอร์การสร้างสตรีม
การตรวจสอบสิทธิ์ HMAC ไม่บังคับ ตรวจสอบสิทธิ์โดยใช้โทเค็นที่ใช้ HMAC

เนื้อหาการตอบกลับ

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีออบเจ็กต์ Stream ใหม่

การวัดผลแบบเปิด

DAI API มีข้อมูลสําหรับการยืนยัน Open Measurement ในช่อง Verifications ช่องนี้มีองค์ประกอบ Verification อย่างน้อย 1 รายการที่แสดงรายการทรัพยากรและข้อมูลเมตาที่จําเป็นสําหรับเรียกใช้โค้ดการวัดผลของบุคคลที่สามเพื่อยืนยันการเล่นครีเอทีฟโฆษณา รองรับ JavaScriptResource เท่านั้น ดูข้อมูลเพิ่มเติมได้ที่ IAB Tech Lab และข้อกำหนด VAST 4.1

วิธีการ: กลุ่มพ็อด

เมธอด
pod segment GET /linear/pods/v1/seg/network/{network_code}/custom_asset/{custom_asset_key}/{pod_identifier}/profile/{profile_name}/{segment_number}.{segment_format}

สร้างสตรีม DAI สําหรับรหัสเหตุการณ์ที่ระบุ

คำขอ HTTP

GET https://dai.google.com/linear/pods/v1/seg/network/{network_code}/custom_asset/{custom_asset_key}/{pod_identifier}/profile/{profile_name}/{segment_number}.{segment_format}

พารามิเตอร์เส้นทาง

พารามิเตอร์
network_code string

รหัสเครือข่าย Google Ad Manager ของผู้เผยแพร่โฆษณา

custom_asset_key string

ตัวระบุที่กําหนดเองซึ่งเชื่อมโยงเหตุการณ์นี้ใน Google Ad Manager

pod_identifier

ระบบรองรับรูปแบบต่อไปนี้

pod/{integer}

ตัวระบุตัวเลขสำหรับช่วงพักโฆษณาปัจจุบัน ระบบจะกําหนดรหัสพ็อดโฆษณาทีละรายการสําหรับเหตุการณ์ช่วงพักโฆษณาแต่ละรายการ โดยเริ่มจาก 1

ad_break_id/{string}

ตัวระบุสตริงของช่วงพักโฆษณาปัจจุบัน
profile_name string

ชื่อโปรไฟล์การเข้ารหัส DAI ของ Google Ad Manager ที่ขอ โปรไฟล์การเข้ารหัสต้องเป็นหนึ่งในโปรไฟล์การเข้ารหัสที่กำหนดค่าไว้สำหรับกิจกรรมที่เลือก

segment_number integer

ดัชนีของกลุ่มที่ขอภายในพ็อดโฆษณาปัจจุบัน โดยเริ่มต้นที่ 0
segment_format string

ส่วนขยายไฟล์ที่เชื่อมโยงกับรูปแบบกลุ่มที่ขอ นามสกุลที่ยอมรับ ได้แก่ ts, mp4, vtt, aac, ac3 หรือ eac3

พารามิเตอร์การค้นหา

พารามิเตอร์
stream_id ต้องระบุ string

รหัสสตรีมสำหรับเซสชันของผู้ใช้ปัจจุบัน ค่านี้จะแสดงขึ้นเมื่อคำขอไปยังปลายทาง stream สำเร็จ
sd required1 integer

ระยะเวลาของส่วนที่ขอเป็นมิลลิวินาที
so ไม่บังคับ

ส่วนเพิ่มของกลุ่มที่ขอภายในพ็อดโฆษณาเป็นมิลลิวินาที หากคุณละเว้นพารามิเตอร์ so ระบบจะคํานวณโดยคูณระยะเวลาของกลุ่มด้วยจํานวนกลุ่ม
pd ต้องระบุ2 integer

ระยะเวลาของพ็อดโฆษณาเป็นมิลลิวินาที
auth-token ต้องระบุ string

โทเค็น HMAC ที่เข้ารหัส URL และลงนามแล้วสําหรับพ็อดโฆษณาปัจจุบัน
last ไม่บังคับ boolean

บ่งชี้กลุ่มสุดท้ายในช่วงพักโฆษณา ละเว้นพารามิเตอร์นี้สําหรับกลุ่มอื่นๆ ทั้งหมด
scte35 ไม่บังคับ string

สัญญาณ SCTE-35 ที่เข้ารหัส Base64 สำหรับช่วงพักโฆษณานี้
cust_params ไม่บังคับ string

ชุดคู่คีย์-ค่าที่ใช้สําหรับการกําหนดเป้าหมายแคมเปญ Ad Manager คู่เหล่านี้ต้องแสดงเป็นสตริงการค้นหาที่เข้ารหัส URL

ตัวอย่างเช่น
พารามิเตอร์
  • section = sports
  • page = golf,tennis
Request URL ...&cust_params=section%3Dsports%26page%3Dgolf%2Ctennis...

เชิงอรรถ

  1. ไม่จำเป็นต้องใช้ sd สำหรับกลุ่มเริ่มต้น ↩
  2. ไม่จำเป็นต้องระบุ pd สำหรับเหตุการณ์ที่เปิดใช้ช่วงพักโฆษณาที่ไม่มีระยะเวลา ↩

ตัวอย่าง

GET https://dai.google.com/linear/pods/v1/seg/network/sandbox_dev/custom_asset/podserving-segredirect-custom-key/ad_break_id/adbreak-2/profile/8b8888cf79ad43f0800482ffc035a1ac_ts_a/1.ts?so=0&sd=10000&pd=30000&stream_id=8e19cbc6-850b-404c-99d7-860aa4a674cb:TEST

GET https://dai.google.com/linear/pods/v1/seg/network/sandbox_dev/custom_asset/podserving-segredirect-custom-key/pod/2/profile/8b8888cf79ad43f0800482ffc035a1ac_ts_a/1.ts?so=0&sd=10000&pd=30000&stream_id=8e19cbc6-850b-404c-99d7-860aa4a674cb:TEST

เนื้อหาการตอบกลับ

หากทำสำเร็จ เนื้อหาการตอบกลับจะเป็นส่วนของสตรีมที่เล่นได้ซึ่งตรงกับรูปแบบและพารามิเตอร์ที่ระบุในคำขอ

วิธีการ: ไฟล์ Manifest ของพ็อด HLS

ดึงข้อมูลไฟล์ Manifest ของพ็อดโฆษณา HLS ของสตรีมแบบสดที่พร้อมให้โปรแกรมเล่นวิดีโอของไคลเอ็นต์โหลดและเล่น

เมธอด
GET GET /linear/pods/v1/hls/network/{network_code}/custom_asset/{custom_asset}/{pod_identifier}.m3u8;

API ดึงข้อมูลเพลย์ลิสต์เวอร์ชันหลายตัวแปรของ HLS สำหรับพ็อดโฆษณา

คำขอ HTTP

GET https://dai.google.com/linear/pods/v1/hls/network/{network_code}/custom_asset/{custom_asset_key}/{pod_identifier}.m3u8?stream_id={stream_id}&pd={pod_duration}

พารามิเตอร์เส้นทาง

พารามิเตอร์
network_code string

รหัสเครือข่าย Google Ad Manager ของผู้เผยแพร่โฆษณา
custom_asset_key string

ตัวระบุที่กําหนดเองซึ่งเชื่อมโยงเหตุการณ์นี้ใน Google Ad Manager
pod_identifier

ระบบรองรับรูปแบบต่อไปนี้

pod/{integer}

ตัวระบุตัวเลขสำหรับช่วงพักโฆษณาปัจจุบัน ระบบจะกําหนดรหัสพ็อดโฆษณาทีละรายการสําหรับเหตุการณ์ช่วงพักโฆษณาแต่ละรายการ โดยเริ่มจาก 1

ad_break_id/{string}

ตัวระบุสตริงของช่วงพักโฆษณาปัจจุบัน

พารามิเตอร์การค้นหา

พารามิเตอร์
stream_id จำเป็น string

รหัสสตรีมสำหรับเซสชันของผู้ใช้ปัจจุบัน ค่านี้จะแสดงขึ้นจากคำขอที่ส่งไปยังปลายทาง stream สำเร็จ
pd จำเป็น integer

ระยะเวลาของพ็อดโฆษณาเป็นมิลลิวินาที
scte35 ไม่บังคับ string

สัญญาณ SCTE-35 ที่เข้ารหัส Base64 สำหรับช่วงพักโฆษณานี้
cust_params ไม่บังคับ string

ชุดคู่คีย์-ค่าที่ใช้สําหรับการกําหนดเป้าหมายแคมเปญ Ad Manager คู่เหล่านี้ต้องแสดงเป็นสตริงการค้นหาที่เข้ารหัส URL

ตัวอย่างเช่น
พารามิเตอร์
  • section = sports
  • page = golf,tennis
Request URL ...&cust_params=section%3Dsports%26page%3Dgolf%2Ctennis...

เนื้อหาการตอบกลับ

หากทำสำเร็จ เนื้อหาการตอบกลับจะเป็นเพลย์ลิสต์เวอร์ชันหลายตัวแปรของ HLS

วิธีการ: ไฟล์ Manifest ของพ็อด DASH

ดึงข้อมูลไฟล์ Manifest ของพ็อดโฆษณา MPEG-DASH ของสตรีมแบบสดที่พร้อมให้วิดีโอเพลเยอร์ฝั่งไคลเอ็นต์โหลดและเล่น

เมธอด
GET GET /linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset}/stream/{stream_id}/pod/{pod_id}/manifest.mpd

API ดึงข้อมูลเพลย์ลิสต์ mpd ของ MPEG-DASH สําหรับพ็อดโฆษณา

คำขอ HTTP

GET https://dai.google.com/linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset_key}/stream/{stream_id}/pod/{pod_id}/manifest.mpd?pd={pod_duration}

พารามิเตอร์เส้นทาง

พารามิเตอร์
network_code string

รหัสเครือข่าย Google Ad Manager ของผู้เผยแพร่โฆษณา
custom_asset_key string

ตัวระบุที่กําหนดเองซึ่งเชื่อมโยงเหตุการณ์นี้ใน Google Ad Manager
stream_id string

รหัสสตรีมสำหรับเซสชันของผู้ใช้ปัจจุบัน ค่านี้จะแสดงขึ้นจากคำขอที่ส่งไปยังปลายทาง stream สำเร็จ
pod_id integer

ตัวระบุตัวเลขสำหรับช่วงพักโฆษณาปัจจุบัน ระบบจะกําหนดรหัสพ็อดโฆษณาทีละรายการสําหรับเหตุการณ์ช่วงพักโฆษณาแต่ละรายการ โดยเริ่มจาก 1

พารามิเตอร์การค้นหา

พารามิเตอร์
pd จำเป็น integer

ระยะเวลาของพ็อดโฆษณาเป็นมิลลิวินาที
scte35 ไม่บังคับ string

สัญญาณ SCTE-35 ที่เข้ารหัส Base64 สำหรับช่วงพักโฆษณานี้
cust_params ไม่บังคับ string

ชุดคู่คีย์-ค่าที่ใช้สําหรับการกําหนดเป้าหมายแคมเปญ Ad Manager คู่เหล่านี้ต้องแสดงเป็นสตริงการค้นหาที่เข้ารหัส URL

ตัวอย่างเช่น
พารามิเตอร์
  • section = sports
  • page = golf,tennis
Request URL ...&cust_params=section%3Dsports%26page%3Dgolf%2Ctennis...

เนื้อหาการตอบกลับ

หากทำสำเร็จ เนื้อหาการตอบกลับจะเป็นเพลย์ลิสต์ mpd ของ MPEG-DASH

วิธีการ: เทมเพลตระยะเวลาของพ็อด DASH

เมธอด
pods GET /linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset_key}/pods.json

ขอเทมเพลตระยะเวลา DASH จาก Google Ad Manager เทมเพลตนี้มีมาโครที่คุณต้องป้อนข้อมูลด้วยพารามิเตอร์สตรีม เมื่อป้อนข้อมูลมาโครเหล่านี้แล้ว เทมเพลตจะกลายเป็นช่วงพักโฆษณา และสามารถต่อเข้ากับไฟล์ Manifest ของ DASH ได้

คำขอ HTTP

GET https://dai.google.com/linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset_key}/pods.json

พารามิเตอร์เส้นทาง

พารามิเตอร์
network_code string

รหัสเครือข่าย Google Ad Manager ของผู้เผยแพร่โฆษณา

custom_asset_key string

ตัวระบุที่กําหนดเองซึ่งเชื่อมโยงเหตุการณ์นี้ใน Google Ad Manager

พารามิเตอร์การค้นหา

พารามิเตอร์
stream_id ต้องระบุ string

รหัสสตรีมสำหรับเซสชันของผู้ใช้ปัจจุบัน ค่านี้จะแสดงขึ้นเมื่อคำขอไปยังปลายทาง stream สำเร็จ

เนื้อหาการตอบกลับ

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีออบเจ็กต์ PodTemplateResponse ใหม่

วิธีการ: การยืนยันสื่อ

หลังจากพบตัวระบุสื่อโฆษณาระหว่างการเล่น ให้ส่งคำขอทันทีโดยใช้ media_verification_url ที่ได้รับจากปลายทาง stream ด้านบน คำขอเหล่านี้ไม่จำเป็นสำหรับสตรีมบีคอนฝั่งเซิร์ฟเวอร์ ซึ่งเซิร์ฟเวอร์จะเป็นผู้เริ่มการยืนยันสื่อ

คำขอไปยังปลายทาง media verification เป็นแบบซ้ำได้

เมธอด
media verification GET /{media_verification_url}/{ad_media_id}

แจ้ง API เกี่ยวกับเหตุการณ์การยืนยันสื่อ

คำขอ HTTP

GET https://{media-verification-url}/{ad-media-id}

เนื้อหาการตอบกลับ

media verification แสดงผลลัพธ์ต่อไปนี้

  • HTTP/1.1 204 No Content หากการยืนยันสื่อสําเร็จและส่งคําสั่ง ping ทั้งหมดแล้ว
  • HTTP/1.1 404 Not Found หากคําขอยืนยันสื่อไม่ได้เนื่องจากรูปแบบ URL ไม่ถูกต้องหรือหมดอายุ
  • HTTP/1.1 404 Not Found หากคำขอยืนยันก่อนหน้านี้สำหรับบัตรประจำตัวนี้สำเร็จ
  • HTTP/1.1 409 Conflict หากมีคำขออื่นส่งคําสั่ง ping อยู่แล้วในขณะนี้

รหัสสื่อโฆษณา

ระบบจะเข้ารหัสตัวระบุสื่อโฆษณาในแทร็กข้อมูลเมตาแยกต่างหาก ซึ่งได้แก่ ข้อมูลเมตาแบบกำหนดเวลาสำหรับสตรีมการขนส่ง HLS หรือ emsg สำหรับไฟล์ mp4 ตัวระบุสื่อโฆษณาจะเริ่มต้นด้วยสตริง google_ เสมอ

คุณควรเพิ่มเนื้อหาข้อความทั้งหมดของรายการข้อมูลเมตาต่อท้าย URL การยืนยันโฆษณาก่อนที่จะส่งคําขอยืนยันโฆษณาแต่ละรายการ

วิธีการ: metadata

ปลายทางข้อมูลเมตาที่ metadata_url จะแสดงข้อมูลที่ใช้ในการสร้าง UI ของโฆษณา ปลายทางข้อมูลเมตาไม่พร้อมใช้งานสำหรับสตรีมบีคอนฝั่งเซิร์ฟเวอร์ ซึ่งเซิร์ฟเวอร์มีหน้าที่รับผิดชอบในการเริ่มการยืนยันสื่อโฆษณา

เมธอด
metadata GET /{metadata_url}/{ad-media-id}

GET /{metadata_url}

ดึงข้อมูลเมตาของโฆษณา

คำขอ HTTP

GET https://{metadata_url}/{ad-media-id}

GET https://{metadata_url}

เนื้อหาการตอบกลับ

หากทำสำเร็จ การตอบกลับจะแสดงอินสแตนซ์ของ PodMetadata

การแยกวิเคราะห์ข้อมูลเมตา

ข้อมูลเมตามี 3 ส่วน ได้แก่ tags, ads และ breaks ของโฆษณา จุดแรกเข้าของข้อมูลคือส่วน tags จากนั้นให้วนดูแท็กต่างๆ และค้นหารายการแรกที่มีชื่อเป็นคำนำหน้าสำหรับรหัสสื่อโฆษณาที่พบในสตรีมวิดีโอ เช่น คุณอาจมีรหัสสื่อโฆษณาที่มีลักษณะดังนี้

google_1234567890

จากนั้นคุณจะเห็นออบเจ็กต์แท็กชื่อ google_12345 ในกรณีนี้ รหัสจะตรงกับรหัสสื่อโฆษณา เมื่อพบออบเจ็กต์คำนำหน้าสื่อโฆษณาที่ถูกต้องแล้ว คุณจะค้นหารหัสโฆษณา รหัสช่วงพักโฆษณา และประเภทเหตุการณ์ได้ จากนั้นระบบจะใช้รหัสโฆษณาเพื่อจัดทำดัชนีออบเจ็กต์ ads และใช้รหัสช่วงพักโฆษณาเพื่อจัดทำดัชนีออบเจ็กต์ breaks

ข้อมูลการตอบกลับ

สตรีม

สตรีมใช้เพื่อแสดงผลรายการทรัพยากรสำหรับสตรีมที่สร้างขึ้นใหม่ในรูปแบบ JSON
การแสดง JSON
{
  "stream_id": string,
  "media_verification_url": string,
  "metadata_url": string,
  "session_update_url": string,
  "heartbeat_url": string,
  "polling_frequency": number,
  "pod_manifest_url": string,
  "manifest_format": string,
}
ช่อง
stream_id string

ตัวระบุสตรีม GAM
media_verification_url string

URL การยืนยันสื่อที่ใช้เป็นปลายทางพื้นฐานสําหรับการติดตามเหตุการณ์การเล่น
metadata_url string

Metadata URL ที่ใช้ในการสำรวจข้อมูลเป็นระยะๆ เกี่ยวกับเหตุการณ์โฆษณาในสตรีมที่กำลังจะเกิดขึ้น
session_update_url string

URL การอัปเดตของเซสชันที่ใช้อัปเดตพารามิเตอร์การกําหนดเป้าหมายสําหรับสตรีมนี้ ระบบจะบันทึกค่าเดิมของพารามิเตอร์การกําหนดเป้าหมายไว้ในระหว่างคําขอสร้างสตรีมครั้งแรก
heartbeat_url string

URL ของการตรวจสอบว่ายังมีชีวิตอยู่ ซึ่งใช้เพื่อทำให้สตรีมการบีคอนฝั่งเซิร์ฟเวอร์ทำงานอยู่เสมอ ต้องได้รับการส่ง Ping ทุก {PollingFrequency} วินาที สร้างขึ้นสำหรับสตรีมบีคอนฝั่งเซิร์ฟเวอร์
polling_frequency number

ความถี่ในการตรวจสอบสถานะ (Polling Frequency) เป็นวินาทีเมื่อขอ metadata_url หรือ heartbeat_url
pod_manifest_url string

เทมเพลต URL ของไฟล์ Manifest ของพ็อดใช้ในการสร้าง URL เพื่อดึงข้อมูลไฟล์ Manifest ของพ็อดของสตรีม ซึ่งสอดคล้องกับ URL ของเพลย์ลิสต์เวอร์ชันหลายตัวแปรใน HLS หรือ MPD ใน DASH สร้างขึ้นสําหรับเหตุการณ์สตรีมแบบสดของการแทรกโฆษณาแบบไดนามิกประเภท POD_SERVING_MANIFEST https://developers.google.com/ad-manager/api/reference/v202305/LiveStreamEventService.DynamicAdInsertionType
manifest_format string

รูปแบบไฟล์ Manifest คือรูปแบบของไฟล์ Manifest ที่ดึงมาจาก pod_manifest_url ซึ่งอาจเป็น Dash หรือ HLS

PodMetadata

PodMetadata มีข้อมูลเมตาเกี่ยวกับโฆษณา ช่วงพักโฆษณา และแท็กรหัสสื่อ
การแสดง JSON
{
  "tags": map[string, object(TagSegment)],
  "ads": map[string, object(Ad)],
  "ad_breaks": map[string, object(AdBreak)],
}
ช่อง
tags map[string, object(TagSegment)]

การแมปกลุ่มแท็กที่จัดทําดัชนีตามคำนำหน้าแท็ก
ads map[string, object(Ad)]

แผนที่โฆษณาที่จัดทําดัชนีตามรหัสโฆษณา
ad_breaks map[string, object(AdBreak)]

แผนที่ของช่วงพักโฆษณาที่จัดทําดัชนีตามรหัสช่วงพักโฆษณา

TagSegment

TagSegment มีการอ้างอิงถึงโฆษณา ช่วงพักโฆษณา และประเภทเหตุการณ์ ไม่ควรส่ง Ping ไปยังปลายทางการยืนยันสื่อโฆษณาสำหรับ TagSegment ที่มี type="progress"
การแสดง JSON
{
  "ad": string,
  "ad_break_id": string,
  "type": string,
}
ช่อง
ad string

รหัสของโฆษณาของแท็กนี้
ad_break_id string

รหัสของช่วงพักโฆษณาของแท็กนี้
type string

ประเภทเหตุการณ์ของแท็กนี้

AdBreak

AdBreak อธิบายช่วงพักโฆษณาเดียวในสตรีม ซึ่งประกอบด้วยระยะเวลา ประเภท (ช่วงพัก/ช่วงก่อน/ช่วงหลัง) และจํานวนโฆษณา
การแสดง JSON
{
  "type": string,
  "duration": number,
  "expected_duration": number,
  "ads": number,
}
ช่อง
type string

ประเภทช่วงพักที่ใช้ได้มีช่วงพักก่อน ช่วงพักระหว่าง และช่วงพักหลัง
duration number

ระยะเวลาโฆษณาทั้งหมดของช่วงพักโฆษณานี้ เป็นวินาที
expected_duration number

ระยะเวลาที่คาดไว้ของช่วงพักโฆษณา (เป็นวินาที) ซึ่งรวมถึงโฆษณาทั้งหมดและแถบสเลท
ads number

จํานวนโฆษณาในช่วงพักโฆษณา
Ad อธิบายโฆษณาในสตรีม
การแสดง JSON
{
  "ad_break_id": string,
  "position": number,
  "duration": number,
  "title": string,
  "description": string,
  "advertiser": string,
  "ad_system": string,
  "ad_id": string,
  "creative_id": string,
  "creative_ad_id": string,
  "deal_id": string,
  "clickthrough_url": string,
  "click_tracking_urls": [],
  "verifications": [object(Verification)],
  "slate": boolean,
  "icons": [object(Icon)],
  "wrappers": [object(Wrapper)],
  "universal_ad_id": object(UniversalAdID),
  "extensions": [],
  "companions": [object(Companion)],
  "interactive_file": object(InteractiveFile),
}
ช่อง
ad_break_id string

รหัสของช่วงพักโฆษณาของโฆษณานี้
position number

ตําแหน่งของโฆษณานี้ในช่วงพักโฆษณา โดยเริ่มจาก 1
duration number

ระยะเวลาของโฆษณาเป็นวินาที
title string

ชื่อโฆษณา (ไม่บังคับ)
description string

คำอธิบายโฆษณา (ไม่บังคับ)
advertiser string

ตัวระบุผู้ลงโฆษณา (ไม่บังคับ)
ad_system string

ระบบโฆษณาที่ไม่บังคับ
ad_id string

รหัสโฆษณา (ไม่บังคับ)
creative_id string

รหัสครีเอทีฟโฆษณา (ไม่บังคับ)
creative_ad_id string

รหัสครีเอทีฟโฆษณา (ไม่บังคับ)
deal_id string

รหัสดีล (ไม่บังคับ)
clickthrough_url string

URL การคลิกผ่าน (ไม่บังคับ)
click_tracking_urls string

URL ติดตามการคลิก (ไม่บังคับ)
verifications [object(Verification)]

รายการการยืนยัน Open Measurement (ไม่บังคับ) ซึ่งแสดงทรัพยากรและข้อมูลเมตาที่จําเป็นสําหรับเรียกใช้โค้ดการวัดผลของบุคคลที่สามเพื่อยืนยันการเล่นครีเอทีฟโฆษณา
slate boolean

บูลีนที่ไม่บังคับซึ่งระบุว่ารายการปัจจุบันเป็นภาพนิ่ง
icons [object(Icon)]

รายการไอคอน ละเว้นหากว่างเปล่า
wrappers [object(Wrapper)]

รายการ Wrapper ซึ่งจะละเว้นหากว่างเปล่า
universal_ad_id object(UniversalAdID)

รหัสโฆษณาสากล (ไม่บังคับ)
extensions string

รายการโหนด <Extension> ทั้งหมดใน VAST (ไม่บังคับ)
companions [object(Companion)]

ครีเอทีฟโฆษณาที่แสดงร่วมกันซึ่งไม่บังคับซึ่งอาจแสดงพร้อมกับโฆษณานี้
interactive_file object(InteractiveFile)

ครีเอทีฟโฆษณาแบบอินเทอร์แอกทีฟ (SIMID) ไม่บังคับซึ่งควรแสดงระหว่างการเล่นโฆษณา

PodTemplateResponse

PodTemplateResponse แสดงเพย์โหลด JSON ที่ส่งกลับไปยัง VTP สำหรับการต่อพ่วงพ็อด
การแสดง JSON
{
  "dash_period_template": string,
  "segment_duration_ms": int64,
}
ช่อง
dash_period_template string

DashPeriodTemplate คือเทมเพลต XML สำหรับระยะเวลาที่จะกรอกข้อมูลที่เหมาะสมก่อนการต่อ
segment_duration_ms int64

SegmentDurationMS คือระยะเวลาของกลุ่มระยะเวลาเป็นมิลลิวินาที

AdpodTimingMetadataResponse

AdpodTimingMetadataResponse มีข้อมูลเกี่ยวกับพ็อดโฆษณาและวิธีสร้าง URL ของกลุ่มสําหรับพ็อดโฆษณา
การแสดง JSON
{
  "status": string,
  "ads": [object(AdRendering)],
  "slate": object(SlateRendering),
  "dash_representations": map[string, object(DASHRepresentation)],
  "dash_adaptation_sets": map[string, object(DASHAdaptationSet)],
}
ช่อง
status string

สถานะการตัดสินใจสําหรับพ็อดโฆษณา
ads [object(AdRendering)]

อาร์เรย์ของออบเจ็กต์โฆษณาที่อธิบายวิธีแสดงผล URL ของกลุ่มโฆษณา โดยจัดทําดัชนีที่เริ่มต้นที่ 0
slate object(SlateRendering)

Slate ที่อธิบายวิธีแสดงผล URL ของกลุ่ม Slate
dash_representations map[string, object(DASHRepresentation)]

รายการการแสดง DASH สำหรับพ็อดโฆษณาที่จะแสดงผลในไฟล์ Manifest ของ DASH
dash_adaptation_sets map[string, object(DASHAdaptationSet)]

รายการชุดการปรับ DASH สำหรับพ็อดโฆษณาที่จะแสดงผลในไฟล์ Manifest ของ DASH

AdRendering

AdRendering อธิบายวิธีแสดงผลโฆษณาที่มีการตัดสิน
การแสดง JSON
{
  "duration_ms": number,
  "variants": map[string, object(VariantRendering)],
}
ช่อง
duration_ms number

ระยะเวลาของโฆษณาเป็นมิลลิวินาที (int)
variants map[string, object(VariantRendering)]

พจนานุกรมของออบเจ็กต์ตัวแปร (ดูด้านล่าง) ซึ่งจัดทําดัชนีตามรหัสตัวแปร/โปรไฟล์ตามที่กําหนดค่าจาก UI

SlateRendering

SlateRendering อธิบายวิธีแสดงผลเนื้อหาสเลท
การแสดง JSON
{
  "duration_ms": number,
  "variants": map[string, object(VariantRendering)],
}
ช่อง
duration_ms number

ระยะเวลาของการ์ดข้อมูลเป็นมิลลิวินาที (int)
variants map[string, object(VariantRendering)]

พจนานุกรมของออบเจ็กต์ตัวแปรที่จัดทําดัชนีตามรหัสตัวแปร/โปรไฟล์ ระยะเวลาของภาพปกต้องวนซ้ำจนกว่าจะถึงความยาวของภาพปกที่ต้องการ โดยแทรกช่วงพักของ HLS ระหว่างการวนซ้ำ หรือวนซ้ำระยะเวลาใหม่สำหรับ MPEG-DASH

VariantRendering

VariantRendering อธิบายตัวแปร/โปรไฟล์ 1 รายการภายในโฆษณา/แถบ
การแสดง JSON
{
  "segment_extension": string,
  "segment_durations": object(SegmentDurations),
}
ช่อง
segment_extension string

สตริงค่าใดค่าหนึ่งต่อไปนี้ ts, mp4, aac, ac3, ec3, m4a, m4v นามสกุลไฟล์เป็นส่วนหนึ่งของ URL ของกลุ่ม
segment_durations object(SegmentDurations)

ออบเจ็กต์ SegmentDurations ระยะเวลาของกลุ่มแต่ละกลุ่มสามารถแปลงเป็น URL ของกลุ่มได้

SegmentDurations

SegmentDurations อธิบายระยะเวลาของลําดับกลุ่มในหน่วยเวลาที่ระบุ
การแสดง JSON
{
  "timescale": number,
  "values": [],
}
ช่อง
timescale number

Timescale คือจํานวนหน่วยต่อวินาที (int) ค่าที่คาดไว้คือ 1000 สำหรับ HLS (มิลลิวินาที) 90000 สำหรับวิดีโอ DASH (PTS) อัตราตัวอย่างเสียงสำหรับเสียง DASH
values number

อาร์เรย์ของระยะเวลาของกลุ่ม int เป็นหน่วยไทม์สเกล

DASHRepresentation

DASHRepresentation อธิบายโหนดการแสดงผลที่จะแสดงผลในไฟล์ Manifest ของ DASH
การแสดง JSON
{
  "codecs": string,
  "bandwidth": number,
  "width": number,
  "height": number,
  "frame_rate": string,
  "audio_sampling_rate": number,
  "audio_channel_config": object(SchemeIDURIAndValue),
}
ช่อง
codecs string

ตัวแปลงรหัสของการแสดงผล
bandwidth number

แบนด์วิดท์ของการแสดงผล
width number

ความกว้างของการแสดงผล
height number

ความสูงของการแสดงผล
frame_rate string

อัตราเฟรมของการแสดงผล
audio_sampling_rate number

อัตราตัวอย่างเสียงของการแสดงผล
audio_channel_config object(SchemeIDURIAndValue)

การกำหนดค่าช่องเสียงของการแสดงผล

DASHAdaptationSet

DASHAdaptationSet อธิบายโหนด AdaptationSet ที่จะแสดงผลในไฟล์ Manifest ของ DASH
การแสดง JSON
{
  "content_type": string,
  "mime_type": string,
  "role": object(SchemeIDURIAndValue),
  "inband_event_stream": object(SchemeIDURIAndValue),
  "min_frame_rate": string,
  "max_frame_rate": string,
  "scan_type": string,
  "start_with_sap": string,
  "segment_alignment": boolean,
  "representations": [],
}
ช่อง
content_type string

ประเภทเนื้อหาของชุดการปรับ
mime_type string

ประเภท MIME ของชุดการปรับ
role object(SchemeIDURIAndValue)

บทบาทของชุดการปรับเปลี่ยน
inband_event_stream object(SchemeIDURIAndValue)

สตรีมเหตุการณ์ในแบนด์ของชุดการปรับ
min_frame_rate string

อัตราเฟรมขั้นต่ำของชุดการปรับ
max_frame_rate string

อัตราเฟรมสูงสุดของชุดการปรับ
scan_type string

สแกนประเภทของชุดการปรับ
start_with_sap string

เริ่มต้นด้วย SAP ของชุดการปรับ
segment_alignment boolean

การจัดกลุ่มชุดการปรับเปลี่ยน
representations string

การนําเสนอชุดการปรับเปลี่ยน

SchemeIDURIAndValue

SchemeIDURIAndValue คือคู่ของรหัสรูปแบบและค่าของรหัส
การแสดง JSON
{
  "scheme_id_uri": string,
  "value": string,
}
ช่อง
scheme_id_uri string

URI รหัสสคีมาของค่า
value string

ค่าของ URI รหัสสคีมา

Icon

ไอคอนมีข้อมูลเกี่ยวกับไอคอน VAST
การแสดง JSON
{
  "click_data": object(ClickData),
  "creative_type": string,
  "click_fallback_images": [object(FallbackImage)],
  "height": int32,
  "width": int32,
  "resource": string,
  "type": string,
  "x_position": string,
  "y_position": string,
  "program": string,
  "alt_text": string,
}
ช่อง
click_data object(ClickData)

creative_type string

click_fallback_images [object(FallbackImage)]

height int32

width int32

resource string

type string

x_position string

y_position string

program string

alt_text string

ClickData

ClickData มีข้อมูลเกี่ยวกับการคลิกผ่านไอคอน
การแสดง JSON
{
  "url": string,
}
ช่อง
url string

FallbackImage

FallbackImage มีข้อมูลเกี่ยวกับรูปภาพสำรองของ VAST
การแสดง JSON
{
  "creative_type": string,
  "height": int32,
  "width": int32,
  "resource": string,
  "alt_text": string,
}
ช่อง
creative_type string

height int32

width int32

resource string

alt_text string

Wrapper

Wrapper มีข้อมูลเกี่ยวกับโฆษณา Wrapper โดยไม่รวมรหัสดีลหากไม่มี
การแสดง JSON
{
  "system": string,
  "ad_id": string,
  "creative_id": string,
  "creative_ad_id": string,
  "deal_id": string,
}
ช่อง
system string

ตัวระบุระบบโฆษณา
ad_id string

รหัสโฆษณาที่ใช้สําหรับโฆษณา Wrapper
creative_id string

รหัสครีเอทีฟโฆษณาที่ใช้สําหรับโฆษณา Wrapper
creative_ad_id string

รหัสโฆษณาครีเอทีฟโฆษณาที่ใช้สำหรับโฆษณา Wrapper
deal_id string

รหัสดีลที่ไม่บังคับสําหรับโฆษณา Wrapper

การยืนยัน

การยืนยันมีข้อมูลสําหรับการวัดผลแบบเปิด ซึ่งช่วยในการวัดความสามารถในการแสดงตัวโฆษณาและการยืนยันของบุคคลที่สาม ปัจจุบันรองรับเฉพาะทรัพยากร JavaScript เท่านั้น ดูข้อมูลได้ที่ https://iabtechlab.com/standards/open-measurement-sdk/
การแสดง JSON
{
  "vendor": string,
  "java_script_resources": [object(JavaScriptResource)],
  "tracking_events": [object(TrackingEvent)],
  "parameters": string,
}
ช่อง
vendor string

ผู้ให้บริการยืนยัน
java_script_resources [object(JavaScriptResource)]

รายการแหล่งข้อมูล JavaScript สำหรับการยืนยัน
tracking_events [object(TrackingEvent)]

รายการเหตุการณ์การติดตามสําหรับการยืนยัน
parameters string

สตริงทึบแสงที่ส่งไปยังรหัสยืนยันการเริ่มต้นระบบ

JavaScriptResource

JavaScriptResource มีข้อมูลสําหรับการยืนยันผ่าน JavaScript
การแสดง JSON
{
  "script_url": string,
  "api_framework": string,
  "browser_optional": boolean,
}
ช่อง
script_url string

URI ไปยังเพย์โหลด JavaScript
api_framework string

APIFramework คือชื่อเฟรมเวิร์กวิดีโอที่ใช้รหัสยืนยัน
browser_optional boolean

สคริปต์นี้เรียกใช้ได้นอกเบราว์เซอร์ไหม

TrackingEvent

TrackingEvent มี URL ที่ไคลเอ็นต์ควรปิงในบางสถานการณ์
การแสดง JSON
{
  "event": string,
  "uri": string,
}
ช่อง
event string

ประเภทเหตุการณ์การติดตาม
uri string

เหตุการณ์การติดตามที่จะส่งคําสั่ง ping

UniversalAdID

UniversalAdID ใช้เพื่อระบุตัวระบุครีเอทีฟโฆษณาที่ไม่ซ้ำกันซึ่งระบบโฆษณาจะดูแลรักษา
การแสดง JSON
{
  "id_value": string,
  "id_registry": string,
}
ช่อง
id_value string

รหัสโฆษณาสากลของครีเอทีฟโฆษณาที่เลือกสําหรับโฆษณา
id_registry string

สตริงที่ใช้ระบุ URL ของเว็บไซต์รีจิสทรีที่จัดทําแคตตาล็อกรหัสโฆษณาแบบ Universal ของครีเอทีฟโฆษณาที่เลือก

Companion

ข้อมูลสําหรับโฆษณาที่แสดงร่วมกันซึ่งอาจแสดงพร้อมกับโฆษณา
การแสดง JSON
{
  "click_data": object(ClickData),
  "creative_type": string,
  "height": int32,
  "width": int32,
  "resource": string,
  "type": string,
  "ad_slot_id": string,
  "api_framework": string,
  "tracking_events": [object(TrackingEvent)],
}
ช่อง
click_data object(ClickData)

ข้อมูลการคลิกของโฆษณาที่แสดงร่วมกันนี้
creative_type string

แอตทริบิวต์ CreativeType ในโหนด <StaticResource> ใน VAST หากเป็นโฆษณาที่แสดงร่วมกันประเภทคงที่
height int32

ความสูงเป็นพิกเซลของโฆษณาที่แสดงร่วมนี้
width int32

ความกว้างเป็นพิกเซลของโฆษณาที่แสดงร่วมนี้
resource string

สำหรับชิ้นงานแบบคงที่และชิ้นงานใน iframe จะเป็น URL ที่โหลดและแสดง สําหรับโฆษณาที่แสดงร่วมกันแบบ HTML ข้อมูลโค้ดนี้จะเป็นข้อมูลโค้ด HTML ที่ควรแสดงเป็นโฆษณาที่แสดงร่วมกัน
type string

ประเภทของข้อมูลประกอบนี้ อาจเป็นแบบคงที่, iframe หรือ HTML
ad_slot_id string

รหัสช่องสำหรับอุปกรณ์เสริมนี้
api_framework string

เฟรมเวิร์ก API สําหรับเครื่องมือนี้
tracking_events [object(TrackingEvent)]

รายการเหตุการณ์การติดตามสําหรับอุปกรณ์เสริมนี้

InteractiveFile

InteractiveFile มีข้อมูลสําหรับครีเอทีฟโฆษณาแบบอินเทอร์แอกทีฟ (เช่น SIMID) ที่ควรแสดงระหว่างการเล่นโฆษณา
การแสดง JSON
{
  "resource": string,
  "type": string,
  "variable_duration": boolean,
  "ad_parameters": string,
}
ช่อง
resource string

URL ไปยังครีเอทีฟโฆษณาแบบอินเทอร์แอกทีฟ
type string

ประเภท MIME ของไฟล์ที่ระบุเป็นทรัพยากร
variable_duration boolean

ครีเอทีฟโฆษณานี้อาจขอขยายระยะเวลาหรือไม่
ad_parameters string

ค่าของโหนด <AdParameters> ใน VAST