דף זה תורגם על ידי Cloud Translation API.

ממשק API להצגת בלוקים של מודעות דינמיות ב-VOD

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

Service: dai.google.com

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

שיטה: יצירת מקור נתונים

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

Methods
`create stream`	`POST: /ondemand/pods/api/v1/network/{network_code}/stream` יוצרים פוד של DAI להצגת סשן של VOD.

בקשת HTTP

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

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

פרמטרים
`network_code`	`string` קוד הרשת של המוציא לאור ב-Google Ad Manager.

גוף הבקשה

גוף הבקשה הוא מסוג application/json והוא חייב להכיל אובייקט CreateStreamRequest.

גוף התשובה

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

שיטה: register stream

השיטה הזו רושמת סטרימינג בשרת העורפי של Google DAI מהמכשיר, ומחזירה את כל המשאבים שנדרשים לאפליקציית הלקוח כדי לעקוב אחרי מודעות ולהציג רכיבי ממשק משתמש. בניגוד לשיטה create stream, השיטה הזו לא מחזירה מניפסט של מודעות שאפשר להפעיל. במקום זאת, הפעולה הזו מתבצעת בקריאה נפרדת לשרת: decision ad pods.

Methods
`register stream`	`POST: /ondemand/pods/api/v1/network/{network_code}/stream_registration` רושם פוד של DAI שמציג סשן VOD.

בקשת HTTP

POST https://dai.google.com/ondemand/pods/api/v1/network/{network_code}/stream_registration

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

פרמטרים
`network_code`	`string` קוד הרשת של המוציא לאור ב-Google Ad Manager.

גוף הבקשה

גוף הבקשה הוא מסוג application/json והוא חייב להכיל אובייקט StreamRegistrationRequest.

גוף התשובה

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

שיטה: אחזור של בלוקים של מודעות

השיטה הזו פועלת אחרי קריאה (call) של register stream ממכשיר, והיא נחוצה כדי לאחזר מניפסטים של מודעות שניתן להפעיל כדי להוסיף אותם למניפסטים של תוכן.

Methods
`decision ad pods`	`POST: /ondemand/pods/api/v1/network/{network_code}/streams/{stream_id}/adpods` רצפים של מודעות להחלטה על הצגת מודעות ב-DAI בסשן של תוכן וידאו על פי דרישה (VOD).

בקשת HTTP

POST https://dai.google.com/ondemand/pods/api/v1/network/{network_code}/streams/{stream_id}/adpods

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

פרמטרים
`network_code`	`string` קוד הרשת של המוציא לאור ב-Google Ad Manager.
`stream_id`	`string` ‫stream_id שהתקבל משיחה של stream_registration.

גוף הבקשה

גוף הבקשה הוא מסוג application/json והוא חייב להכיל אובייקט AdPodDecisionRequest.

גוף התשובה

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

שיטה: מטא-נתונים של רצפי מודעות

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

Methods
`ad pods metadata`	`GET: /ondemand/pods/api/v1/network/.../metadata` אחזור מטא-נתונים של בלוקים של מודעות בסשן ספציפי. כתובת ה-URL הזו מוחזרת במאפיין `StreamRegistrationResponse` metadata_url.

בקשת HTTP

GET: /ondemand/pods/api/v1/network/.../metadata

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל אובייקט Ad pods metadata.

אובייקטים של API

PodMetadata

‫PodMetadata מכיל מידע על מטא-נתונים של מודעות, הפסקות פרסום ותגי מזהה מדיה.

ייצוג ב-JSON
{ "tags": map[string, object(TagSegment)], "ads": map[string, object(Ad)], "ad_breaks": map[string, object(AdBreak)], "polling_frequency": number, }

