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

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

טיפוסים בני מנייה (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

פרטים של מודעת וידאו 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.

טיפוסים בני מנייה (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 נוספות שקשורות למודעה, כולל סמנים.

ייצוג ב-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 ששולח הודעה (ping) כשמתקבלת חשיפה של קריאייטיב.
AD_URL_TYPE_BEACON_EXPANDABLE_DCM_IMPRESSION חיישן חשיפה ניתן להרחבה ב-DCM. בזמן ההצגה, הוא מורחב לכמה סמנים.
AD_URL_TYPE_BEACON_CLICK כתובת ה-URL למעקב שתישלח לפינג כשאירוע הקליק מופעל.
AD_URL_TYPE_BEACON_SKIP כתובת ה-URL למעקב ששולחת הודעות ping כשאירוע הדילוג מופעל.

שיטות

get

 אחזור של מודעה מקבוצת מודעות.

list

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