Package google.ads.drx.video.v1

אינדקס

AdBreakNotificationService

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

CreateAdBreak

rpc CreateAdBreak(CreateAdBreakRequest) returns (AdBreak)

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

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/contentingestion
  • https://www.googleapis.com/auth/video-ads

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.
ListAdBreaks

rpc ListAdBreaks(ListAdBreaksRequest) returns (ListAdBreaksResponse)

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

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/contentingestion
  • https://www.googleapis.com/auth/video-ads

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

VideoContentIngestionService

שירות API להטמעת נתוני תוכן שמאפשר ליצור או לעדכן תוכן וידאו ואת המטא-נתונים שמשויכים אליו ב-Google Ad Manager.

UpdateVideoContent

rpc UpdateVideoContent(UpdateVideoContentRequest) returns (VideoContent)

API ליצירת תוכן חדש או לעדכון המטא-נתונים שלו אם התוכן כבר קיים ב-Ad Manager. הפונקציה מחזירה את התוכן על כישלון או על כישלון google.rpc.Code.

בקשה לדוגמה נראית כך:

{
   "status": "ACTIVE",
   "title": "Best video ever",
   "updateTime": "2019-01-24T01:30:15.01Z",
   "duration": "230s",
   "cuePoints": ["55.532s", "192s"],
   "publishTime": "2019-01-24T01:30:15.01Z",
   "thumbnailUrl": "http://www.domain.com/tn.jpg",
   "metadata": {
       "keyValues": {
           "category": "sports",
           "tag": ["soccer", "messi"],
       }
   }
}
היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/contentingestion
  • https://www.googleapis.com/auth/video-ads

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

AdBreak

מטא-נתונים של הפסקה למודעה שמשמש לבחירת מודעות להפסקה למודעה באירוע וידאו בשידור חי.

שדות
name

string

פלט בלבד. שם המשאב של ההפסקה למודעות. הפורמט של השדה הזה הוא "networks//assets//adBreaks/".

network_code הוא קוד הרשת ב-Google Ad Manager שאליו שייך התוכן הזה.

asset_key הוא המפתח של האירוע בשידור חי ב-Google Ad Manage שבו נוצר ההפסקה למודעות.

ad_break_id הוא המפתח להפסקה למודעות. פלט בלבד.
expected_duration

Duration

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

string

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

string

יציאה בקידוד scte35 מסימון scte35 על בסיס נתונים בקידוד 64. יכול לכלול את הפקודה splice_insert() או time_signal() . דוגמאות: - עם time_signal():‏ ‎“/DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAjn/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg==”‎ - עם splice_insert():‏ ‎"/DAvAAAAAAAA///wFAVIAACPf+/+c2nALv4AUsz1AAAAAAAKAAhDVUVJAAABNWLbowo="‎
pod_template_name

string

שם תבנית Pod של Google Ad Manager.
break_state

BreakState

המצב הנוכחי של ההפסקה למודעות.

BreakState

הסטטוס של ההפסקה למודעה.

טיפוסים בני מנייה (enum)
BREAK_STATE_UNSPECIFIED הסטטוס של ההפסקה למודעה לא ידוע.
BREAK_STATE_DECISIONED ההחלטה לגבי ההפסקות למודעות התחילה אבל עדיין לא נמסרה למשתמשים.
BREAK_STATE_COMPLETE הפסקת המודעות הוצגה למשתמשים.

ClosedCaptionFormat

הפורמטים שבהם יכולים להיות קובצי הכתוביות.

טיפוסים בני מנייה (enum)
CLOSED_CAPTION_FORMAT_UNSPECIFIED לא צוין פורמט של כתוביות.
TTML application/ttaf+xml
WEB_VTT text/vtt

ClosedCaptionUrlInfo

מטא-נתונים של קובץ כתוביות אחד.

שדות
language_code

string

קוד השפה IETF BCP-47 שמייצג את השפה שבה נכתבו הכתוביות בקובץ.
closed_caption_format

ClosedCaptionFormat

הפורמט של קובץ הכתוביות.
url

string

כתובת ה-URL של קובץ הכתוביות.

CreateAdBreakRequest

בקשה עבור AdBreakNotificationService.CreateAdBreak.

