ממשק API להצגת מודעות דינמיות של הטמעת מודעות דינמיות (DAI)

ממשק ה-API של הטמעת מודעות דינמיות (DAI) מאפשר לכם לבקש שידורים חיים עם DAI ולעקוב אחריהם.

Service: dai.google.com

כל מזהי ה-URI הם יחסיים ל-https://dai.google.com.

שיטה: סטרימינג

Methods
stream POST /ssai/pods/api/v1/network/{network_code}/custom_asset/{custom_asset_key}/stream

רישום של סשן שידור חי של פוד DAI.

בקשת HTTP

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

פרמטרים של נתיב

פרמטרים
network_code string

קוד הרשת של המוציא לאור ב-Google Ad Manager.

custom_asset_key string

המזהה המותאם אישית שמשויך לאירוע הזה ב-Google Ad Manager.

גוף הבקשה

גוף הבקשה הוא מסוג application/x-www-form-urlencoded והוא מכיל את הפרמטרים הבאים:

פרמטרים
פרמטרים של טירגוט ב-DFP אופציונלי פרמטרים נוספים לטירגוט.
Override Stream Parameters אופציונלי החלפת ערכי ברירת המחדל של פרמטר ליצירת מקור נתונים.
אימות HMAC אופציונלי אימות באמצעות טוקן מבוסס-HMAC.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל אובייקט חדש של Stream.

מדידה פתוחה

ממשק ה-API של DAI מכיל מידע לאימות Open Measurement בשדה Verifications. השדה הזה מכיל רכיב Verification אחד או יותר שמפרטים את המשאבים ואת המטא-נתונים שנדרשים להפעלת קוד מדידה של צד שלישי כדי לאמת את ההפעלה של הקריאייטיב. יש תמיכה רק ב-JavaScriptResource. מידע נוסף זמין באתר של IAB Tech Lab ובמפרט של VAST 4.1.

שיטה: פלח של פוד

Methods
pod segment GET /linear/pods/v1/seg/network/{network_code}/custom_asset/{custom_asset_key}/{pod_identifier}/profile/{profile_name}/{segment_number}.{segment_format}

יוצר מקור DAI לנתונים עבור מזהה האירוע הנתון.

בקשת HTTP

GET https://dai.google.com/linear/pods/v1/seg/network/{network_code}/custom_asset/{custom_asset_key}/{pod_identifier}/profile/{profile_name}/{segment_number}.{segment_format}

פרמטרים של נתיב

פרמטרים
network_code string

קוד הרשת של המוציא לאור ב-Google Ad Manager.

custom_asset_key string

המזהה המותאם אישית שמשויך לאירוע הזה ב-Google Ad Manager.

pod_identifier

הפורמטים הנתמכים הם:

pod/{integer}

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

ad_break_id/{string}

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

profile_name string

השם של פרופיל הקידוד של DAI ב-Google Ad Manager שביקשתם. פרופיל הקידוד צריך להיות אחד מפרופילי הקידוד שהוגדרו לאירוע שנבחר.

segment_number integer

האינדקס של פלח המודעות המבוקש בתוך בלוק המודעות הנוכחי, החל מאפס.
segment_format string

סיומת הקובץ שמשויכת לפורמט המקטע המבוקש. הסיומות המקובלות הן: ts, ‏mp4, ‏vtt, ‏aac, ‏ac3 או eac3.

פרמטרים של שאילתה

פרמטרים
stream_id חובה string

מזהה מקור הנתונים של הסשן הנוכחי של המשתמש. הערך הזה מוחזר על ידי בקשה מוצלחת לנקודת הקצה stream.
sd required1 integer

משך המקטע המבוקש, באלפיות השנייה.
so אופציונלי

ההיסט של הפלח המבוקש בתוך רצף המודעות, באלפיות השנייה. אם משמיטים את הפרמטר so, הוא יחושב על ידי הכפלת משך הפלח במספר הפלח.
pd חובה2 integer

משך רצף המודעות, באלפיות השנייה.
auth-token חובה string

אסימון HMAC חתום בקידוד URL עבור בלוק המודעות הנוכחי.
last אופציונלי boolean

