Dynamic Ad Insertion Pod Serving VOD API

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

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

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

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

เมธอดนี้จะสร้างสตรีมจากอุปกรณ์โดยตรง และส่งคืนทรัพยากรทั้งหมด ที่แอปพลิเคชันไคลเอ็นต์ต้องใช้ในการเล่นและติดตามโฆษณา รวมถึงแสดงองค์ประกอบ UI

เมธอด
create stream POST: /ondemand/pods/api/v1/network/{network_code}/stream

สร้างเซสชัน VOD ของ DAI Pod Serving

คำขอ HTTP

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

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

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

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

เนื้อความของคำขอ

เนื้อความของคำขอมีประเภทเป็น application/json และต้องมีออบเจ็กต์ CreateStreamRequest

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

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

วิธี: ลงทะเบียนสตรีม

เมธอดนี้จะลงทะเบียนสตรีมในแบ็กเอนด์ของ Google DAI จากอุปกรณ์ โดยจะแสดงทรัพยากรทั้งหมดที่แอปพลิเคชันไคลเอ็นต์ต้องใช้เพื่อติดตามโฆษณาและ แสดงองค์ประกอบ UI ซึ่งต่างจากวิธี create stream วิธีนี้จะไม่แสดงไฟล์ Manifest ของโฆษณาที่เล่นได้ แต่การดำเนินการนี้จะ ทำได้ในการเรียกเซิร์ฟเวอร์แยกต่างหาก: decision ad pods

เมธอด
register stream POST: /ondemand/pods/api/v1/network/{network_code}/stream_registration

ลงทะเบียนเซสชัน VOD ของ DAI Pod Serving

คำขอ HTTP

POST https://dai.google.com/ondemand/pods/api/v1/network/{network_code}/stream_registration

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

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

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

เนื้อความของคำขอ

เนื้อความของคำขอมีประเภทเป็น application/json และต้องมีออบเจ็กต์ StreamRegistrationRequest

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

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

วิธี: ดึงข้อมูลพ็อดโฆษณา

วิธีนี้จะทำตามการเรียก register stream จากอุปกรณ์ และจำเป็นต้องดึงข้อมูลไฟล์ Manifest ของโฆษณาที่เล่นได้เพื่อต่อเข้ากับไฟล์ Manifest ของเนื้อหา

เมธอด
decision ad pods POST: /ondemand/pods/api/v1/network/{network_code}/streams/{stream_id}/adpods

ตัดสินใจเกี่ยวกับพ็อดโฆษณาสำหรับเซสชัน VOD ของ DAI Pod Serving

คำขอ HTTP

POST https://dai.google.com/ondemand/pods/api/v1/network/{network_code}/streams/{stream_id}/adpods

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

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

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

stream_id string

stream_id ที่ได้รับจากการเรียก stream_registration

เนื้อความของคำขอ

เนื้อความของคำขอมีประเภทเป็น application/json และต้องมีออบเจ็กต์ AdPodDecisionRequest

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

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

วิธี: ข้อมูลเมตาของพ็อดโฆษณา

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

เมธอด
ad pods metadata GET: /ondemand/pods/api/v1/network/.../metadata

เรียกข้อมูลเมตาของพ็อดโฆษณาสําหรับเซสชันที่เฉพาะเจาะจง URL นี้จะแสดงในแอตทริบิวต์ StreamRegistrationResponse metadata_url

คำขอ HTTP

GET: /ondemand/pods/api/v1/network/.../metadata

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

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีออบเจ็กต์ Ad pods metadata

ออบเจ็กต์ API

PodMetadata

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

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

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

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

ความถี่ในการสำรวจ URL ของข้อมูลเมตาที่แนะนำเป็นวินาที ระบุสำหรับสตรีม VOD โดยใช้การตัดสินใจแบบออนดีมานด์

TagSegment

TagSegment มีการอ้างอิงถึงโฆษณา ช่วงพักโฆษณา และประเภทเหตุการณ์ ไม่ควรปิง 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) ซึ่งควรแสดงระหว่างการเล่นโฆษณา

MatchOpts

MatchOpts ระบุข้อกำหนดการจับคู่สื่อที่เข้มงวดสำหรับสตรีม
การแสดง JSON
{
  "audio_channels": boolean,
  "audio_sample_rate": boolean,
}
ช่อง
audio_channels boolean