שדות
`tags`	`map[string, object(TagSegment)]` מפה של פלחים בתגים שממוינים לפי קידומת התג.
`ads`	`map[string, object(Ad)]` מיפוי של מודעות שעברו אינדוקס לפי מזהה המודעה.
`ad_breaks`	`map[string, object(AdBreak)]` מיפוי של הפסקות למודעות באינדקס לפי מזהה ההפסקה למודעה.
`polling_frequency`	`number` תדירות מומלצת של שליפת נתונים מכתובת ה-URL של המטא-נתונים, בשניות. המאפיין הזה מאוכלס בשידורי VOD באמצעות קבלת החלטות על פי דרישה.

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), }

ייצוג ב-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) שיוצג במהלך הפעלת המודעה.

MatchOpts

ההגדרה MatchOpts מציינת דרישות מחמירות להתאמת מדיה לשידור.

ייצוג ב-JSON
{ "audio_channels": boolean, "audio_sample_rate": boolean, }

שדות
`audio_channels`	`boolean` התאמה בין ערוצי האודיו של התוכן והמודעות.
`audio_sample_rate`	`boolean` התאמה בין קצב דגימת האודיו של התוכן לבין קצב דגימת האודיו של המודעות.

CreateStreamRequest

‫CreateStreamRequest מתאר את המידע שנמצא בבקשות HTTP אל ה-API של שרת ה-pod של VOD. יצירת הסטרימינג מתבצעת על ידי ספק הטכנולוגיה של הסרטונים (VTP), בשם ה-SDK והמוציא לאור, לכל משתמש. הסטרימינג שנוצר מוביל להחלטה על רצפי פרסומות שה-VTP צריך לצרף. זה שונה מהתהליך StreamRegistrationRequest+AdPodDecisionRequest, שבו המערכת רושמת סטרימינג ומקבלת החלטות לגבי בלוקים של מודעות בכמה בקשות.

ייצוג ב-JSON
{ "encoding_profiles": [object(EncodingProfile)], "ad_tag": string, "cuepoints": [], "manifest_type": string, "enable_hls_asset_list": boolean, "targeting_parameters": map[string, string], "content_duration_seconds": number, "decision_timing_options": object(DecisionTimingOptions), "enable_inline_manifests": boolean, "dai_options": object(CreateStreamOptions), }

ייצוג ב-JSON

{
  "encoding_profiles": [object(EncodingProfile)],
  "ad_tag": string,
  "cuepoints": [],
  "manifest_type": string,
  "enable_hls_asset_list": boolean,
  "targeting_parameters": map[string, string],
  "content_duration_seconds": number,
  "decision_timing_options": object(DecisionTimingOptions),
  "enable_inline_manifests": boolean,
  "dai_options": object(CreateStreamOptions),
}

שדות
`encoding_profiles`	`[object(EncodingProfile)]` רשימה של פרופילי קידוד. חובה.
`ad_tag`	`string` תג המודעה הבסיסי לקבלת החלטות. חובה.
`cuepoints`	`number` רשימה של נקודות ציון, בשניות. נדרש אם התגובה של תג המודעה משתמשת בהיסטים של זמן לפי מיקום.
`manifest_type`	`string` סוגי המניפסט התקינים הם: hls ו-dash. ברירת מחדל: hls. אופציונלי.
`enable_hls_asset_list`	‫`boolean` מציין אם מודעות מעברון ברשימת נכסי HLS מופעלות. כשמפעילים את DAI, המערכת מחזירה כתובות URL של רשימת נכסים לכל הפסקה לפרסומות, שאפשר להשתמש בהן למודעות מעבר ב-HLS.
`targeting_parameters`	`string` פרמטרים נוספים לטירגוט ב-Ad Manager. אופציונלי.
`content_duration_seconds`	‫`number` ‫ContentDurationSeconds הוא משך התוכן בשניות. חובה אם התגובה של תג המודעה משתמשת בהיסטים של אחוזים מהזמן.
`decision_timing_options`	`object(DecisionTimingOptions)` מציין מתי צריך לקבל החלטה לגבי חבילות מודעות.
`enable_inline_manifests`	‫`boolean` מציין אם מניפסטים של הפסקות פרסומיות צריכים להיות מוטבעים בתגובת ה-JSON.
`dai_options`	‫`object(CreateStreamOptions)` DAIOptions ליצירת מקור נתונים.