מציין את הפלח האחרון בהפסקת הפרסום. לא כוללים את הפרמטר הזה בכל הפלחים האחרים.
scte35 אופציונלי string

אות SCTE-35 בקידוד Base64 להפסקת הפרסום הזו.
cust_params אופציונלי string

קבוצה של צמדי מפתח/ערך שמשמשת לטירגוט קמפיינים ב-Ad Manager. הזוגות האלה צריכים להיות מיוצגים כמחרוזת שאילתה שעברה קידוד URL.

דוגמה:
פרמטרים
  • ‫section = sports
  • ‫page = golf,tennis
Request URL ...&cust_params=section%3Dsports%26page%3Dgolf%2Ctennis...

הערות שוליים

  1. התג sd לא נדרש לפלחים של אתחול. ↩
  2. אין צורך ב-pd לאירועים שמופעלות בהם הפסקות למודעות ללא משך. ↩

דוגמה

GET https://dai.google.com/linear/pods/v1/seg/network/sandbox_dev/custom_asset/podserving-segredirect-custom-key/ad_break_id/adbreak-2/profile/8b8888cf79ad43f0800482ffc035a1ac_ts_a/1.ts?so=0&sd=10000&pd=30000&stream_id=8e19cbc6-850b-404c-99d7-860aa4a674cb:TEST

GET https://dai.google.com/linear/pods/v1/seg/network/sandbox_dev/custom_asset/podserving-segredirect-custom-key/pod/2/profile/8b8888cf79ad43f0800482ffc035a1ac_ts_a/1.ts?so=0&sd=10000&pd=30000&stream_id=8e19cbc6-850b-404c-99d7-860aa4a674cb:TEST

גוף התשובה

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

שיטה: מניפסט של פוד HLS

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

Methods
GET GET /linear/pods/v1/hls/network/{network_code}/custom_asset/{custom_asset}/{pod_identifier}.m3u8;

‫API לאחזור רשימת השמעה מרובת וריאציות בפורמט HLS עבור בלוק פרסום.

בקשת HTTP

GET https://dai.google.com/linear/pods/v1/hls/network/{network_code}/custom_asset/{custom_asset_key}/{pod_identifier}.m3u8?stream_id={stream_id}&pd={pod_duration}

פרמטרים של נתיב

פרמטרים
network_code string

קוד הרשת של המוציא לאור ב-Google Ad Manager.
custom_asset_key string

המזהה בהתאמה אישית שמשויך לאירוע הזה ב-Google Ad Manager
pod_identifier

הפורמטים הנתמכים הם:

pod/{integer}

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

ad_break_id/{string}

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

פרמטרים של שאילתה

פרמטרים
stream_id חובה string

מזהה מקור הנתונים של הסשן הנוכחי של המשתמש. הערך הזה מוחזר על ידי בקשה מוצלחת לנקודת הקצה stream.
pd חובה integer

משך רצף המודעות, באלפיות השנייה.
scte35 אופציונלי string

אות SCTE-35 בקידוד Base64 להפסקת הפרסום הזו.
cust_params אופציונלי string

קבוצה של צמדי מפתח/ערך שמשמשת לטירגוט קמפיינים ב-Ad Manager. הזוגות האלה צריכים להיות מיוצגים כמחרוזת שאילתה שעברה קידוד URL.

דוגמה:
פרמטרים
  • ‫section = sports
  • ‫page = golf,tennis
Request URL ...&cust_params=section%3Dsports%26page%3Dgolf%2Ctennis...

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה הוא רשימת השמעה מרובת משתנים של HLS.

שיטה: מניפסט של פוד DASH

הפונקציה מאחזרת מניפסט של קבוצת מודעות בפורמט MPEG-DASH משידור חי שמוכן לטעינה ולהפעלה בנגן וידאו של לקוח.

Methods
GET GET /linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset}/stream/{stream_id}/pod/{pod_id}/manifest.mpd

‫API לאחזור פלייליסט של MPEG-DASH mpd עבור קבוצת מודעות.

בקשת HTTP

GET https://dai.google.com/linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset_key}/stream/{stream_id}/pod/{pod_id}/manifest.mpd?pd={pod_duration}