จับคู่ช่องเสียงระหว่างเนื้อหากับโฆษณา
audio_sample_rate boolean

จับคู่อัตราการสุ่มตัวอย่างเสียงระหว่างเนื้อหากับโฆษณา

CreateStreamRequest

CreateStreamRequest อธิบายข้อมูลที่พบในคำขอ HTTP ไปยัง VOD Pod Serving API VTP (พาร์ทเนอร์เทคโนโลยีวิดีโอ) จะเป็นผู้เริ่มสตรีมสร้างในนามของ SDK และผู้เผยแพร่โฆษณาสำหรับผู้ใช้ทุกคน สตรีม ที่สร้างขึ้นจะส่งผลให้เกิดพ็อดโฆษณาที่ได้รับเลือกเพื่อให้ VTP เย็บ ซึ่งแตกต่างจากโฟลว์ StreamRegistrationRequest+AdPodDecisionRequest ที่ ลงทะเบียนสตรีมและตัดสินใจเกี่ยวกับ Ad Pod ในคำขอหลายรายการ
การแสดง JSON
{
  "encoding_profiles": [object(EncodingProfile)],
  "ad_tag": string,
  "cuepoints": [],
  "manifest_type": string,
  "enable_hls_asset_list": boolean,
  "targeting_parameters": map[string, string],
  "content_duration_seconds": number,
  "decision_timing_options": object(DecisionTimingOptions),
  "enable_inline_manifests": boolean,
  "dai_options": object(CreateStreamOptions),
}
ช่อง
encoding_profiles [object(EncodingProfile)]

รายการโปรไฟล์การเข้ารหัส ต้องระบุ
ad_tag string

แท็กโฆษณาฐานสำหรับการตัดสินใจ ต้องระบุ
cuepoints number

รายการคิวพอยท์ในหน่วยวินาที ต้องระบุเมื่อการตอบกลับของแท็กโฆษณาใช้การชดเชยเวลาตามตำแหน่ง
manifest_type string

ประเภทไฟล์ Manifest ที่ใช้ได้คือ hls และ dash ค่าเริ่มต้น: hls ไม่บังคับ
enable_hls_asset_list boolean

ระบุว่ามีการเปิดใช้โฆษณาคั่นระหว่างหน้าในรายการเนื้อหา HLS หรือไม่ เมื่อเปิดใช้แล้ว DAI จะแสดง URL รายการชิ้นงานสำหรับช่วงพักโฆษณาแต่ละช่วง ซึ่งใช้กับ โฆษณาคั่นระหว่างหน้า HLS ได้
targeting_parameters string

พารามิเตอร์การกำหนดเป้าหมายเพิ่มเติมของ Ad Manager ไม่บังคับ
content_duration_seconds number

ContentDurationSeconds คือระยะเวลาของเนื้อหาเป็นวินาที ต้องระบุเมื่อการตอบกลับของแท็กโฆษณาใช้การชดเชยเวลาเป็นเปอร์เซ็นต์
decision_timing_options object(DecisionTimingOptions)

ระบุเวลาที่ควรตัดสินใจเกี่ยวกับพ็อดโฆษณา
enable_inline_manifests boolean

ระบุว่าควรฝัง Manifest ของช่วงพักโฆษณาในการตอบกลับ JSON หรือไม่
dai_options object(CreateStreamOptions)

ตัวเลือก DAI สำหรับการสร้างสตรีม

CreateStreamOptions

CreateStreamOptions แสดงตัวเลือกที่มีในเวิร์กโฟลว์การสร้างสตรีมแบบขั้นตอนเดียว
การแสดง JSON
{
  "dash_profile": string,
  "match_options": object(MatchOpts),
  "data_sharing_policy_code": string,
  "sam_id": string,
  "session_title": string,
  "dash_inband_event_stream": boolean,
  "distinct_ad_profiles": boolean,
  "tracking_mode": string,
  "emsg_version": uint32,
}
ช่อง
dash_profile string

โปรไฟล์ MPEG-DASH ที่จะใช้ "สด" หรือ "ออนดีมานด์"
match_options object(MatchOpts)

data_sharing_policy_code string

อนุญาตให้ผู้เผยแพร่เนื้อหาลบล้างนโยบายการแชร์ข้อมูลเริ่มต้นของเครือข่าย
sam_id string

