Early ad break notification v1

שימוש ב-Early Ad Break Notification API

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

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

• משך הזמן הצפוי של ההפסקה הבאה למודעה. משך ההפסקה צריך להיות קרוב ככל האפשר למשך ההפסקה בפועל למודעה.

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

דרישות מוקדמות

כדי להשתמש ב-EABN API, צריך ליצור חשבון שירות ולהוסיף את החשבון לרשת שלכם ב-Google Ad Manager.

יצירת חשבון שירות

כדי ליצור חשבון שירות לקריאה ל-EABN API, מבצעים את השלבים הבאים: - אם יש לכם חשבון Google Cloud, אתם יכולים להשתמש במודול IAM כדי ליצור חשבון שירות. למידע נוסף, קראו את המאמר יצירה וניהול של חשבונות שירות. - אם אין לכם חשבון Google Cloud, עליכם לפעול לפי השלבים הבאים כדי ליצור חשבון דרך מסוף Google API:

1. יוצרים פרויקט חדש או בוחרים פרויקט קיים.
2. בדף Credentials, לוחצים על Manage service accounts.
3. בדף Service accounts, לוחצים על CREATE SERVICE ACCOUNT.
4. בדף Create Service account, מזינים את פרטי החשבון. לאחר מכן, לוחצים על יצירה.

אחרי שיוצרים חשבון שירות, מעתיקים את מפתח ה-JSON של החשבון, שמשמש לאימות.

הוספת חשבון השירות לרשת Google Ad Manager

כדי להוסיף את חשבון השירות לרשת, מבצעים את השלבים המפורטים במאמר הוספת משתמש בחשבון שירות לגישה ל-API.

הפעלת ה-API

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

• כתובת האימייל של חשבון Google Cloud
• חשבון השירות שלכם
• קוד הרשת של הרשת שלכם ב-Google Ad Manager.

אחרי שמנהל החשבון מפעיל את ה-API, מבצעים את השלבים הבאים כדי להפעיל אותו:

1. בספריית Google API, מחפשים את 'Google Ad Manager Video API'.
2. לוחצים על ENABLE.

הערה: אם ה-API לא מופיע בתוצאות החיפוש, פנו למנהל החשבון כדי לוודא שהחשבון שלכם הופעל ל-DAI API.

שימוש ב-API

אפשר לקרוא ל-EABN API באמצעות בקשות JSON/REST.

אישור

כדי לבצע קריאות מורשות ל-EABN API, צריך ליצור פרטי כניסה לחשבון שירות של OAuth2 באמצעות מפתח ה-JSON מחשבון השירות וההיקף https://www.googleapis.com/auth/video-ads. למידע נוסף, ראו שימוש ב-OAuth 2.0 לאפליקציות שרת-אל-שרת.

צריך לכלול את אסימון ההרשאה שנוצר ככותרת Auth בכל קריאה ל-EABN API.

שליחת התראה מראש על הפסקה למודעה

כדי לשלוח התראה על הפסקה מוקדמת למודעה, שולחים בקשת POST לאחת משלוש כתובות ה-URL התקפות של EABN, בהתאם לאופן שבו רוצים לציין את השידור החי. בקטעים הבאים מוסבר על ההבדלים בין כתובות ה-URL, ומפורטות דוגמאות לבקשות ולתשובות.

כתובות URL

יש שלוש כתובות URL תקינות לקבלת התראה על הפסקה מוקדמת למודעה. אפשר להשתמש בכל שלושת הסוגים כדי ליצור הפסקה למודעה (POST) או לקבל את רשימת ההפסקות למודעות שהוקצו (GET).

כדי להשתמש במפתח הנכס של שידור חי, צריך להשתמש ב-:

POST admanagervideo.googleapis.com/v1/networks/{network_code}/assets/{asset_key}/adBreaks

GET admanagervideo.googleapis.com/v1/networks/{network_code}/assets/{asset_key}/adBreaks