פרמטרים של נתיב

פרמטרים
network_code string

קוד הרשת של המוציא לאור ב-Google Ad Manager.
custom_asset_key string

המזהה בהתאמה אישית שמשויך לאירוע הזה ב-Google Ad Manager
stream_id string

מזהה מקור הנתונים של הסשן הנוכחי של המשתמש. הערך הזה מוחזר על ידי בקשה מוצלחת לנקודת הקצה stream.
pod_id integer

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

פרמטרים של שאילתה

פרמטרים
pd חובה integer

משך רצף המודעות, באלפיות השנייה.
scte35 אופציונלי string

אות SCTE-35 בקידוד Base64 להפסקת הפרסום הזו.
cust_params אופציונלי string

קבוצה של צמדי מפתח/ערך שמשמשת לטירגוט קמפיינים ב-Ad Manager. הזוגות האלה צריכים להיות מיוצגים כמחרוזת שאילתה שעברה קידוד URL.

דוגמה:
פרמטרים
  • ‫section = sports
  • ‫page = golf,tennis
Request URL ...&cust_params=section%3Dsports%26page%3Dgolf%2Ctennis...

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה הוא רשימת השמעה של MPEG-DASH mpd.

שיטה: תבנית תקופה של DASH pod

Methods
pods GET /linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset_key}/pods.json

שולח בקשה לתבנית של תקופת DASH מ-Google Ad Manager. התבנית הזו כוללת פקודות מאקרו שצריך לאכלס בפרמטרים של השידור. אחרי שהפקודות המאקרו האלה מאוכלסות, התבנית הופכת לתקופת ההפסקה הפרסומית, ואפשר לשלב אותה במניפסט DASH.

בקשת HTTP

GET https://dai.google.com/linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset_key}/pods.json

פרמטרים של נתיב

פרמטרים
network_code string

קוד הרשת של המוציא לאור ב-Google Ad Manager.

custom_asset_key string

המזהה המותאם אישית שמשויך לאירוע הזה ב-Google Ad Manager.

פרמטרים של שאילתה

פרמטרים
stream_id חובה string

מזהה מקור הנתונים של הסשן הנוכחי של המשתמש. הערך הזה מוחזר על ידי בקשה מוצלחת לנקודת הקצה stream.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל אובייקט PodTemplateResponse חדש.

שיטה: מטא-נתונים של תזמון בלוקים של מודעות

Methods
ad pod timing metadata GET /linear/pods/v1/adv/network/{network_code}/custom_asset/{custom_asset_key}/pod.json

אחזור מטא-נתונים של תזמון בלוקים של מודעות.

בקשת HTTP

GET https://dai.google.com/linear/pods/v1/adv/network/{network_code}/custom_asset/{custom_asset_key}/pod.json

פרמטרים של נתיב

פרמטרים
network_code string

קוד הרשת של המוציא לאור ב-Google Ad Manager.

custom_asset_key string

המזהה המותאם אישית שמשויך לשידור החי הזה ב-Google Ad Manager.

פרמטרים של שאילתה

פרמטרים
stream_id חובה string

מזהה הסטרימינג ב-Ad Manager מאפליקציית נגן הווידאו של הלקוח.
ad_break_id חובה string

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

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

ההגבלות הבאות חלות על מזהים מותאמים אישית של הפסקות פרסומיות:

  • האורך צריך להיות בין 1 ל-63 תווים
  • חייב להכיל רק אותיות קטנות, ספרות ומקפים.
  • המזהה של הפסקת הפרסום preroll שמור לאחזור של בלוק מודעות לפני הסרטון. אי אפשר להשתמש בו כדי לזהות פודים אחרים של מודעות.
auth-token חובה string

המחרוזת auth-token מורכבת מאסימון HMAC עם הפרמטרים הבאים:

  • ad_break_id
  • custom_asset_key
  • exp
  • network_code
  • custom_params
  • pd
  • scte35
timeout אופציונלי integer

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

אם חורגים מהזמן הקצוב לתפוגה, הבקשה מחזירה סטטוס של המתנה.

