REST Resource: 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)

חובה. משך ההפסקה הצפוי.

משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב-'s'. דוגמה: "3.5s".
customParams
(deprecated)

string

אופציונלי. צמדים של מפתח/ערך שייכללו בבקשות להצגת מודעות להפסקה הזו לצורך טירגוט לפי קריטריונים מותאמים אישית ב-Ad Manager. דוגמה: 'key1=value&key2=value2,value22' הוצא משימוש: צריך להגדיר את cust_params ב-breakParams.ad_tag_params באמצעות המפתח cust_params.
scte35CueOut

string

אופציונלי. נתונים בקידוד Base64 מ-scte35 cue out. עשוי לכלול את הפקודה splice_insert()‎ או time_signal()‎. דוגמאות: – עם time_signal(): ‪“/DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAjn/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg==” – עם splice_insert(): ‪"/DAvAAAAAAAA///wFAVIAACPf+/+c2nALv4AUsz1AAAAAAAKAAhDVUVJAAABNWLbowo="
podTemplateName
(deprecated)

string

אופציונלי. שם תבנית ה-Pod ב-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 שעות.

משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב-'s'. דוגמה: "3.5s".
breakSequence

string (int64 format)

פלט בלבד. המזהה של רצף המודעות באמצע הסרטון בהפסקת הפרסום. יכול להיות שלכמה הפסקות למודעות יהיה אותו breakSequence אם הוא צוין במפורש באמצעות breakParams.ad_tag_params עם המפתח mridx. הפעולה הזו מקשרת למעשה בין שתי הפסקות פרסום ב-GAM.
breakParams

object (BreakParams)

אופציונלי. פרמטרים של הפסקה שייכללו בבקשות להצגת מודעות בהפסקה הזו.
matchParams

object (MatchParams)

אופציונלי. הפרמטר הזה משמש ב-DAI עם תפירת מודעות כדי לקבוע איך הפסקה לפרסומות שנוצרה באמצעות ה-API תותאם להפסקה לפרסומות שמוגדרת בקובץ המניפסט. כשמזוהה הפסקה חדשה, מופעלת פונקציית התאמה על כל ההפסקות לפרסום באירוע עם breakState של SCHEDULED או DECISIONED כדי לבדוק אם כל הפרמטרים שמוגדרים ב-matchParams של ההפסקה לפרסום תואמים להפסקה שזוהתה. התאמה מתרחשת אם אחד מהתנאים הבאים מתקיים: 1. למודעה עם הפסקה יש שדה matchParams, וכל הפרמטרים שמוגדרים בו תואמים להפסקה החדשה. 2. ההפסקה המסחרית היא DECISIONED ואין לה שדה matchParams.

כדי למנוע התנהגות של 'התאמה לכל' בטעות (שתתרחש עם matchParams ריק אבל קיים), אם מגדירים את matchParams, הוא לא יכול להיות ריק. אם השדה מופיע בבקשה, צריך להגדיר לפחות אחד מהשדות שלו.

הפסקות הפרסום נבדקות לפי הסדר הזה: 1. עם matchParams, מסודרות לפי expectedStartTime בסדר עולה, createTime בסדר עולה, כאשר הפסקות פרסום ללא expectedStartTime מקבלות עדיפות כשממיינים אותן 2. ללא matchParams, מסודרות לפי expectedStartTime בסדר עולה, createTime בסדר עולה, כאשר הפסקות פרסום ללא expectedStartTime מקבלות עדיפות כשממיינים אותן

אם אף אחד ממספרי ה-EABN בהמתנה לא תואם, DAI יחזור להתנהגות של קבלת החלטות JIT וישתמש באינדקס הזמין הבא של מודעה באמצע הסרטון
servedBreak

object (ServedBreak)

פלט בלבד. העמודה הזו משקפת את המידע בפועל של ההפסקה למודעה שהוצגה. ההגדרה הזו חלה רק על הפסקות למודעות עם COMPLETE breakState.

Methods

create

 ‫API ליצירת הפסקת פרסום בשידור חי.

list

 ‫API להצגת רשימה של הפסקות לפרסום בשידור חי.