CreateStreamOptions

‫CreateStreamOptions מייצג את האפשרויות שזמינות בתהליך העבודה ליצירת סטרימינג בשלב אחד.

ייצוג ב-JSON
{ "dash_profile": string, "match_options": object(MatchOpts), "data_sharing_policy_code": string, "sam_id": string, "session_title": string, "dash_inband_event_stream": boolean, "distinct_ad_profiles": boolean, "tracking_mode": string, "emsg_version": uint32, }

ייצוג ב-JSON

{
  "dash_profile": string,
  "match_options": object(MatchOpts),
  "data_sharing_policy_code": string,
  "sam_id": string,
  "session_title": string,
  "dash_inband_event_stream": boolean,
  "distinct_ad_profiles": boolean,
  "tracking_mode": string,
  "emsg_version": uint32,
}

שדות
`dash_profile`	`string` פרופיל MPEG-DASH לשימוש, 'בשידור חי' או 'על פי דרישה'.
`match_options`	`object(MatchOpts)`
`data_sharing_policy_code`	‫`string` מאפשר לבעלי תוכן דיגיטלי לעקוף את מדיניות ברירת המחדל של הרשת בנושא שיתוף נתונים.
`sam_id`	`string` sam_id הוא מפתח לניפוי באגים של SAM בסשן, אופציונלי.
`session_title`	`string` session_title הוא שם הסשן של SAM בסטרימינג, אופציונלי.
`dash_inband_event_stream`	‫`boolean` dash_inband_event_stream מציין ש-DAI מוסיף הודעות ID3 כאירועים בתוך פס (בתוך המדיה) באמצעות הרכיב InbandEventStream, ולא כרכיבי EventStream (במניפסט).
`distinct_ad_profiles`	`boolean` אם הערך הוא true, השרת ישתמש בכל פרופיל מודעות זמין פעם אחת לכל היותר כשמתאימים פרופילים של קידוד שהתבקשו.
`tracking_mode`	`string` ‫tracking_mode הוא סוג מעקב המודעות שבו רוצים להשתמש בסטרימינג, אופציונלי. הערכים התקפים הם: ad_media,‏ server,‏ client.
`emsg_version`	‫`uint32` ‫emsg_version מאלץ שימוש בגרסה ספציפית של emsg עבור תגי ID3 בתוך מדיה. התמיכה קיימת רק אם dash_inband_event_stream הוא true.

StreamRegistrationRequest

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

ייצוג ב-JSON
{ "targeting_parameters": map[string, string], "dai_options": object(StreamRegistrationOptions), }

שדות
`targeting_parameters`	`string` פרמטרים נוספים לטירגוט ב-Ad Manager. אופציונלי.
`dai_options`	`object(StreamRegistrationOptions)` DAIOptions for stream registration.

StreamRegistrationOptions

ב-StreamRegistrationOptions מפורטות האפשרויות שזמינות ליצירת סטרימינג

ייצוג ב-JSON
{ "sam_id": string, "tracking_mode": string, "emsg_version": uint32, "skippable_ads_supported": boolean, }

שדות
`sam_id`	`string` sam_id הוא מפתח לניפוי באגים של SAM בסשן, אופציונלי.
`tracking_mode`	`string` ‫tracking_mode הוא סוג מעקב המודעות שבו רוצים להשתמש בסטרימינג, אופציונלי. הערכים התקפים הם: ad_media,‏ server,‏ client.
`emsg_version`	‫`uint32` ‫emsg_version מאלץ שימוש בגרסה ספציפית של emsg עבור תגי ID3 בתוך מדיה. התמיכה קיימת רק אם dash_inband_event_stream הוא true.
`skippable_ads_supported`	`boolean` מציין אם יש תמיכה במודעות שניתן לדלג עליהן.