אם כוללים את הערך הזה, הוא חייב להיות בין 1,000 ל-15,000 מילישניות. אם לא מציינים את הפרמטר הזה, התגובות לא מתעכבות כדי להמתין להחלטה לגבי הצגת מודעה.
final אופציונלי boolean

הערך שמוגדר הוא true כדי לציין ל-DAI שזו הבקשה האחרונה ש-VTP מוכן לשלוח בשביל בלוק המודעות הזה. אם החלטה לגבי מודעה עדיין לא זמינה (בזמן הקצוב האופציונלי לתפוגה), DAI תחזיר לוח קבוע לבקשה הזו.

ברירת המחדל היא false.

פרמטרים לקבלת החלטות לגבי מודעות
pd אופציונלי integer

משך ההפסקה למודעה (באלפיות השנייה). נקרא גם משך רצף המודעות.

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

cust_params אופציונלי string

פרמטרים מותאמים אישית לטירגוט הפסקות פרסום, כפי שמתואר במרכז העזרה של Ad Manager.
scte35 אופציונלי string

אות SCTE-35 בקידוד Base64.

אם האות לא תקין, תישלח הודעה בכותרת X-Ad-Manager-Dai-Warning HTTP של התגובה והבקשה תישלח ללא הערך הלא תקין של scte35.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל אובייקט AdPodTimingMetadataResponse חדש.

שיטה: אימות מדיה

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

בקשות לנקודת הקצה media verification הן אידמפוטנטיות.

Methods
media verification GET /{media_verification_url}/{ad_media_id}

הודעה ל-API על אירוע אימות מדיה.

בקשת HTTP

GET https://{media-verification-url}/{ad-media-id}

גוף התשובה

‫media verification מחזיר את התשובות הבאות:

  • ‫HTTP/1.1 204 No Content אם אימות המדיה מצליח וכל הפינגים נשלחים.
  • HTTP/1.1 404 Not Found אם הבקשה לא יכולה לאמת את המדיה בגלל פורמט לא נכון של כתובת ה-URL או תפוגה.
  • HTTP/1.1 404 Not Found אם בקשת אימות קודמת של המזהה הזה הצליחה.
  • HTTP/1.1 409 Conflict אם בקשה אחרת כבר שולחת פינגים בזמן הזה.

מזהי מדיה של מודעות

מזהי המדיה של המודעות יקודדו בנתיב נפרד של מטא-נתונים – timed metadata עבור נתוני הובלה של HLS, או emsg עבור קובצי mp4. מזהים של מדיה פרסומית תמיד יתחילו במחרוזת google_.

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

שיטה: מטא-נתונים

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

Methods
metadata GET /{metadata_url}/{ad-media-id}

GET /{metadata_url}

אחזור של נתוני מטא-נתונים של מודעות.

בקשת HTTP

GET https://{metadata_url}/{ad-media-id}

GET https://{metadata_url}

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, התגובה מחזירה מופע של PodMetadata.

ניתוח מטא-נתונים

המטא-נתונים מחולקים לשלושה קטעים נפרדים: tags,‏ ads ו-breaks. נקודת הכניסה לנתונים היא הקטע tags. משם, חוזרים על התהליך עם התגים ומחפשים את הרשומה הראשונה שהשם שלה הוא קידומת של מזהה המדיה של המודעה שנמצא בזרם הווידאו. לדוגמה, יכול להיות שמזהה המדיה של המודעה ייראה כך:

google_1234567890

אחרי כן, מחפשים אובייקט תג בשם google_12345. במקרה הזה, הוא תואם למזהה המדיה של המודעה. אחרי שמאתרים את האובייקט הנכון של קידומת המדיה של המודעה, אפשר לחפש מזהי מודעות, מזהי הפסקות פרסום וסוג האירוע. לאחר מכן, מזהי המודעות משמשים לאינדקס של אובייקטים מסוג ads ומזהי ההפסקות הפרסומיות משמשים לאינדקס של אובייקטים מסוג breaks.

נתוני תגובות

מקור נתונים

