REST Resource: adBreak.networks.assets.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/{network_code}/assets/{asset_key}/adBreaks/{adBreakId}"

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 ซึ่งจะลิงก์ช่วงพักโฆษณา GAM 2 ช่วงอย่างมีประสิทธิภาพ
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 เท่านั้น

BreakState

สถานะของช่วงพักโฆษณา

Enum
BREAK_STATE_UNSPECIFIED ไม่ทราบสถานะช่วงพักโฆษณา
BREAK_STATE_DECISIONED การตัดสินใจเกี่ยวกับช่วงพักโฆษณาเริ่มต้นแล้ว แต่ยังไม่ได้แสดงต่อผู้ใช้
BREAK_STATE_COMPLETE ระบบแสดงช่วงพักโฆษณาต่อผู้ใช้
BREAK_STATE_SCHEDULED ระบบกำหนดเวลาช่วงพักโฆษณาสำหรับการตัดสินใจแล้ว
BREAK_STATE_EXPIRED ช่วงพักโฆษณาหมดอายุและใช้งานไม่ได้ โดยค่าเริ่มต้น ช่วงพักโฆษณาจะหมดอายุ 30 นาทีหลังจาก expectedStartTime หรือ 30 นาทีหลังจากที่ช่วงพักโฆษณาเริ่มการตัดสินใจ หากไม่ได้ตั้งค่า expectedStartTime คุณตั้งค่าการหมดอายุอย่างชัดเจนได้โดยใช้ฟิลด์ expireDuration

BreakParams

พารามิเตอร์ที่เชื่อมโยงกับช่วงพักโฆษณา

การแสดง JSON 
{
  "macros": [
    {
      object (KeyValue)
    }
  ],
  "adTagParams": [
    {
      object (KeyValue)
    }
  ]
}
ฟิลด์
macros[]

object (KeyValue)

ไม่บังคับ ค่ามาโครที่กำหนดเองซึ่งแทนที่ตัวยึดตำแหน่งที่กำหนดเองในแท็กโฆษณา เมื่อถึงเวลาส่งคำขอโฆษณา DAI จะขยายมาโครแท็กโฆษณาในรูปแบบ %%DAI_PATTERN:[MACRO_KEY]%% โดยที่ MACRO_KEY คือคีย์

หากตั้งค่าไว้ มาโครเหล่านี้จะมีลำดับความสำคัญเหนือกว่ามาโครที่ตั้งค่าในคำขอการแสดงโฆษณาพ็อด
adTagParams[]

object (KeyValue)

ไม่บังคับ ลบล้างพารามิเตอร์แท็กโฆษณาในคำขอโฆษณาหลัก

ระบบจะใช้พารามิเตอร์เหล่านี้ในการตัดสินใจหากทริกเกอร์ก่อนคำขอการแสดงโฆษณาพ็อดที่มีการตั้งค่า cust_params

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

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

KeyValue

แสดงคู่คีย์-ค่า

การแสดง JSON 
{
  "key": string,
  "value": string
}
ช่อง
key

string

ต้องระบุ คีย์ของคู่คีย์-ค่านี้
value

string

ต้องระบุ ค่าของคู่คีย์-ค่านี้

MatchParams

พารามิเตอร์ที่ตรงกับช่วงพักโฆษณา DAI ที่ผสานรวมที่ตรวจพบ

การแสดง JSON 
{
  "scte35Binary": string,
  "scte35Upid": string,
  "scte35EventId": integer,
  "breakDuration": boolean
}
ฟิลด์
scte35Binary

string

ไม่บังคับ ไบนารี SCTE-35 หากต้องการให้ช่องนี้ตรงกัน ช่วงพักโฆษณาในไฟล์ Manifest ต้องมีสตริงไบนารี SCTE-35 เดียวกัน (เข้ารหัสแบบ base64) หากว่างเปล่า ระบบจะข้าม
scte35Upid

string

ไม่บังคับ UPID (ตัวระบุโปรแกรมที่ไม่ซ้ำกัน) ของ SCTE-35 หากต้องการให้ฟิลด์นี้ตรงกัน ช่วงพักโฆษณาในไฟล์ Manifest ต้องมี UPID ของ SCTE-35 เดียวกัน UPID คือค่าที่แยกวิเคราะห์จากไบนารี SCTE-35 หากว่างเปล่า ระบบจะข้าม
scte35EventId

integer (uint32 format)

ไม่บังคับ รหัสเหตุการณ์ SCTE-35 หากต้องการจับคู่ช่องนี้ ช่วงพักโฆษณาในไฟล์ Manifest ต้องมีรหัสเหตุการณ์เดียวกัน (รหัสเหตุการณ์การต่อ/รหัสเหตุการณ์การแบ่งกลุ่ม) รหัสเหตุการณ์คือค่าที่แยกวิเคราะห์จากไบนารี SCTE-35 หากว่างเปล่า ระบบจะข้าม
breakDuration

boolean

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

ServedBreak

แสดงข้อมูลจริงของช่วงพักโฆษณาที่แสดง

การแสดง JSON 
{
  "breakDetectTime": string,
  "detectedDuration": string,
  "scte35CueOut": string
}
ช่อง
breakDetectTime

string (Timestamp format)

เอาต์พุตเท่านั้น เวลาที่ตรวจพบช่วงพักโฆษณาที่ตรงกัน สำหรับการแสดงโฆษณาพ็อด นี่คือเวลาที่ขอกลุ่ม/ไฟล์ Manifest แรกของพ็อดโฆษณา สำหรับ DAI ที่มีการต่อโฆษณา นี่คือเวลาที่ตรวจพบช่วงพักโฆษณาในไฟล์ Manifest เป็นครั้งแรก

ใช้ 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"
detectedDuration

string (Duration format)

เอาต์พุตเท่านั้น ระยะเวลาที่ตรวจพบซึ่งส่งผ่านในช่วงพักโฆษณาที่ตรงกัน

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

string

เอาต์พุตเท่านั้น ข้อความ SCTE-35 ที่เข้ารหัสแบบ base64 ที่ตรวจพบซึ่งส่งผ่านในช่วงพักโฆษณาที่ตรงกัน

เมธอด

create

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

delete

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

get

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

list

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

patch

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