StreamRegistrationResponse

‫StreamRegistrationResponse מייצג את תגובת ה-JSON שנשלחת חזרה ללקוח בתגובה ל-StreamRegistrationRequest. ההגדרות כוללות את מזהה השידור ואת כל כתובות ה-URL שהמכשיר יצטרך. אפשר להפנות למזהה של מקור הנתונים בבקשה הבאה להחלטה לגבי בלוק פרסום. לעומת זאת, CreateStreamResponse מייצג תגובה ליצירת סטרימינג וקבלת החלטות לגבי בלוקים של מודעות בו-זמנית.

ייצוג ב-JSON
{ "stream_id": string, "media_verification_url": string, "valid_for": string, "valid_until": string, "metadata_url": string, }

שדות
`stream_id`	‫`string` ‫StreamID הוא המזהה הייחודי של הסטרימינג הנוכחי של הצופה.
`media_verification_url`	`string` MediaVerificationURL הוא קידומת כתובת ה-URL שתשמש בבקשות לאימות מדיה במודעות, כפי שמתואר בהמשך. לא מופיע בזרמי נתונים של העברת נתונים באמצעות Beacon בצד הלקוח.
`valid_for`	‫`string` ‫ValidFor הוא משך הזמן שבו הסטרים הזה תקף, בפורמט '00h00m00s'.
`valid_until`	`string` התאריך והשעה שעד אליהם השידור הזה תקף.
`metadata_url`	‫`string` MetadataURL היא כתובת ה-URL של המטא-נתונים שבה יש להשתמש כדי לבקש מטא-נתונים של בלוק פרסום.

DecisionTimingOptions

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

ייצוג ב-JSON
{ "type": string, "on_create_breaks": [], }

שדות

type string

המאפיין Type מתאר מתי מתקבלת החלטה לגבי הצגת בלוקים של מודעות בשידור. הסוגים התקפים הם: on_create (ברירת מחדל), on_demand. כשהסוג הוא on_demand, המערכת מקבלת החלטה לגבי המודעות רק כשנשלחת בקשה למניפסט של הפסקת פרסום מסוימת. אם הערך של המאפיין type הוא on_create, כל ההחלטות לגבי המודעות מתקבלות כשהשידור נוצר.

on_create_breaks ‫string

‫OnCreateBreaks היא רשימה של מזהי הפסקות VMAP שרגישים לאותיות רישיות, שצריך לקבל לגביהם החלטה לגבי יצירת הסטרימינג. השדה הזה מותר רק אם הערך של type הוא on_demand. אפשר להשתמש במזהים המיוחדים של הפסקות הפרסום preroll ו-postroll כדי לציין שההחלטה לגבי הפסקת הפרסום לפני הסרטון או אחרי הסרטון צריכה להתקבל בזמן יצירת הסטרימינג.

שדות
`type`	`string` המאפיין Type מתאר מתי מתקבלת החלטה לגבי הצגת בלוקים של מודעות בשידור. הסוגים התקפים הם: on_create (ברירת מחדל), on_demand. כשהסוג הוא on_demand, המערכת מקבלת החלטה לגבי המודעות רק כשנשלחת בקשה למניפסט של הפסקת פרסום מסוימת. אם הערך של המאפיין type הוא on_create, כל ההחלטות לגבי המודעות מתקבלות כשהשידור נוצר.
`on_create_breaks`	‫`string` ‫OnCreateBreaks היא רשימה של מזהי הפסקות VMAP שרגישים לאותיות רישיות, שצריך לקבל לגביהם החלטה לגבי יצירת הסטרימינג. השדה הזה מותר רק אם הערך של type הוא on_demand. אפשר להשתמש במזהים המיוחדים של הפסקות הפרסום preroll ו-postroll כדי לציין שההחלטה לגבי הפסקת הפרסום לפני הסרטון או אחרי הסרטון צריכה להתקבל בזמן יצירת הסטרימינג.