הפונקציה Stream משמשת לעיבוד רשימת משאבים עבור עדכון תוכן חדש בפורמט JSON.
ייצוג ב-JSON
{
  "stream_id": string,
  "media_verification_url": string,
  "metadata_url": string,
  "session_update_url": string,
  "heartbeat_url": string,
  "polling_frequency": number,
  "pod_manifest_url": string,
  "manifest_format": string,
}
שדות
stream_id ‫string

מזהה מקור הנתונים ב-GAM.
media_verification_url string

כתובת ה-URL לאימות המדיה שמשמשת כנקודת קצה בסיסית למעקב אחרי אירועי הפעלה.
metadata_url ‫string

כתובת ה-URL של המטא-נתונים שמשמשת לשליחת בקשות חוזרות לקבלת מידע תקופתי על אירועי מודעות בשידור הקרוב.
session_update_url string

כתובת ה-URL לעדכון של הסשן שמשמשת לעדכון פרמטרים של טירגוט בסטרימינג הזה. הערכים המקוריים של פרמטרים הטירגוט נשמרים במהלך הבקשה הראשונית ליצירת הזרם.
heartbeat_url string

כתובת ה-URL של אות הפעימה, שמשמשת לשמירה על הסטרימינג של העברת נתונים מצד השרת, חייבת להישלח כל {PollingFrequency} שניות. מאוכלס עבור זרמי איתות בצד השרת.
polling_frequency number

תדירות הבדיקה, בשניות, כששולחים בקשה ל-metadata_url או ל-heartbeat_url.
pod_manifest_url string

תבנית כתובת ה-URL של מניפסט הפוד משמשת ליצירת כתובת ה-URL לאחזור מניפסט הפוד של סטרימינג, בהתאם לכתובת ה-URL של רשימת ההשמעה מרובת הווריאציות ב-HLS או ב-MPD ב-DASH. הערך מאוכלס עבור אירועים של שידורים חיים מסוג הטמעת מודעות דינמיות (DAI) ‏POD_SERVING_MANIFEST. https://developers.google.com/ad-manager/api/reference/v202305/LiveStreamEventService.DynamicAdInsertionType
manifest_format ‫string

הפורמט של המניפסט הוא הפורמט של המניפסט שאוחזר מ-pod_manifest_url,‏ dash או hls.

PodMetadata

‫PodMetadata מכיל מידע על מטא-נתונים של מודעות, הפסקות פרסום ותגי מזהה מדיה.
ייצוג ב-JSON
{
  "tags": map[string, object(TagSegment)],
  "ads": map[string, object(Ad)],
  "ad_breaks": map[string, object(AdBreak)],
}
שדות
tags map[string, object(TagSegment)]

מיפוי של פלחים בתגים לפי קידומת התג.
ads map[string, object(Ad)]

מיפוי של מודעות שעברו אינדוקס לפי מזהה המודעה.
ad_breaks map[string, object(AdBreak)]

מיפוי של הפסקות למודעות באינדקס לפי מזהה ההפסקה למודעה.

TagSegment

התג TagSegment מכיל הפניה למודעה, להפסקת הפרסום שלה ולסוג האירוע. אין לשלוח פינג לנקודת הקצה של אימות המדיה של המודעה באמצעות TagSegment עם type="progress".
ייצוג ב-JSON
{
  "ad": string,
  "ad_break_id": string,
  "type": string,
}
שדות
ad string

המזהה של המודעה של התג הזה.
ad_break_id string

המזהה של ההפסקה הפרסומית של התג הזה.
type string

סוג האירוע של התג הזה.

AdBreak

‫AdBreak מתאר הפסקת פרסומות אחת בשידור. הוא מכיל משך זמן, סוג (mid/pre/post) ומספר המודעות.
ייצוג ב-JSON
{
  "type": string,
  "duration": number,
  "expected_duration": number,
  "ads": number,
}
שדות
type string

סוגי המעברים הקבילים הם: pre,‏ mid ו-post.
duration number

משך הזמן הכולל של המודעות בהפסקה הזו למודעות, בשניות.
expected_duration number

משך הזמן הצפוי של ההפסקה לפרסומות (בשניות), כולל כל המודעות וכל מסך ההמתנה.
ads ‪number

מספר המודעות בהפסקת הפרסומות.
מודעה מתארת מודעה בשידור.
ייצוג ב-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

