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)

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

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

string

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

string

אופציונלי. נתונים בקידוד Base64 מ-cue out של scte35. עשוי לכלול את הפקודה 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.

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)

אופציונלי. ערכים של פקודות מאקרו מותאמות אישית שמחליפים placeholder שרירותי בתג המודעה. בזמן שליחת הבקשה להצגת מודעה, DAI מרחיב את פקודות המאקרו של תג המודעה בפורמט %%DAI_PATTERN:[MACRO_KEY]%%, כאשר MACRO_KEY הוא המפתח.

אם מגדירים פקודות מאקרו כאלה, הן מקבלות עדיפות על פני פקודות מאקרו שמוגדרות בבקשה להצגת מודעות ב-Pod.
adTagParams[]

object (KeyValue)

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

הם משמשים לקבלת החלטות אם הם מופעלים לפני בקשות להצגת מודעות בבלוק עם cust_params מוגדר.

בדרך כלל, פרמטרים מבטלים פרמטר של מחרוזת שאילתה בבקשה הראשית להצגת מודעה בהפסקה. בשרתי מודעות מסוימים עם פורמטים של כתובות URL מותאמות אישית, פרמטרים עשויים לבטל מקומות ספציפיים בתג המודעה כדי לעמוד בדרישות של שרת המודעות. הגדרת הערך mridx ב-AdBreak תבטל את השדה breakSequence עם הערך שסופק, אם הוא מספר שלם חיובי ותקף. זה נכון גם לשרתי מודעות שאינם GAM.

אם הפרמטרים האלה מוגדרים, הם מקבלים עדיפות על פני פרמטרים שמוגדרים בבקשה להצגת מודעות ב-Pod.

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 בינארי. כדי שהשדה הזה יתאים, להפסקה למודעה במניפסט צריכה להיות אותה מחרוזת בינארית SCTE-35 (בקידוד Base64). אם השדה ריק, המערכת מדלגת עליו.
scte35Upid

string

אופציונלי. SCTE-35 UPID (מזהה תוכנית ייחודי). כדי שהשדה הזה יתאים, ההפסקה למודעה שמוגדרת במניפסט צריכה להיות בעלת אותו מזהה UPID של SCTE-35. ה-UPID הוא ערך שמנותח מהקובץ הבינארי SCTE-35. אם השדה ריק, המערכת מדלגת עליו.
scte35EventId

integer (uint32 format)

אופציונלי. מזהה האירוע SCTE-35. כדי שתהיה התאמה לשדה הזה, למודעה שמוגדרת במניפסט חייב להיות אותו מזהה אירוע (מזהה אירוע של החלפת תוכן/מזהה אירוע של פילוח). מזהה האירוע הוא ערך שמנותח מהקובץ הבינארי SCTE-35. אם השדה ריק, המערכת מדלגת עליו.
breakDuration

boolean

אופציונלי. משך ההפסקה. כדי שהשדה הזה יתאים, משך ההפסקה למודעה במניפסט חייב להיות זהה ל-expectedDuration של ההפסקה למודעה, עם טווח שגיאה של 1ms. אם הערך הוא False, המערכת מדלגת על השלב הזה.

ServedBreak

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

ייצוג ב-JSON 
{
  "breakDetectTime": string,
  "detectedDuration": string,
  "scte35CueOut": string
}
שדות
breakDetectTime

string (Timestamp format)

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

הפלט שנוצר תמיד יהיה בפורמט 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)

פלט בלבד. המשך שזוהה עבר בהפסקה למודעה התואמת.

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

string

פלט בלבד. ההודעה שזוהתה בקידוד Base64 של SCTE-35 הועברה להפסקה למודעה התואמת.

Methods

create

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

delete

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

get

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

list

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

patch

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