EncodingProfile

‫EncodingProfile מתאר את הקידוד של וריאציה אחת של תוכן. יכול להיות שהיא תכיל רק הגדרות וידאו, רק הגדרות אודיו (במקרה של סוג המדיה), גם הגדרות וידאו וגם הגדרות אודיו, או אף אחת מהן (במקרה של כתוביות).

ייצוג ב-JSON
{ "profile_name": string, "type": string, "container_type": string, "video_settings": object(VideoSettings), "audio_settings": object(AudioSettings), "subtitle_settings": object(SubtitleSettings), }

שדות
`profile_name`	`string` השם שבעל התוכן הדיגיטלי סיפק לפרופיל. ייחודי לכל זרם. חובה.
`type`	`string` הסוגים התקינים הם: media, ‏ iframe, ‏ subtitles. חובה.
`container_type`	`string` הסוגים התקינים הם: mpeg2ts,‏ fmp4cmaf ו-hls_packed_audio. חובה לציין את הערך הזה עבור סוגי המדיה ו-iframe.
`video_settings`	`object(VideoSettings)` חובה להגדיר את הגדרות הווידאו אם סוג המאגר הוא iframe. אחרת, הם מוצגים רק אם הפרופיל מכיל סרטון.
`audio_settings`	`object(AudioSettings)` הגדרות האודיו מוצגות אם הפרופיל מכיל אודיו. מותר להשתמש בהגדרות אודיו רק אם סוג מאגר התגים הוא מדיה.
`subtitle_settings`	`object(SubtitleSettings)` כדי להשתמש בכתוביות מסוג 'הקלדה' צריך להגדיר את ההגדרות של הכתוביות.

VideoSettings

‫VideoSettings מתאר את הסרטון של פרופיל קידוד. אם מופיעה הגדרה אחת של סרטון, כל ההגדרות חייבות להופיע.

ייצוג ב-JSON
{ "codec": string, "bitrate": int32, "frames_per_second": number, "resolution": object(Resolution), }

שדות
`codec`	`string` מחרוזת הקודק RFC6381 של הווידאו.
`bitrate`	‫`int32` קצב העברת הנתונים המקסימלי של הווידאו בפרופיל הקידוד.
`frames_per_second`	`number` מספר הפריימים לשנייה של הסרטון.
`resolution`	`object(Resolution)` הרזולוציה של הסרטון (רוחב x גובה).

AudioSettings

‫AudioSettings מתאר את האודיו של פרופיל קידוד. אם מופיעה הגדרת אודיו אחת, כל הגדרות האודיו צריכות להופיע.

ייצוג ב-JSON
{ "codec": string, "bitrate": int32, "channels": int32, "sample_rate": int64, }

שדות
`codec`	`string` מחרוזת הקודק RFC6381 של האודיו.
`bitrate`	‫`int32` קצב העברת הנתונים המקסימלי של האודיו בפרופיל הקידוד.
`channels`	`int32` מספר ערוצי האודיו (כולל ערוצים בתדר נמוך).
`sample_rate`	‫`int64` תדירות הדגימה של האודיו, בהרץ.

SubtitleSettings

‫SubtitleSettings מתאר את הכתוביות של פרופילי קידוד.

ייצוג ב-JSON
{ "format": string, "language": string, }

שדות
`format`	`string` הפורמט של הכתוביות: webvtt ל-hls, ‏ webvtt או ttml ל-dash.
`language`	‫`string` השפה להוספה למניפסט.

רזולוציה

הרזולוציה מתארת את הרוחב x הגובה של סרטון.

ייצוג ב-JSON
{ "width": int32, "height": int32, }

שדות
`width`	`int32` רוחב הסרטון, בפיקסלים. חובה.
`height`	`int32` גובה הסרטון, בפיקסלים. חובה.