כתובת היעד של קליק (אופציונלי).
click_tracking_urls string

כתובות URL אופציונליות למעקב קליקים.
verifications [object(Verification)]

רשומות אימות אופציונליות של Open Measurement שמפרטות את המשאבים והמטא-נתונים שנדרשים להרצת קוד מדידה של צד שלישי כדי לאמת את הפעלת הקריאייטיב.
slate boolean

Optional bool indicating the current entry is slate.
icons [object(Icon)]

רשימת סמלים, לא מופיעה אם ריקה.
wrappers [object(Wrapper)]

רשימה של רכיבי Wrapper, מושמטת אם ריקה.
universal_ad_id object(UniversalAdID)

מזהה מודעה אוניברסלי אופציונלי.
extensions ‫string

רשימה אופציונלית של כל הצמתים מסוג <Extension> ב-VAST.
companions [object(Companion)]

מודעות נלוות אופציונליות שיכולות להופיע לצד המודעה הזו.
interactive_file object(InteractiveFile)

קריאייטיב אינטראקטיבי אופציונלי (SIMID) שיוצג במהלך הפעלת המודעה.

PodTemplateResponse

‫PodTemplateResponse מייצג את מטען ה-JSON שמוחזר ל-VTP לצורך חיבור בין פודים.
ייצוג ב-JSON
{
  "dash_period_template": string,
  "segment_duration_ms": int64,
}
שדות
dash_period_template string

DashPeriodTemplate היא תבנית ה-XML של התקופה שאותה צריך למלא בנתונים מתאימים לפני השילוב.
segment_duration_ms int64

SegmentDurationMS הוא משך הזמן של פלחי התקופה באלפיות השנייה.

AdpodTimingMetadataResponse

התגובה AdpodTimingMetadataResponse מכילה מידע על בלוק המודעות ועל אופן הבנייה של כתובות URL של פלחים עבורו.
ייצוג ב-JSON
{
  "status": string,
  "ads": [object(AdRendering)],
  "slate": object(SlateRendering),
  "dash_representations": map[string, object(DASHRepresentation)],
  "dash_adaptation_sets": map[string, object(DASHAdaptationSet)],
}
שדות
status string

סטטוס ההחלטה לגבי חבילת המודעות.
ads [object(AdRendering)]

מערך של אובייקטים מסוג Ad שמתארים איך להציג את כתובות ה-URL של פלח המודעה, עם אינדקס שמתחיל ב-0.
slate object(SlateRendering)

Slate describing how to render the slate segment urls.
dash_representations map[string, object(DASHRepresentation)]

רשימה של ייצוגי DASH של בלוק המודעות הזה, שיוצגו במניפסטים של DASH.
dash_adaptation_sets map[string, object(DASHAdaptationSet)]

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

AdRendering

במאמר AdRendering מוסבר איך להציג מודעה שהתקבלה לגביה החלטה.
ייצוג ב-JSON
{
  "duration_ms": number,
  "variants": map[string, object(VariantRendering)],
}
שדות
duration_ms number

משך הצגת המודעה, באלפיות השנייה (מספר שלם).
variants map[string, object(VariantRendering)]

מילון של אובייקטים מסוג Variant (וריאנט) (ראו בהמשך), שמוצג לפי מזהה הווריאנט או הפרופיל, כפי שהוגדר בממשק המשתמש.

SlateRendering

‫SlateRendering מתאר איך להציג תוכן של Slate.
ייצוג ב-JSON
{
  "duration_ms": number,
  "variants": map[string, object(VariantRendering)],
}
שדות
duration_ms number

משך הזמן של המסך, באלפיות השנייה (מספר שלם).
variants map[string, object(VariantRendering)]

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

VariantRendering

‫VariantRendering מתאר וריאנט או פרופיל אחד בתוך המודעה או הלוח.
ייצוג ב-JSON
{
  "segment_extension": string,
  "segment_durations": object(SegmentDurations),
}
שדות
segment_extension string

מחרוזת, אחת מהאפשרויות הבאות: ts, ‏ mp4, ‏ aac, ‏ ac3, ‏ ec3, ‏ m4a, ‏ m4v. חלק מסיומת שם הקובץ של כתובות ה-URL של הפלח.
segment_durations ‫object(SegmentDurations)

