REST Resource: advertisers.youtubeAdGroupAds

משאב: YouTubeAdGroupAd

מודעה יחידה שמשויכת לקבוצת מודעות ב-YouTube.

ייצוג ב-JSON 
{
  "name": string,
  "advertiserId": string,
  "adGroupAdId": string,
  "adGroupId": string,
  "displayName": string,
  "entityStatus": enum (EntityStatus),
  "adUrls": [
    {
      object (AdUrl)
    }
  ],

  // Union field ad_details can be only one of the following:
  "displayVideoSourceAd": {
    object (DisplayVideoSourceAd)
  },
  "mastheadAd": {
    object (MastheadAd)
  },
  "inStreamAd": {
    object (InStreamAd)
  },
  "nonSkippableAd": {
    object (NonSkippableAd)
  },
  "bumperAd": {
    object (BumperAd)
  },
  "audioAd": {
    object (AudioAd)
  },
  "videoDiscoverAd": {
    object (VideoDiscoveryAd)
  },
  "videoPerformanceAd": {
    object (VideoPerformanceAd)
  }
  // End of list of possible types for union field ad_details.
}
שדות
name

string

שם המשאב של המודעה.
advertiserId

string (int64 format)

המזהה הייחודי של המפרסם שאליו שייכת המודעה.
adGroupAdId

string (int64 format)

המזהה הייחודי של המודעה. המערכת מקצה את השם.
adGroupId

string (int64 format)

המזהה הייחודי של קבוצת המודעות שאליה המודעה שייכת.
displayName

string

השם המוצג של המודעה.

חייב להיות בקידוד UTF-8 ובגודל מקסימלי של 255 בייטים.
entityStatus

enum (EntityStatus)

סטטוס הישות של המודעה.
adUrls[]

object (AdUrl)

רשימת כתובות URL שבהן המודעה משתמשת.
שדה איחוד ad_details. פרטי המודעה. הערך של ad_details יכול להיות רק אחת מהאפשרויות הבאות:
displayVideoSourceAd

object (DisplayVideoSourceAd)

פרטים על מודעה שמקורה ברשת המדיה קריאייטיב של וידאו 360.
mastheadAd

object (MastheadAd)

פרטים על מודעה שמוצגת בפיד הבית של YouTube.
inStreamAd

object (InStreamAd)

פרטים על מודעת וידאו In-stream שניתן לדלג עליה אחרי 5 שניות, שמשמשת להגברת המוּדעוּת למותג או להשגת יעדים שיווקיים.
nonSkippableAd

object (NonSkippableAd)

פרטים על מודעת וידאו In-stream קצרה שלא ניתן לדלג עליה, באורך של 6 עד 15 שניות, שמשמשת להשגת יעדים שיווקיים.
bumperAd

object (BumperAd)

פרטים של מודעת וידאו קצרה שלא ניתנת לדילוג, באורך 6 שניות או פחות, ששימשה להגדלת פוטנציאל החשיפה.
audioAd

object (AudioAd)

פרטים על מודעת אודיו שמשמשת להשגת יעדים שיווקיים.
videoDiscoverAd

object (VideoDiscoveryAd)

פרטים על מודעה שמקדמת סרטון שמוצגת במקומות שבהם משתמשים מחפשים ומגלים דברים חדשים.
videoPerformanceAd

object (VideoPerformanceAd)

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

DisplayVideoSourceAd

המודעה שמקורה בקריאייטיב ב-DV360.

ייצוג JSON 
{
  "creativeId": string
}
שדות
creativeId

string (int64 format)

המזהה של קריאייטיב המקור.

MastheadAd

פרטים של מודעה מסוג Masthead.

ייצוג ב-JSON 
{
  "video": {
    object (YoutubeVideoDetails)
  },
  "headline": string,
  "description": string,
  "videoAspectRatio": enum (VideoAspectRatio),
  "autoplayVideoStartMillisecond": string,
  "autoplayVideoDuration": string,
  "callToActionButtonLabel": string,
  "callToActionFinalUrl": string,
  "callToActionTrackingUrl": string,
  "showChannelArt": boolean,
  "companionYoutubeVideos": [
    {
      object (YoutubeVideoDetails)
    }
  ]
}
שדות
video

object (YoutubeVideoDetails)

הסרטון ב-YouTube שבו המודעה מוצגת.
headline

string

הכותרת של המודעה.
description

string

תיאור המודעה.
videoAspectRatio

enum (VideoAspectRatio)

יחס הגובה-רוחב של סרטון YouTube שמופעל באופן אוטומטי במודעת Masthead.
autoplayVideoStartMillisecond

string (int64 format)

משך הזמן באלפיות השנייה שאחריו הסרטון יתחיל לפעול.
autoplayVideoDuration

string (Duration format)

משך הזמן שבו הסרטון יופעל באופן אוטומטי.

משך הזמן בשניות, עם עד תשע ספרות עשרוניות, שמסתיימים ב-'s'. דוגמה: "3.5s".
callToActionButtonLabel

string

הטקסט שיופיע בלחצן הקריאה לפעולה.
callToActionFinalUrl

string