sam_id คือคีย์การแก้ไขข้อบกพร่องของ SAM สำหรับเซสชัน ซึ่งไม่บังคับ
session_title string

session_title คือชื่อเซสชัน SAM สำหรับสตรีม ซึ่งไม่บังคับ
dash_inband_event_stream boolean

dash_inband_event_stream ระบุว่า DAI จะแทรกข้อความ ID3 เป็นเหตุการณ์ในแบนด์ (ในสื่อ) โดยใช้องค์ประกอบ InbandEventStream แทนที่จะเป็นองค์ประกอบ EventStream (ในไฟล์ Manifest)
distinct_ad_profiles boolean

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

tracking_mode คือประเภทการติดตามโฆษณาที่จะใช้กับสตรีม ซึ่งไม่บังคับ ค่าที่ใช้ได้คือ "ad_media", "server", "client"
emsg_version uint32

emsg_version บังคับให้ใช้ emsg เวอร์ชันที่เฉพาะเจาะจงสำหรับ ID3 ในสื่อ รองรับเฉพาะเมื่อ dash_inband_event_stream เป็นจริง

StreamRegistrationRequest

StreamRegistrationRequest จะลงทะเบียนสตรีมจากอุปกรณ์สำหรับการตัดสินใจเกี่ยวกับ พ็อดโฆษณาในอนาคต ซึ่งแตกต่างจาก CreateStreamRequest ที่สร้างสตรีมและตัดสินใจเกี่ยวกับพ็อดโฆษณาในคำขอเดียว
การแสดง JSON
{
  "targeting_parameters": map[string, string],
  "dai_options": object(StreamRegistrationOptions),
}
ช่อง
targeting_parameters string

พารามิเตอร์การกำหนดเป้าหมายเพิ่มเติมของ Ad Manager ไม่บังคับ
dai_options object(StreamRegistrationOptions)

DAIOptions สำหรับการลงทะเบียนสตรีม

StreamRegistrationOptions

StreamRegistrationOptions แสดงตัวเลือกที่ใช้ได้สำหรับการสร้างสตรีม
การแสดง JSON
{
  "sam_id": string,
  "tracking_mode": string,
  "emsg_version": uint32,
  "skippable_ads_supported": boolean,
}
ช่อง
sam_id string

sam_id คือคีย์การแก้ไขข้อบกพร่องของ SAM สำหรับเซสชัน ซึ่งไม่บังคับ
tracking_mode string

tracking_mode คือประเภทการติดตามโฆษณาที่จะใช้กับสตรีม ซึ่งไม่บังคับ ค่าที่ใช้ได้คือ "ad_media", "server", "client"
emsg_version uint32

emsg_version บังคับให้ใช้ emsg เวอร์ชันที่เฉพาะเจาะจงสำหรับ ID3 ในสื่อ รองรับเฉพาะเมื่อ dash_inband_event_stream เป็นจริง
skippable_ads_supported boolean

ระบุว่ารองรับโฆษณาแบบข้ามได้หรือไม่

StreamRegistrationResponse

StreamRegistrationResponse แสดงการตอบกลับ JSON ที่ส่งกลับไปยังไคลเอ็นต์ เพื่อตอบสนองต่อ StreamRegistrationRequest ซึ่งประกอบด้วยรหัสสตรีมและ URL ทั้งหมดที่อุปกรณ์จะต้องใช้ คุณอ้างอิงรหัสสตรีมได้ในคำขอตัดสินพ็อดโฆษณา ที่ตามมา ซึ่งแตกต่างจาก CreateStreamResponse ที่แสดงถึงการตอบสนองสำหรับการสร้างสตรีมและ การตัดสินใจเกี่ยวกับพ็อดโฆษณาพร้อมกัน
การแสดง JSON
{
  "stream_id": string,
  "media_verification_url": string,
  "valid_for": string,
  "valid_until": string,
  "metadata_url": string,
}
ช่อง
stream_id string

StreamID คือตัวระบุที่ไม่ซ้ำกันสำหรับสตรีมปัจจุบันของผู้ชมรายนี้
media_verification_url string

MediaVerificationURL คือคำนำหน้า URL ที่จะใช้ในการยืนยันสื่อโฆษณา คำขอที่อธิบายไว้ด้านล่าง ไม่มีสำหรับสตรีมที่ใช้บีคอนฝั่งไคลเอ็นต์
valid_for string