אובייקטים של SegmentDurations. אפשר לתרגם את משך הזמן של כל פלח לכתובת URL של פלח.

SegmentDurations

הפונקציה SegmentDurations מתארת את משך הזמן של רצף פלחים, ביחידת זמן שצוינה.
ייצוג ב-JSON
{
  "timescale": number,
  "values": [],
}
שדות
timescale number

Timescale הוא מספר היחידות לשנייה (int) הערך הצפוי: ‫1000 ל-HLS (אלפיות השנייה) ‫90000 לסרטון DASH (PTS) קצב הדגימה של האודיו ב-DASH.
values ‫number

מערך של משכי פלחים מסוג int, ביחידות של ציר הזמן.

DASHRepresentation

‫DASHRepresentation מתאר צמתי Representation שצריך לעבד במניפסטים של DASH.
ייצוג ב-JSON
{
  "codecs": string,
  "bandwidth": number,
  "width": number,
  "height": number,
  "frame_rate": string,
  "audio_sampling_rate": number,
  "audio_channel_config": object(SchemeIDURIAndValue),
}
שדות
codecs string

הקודקים של הייצוג.
bandwidth number

רוחב הפס של הייצוג.
width number

רוחב הייצוג.
height number

גובה הייצוג.
frame_rate ‫string

קצב הפריימים של הייצוג.
audio_sampling_rate ‫number

תדירות הדגימה של האודיו בייצוג.
audio_channel_config ‫object(SchemeIDURIAndValue)

הגדרת ערוץ האודיו של הייצוג.

DASHAdaptationSet

‫DASHAdaptationSet מתאר צמתי AdaptationSet שיוצגו במניפסטים של DASH.
ייצוג ב-JSON
{
  "content_type": string,
  "mime_type": string,
  "role": object(SchemeIDURIAndValue),
  "inband_event_stream": object(SchemeIDURIAndValue),
  "min_frame_rate": string,
  "max_frame_rate": string,
  "scan_type": string,
  "start_with_sap": string,
  "segment_alignment": boolean,
  "representations": [],
}
שדות
content_type ‫string

סוג התוכן של קבוצת ההתאמות.
mime_type string

סוג ה-MIME של קבוצת ההתאמות.
role object(SchemeIDURIAndValue)

תפקיד ערכת ההתאמה.
inband_event_stream ‫object(SchemeIDURIAndValue)

Inband event stream of the adaptation set.
min_frame_rate string

קצב הפריימים המינימלי של קבוצת ההתאמה.
max_frame_rate ‫string

קצב הפריימים המקסימלי של קבוצת ההתאמה.
scan_type string

סוג הסריקה של קבוצת ההתאמות.
start_with_sap string

מתחילים עם SAP של קבוצת ההתאמה.
segment_alignment boolean

התאמת הפלחים של חבילת ההתאמה.
representations string

ייצוגים של קבוצת ההתאמות.

SchemeIDURIAndValue

‫SchemeIDURIAndValue הוא צמד של מזהה סכימה והערך שלו.
ייצוג ב-JSON
{
  "scheme_id_uri": string,
  "value": string,
}
שדות
scheme_id_uri string

מזהה הסכימה URI של הערך.
value ‪string

הערך של ה-URI של מזהה הסכימה.

סמל

הסמל מכיל מידע על סמל 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

מזהה המודעה שמשמשת למודעת העטיפה.
creative_id string

מזהה הקריאייטיב שמשמש למודעת העטיפה.
creative_ad_id string

מזהה מודעה של קריאייטיב שמשמש למודעת העטיפה.
deal_id string

מזהה עסקה אופציונלי של מודעת העטיפה.

אימות

האימות מכיל מידע על מדידה פתוחה (OM), שמקלה על מדידת הנראות ואימות של צד שלישי. בשלב הזה יש תמיכה רק במשאבי 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 to javascript payload.
api_framework string

APIFramework הוא השם של מסגרת הווידאו שמפעילה את קוד האימות.
browser_optional boolean

Whether this script can be run outside of a browser.

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.