כתובת היעד של לחצן הקריאה לפעולה.
callToActionTrackingUrl

string

כתובת ה-URL למעקב אחרי לחצן הקריאה לפעולה.
showChannelArt

boolean

האם להציג רקע או באנר שמופיעים בחלק העליון של דף YouTube.
companionYoutubeVideos[]

object (YoutubeVideoDetails)

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

YoutubeVideoDetails

פרטים של סרטון YouTube.

ייצוג ב-JSON 
{
  "id": string,
  "unavailableReason": enum (VideoUnavailableReason)
}
שדות
id

string

מזהה הסרטון ב-YouTube שניתן לחפש בדף האינטרנט של YouTube.
unavailableReason

enum (VideoUnavailableReason)

הסיבה לכך שאין נתוני סרטון זמינים.

VideoUnavailableReason

סיבות אפשריות לכך שסרטון מסוים לא זמין.

טיפוסים בני מנייה (enum)
VIDEO_UNAVAILABLE_REASON_UNSPECIFIED לא ידוע או לא צוין.
VIDEO_UNAVAILABLE_REASON_PRIVATE הסרטון פרטי.
VIDEO_UNAVAILABLE_REASON_DELETED הסרטון נמחק.

VideoAspectRatio

יחסי גובה-רוחב אפשריים לסרטון ב-YouTube.

טיפוסים בני מנייה (enum)
VIDEO_ASPECT_RATIO_UNSPECIFIED לא צוין או לא ידוע.
VIDEO_ASPECT_RATIO_WIDESCREEN הסרטון נמתח והחלק העליון והתחתון נחתכים.
VIDEO_ASPECT_RATIO_FIXED_16_9 הסרטון ביחס גובה-רוחב קבוע של 16:9.

InStreamAd

פרטים של מודעת וידאו In-stream.

ייצוג ב-JSON 
{
  "commonInStreamAttribute": {
    object (CommonInStreamAttribute)
  },
  "customParameters": {
    string: string,
    ...
  }
}
שדות
commonInStreamAttribute

object (CommonInStreamAttribute)

מאפיינים נפוצים של מודעות.
customParameters

map (key: string, value: string)

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

אובייקט שמכיל רשימה של זוגות "key": value. דוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

CommonInStreamAttribute

מאפיינים נפוצים של מודעות וידאו In-stream, מודעות באמפר ומודעות וידאו In-stream שלא ניתן לדלג עליהן.

ייצוג JSON 
{
  "displayUrl": string,
  "finalUrl": string,
  "trackingUrl": string,
  "actionButtonLabel": string,
  "actionHeadline": string,
  "video": {
    object (YoutubeVideoDetails)
  },
  "companionBanner": {
    object (ImageAsset)
  }
}
שדות
displayUrl

string

כתובת דף האינטרנט שמופיעה במודעה.
finalUrl

string

כתובת ה-URL של דף האינטרנט שאליו אנשים מגיעים אחרי שהם לוחצים על המודעה.
trackingUrl

string

כתובת ה-URL שנטענת ברקע למטרות מעקב.
actionButtonLabel

string

הטקסט בלחצן הקריאה לפעולה.
actionHeadline

string

הכותרת של באנר הקריאה לפעולה.
video

object (YoutubeVideoDetails)

הסרטון ב-YouTube שבו מוצגת המודעה.
companionBanner

object (ImageAsset)

התמונה שמוצגת לצד מודעת הווידאו.

ImageAsset

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

ייצוג ב-JSON 
{
  "mimeType": string,
  "fullSize": {
    object (Dimensions)
  },
  "fileSize": string
}
שדות
mimeType

string

סוג ה-MIME של נכס התמונות.
fullSize

object (Dimensions)

מטא-נתונים של התמונה הזו בגודל המקורי שלה.
fileSize

string (int64 format)

גודל הקובץ של נכס התמונות בבייטים.

NonSkippableAd

פרטים על מודעה שאי אפשר לדלג עליה.

ייצוג JSON 
{
  "commonInStreamAttribute": {
    object (CommonInStreamAttribute)
  },
  "customParameters": {
    string: string,
    ...
  }
}
שדות
commonInStreamAttribute

object (CommonInStreamAttribute)

מאפיינים נפוצים של מודעות.
customParameters

map (key: string, value: string)

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

אובייקט שמכיל רשימה של זוגות "key": value. לדוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

BumperAd

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

ייצוג JSON 
{
  "commonInStreamAttribute": {
    object (CommonInStreamAttribute)
  }
}
שדות
commonInStreamAttribute

object (CommonInStreamAttribute)

מאפיינים נפוצים של מודעות.

AudioAd

פרטים של מודעת אודיו.

ייצוג ב-JSON 
{
  "displayUrl": string,
  "finalUrl": string,
  "trackingUrl": string,
  "video": {
    object (YoutubeVideoDetails)
  }
}
שדות
displayUrl

string

כתובת דף האינטרנט שמופיעה במודעה.
finalUrl

string

כתובת ה-URL של דף האינטרנט שאליו אנשים מגיעים אחרי שהם לוחצים על המודעה.
trackingUrl

string

