REST Resource: advertisers.adGroupAds

משאב: AdGroupAd

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

ייצוג 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 נוספות שקשורות למודעה, כולל איתות Bluetooth.

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

enum (AdUrlType)

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

string

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

AdUrlType

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

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

שיטות

get

 הפונקציה מקבלת מודעה ברמת קבוצת המודעות.

list

 הצגת המודעות בקבוצת המודעות.