כדי להשתמש במפתח הנכס המותאם אישית של שידור חי, צריך להשתמש ב-:

POST admanagervideo.googleapis.com/v1/networks/{network_code}/customAssets/{custom_asset_key}/adBreaks

GET admanagervideo.googleapis.com/v1/networks/{network_code}/customAssets/{custom_asset_key}/adBreaks

כדי להשתמש במזהה של מקור התוכן ובגישה של Content ID, צריך להשתמש באפשרויות הבאות:

POST admanagervideo.googleapis.com/v1/networks/{network_code}/sources/{content_source_id}/content/{content_id}/adBreaks

GET admanagervideo.googleapis.com/v1/networks/{network_code}/sources/{content_source_id}/content/{content_id}/adBreaks

לכל הפרמטרים:

• network_code מייצג את קוד הרשת של הרשת ב-Google Ad Manager.
• asset_key מייצג את מפתח הנכס שמוצג בדף הפרטים של השידור החי.
• custom_asset_key מייצג את מפתח הנכס המותאם אישית של השידור החי.
• השדה content_source_id מייצג את המזהה של מקור תוכן ב-Google Ad Manager.
• content_id מייצג את המזהה של קטע תוכן ב-Google Ad Manager.

הערה: הצמד content_source_id/content_id שצוין צריך להיות משויך לשידור חי ב-Google Ad Manager.

גוף הבקשה – משמש רק ליצירת הפסקה למודעה (POST)

אובייקט
expectedDuration	חובה	משך ההפסקה למודעה, לפי הפורמט הסטנדרטי של Google למשך זמן (xx.xxx שניות, כאשר xx.xxx הוא מספר השניות)
customParams	אופציונלי	צמדי מפתח/ערך שכלולים בבקשות להצגת מודעות להפסקה הזו לטירגוט לפי קריטריונים מותאמים אישית ב-AM360, מופרדים באמצעות = וגם הצטרפו אליה & . דוגמה: key=value&key2=value2,value3 מידע נוסף על טירגוט זמין במאמר הוספת פרמטרים של טירגוט לשידור.
podTemplateName	אופציונלי	שם התבנית של רצף המודעות
scte35CueOut	אופציונלי	נתונים בקידוד Base64 מהאות לסיום של scte35. יכולים לכלול את splice_insert() או time_signal() פקודה. דוגמאות: time_signal(): /DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAjn/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg== splice_insert(): /DAvAAAAAAAA///wFAVIAACPf+/+c2nALv4AUsz1AAAAAAAKAAhDVUVJAAABNWLbowo=

דוגמאות לבקשות

יצירת הפסקה למודעה

POST admanagervideo.googleapis.com/v1/networks/.../sources/.../content/.../adBreaks
Content-Type: application/json
Authorization: Bearer …
{
    "expectedDuration": "30s",
    "scte35CueOut": "/DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAjn/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg==",
    "customParams": "param1=value1&param2=value2",
    "podTemplateName": "podtemplate"
}

גוף התשובה

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

networks/{network_code}/assets/{asset_key}/adBreaks/{ad_break_id}

דוגמה לתשובה

HTTP/1.1 200 OK
{
  "name": "networks/.../assets/.../adBreaks/1",
  "expectedDuration": "30s",
  "scte35CueOut": "/DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAjn/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg==",
  "customParams": "param1=value1&param2=value2",
  "podTemplateName": "podtemplate"
}

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

GET admanagervideo.googleapis.com/v1/networks/.../sources/.../content/.../adBreaks
Content-Type: application/json
Authorization: Bearer …

גוף התשובה

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

 // Ad break decisioning has started.
BREAK_STATE_DECISIONED

// Break has started to be delivered to end users.
BREAK_STATE_COMPLETE

דוגמה לתשובה

HTTP/1.1 200 OK
{
  "name": "networks/.../assets/.../adBreaks/1",
  "expectedDuration": "30s",
  "breakState": "BREAK_STATE_COMPLETE"
}