ValidFor คือระยะเวลาที่สตรีมนี้ใช้งานได้ในรูปแบบ "00h00m00s"
valid_until string

ValidUntil คือวันที่และเวลาที่สตรีมนี้จะใช้ได้
metadata_url string

MetadataURL คือ URL ของข้อมูลเมตาที่จะใช้เพื่อขอข้อมูลเมตาของ Ad Pod

DecisionTimingOptions

DecisionTimingOptions อธิบายตัวเลือกเวลาสำหรับการตัดสินใจเกี่ยวกับช่วงพักโฆษณาสำหรับสตรีม
การแสดง JSON
{
  "type": string,
  "on_create_breaks": [],
}
ช่อง
type string

ประเภทอธิบายเมื่อมีการตัดสินใจเกี่ยวกับพ็อดโฆษณาสําหรับสตรีม ประเภทที่ใช้ได้ ได้แก่ on_create (ค่าเริ่มต้น) และ on_demand เมื่อประเภทเป็น on_demand ระบบจะตัดสินใจเกี่ยวกับโฆษณาแบบเลซีโหลดเมื่อมีการขอไฟล์ Manifest สำหรับ ช่วงพักโฆษณาที่เฉพาะเจาะจง เมื่อประเภทเป็น on_create ระบบจะตัดสินใจเกี่ยวกับโฆษณาทั้งหมดเมื่อสร้างสตรีม
on_create_breaks string

OnCreateBreaks คือรายการ breakID ของ VMAP ที่คำนึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่ซึ่งควรตัดสินใจในสตรีม create อนุญาตให้ใช้ฟิลด์นี้ได้ก็ต่อเมื่อประเภทเป็น on_demand เท่านั้น คุณสามารถใช้ตัวระบุช่วงพักโฆษณาพิเศษ "preroll" และ "postroll" เพื่อระบุว่าควรตัดสินใจเกี่ยวกับช่วงพักโฆษณาตอนต้นหรือตอนท้ายเมื่อสร้างสตรีม

EncodingProfile

EncodingProfile อธิบายการเข้ารหัสของเนื้อหาตัวแปรเดียว โดยอาจมีเฉพาะการตั้งค่าวิดีโอ เฉพาะการตั้งค่าเสียง (ในกรณีของ ประเภทสื่อ) ทั้งการตั้งค่าวิดีโอและเสียง หรือไม่มีเลยในกรณี ของคำบรรยายแทนเสียง
การแสดง JSON
{
  "profile_name": string,
  "type": string,
  "container_type": string,
  "video_settings": object(VideoSettings),
  "audio_settings": object(AudioSettings),
  "subtitle_settings": object(SubtitleSettings),
}
ช่อง
profile_name string

ชื่อที่ผู้เผยแพร่โฆษณาให้ไว้สำหรับโปรไฟล์ ไม่ซ้ำกันต่อสตรีม ต้องระบุ
type string

ประเภทที่ใช้ได้ ได้แก่ สื่อ, iframe, คำบรรยาย ต้องระบุ
container_type string

ประเภทที่ใช้ได้ ได้แก่ mpeg2ts, fmp4cmaf และ hls_packed_audio ต้องระบุสำหรับสื่อประเภทและ iframe
video_settings object(VideoSettings)

ต้องมีการตั้งค่าวิดีโอหากประเภทคอนเทนเนอร์เป็น iframe มิเช่นนั้น จะแสดงเฉพาะในกรณีที่โปรไฟล์มีวิดีโอ
audio_settings object(AudioSettings)

การตั้งค่าเสียงจะปรากฏขึ้นหากโปรไฟล์มีเสียง อนุญาตให้ใช้การตั้งค่าเสียงได้ก็ต่อเมื่อประเภทคอนเทนเนอร์เป็นสื่อ
subtitle_settings object(SubtitleSettings)

ต้องมีการตั้งค่าคำบรรยายสำหรับคำบรรยายประเภท

VideoSettings

VideoSettings อธิบายวิดีโอของโปรไฟล์การเข้ารหัส หากมีการตั้งค่าวิดีโออย่างใดอย่างหนึ่ง ก็ต้องมีการตั้งค่าทั้งหมด
การแสดง JSON
{
  "codec": string,
  "bitrate": int32,
  "frames_per_second": number,
  "resolution": object(Resolution),
}
ช่อง
codec string

