Package google.ads.drx.video.v1

אינדקס

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.

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 של קובץ הכתוביות.

DynamicAdInsertionInfo

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

שדות
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'.

מטא-נתונים

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

שדות
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

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

string

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

Timestamp

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

Timestamp

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

Duration

משך התוכן. המשך נתמך עד לרמת המילי-שנייה.
cue_points[]

Duration

מזהה את נקודות הסימון. נקודות Cue הן נקודות זמן שבהן אפשר להוסיף מודעה לסרטון. יש תמיכה בנקודות ציון עד לרמת המילי-שנייה. זהו שדה חובה אם הסרטון מכיל הפסקות למודעות באמצע הסרטון.
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 מקבל בקשה להצגת מודעה עבור תוכן שמסומן כתוכן שנמחק, עדיין אפשר להציג מודעות בית או מודעות שמטרגטות יחידות מלאי או קריטריונים אחרים לטירגוט. כדי לחסום מודעות, מגדירים את הסטטוס כ-BLOCKED.

VideoContentSyndicationInfo

המטא-נתונים להגדרת קשרים בין תוכן קנוני לבין תוכן בסינדיקציה.

שדות
שדה איחוד syndication. התג VideoContentSyndicationMetadata יכול להכיל רק אחד מהערכים הבאים. הערך 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 הסרטון עבר התניה או פיצול.