כתובת ה-URL שנטענת ברקע למטרות מעקב.
video

object (YoutubeVideoDetails)

הסרטון ב-YouTube שבו מוצגת המודעה.

VideoDiscoveryAd

פרטים למודעת Video Discovery.

ייצוג ב-JSON 
{
  "headline": string,
  "description1": string,
  "description2": string,
  "video": {
    object (YoutubeVideoDetails)
  },
  "thumbnail": enum (Thumbnail)
}
שדות
headline

string

הכותרת של המודעה.
description1

string

שורת הטקסט הראשונה של המודעה.
description2

string

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

object (YoutubeVideoDetails)

הסרטון ב-YouTube שהמודעה מקדמת.
thumbnail

enum (Thumbnail)

תמונה ממוזערת שנעשה בה שימוש במודעה.

תמונה ממוזערת

אפשרויות אפשריות לקובצי ממוזערים במודעות וידאו Discovery.

טיפוסים בני מנייה (enum)
THUMBNAIL_UNSPECIFIED לא ידוע או לא צוין.
THUMBNAIL_DEFAULT התמונה הממוזערת שמוגדרת כברירת מחדל יכולה להיווצר באופן אוטומטי או להעלות על ידי המשתמש.
THUMBNAIL_1 תמונה ממוזערת 1 שנוצרה מהסרטון.
THUMBNAIL_2 תמונה ממוזערת 2, שנוצרה מהסרטון.
THUMBNAIL_3 תמונה ממוזערת 3 שנוצרה מהסרטון.

VideoPerformanceAd

פרטים למודעת ביצועים של סרטון.

ייצוג JSON 
{
  "finalUrl": string,
  "trackingUrl": string,
  "actionButtonLabels": [
    string
  ],
  "headlines": [
    string
  ],
  "longHeadlines": [
    string
  ],
  "descriptions": [
    string
  ],
  "displayUrlBreadcrumb1": string,
  "displayUrlBreadcrumb2": string,
  "domain": string,
  "videos": [
    {
      object (YoutubeVideoDetails)
    }
  ],
  "customParameters": {
    string: string,
    ...
  },
  "companionBanners": [
    {
      object (ImageAsset)
    }
  ]
}
שדות
finalUrl

string

כתובת ה-URL של דף האינטרנט שאליו אנשים מגיעים אחרי שהם לוחצים על המודעה.
trackingUrl

string

כתובת ה-URL נטענת ברקע למטרות מעקב.
actionButtonLabels[]

string

רשימת נכסי הטקסט שמוצגים בלחצן הקריאה לפעולה.
headlines[]

string

רשימת הכותרות שמוצגות בבאנר של הקריאה לפעולה.
longHeadlines[]

string

רשימת הכותרות הבודדות שמוצגת בבאנר הקריאה לפעולה.
descriptions[]

string

רשימת התיאורים שמוצגים בבאנר של הקריאה לפעולה.
displayUrlBreadcrumb1

string

החלק הראשון אחרי הדומיין בכתובת ה-URL לתצוגה.
displayUrlBreadcrumb2

string

החלק השני אחרי הדומיין בכתובת ה-URL לתצוגה.
domain

string

הדומיין של כתובת ה-URL לתצוגה.
videos[]

object (YoutubeVideoDetails)

רשימת נכסי הווידאו ב-YouTube שבהם נעשה שימוש במודעה הזו.
customParameters

map (key: string, value: string)

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

אובייקט שמכיל רשימה של זוגות "key": value. לדוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
companionBanners[]

object (ImageAsset)

רשימת מודעות הבאנר הנלוויות שבהן נעשה שימוש במודעה הזו.

AdUrl

כתובות URL נוספות שקשורות למודעה, כולל משׂואות רשת (beacons).

ייצוג ב-JSON 
{
  "type": enum (AdUrlType),
  "url": string
}
שדות
type

enum (AdUrlType)

הסוג של כתובת ה-URL של המודעה.
url

string

ערך המחרוזת של כתובת ה-URL.

AdUrlType

סוגי כתובות URL של מודעות אפשריים.

טיפוסים בני מנייה (enum)
AD_URL_TYPE_UNSPECIFIED לא ידוע או לא צוין.
AD_URL_TYPE_BEACON_IMPRESSION פיקסל למעקב בגודל 1x1 לשליחת פינג כאשר מוצגת חשיפה של קריאייטיב.
AD_URL_TYPE_BEACON_EXPANDABLE_DCM_IMPRESSION חיישן חשיפה ניתן להרחבה ב-DCM. בזמן מילוי הבקשה, הוא מורחב לכמה משׂואות רשת (beacons).
AD_URL_TYPE_BEACON_CLICK כתובת ה-URL למעקב שתישלח לפינג כשאירוע הקליק מופעל.
AD_URL_TYPE_BEACON_SKIP כתובת ה-URL למעקב ששולחת הודעות ping כשאירוע הדילוג מופעל.

שיטות

get

 מקבל מודעה בקבוצת מודעות ב-YouTube.

list

 בתיבת הדו-שיח הזו מפורטים מודעות ברמת קבוצת המודעות ב-YouTube.