สตริงตัวแปลงรหัส RFC6381 ของวิดีโอ
bitrate int32

อัตราบิตสูงสุดของวิดีโอในโปรไฟล์การเข้ารหัส
frames_per_second number

เฟรมต่อวินาทีของวิดีโอ
resolution object(Resolution)

ความละเอียดความกว้าง x ความสูงของวิดีโอ

AudioSettings

AudioSettings อธิบายเสียงของโปรไฟล์การเข้ารหัส หากมีการตั้งค่าเสียงอย่างใดอย่างหนึ่ง ก็ต้องมีการตั้งค่าเสียงทั้งหมด
การแสดง JSON
{
  "codec": string,
  "bitrate": int32,
  "channels": int32,
  "sample_rate": int64,
}
ช่อง
codec string

สตริงตัวแปลงสัญญาณ RFC6381 ของเสียง
bitrate int32

อัตราบิตเสียงสูงสุดของโปรไฟล์การเข้ารหัส
channels int32

จำนวนช่องเสียง (รวมถึงช่องความถี่ต่ำ)
sample_rate int64

อัตราการสุ่มตัวอย่างของเสียงในหน่วยเฮิรตซ์

SubtitleSettings

SubtitleSettings อธิบายคำบรรยายแทนเสียงของโปรไฟล์การเข้ารหัส
การแสดง JSON
{
  "format": string,
  "language": string,
}
ช่อง
format string

รูปแบบของคำบรรยายแทนเสียง webvtt สำหรับ hls, webvtt หรือ ttml สำหรับ dash
language string

ภาษาที่จะแทรกในไฟล์ Manifest

ความละเอียด

ความละเอียดอธิบายความกว้าง x ความสูงของวิดีโอ
การแสดง JSON
{
  "width": int32,
  "height": int32,
}
ช่อง
width int32

ความกว้างของวิดีโอเป็นพิกเซล ต้องระบุ
height int32

ความสูงของวิดีโอในหน่วยพิกเซล ต้องระบุ

AdPodDecisionRequest

AdPodDecisionRequest แสดงคำขอให้ตัดสินใจเกี่ยวกับพ็อดโฆษณาสำหรับสตรีมที่ลงทะเบียนไว้ก่อนหน้านี้
การแสดง JSON
{
  "encoding_profiles": [object(EncodingProfile)],
  "ad_tag": string,
  "cuepoints": [],
  "manifest_type": string,
  "enable_hls_asset_list": boolean,
  "targeting_parameters": map[string, string],
  "content_duration_seconds": number,
  "decision_timing_options": object(DecisionTimingOptions),
  "enable_inline_manifests": boolean,
  "dai_options": object(AdPodDecisionOptions),
}
ช่อง
encoding_profiles [object(EncodingProfile)]

รายการโปรไฟล์การเข้ารหัส ต้องระบุ
ad_tag string

แท็กโฆษณาฐานสำหรับการตัดสินใจ ต้องระบุ
cuepoints number

รายการคิวพอยท์ในหน่วยวินาที ต้องระบุเมื่อการตอบกลับของแท็กโฆษณาใช้การชดเชยเวลาตามตำแหน่ง
manifest_type string

ประเภทไฟล์ Manifest ที่ใช้ได้คือ hls และ dash ค่าเริ่มต้น: hls ไม่บังคับ
enable_hls_asset_list boolean

ระบุว่ามีการเปิดใช้โฆษณาคั่นระหว่างหน้าในรายการเนื้อหา HLS หรือไม่ เมื่อเปิดใช้แล้ว DAI จะแสดง URL รายการชิ้นงานสำหรับช่วงพักโฆษณาแต่ละช่วง ซึ่งใช้กับ โฆษณาคั่นระหว่างหน้า HLS ได้
targeting_parameters string

พารามิเตอร์การกำหนดเป้าหมายเพิ่มเติมของ Ad Manager ไม่บังคับ
content_duration_seconds number

ContentDurationSeconds คือระยะเวลาของเนื้อหาเป็นวินาที ต้องระบุเมื่อการตอบกลับของแท็กโฆษณาใช้การชดเชยเวลาเป็นเปอร์เซ็นต์
decision_timing_options object(DecisionTimingOptions)