AdPodDecisionRequest

‫AdPodDecisionRequest מייצג בקשה להחלטה לגבי בלוקים של מודעות בסטרימינג שנרשם בעבר.

ייצוג ב-JSON
{ "encoding_profiles": [object(EncodingProfile)], "ad_tag": string, "cuepoints": [], "manifest_type": string, "enable_hls_asset_list": boolean, "targeting_parameters": map[string, string], "content_duration_seconds": number, "decision_timing_options": object(DecisionTimingOptions), "enable_inline_manifests": boolean, "dai_options": object(AdPodDecisionOptions), }

ייצוג ב-JSON

{
  "encoding_profiles": [object(EncodingProfile)],
  "ad_tag": string,
  "cuepoints": [],
  "manifest_type": string,
  "enable_hls_asset_list": boolean,
  "targeting_parameters": map[string, string],
  "content_duration_seconds": number,
  "decision_timing_options": object(DecisionTimingOptions),
  "enable_inline_manifests": boolean,
  "dai_options": object(AdPodDecisionOptions),
}

שדות
`encoding_profiles`	`[object(EncodingProfile)]` רשימה של פרופילי קידוד. חובה.
`ad_tag`	`string` תג המודעה הבסיסי לקבלת החלטות. חובה.
`cuepoints`	`number` רשימה של נקודות ציון, בשניות. נדרש אם התגובה של תג המודעה משתמשת בהיסטים של זמן לפי מיקום.
`manifest_type`	`string` סוגי המניפסט התקינים הם: hls ו-dash. ברירת מחדל: hls. אופציונלי.
`enable_hls_asset_list`	‫`boolean` מציין אם מודעות מעברון ברשימת נכסי HLS מופעלות. כשמפעילים את DAI, המערכת מחזירה כתובות URL של רשימת נכסים לכל הפסקה לפרסומות, שאפשר להשתמש בהן למודעות מעבר ב-HLS.
`targeting_parameters`	`string` פרמטרים נוספים לטירגוט ב-Ad Manager. אופציונלי.
`content_duration_seconds`	‫`number` ‫ContentDurationSeconds הוא משך התוכן בשניות. חובה אם התגובה של תג המודעה משתמשת בהיסטים של אחוזים מהזמן.
`decision_timing_options`	`object(DecisionTimingOptions)` מציין מתי צריך לקבל החלטה לגבי חבילות מודעות.
`enable_inline_manifests`	‫`boolean` מציין אם מניפסטים של הפסקות פרסומיות צריכים להיות מוטבעים בתגובת ה-JSON.
`dai_options`	`object(AdPodDecisionOptions)` DAIOptions לקבלת החלטה לגבי רצף מודעות.

AdPodDecisionResponse

‫AdPodDecisionResponse מייצג תגובה לבקשה להצגת בלוקים של מודעות בהחלטה עבור סטרימינג שנרשם בעבר. הוא מכיל רשימה של החלטות לגבי בלוקים של מודעות בסטרימינג.

ייצוג ב-JSON
{ "valid_for": string, "valid_until": string, "ad_pods": [object(AdPod)], }

שדות
`valid_for`	‫`string` ‫ValidFor הוא משך הזמן שבו הסטרים הזה תקף, בפורמט '00h00m00s'.
`valid_until`	`string` התאריך והשעה שעד אליהם השידור הזה תקף.
`ad_pods`	`[object(AdPod)]` רשימה של בלוקי מודעות ממוינת לפי סדר הכנסה.

CreateStreamResponse

‫CreateStreamResponse מייצג את תגובת ה-JSON שנשלחת בחזרה ללקוח בתגובה ל-CreateStreamRequest.

ייצוג ב-JSON
{ "valid_for": string, "valid_until": string, "ad_pods": [object(AdPod)], "stream_id": string, "media_verification_url": string, "pod_metadata": object(PodMetadata), "metadata_url": string, }

