REST Resource: adBreak.networks.customAssets.adBreaks

ทรัพยากร: AdBreak

ข้อมูลเมตาของช่วงพักโฆษณาที่ใช้ในการตัดสินใจเลือกโฆษณาสำหรับช่วงพักโฆษณาในกิจกรรมวิดีโอสด

การแสดง JSON 
{
  "name": string,
  "createTime": string,
  "expectedDuration": string,
  "customParams": string,
  "scte35CueOut": string,
  "podTemplateName": string,
  "breakState": enum (BreakState),
  "expectedStartTime": string,
  "expireDuration": string,
  "breakSequence": string,
  "breakParams": {
    object (BreakParams)
  },
  "matchParams": {
    object (MatchParams)
  },
  "servedBreak": {
    object (ServedBreak)
  }
}
ช่อง
name

string

เอาต์พุตเท่านั้น ชื่อทรัพยากรของช่วงพักโฆษณา ฟิลด์นี้จะมีรูปแบบเป็น "networks//assets//adBreaks/"

network_code คือรหัสเครือข่ายใน Google Ad Manager ที่เนื้อหานี้เป็นของ

asset_key คือคีย์ของเหตุการณ์ไลฟ์สดใน Google Ad Manager ซึ่งเป็นที่สร้างช่วงพักโฆษณา

adBreakId คือคีย์ของช่วงพักโฆษณา เอาต์พุตเท่านั้น
createTime

string (Timestamp format)

เอาต์พุตเท่านั้น เวลาสร้างช่วงพักโฆษณา

ใช้ RFC 3339 โดยเอาต์พุตที่สร้างขึ้นจะได้รับการแปลงเป็นรูปแบบ Z เสมอ และใช้ตัวเลขเศษส่วน 0, 3, 6 หรือ 9 หลัก นอกจากนี้ ระบบยังยอมรับออฟเซ็ตอื่นๆ นอกเหนือจาก "Z" ด้วย เช่น "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" หรือ "2014-10-02T15:01:23+05:30"
expectedDuration

string (Duration format)

ต้องระบุ ระยะเวลาพักที่คาดไว้

ระยะเวลาเป็นวินาทีที่มีตัวเลขเศษส่วนได้สูงสุด 9 หลัก โดยลงท้ายด้วย 's' ตัวอย่าง: "3.5s"
customParams
(deprecated)

string

ไม่บังคับ คู่คีย์-ค่าจะรวมอยู่ในคำขอโฆษณาของช่วงพักโฆษณานี้สำหรับการกำหนดเป้าหมายเกณฑ์ที่กำหนดเองใน Ad Manager ตัวอย่าง: "key1=value&key2=value2,value22" เลิกใช้งานแล้ว: โปรดตั้งค่า cust_params ใน breakParams.ad_tag_params โดยใช้คีย์ "cust_params"
scte35CueOut

string

ไม่บังคับ ข้อมูลที่เข้ารหัส Base64 จากข้อความสุดท้าย SCTE-35 อาจมีคำสั่ง splice_insert() หรือ time_signal() ตัวอย่าง - with time_signal(): "/DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAjn/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg==" - with splice_insert(): "/DAvAAAAAAAA///wFAVIAACPf+/+c2nALv4AUsz1AAAAAAAKAAhDVUVJAAABNWLbowo="
podTemplateName
(deprecated)

string

ไม่บังคับ ชื่อเทมเพลตพ็อด Google Ad Manager เลิกใช้งานแล้ว: โปรดตั้งค่า cust_params ใน breakParams.ad_tag_params โดยใช้คีย์ "ptpln"
breakState

enum (BreakState)

เอาต์พุตเท่านั้น สถานะปัจจุบันของช่วงพักโฆษณา
expectedStartTime

string (Timestamp format)

ไม่บังคับ เวลาเริ่มต้นที่คาดไว้ของช่วงพักโฆษณา

ใช้ RFC 3339 โดยเอาต์พุตที่สร้างขึ้นจะได้รับการแปลงเป็นรูปแบบ Z เสมอ และใช้ตัวเลขเศษส่วน 0, 3, 6 หรือ 9 หลัก นอกจากนี้ ระบบยังยอมรับออฟเซ็ตอื่นๆ นอกเหนือจาก "Z" ด้วย เช่น "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" หรือ "2014-10-02T15:01:23+05:30"
expireDuration

string (Duration format)

ไม่บังคับ ทำให้ช่วงพักโฆษณาหมดอายุที่ expectedStartTime + expireDuration หากไม่ได้ตั้งค่า expectedStartTime ช่วงพักโฆษณาจะหมดอายุ expireDuration หลังจากที่การตัดสินใจเริ่มขึ้น ค่าเริ่มต้น: 30 นาที ขั้นต่ำ: 5 นาที สูงสุด: 6 ชั่วโมง