ระบุเวลาที่ควรตัดสินใจเกี่ยวกับพ็อดโฆษณา
enable_inline_manifests boolean

ระบุว่าควรฝัง Manifest ของช่วงพักโฆษณาในการตอบกลับ JSON หรือไม่
dai_options object(AdPodDecisionOptions)

DAIOptions สำหรับการตัดสินใจเกี่ยวกับพ็อดโฆษณา

AdPodDecisionResponse

AdPodDecisionResponse แสดงการตอบกลับเพื่อตัดสินใจเกี่ยวกับพ็อดโฆษณาสําหรับสตรีมที่ลงทะเบียนไว้ก่อนหน้านี้ มีรายการพ็อดโฆษณาที่พิจารณา สำหรับสตรีมนั้น
การแสดง JSON
{
  "valid_for": string,
  "valid_until": string,
  "ad_pods": [object(AdPod)],
}
ช่อง
valid_for string

ValidFor คือระยะเวลาที่สตรีมนี้ใช้งานได้ในรูปแบบ "00h00m00s"
valid_until string

ValidUntil คือวันที่และเวลาที่สตรีมนี้จะใช้ได้
ad_pods [object(AdPod)]

รายการพ็อดโฆษณาที่เรียงตามลำดับการแทรก

CreateStreamResponse

CreateStreamResponse แสดงการตอบกลับ JSON ที่ส่งกลับไปยังไคลเอ็นต์ เพื่อตอบสนองต่อ CreateStreamRequest
การแสดง JSON
{
  "valid_for": string,
  "valid_until": string,
  "ad_pods": [object(AdPod)],
  "stream_id": string,
  "media_verification_url": string,
  "pod_metadata": object(PodMetadata),
  "metadata_url": string,
}
ช่อง
valid_for string

ValidFor คือระยะเวลาที่สตรีมนี้ใช้งานได้ในรูปแบบ "00h00m00s"
valid_until string

ValidUntil คือวันที่และเวลาที่สตรีมนี้จะใช้ได้
ad_pods [object(AdPod)]

รายการพ็อดโฆษณาที่เรียงตามลำดับการแทรก
stream_id string

StreamID คือตัวระบุที่ไม่ซ้ำกันสำหรับสตรีมปัจจุบันของผู้ชมรายนี้
media_verification_url string

MediaVerificationURL คือคำนำหน้า URL ที่จะใช้ในการยืนยันสื่อโฆษณา คำขอที่อธิบายไว้ด้านล่าง ไม่มีสำหรับสตรีมที่ใช้บีคอนฝั่งไคลเอ็นต์
pod_metadata object(PodMetadata)

PodMetadata มีข้อมูลเพิ่มเติมที่จำเป็นต่อการแสดงพ็อดใน อุปกรณ์และทริกเกอร์การยืนยัน ตามที่อธิบายไว้ในเอกสาร API เชิงเส้นสำหรับการแทรกโฆษณาแบบไดนามิก รวมไว้สำหรับสตรีมที่ใช้บีคอนฝั่งไคลเอ็นต์เท่านั้น
metadata_url string

MetadataURL คือ URL ของข้อมูลเมตาที่จะใช้เพื่อขอข้อมูลเมตาของ Ad Pod

AdPod

AdPod แสดงช่วงพักโฆษณาที่ได้รับเลือกซึ่งพร้อมสำหรับการเล่น
การแสดง JSON
{
  "manifest_uris": map[string, string],
  "multivariant_uri": string,
  "mpd_uri": string,
  "manifests": map[string, string],
  "multivariant_manifest": string,
  "mpd_manifest": string,
  "asset_list_uri": string,
  "start": number,
  "duration": number,
  "type": string,
  "midroll_index": number,
}
ช่อง
manifest_uris string

ManifestURIs คือแผนที่ของชื่อโปรไฟล์การเข้ารหัสไปยัง manifest_uris ของรูปแบบ HLS สำหรับเนื้อหา HLS
multivariant_uri string

MultivariantURI คือ URI สำหรับไฟล์ Manifest เวอร์ชันหลายตัวแปรของเนื้อหา HLS
mpd_uri string

MPDURI คือ URI สำหรับ MPD สำหรับเนื้อหา DASH
manifests string