שדות
`valid_for`	‫`string` ‫ValidFor הוא משך הזמן שבו הסטרים הזה תקף, בפורמט '00h00m00s'.
`valid_until`	`string` התאריך והשעה שעד אליהם השידור הזה תקף.
`ad_pods`	`[object(AdPod)]` רשימה של בלוקי מודעות ממוינת לפי סדר הכנסה.
`stream_id`	‫`string` ‫StreamID הוא המזהה הייחודי של הסטרימינג הנוכחי של הצופה.
`media_verification_url`	`string` MediaVerificationURL הוא קידומת כתובת ה-URL שתשמש בבקשות לאימות מדיה במודעות, כפי שמתואר בהמשך. לא מופיע בזרמי נתונים של העברת נתונים באמצעות Beacon בצד הלקוח.
`pod_metadata`	`object(PodMetadata)` PodMetadata מכיל את המידע הנוסף שנדרש כדי להציג את ה-Pod במכשיר ולהפעיל את האימות. כפי שמתואר במסמכי התיעוד של Dynamic Ad Insertion Linear API. הפרמטר הזה נכלל רק בזרמים של העברת נתונים באמצעות Beacon בצד הלקוח.
`metadata_url`	‫`string` MetadataURL היא כתובת ה-URL של המטא-נתונים שבה יש להשתמש כדי לבקש מטא-נתונים של בלוק פרסום.

AdPod

‫AdPod מייצג הפסקה לפרסום שהוחלט להציג אותה ומוכנה להפעלה.

ייצוג ב-JSON
{ "manifest_uris": map[string, string], "multivariant_uri": string, "mpd_uri": string, "manifests": map[string, string], "multivariant_manifest": string, "mpd_manifest": string, "asset_list_uri": string, "start": number, "duration": number, "type": string, "midroll_index": number, }

ייצוג ב-JSON

{
  "manifest_uris": map[string, string],
  "multivariant_uri": string,
  "mpd_uri": string,
  "manifests": map[string, string],
  "multivariant_manifest": string,
  "mpd_manifest": string,
  "asset_list_uri": string,
  "start": number,
  "duration": number,
  "type": string,
  "midroll_index": number,
}

שדות
`manifest_uris`	‫`string` ManifestURIs היא מפה של שם פרופיל הקידוד ל-HLS variant manifest_uris לתוכן HLS.
`multivariant_uri`	`string` MultivariantURI הוא ה-URI של מניפסט מרובה משתנים לתוכן HLS.
`mpd_uri`	‫`string` MPDURI הוא ה-URI של ה-MPD לתוכן DASH.
`manifests`	`string` Manifests is a map of encoding profile name to the HLS variant manifest. השדה הזה יאוכלס רק אם הערך של enable_inline_manifests בשידור מוגדר כ-true.
`multivariant_manifest`	‫`string` ‫MultivariantManifest הוא מניפסט מרובה וריאציות לתוכן HLS. השדה הזה יאוכלס רק אם הערך של enable_inline_manifests בשידור מוגדר כ-true.
`mpd_manifest`	‫`string` ‫MPDManifest הוא מניפסט MPD לתוכן DASH. השדה הזה יאוכלס רק אם הערך של enable_inline_manifests בשידור מוגדר כ-true.
`asset_list_uri`	`string` ‫AssetListURI הוא ה-URI של רשימת הנכסים של מודעת המעברון ב-HLS לתוכן HLS. הערך מאוכלס רק אם הופעלו מודעות מעבר לרשימת נכסי HLS בסטרימינג.
`start`	`number` שעת ההתחלה של רצף המודעות בציר הזמן של הנכס (לא כולל את רצפי המודעות הקודמים) בשניות של נקודה צפה.
`duration`	`number` משך בלוק המודעות בשניות עם נקודה עשרונית.
`type`	`string` סוג ההפסקה למודעה.
`midroll_index`	‫`number` אינדקס מבוסס-1 של פרסומות באמצע הסרטון בסטרימינג, על סמך מזהה ההפסקה ב-VMAP. ההגדרה הזו לא רלוונטית לסרטונים שלפני או אחרי התוכן.