שדות
parent

string

השדה הזה מזהה את האירוע LiveStreamEvent שצריך לשייך אליו את ההפסקה הזו למודעה באמצעות מפתח הנכס של השידור החי. הפורמט צריך להיות networks/{network_code}/assets/{asset_code}‎
custom_parent

string

השדה הזה מזהה את האירוע LiveStreamEvent שצריך לשייך אליו את ההפסקה הזו למודעה באמצעות מפתח הנכס המותאם אישית. הפורמט צריך להיות 'networks/{network_code}/customAssets/{asset_code}'
content

string

זוהי דרך חלופית לזהות את ה-LiveStreamEvent, אם הוא משויך לקטע תוכן ב-GAM. חייב להיות בפורמט הבא: 'networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}'
ad_break

AdBreak

חובה. ההפסקה בפועל למודעה.
ad_break_id

string

זהו מזהה ה-ad_break_id שהמשתמשים יכולים לספק באמצעות הבקשה.

DynamicAdInsertionInfo

מידע שקשור להטמעת מודעות דינמיות.

שדות
video_ingest_url_info

VideoIngestUrlInfo

קישור לקובץ ה-m3u8 הראשי שמשמש ליצירת התאמות וליצירת פלייליסטים.
media_update_time

Timestamp

המועד שבו בוצע השינוי האחרון בקובץ הסרטון שאליו מפנה video_ingest_url_info.
closed_caption_url_info[]

ClosedCaptionUrlInfo

כתובת ה-URL של קובץ הכתוביות.
fw_caid

string

מזהה נכס מותאם אישית של Freewheel שמשמש לטירגוט מודעות.

GracenoteMetadata

המטא-נתונים של Gracenote של התוכן.

שדות
gracenote_id

string

חובה. מתייחס למזהה Gracenote של התוכן. היא חייבת לכלול את אחת מהקידומות החוקיות הבאות: 1. 'EP' – פרק בסדרה 2. 'MV' – סרט 3. 'SP' – אירוע ספורט
gracenote_series_id

string

זה שינוי אופציונלי. השדה הזה מתייחס למזהה הסדרה ב-Gracenote. התחילית של הכתובת חייבת להיות 'SH'.

ListAdBreaksRequest

בקשה עבור AdBreakNotificationService.ListAdBreaks.

שדות
parent

string

זה שינוי אופציונלי. השדה הזה מזהה את ה-LiveStreamEvent שאליו צריך לשייך את ההפסקה למודעה באמצעות מַפתח הנכס של השידור החי. חייב להיות בפורמט הבא: "networks/{network_code}/assets/{asset_code}"
custom_parent

string

זה שינוי אופציונלי. השדה הזה מזהה את ה-LiveStreamEvent שאליו צריך לשייך את ההפסקה למודעה באמצעות מפתח הנכס המותאם אישית. הפורמט צריך להיות 'networks/{network_code}/customAssets/{asset_code}'
content

string

זה שינוי אופציונלי. זוהי דרך חלופית לזהות את LiveStreamEvent, אם הוא משויך לתוכן ב-GAM. הפורמט שלו צריך להיות networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}‎
page_size

int32

זה שינוי אופציונלי. המספר המקסימלי של הפסקות למודעות שצריך להחזיר. יכול להיות שהשירות יחזיר פחות מהערך הזה. אם לא צוין, יוחזרו 10 הפסקות למודעות לכל היותר. הערך המקסימלי הוא 100; ערכים מעל 100 יקובצו ל-100.
page_token

string

זה שינוי אופציונלי. אסימון דף, שהתקבל מקריאה קודמת ב-ListAdBreaks. יש לספק אותו כדי לאחזר את הדף הבא.

כשמחלקים את הדפים, כל הפרמטרים האחרים שסופקו ל-ListAdBreaks חייבים להתאים לקריאה שסיפקה את אסימון הדף.

ListAdBreaksResponse

תשובה עבור AdBreakNotificationService.ListAdBreaks.

שדות
ad_breaks[]

AdBreak

פלט בלבד. רשימה של הפסקות למודעות שתואמות ל-LiveStreamEvent המבוקש.
next_page_token

string

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

מטא-נתונים

