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)

פרטים על מודעה שמקורה בקריאייטיב ב-Display & Video 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

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

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

VideoAspectRatio

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

טיפוסים בני מנייה (enums)
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, מודעות שלא ניתן לדלג עליהן ומודעות באמפר.

ייצוג 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)

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

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

אפשרויות אפשריות לתמונות ממוזערות במודעות Video Discovery.

טיפוסים בני מנייה (enums)
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 של מודעה.

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

שיטות

get

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

list

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