AdPodDecisionOptions

‫AdPodDecisionOptions מייצג אפשרויות נוספות לסטרימינג.

ייצוג ב-JSON
{ "dash_profile": string, "match_options": object(MatchOpts), "data_sharing_policy_code": string, "sam_id": string, "session_title": string, "dash_inband_event_stream": boolean, "distinct_ad_profiles": boolean, }

ייצוג ב-JSON

{
  "dash_profile": string,
  "match_options": object(MatchOpts),
  "data_sharing_policy_code": string,
  "sam_id": string,
  "session_title": string,
  "dash_inband_event_stream": boolean,
  "distinct_ad_profiles": boolean,
}

שדות
`dash_profile`	`string` פרופיל MPEG-DASH לשימוש, 'בשידור חי' או 'על פי דרישה'.
`match_options`	`object(MatchOpts)`
`data_sharing_policy_code`	‫`string` מאפשר לבעלי תוכן דיגיטלי לעקוף את מדיניות ברירת המחדל של הרשת בנושא שיתוף נתונים.
`sam_id`	`string` sam_id הוא מפתח לניפוי באגים של SAM בסשן, אופציונלי.
`session_title`	`string` session_title הוא שם הסשן של SAM בסטרימינג, אופציונלי.
`dash_inband_event_stream`	‫`boolean` dash_inband_event_stream מציין ש-DAI מוסיף הודעות ID3 כאירועים בתוך פס (בתוך המדיה) באמצעות הרכיב InbandEventStream, ולא כרכיבי EventStream (במניפסט).
`distinct_ad_profiles`	`boolean` אם הערך הוא true, השרת ישתמש בכל פרופיל מודעות זמין פעם אחת לכל היותר כשמתאימים פרופילים של קידוד שהתבקשו.

מקור נתונים

השיטה Stream משמשת לעיבוד רשימה של כל המשאבים של שידור חדש בפורמט JSON .

ייצוג ב-JSON
{ "stream_id": string, "valid_for": string, "valid_until": string, "media_verification_url": string, }

שדות
`stream_id`	`string` מזהה מקור הנתונים.
`valid_for`	`string` משך הזמן שהזרם תקף לגביו, בפורמט '00h00m00s'.
`valid_until`	`string` התאריך שעד אליו הפיד תקף, בפורמט RFC 3339.
`media_verification_url`	`string` כתובת URL לאימות מדיה.

סמל

הסמל מכיל מידע על סמל 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` מזהה המודעה שמשמשת כ-wrapper.
`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.

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

Service: dai.google.com

שיטה: יצירת מקור נתונים

בקשת HTTP

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

גוף הבקשה

גוף התשובה

שיטה: register stream

בקשת HTTP

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

גוף הבקשה

גוף התשובה

שיטה: אחזור של בלוקים של מודעות

בקשת HTTP

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

גוף הבקשה

גוף התשובה

שיטה: מטא-נתונים של רצפי מודעות

בקשת HTTP

גוף התשובה

אובייקטים של API

PodMetadata

TagSegment

AdBreak

מודעה

MatchOpts

CreateStreamRequest

CreateStreamOptions

StreamRegistrationRequest

StreamRegistrationOptions

StreamRegistrationResponse

DecisionTimingOptions

EncodingProfile

VideoSettings

AudioSettings

SubtitleSettings

רזולוציה

AdPodDecisionRequest

AdPodDecisionResponse

CreateStreamResponse

AdPod

AdPodDecisionOptions

מקור נתונים

סמל

ClickData

FallbackImage

Wrapper

אימות

JavaScriptResource

TrackingEvent

UniversalAdID

Companion

InteractiveFile

ממשק API להצגת בלוקים של מודעות דינמיות ב-VOD