מטא-נתונים מותאמים אישית של התוכן.

שדות
key_values

map<string, Value>

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

SyndicatedVideoContentNames

רשימת השמות של כל התוכן שבהפצה.

שדות
syndicated_video_content[]

string

שדה חוזר של שם התוכן שבהפצה. הפורמט שלהן צריך להיות networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}, והן צריכות להשתייך לאותה רשת כמו התוכן שמכיל את השדה הזה.

UpdateVideoContentRequest

בקשה לקבלת [VideoContentIngestionService.UpdateVideoContentRequest][].

שדות
video_content

VideoContent

חובה. המטא-נתונים של התוכן.

תוכן וידאו

המטא-נתונים של התוכן.

שדות
name

string

פלט בלבד. שם המשאב של תוכן הסרטון. הפורמט של השדה הזה הוא: 'networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}'

network_code הוא קוד הרשת ב-Google Ad Manager שאליו שייך התוכן הזה.

content_source_id הוא המזהה של מקור התוכן ב-Google Ad Manager שאליו התוכן הזה צריך להשתייך.

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

VideoContentStatus

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

string

חובה. הכותרת של התוכן.
update_time

Timestamp

חובה. מועד השינוי האחרון של התוכן.
publish_time

Timestamp

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

Duration

משך הזמן של התוכן. יש תמיכה במשך זמן עד לרמת אלפיית השנייה.
cue_points[]

Duration

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

string

כתובת ה-URL של התמונה הממוזערת של התוכן.
metadata

Metadata

מזהה את המטא-נתונים המותאמים אישית של התוכן.
gracenote_metadata

GracenoteMetadata

מטא-נתונים של התוכן שקשורים ל-Gracenote.
syndication_metadata

VideoContentSyndicationInfo

מטא-נתונים של התוכן שקשורים להפצה.
dynamic_ad_insertion_metadata

DynamicAdInsertionInfo

מטא-נתונים של התוכן שקשורים להטמעת מודעות דינמיות.

VideoContentStatus

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

טיפוסים בני מנייה (enum)
ACTIVE יוצגו מודעות שמטורגטות לפי תוכן.
BLOCKED לא יוצגו מודעות בתוכן הזה אם הסטטוס שלו הוא 'חסום'.
DELETED התוכן יועבר לארכיון ב-Ad Manager. אם מערכת Ad Manager מקבלת בקשה להצגת מודעה לגבי תוכן שמסומן כ'נמחק', עדיין יכולות להופיע מודעת בית או מודעות שמטורגטות ליחידות מלאי שטחי פרסום או לקריטריונים אחרים לטירגוט. כדי לחסום מודעות, מגדירים את הסטטוס כ'חסום'.

VideoContentSyndicationInfo

המטא-נתונים לציון הקשרים בין תוכן קנוני לבין תוכן שמופץ.

שדות
שדה איחוד syndication. VideoContentSyndiationMetadata יכול להכיל רק אחד מהערכים הבאים. הערך של syndication יכול להיות רק אחת מהאפשרויות הבאות:
canonical_video_content

string

שם התוכן הקנוני הפורמט שלו צריך להיות networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}, והוא צריך להיות שייך לאותה רשת כמו התוכן שמכיל את השדה הזה.
syndicated_video_content_names

SyndicatedVideoContentNames

אוסף של תוכן בסינדיקציה

VideoFormat

הפורמטים שבהם ניתן לקודד תוכן וידאו.

טיפוסים בני מנייה (enum)
VIDEO_FORMAT_UNSPECIFIED פורמט הסרטון לא צוין.
HLS application/x-mpegURL
DASH application/dash+xml

VideoIngestUrlInfo

מטא-נתונים שמציינים את הקישור לקובץ m3u8 המשמש ליצירת תנאי וליצירת פלייליסטים.

שדות
video_format

VideoFormat

הפורמט של הסרטון.
video_preconditioned

VideoPreconditioned

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

string

הקישור לקובץ m3u8.

VideoPreconditioned

המצב המותנה של תוכן הסרטון.

טיפוסים בני מנייה (enum)
NO עדיין לא הוגדרו תנאים.
YES הסרטון עבר תנאי/פוצל.