Manifests คือแผนที่ของชื่อโปรไฟล์การเข้ารหัสไปยังไฟล์ Manifest ของ HLS Variant จะแสดงข้อมูลก็ต่อเมื่อตั้งค่า enable_inline_manifests เป็น true ในสตรีม
multivariant_manifest string

MultivariantManifest คือไฟล์ Manifest แบบหลายเวอร์ชันสำหรับเนื้อหา HLS จะแสดงข้อมูลก็ต่อเมื่อตั้งค่า enable_inline_manifests เป็น true ในสตรีม
mpd_manifest string

MPDManifest คือไฟล์ Manifest MPD สำหรับเนื้อหา DASH จะแสดงข้อมูลก็ต่อเมื่อตั้งค่า enable_inline_manifests เป็น true ในสตรีม
asset_list_uri string

AssetListURI คือ URI สำหรับรายการชิ้นงานโฆษณาคั่นระหว่างหน้า HLS สำหรับเนื้อหา HLS จะแสดงข้อมูลก็ต่อเมื่อสตรีมเปิดใช้โฆษณาคั่นระหว่างเนื้อหาในรายการเนื้อหา HLS
start number

เวลาเริ่มต้นของพ็อดโฆษณาในไทม์ไลน์ของชิ้นงาน (ไม่รวมพ็อดโฆษณาที่ อยู่ก่อนหน้า) ในหน่วยวินาทีแบบทศนิยม
duration number

ระยะเวลาของพ็อดโฆษณาเป็นวินาทีแบบทศนิยม
type string

ประเภทช่วงพักโฆษณา
midroll_index number

ดัชนีโฆษณาตอนกลางในสตรีมโดยอิงตามรหัสช่วงพักโฆษณาของ VMAP ไม่รวมสำหรับโฆษณาตอนต้นและโฆษณาตอนท้าย

AdPodDecisionOptions

AdPodDecisionOptions แสดงตัวเลือกเพิ่มเติมสำหรับสตรีม
การแสดง JSON
{
  "dash_profile": string,
  "match_options": object(MatchOpts),
  "data_sharing_policy_code": string,
  "sam_id": string,
  "session_title": string,
  "dash_inband_event_stream": boolean,
  "distinct_ad_profiles": boolean,
}
ช่อง
dash_profile string

โปรไฟล์ MPEG-DASH ที่จะใช้ "สด" หรือ "ออนดีมานด์"
match_options object(MatchOpts)

data_sharing_policy_code string

อนุญาตให้ผู้เผยแพร่เนื้อหาลบล้างนโยบายการแชร์ข้อมูลเริ่มต้นของเครือข่าย
sam_id string

sam_id คือคีย์การแก้ไขข้อบกพร่องของ SAM สำหรับเซสชัน ซึ่งไม่บังคับ
session_title string

session_title คือชื่อเซสชัน SAM สำหรับสตรีม ซึ่งไม่บังคับ
dash_inband_event_stream boolean

dash_inband_event_stream ระบุว่า DAI จะแทรกข้อความ ID3 เป็นเหตุการณ์ในแบนด์ (ในสื่อ) โดยใช้องค์ประกอบ InbandEventStream แทนที่จะเป็นองค์ประกอบ EventStream (ในไฟล์ Manifest)
distinct_ad_profiles boolean

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

สตรีม

Stream ใช้เพื่อแสดงรายการทรัพยากรทั้งหมดสำหรับสตรีมที่สร้างขึ้นใหม่ในรูปแบบ JSON
การแสดง JSON
{
  "stream_id": string,
  "valid_for": string,
  "valid_until": string,
  "media_verification_url": string,
}
ช่อง
stream_id string

ตัวระบุสตรีม
valid_for string

ระยะเวลาของสตรีมที่ถูกต้องในรูปแบบ "00h00m00s"
valid_until string

วันที่สตรีมจะใช้ได้จนถึงในรูปแบบ RFC 3339
media_verification_url string

URL การยืนยันสื่อ

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

การยืนยัน

การยืนยันมีข้อมูลสำหรับ Open Measurement ซึ่งช่วยให้การวัดความสามารถในการแสดงตัวโฆษณาและการวัดการยืนยันของบุคคลที่สามเป็นไปได้ ปัจจุบันรองรับเฉพาะทรัพยากร 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

เหตุการณ์การติดตามที่จะปิง

UniversalAdID

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

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

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

Companion

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