ระยะเวลาเป็นวินาทีที่มีตัวเลขเศษส่วนได้สูงสุด 9 หลัก โดยลงท้ายด้วย 's' ตัวอย่าง: "3.5s"
breakSequence

string (int64 format)

เอาต์พุตเท่านั้น รหัสลำดับช่วงพักโฆษณาตอนกลางของช่วงพักโฆษณา ช่วงพักโฆษณาหลายช่วงอาจมี breakSequence เดียวกันหากระบุอย่างชัดเจนผ่าน breakParams.ad_tag_params ด้วยคีย์ mridx ซึ่งจะลิงก์ช่วงพักโฆษณา 2 ช่วงของ GAM อย่างมีประสิทธิภาพ
breakParams

object (BreakParams)

ไม่บังคับ พารามิเตอร์ช่วงพักที่จะรวมไว้ในคำขอโฆษณาสำหรับช่วงพักนี้
matchParams

object (MatchParams)

ไม่บังคับ ใช้สำหรับ DAI แบบผสานรวมเพื่อกำหนดวิธีจับคู่ช่วงพักโฆษณาที่สร้างผ่าน API กับช่วงพักโฆษณาในไฟล์ Manifest เมื่อตรวจพบช่วงพักใหม่ ระบบจะเรียกใช้ฟังก์ชันการจับคู่กับช่วงพักโฆษณาทั้งหมดของเหตุการณ์ที่มี breakState เป็น SCHEDULED หรือ DECISIONED เพื่อตรวจสอบว่าพารามิเตอร์ที่ตั้งค่าทั้งหมดใน matchParams ของช่วงพักโฆษณาตรงกับช่วงพักที่ตรวจพบหรือไม่ ระบบจะจับคู่หากเป็นไปตามเงื่อนไขใดเงื่อนไขหนึ่งต่อไปนี้ 1. ช่วงพักโฆษณามีช่อง matchParams และพารามิเตอร์ทั้งหมดที่ตั้งค่าไว้ในช่องนี้จะตรงกับช่วงพักใหม่ 2. ช่วงพักโฆษณาคือ DECISIONED และไม่มีช่อง matchParams

หากตั้งค่า matchParams ไว้ จะต้องไม่เว้นว่างไว้เพื่อป้องกันลักษณะการทำงานแบบ "จับคู่ทั้งหมด" โดยไม่ตั้งใจ (ซึ่งจะเกิดขึ้นกับ matchParams ที่ว่างเปล่าแต่มีอยู่) หากมีฟิลด์ในคำขอ จะต้องตั้งค่าฟิลด์ของตัวเองอย่างน้อย 1 ฟิลด์

ระบบจะตรวจสอบช่วงพักโฆษณาตามลำดับต่อไปนี้ 1. ที่มี matchParams โดยเรียงตาม expectedStartTime ที่เพิ่มขึ้น, createTime ที่เพิ่มขึ้น โดยจะจัดลำดับความสำคัญของช่วงพักโฆษณาที่ไม่มี expectedStartTime เมื่อจัดเรียง 2. ที่ไม่มี matchParams โดยเรียงตาม expectedStartTime ที่เพิ่มขึ้น, createTime ที่เพิ่มขึ้น โดยจะจัดลำดับความสำคัญของช่วงพักโฆษณาที่ไม่มี expectedStartTime เมื่อจัดเรียง

หาก EABN ที่รอดำเนินการทั้งหมดไม่ตรงกัน DAI จะกลับไปใช้ลักษณะการทำงานของการตัดสินใจแบบ JIT โดยใช้ดัชนีโฆษณากลางที่ใช้ได้ถัดไป
servedBreak

object (ServedBreak)

เอาต์พุตเท่านั้น ซึ่งแสดงถึงข้อมูลจริงของช่วงพักโฆษณาที่แสดง ตั้งค่าสำหรับช่วงพักโฆษณาที่มี COMPLETE breakState เท่านั้น

เมธอด

create

 API สำหรับสร้างช่วงพักโฆษณาภายในไลฟ์สด

delete

 API สำหรับลบช่วงพักโฆษณาภายในไลฟ์สด

get

 API เพื่อรับช่วงพักโฆษณาภายในไลฟ์สด

list

 API สำหรับแสดงช่วงพักโฆษณาภายในไลฟ์สด

patch

 API สำหรับอัปเดตช่วงพักโฆษณาภายในไลฟ์สด