REST Resource: advertisers.creatives

משאב: קריאייטיב

קריאייטיב יחיד.

ייצוג JSON
{
  "name": string,
  "advertiserId": string,
  "creativeId": string,
  "cmPlacementId": string,
  "displayName": string,
  "entityStatus": enum (EntityStatus),
  "updateTime": string,
  "createTime": string,
  "creativeType": enum (CreativeType),
  "hostingSource": enum (HostingSource),
  "dynamic": boolean,
  "dimensions": {
    object (Dimensions)
  },
  "additionalDimensions": [
    {
      object (Dimensions)
    }
  ],
  "mediaDuration": string,
  "creativeAttributes": [
    enum (CreativeAttribute)
  ],
  "reviewStatus": {
    object (ReviewStatusInfo)
  },
  "assets": [
    {
      object (AssetAssociation)
    }
  ],
  "exitEvents": [
    {
      object (ExitEvent)
    }
  ],
  "timerEvents": [
    {
      object (TimerEvent)
    }
  ],
  "counterEvents": [
    {
      object (CounterEvent)
    }
  ],
  "appendedTag": string,
  "integrationCode": string,
  "notes": string,
  "iasCampaignMonitoring": boolean,
  "companionCreativeIds": [
    string
  ],
  "skippable": boolean,
  "skipOffset": {
    object (AudioVideoOffset)
  },
  "progressOffset": {
    object (AudioVideoOffset)
  },
  "universalAdId": {
    object (UniversalAdId)
  },
  "thirdPartyUrls": [
    {
      object (ThirdPartyUrl)
    }
  ],
  "transcodes": [
    {
      object (Transcode)
    }
  ],
  "trackerUrls": [
    string
  ],
  "jsTrackerUrl": string,
  "cmTrackingAd": {
    object (CmTrackingAd)
  },
  "obaIcon": {
    object (ObaIcon)
  },
  "thirdPartyTag": string,
  "requireMraid": boolean,
  "requireHtml5": boolean,
  "requirePingForAttribution": boolean,
  "expandingDirection": enum (ExpandingDirection),
  "expandOnHover": boolean,
  "vastTagUrl": string,
  "vpaid": boolean,
  "html5Video": boolean,
  "lineItemIds": [
    string
  ],
  "mp3Audio": boolean,
  "oggAudio": boolean
}
שדות
name

string

פלט בלבד. שם המשאב של הקריאייטיב.

advertiserId

string (int64 format)

פלט בלבד. המזהה הייחודי של המפרסם שאליו שייך הקריאייטיב.

creativeId

string (int64 format)

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

cmPlacementId

string (int64 format)

פלט בלבד. המזהה הייחודי של מיקום המודעה ב-Campaign Manager 360 שמשויך לקריאייטיב. השדה הזה רלוונטי רק לקריאייטיבים שמסונכרנים מ-Campaign Manager.

displayName

string

חובה. השם המוצג של הקריאייטיב.

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

entityStatus

enum (EntityStatus)

חובה. המדיניות קובעת אם הקריאייטיב יוצג.

הערכים הקבילים הם:

  • ENTITY_STATUS_ACTIVE
  • ENTITY_STATUS_ARCHIVED
  • ENTITY_STATUS_PAUSED
updateTime

string (Timestamp format)

פלט בלבד. חותמת הזמן של העדכון האחרון של הקריאייטיב – על ידי המשתמש או המערכת (למשל, בדיקת הקריאייטיב). הוקצתה על ידי המערכת.

חותמת זמן בפורמט 'Zulu' בפורמט RFC3339 UTC, עם רזולוציה של ננו-שנייה ועד תשע ספרות אחרי הנקודה. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".

createTime

string (Timestamp format)

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

חותמת זמן בפורמט 'Zulu' בפורמט RFC3339 UTC, עם רזולוציה של ננו-שנייה ועד תשע ספרות אחרי הנקודה. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".

creativeType

enum (CreativeType)

חובה. בלתי ניתן לשינוי. סוג הקריאייטיב.

hostingSource

enum (HostingSource)

חובה. מציין איפה הקריאייטיב מתארח.

dynamic

boolean

פלט בלבד. מציין אם הקריאייטיב הוא דינמי.

dimensions

object (Dimensions)

חובה. המאפיינים הראשיים של הקריאייטיב. רלוונטי לכל סוגי הקריאייטיב. הערך של widthPixels ו-heightPixels מוגדר כברירת מחדל ל-0 כאשר creativeType הוא אחד מ:

  • CREATIVE_TYPE_VIDEO
  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_NATIVE_VIDEO
additionalDimensions[]

object (Dimensions)

מאפיינים נוספים. רלוונטי אם creativeType הוא אחד מהתנאים הבאים:

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_EXPANDABLE
  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_LIGHTBOX
  • CREATIVE_TYPE_PUBLISHER_HOSTED

אם השדה הזה מצוין, גם widthPixels וגם heightPixels חייבים להיות גדולים מ-0 או שווים לו.

mediaDuration

string (Duration format)

פלט בלבד. משך המדיה של הקריאייטיב. רלוונטי אם creativeType הוא אחד מהתנאים הבאים:

  • CREATIVE_TYPE_VIDEO
  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_NATIVE_VIDEO
  • CREATIVE_TYPE_PUBLISHER_HOSTED

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

creativeAttributes[]

enum (CreativeAttribute)

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

reviewStatus

object (ReviewStatusInfo)

פלט בלבד. הסטטוס הנוכחי של תהליך בדיקת הקריאייטיב.

assets[]

object (AssetAssociation)

חובה. נכסים שמשויכים לקריאייטיב הזה.

exitEvents[]

object (ExitEvent)

חובה. אירועי יציאה עבור הקריאייטיב הזה. יציאה (שנקראת גם תג קליק) היא כל אזור בקריאייטיב שהמשתמשים יכולים ללחוץ עליו או להקיש עליו כדי לפתוח דף נחיתה של מפרסם. כל קריאייטיב חייב לכלול לפחות יציאה אחת. אפשר להוסיף יציאה לקריאייטיב באחת מהדרכים הבאות:

  • להשתמש באזור ההקשה של Google Web Designer.
  • מגדירים משתנה JavaScript שנקרא clickTag.
  • משתמשים במתג ההפעלה (Enabler.exit() ) כדי לעקוב אחרי יציאות בפורמטים של מדיה עשירה.
timerEvents[]

object (TimerEvent)

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

counterEvents[]

object (CounterEvent)

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

appendedTag

string

תג מעקב של צד שלישי בפורמט HTML שיש לצרף לתג הקריאייטיב.

integrationCode

string

פרטי המזהה המשמשים לקישור הקריאייטיב הזה למערכת חיצונית. חייב להיות בקידוד UTF-8 ובאורך של 10,000 תווים לכל היותר.

notes

string

הערות משתמש לקריאייטיב הזה. חייב להיות בקידוד UTF-8 ובאורך של 20,000 תווים לכל היותר.

iasCampaignMonitoring

boolean

מציינת אם מופעל מעקב אחר קמפיינים של Integral Ad Science (IAS). כדי להפעיל אפשרות זו עבור הקריאייטיב, יש לוודא שה-Advertiser.creative_config.ias_client_id הוגדר למזהה הלקוח שלך ב-IAS.

companionCreativeIds[]

string (int64 format)

המזהים של נכסי קריאייטיב נלווים לקריאייטיב וידאו.

אתם יכולים להקצות קריאייטיבים קיימים לרשת המדיה (עם נכסי תמונה או נכסי HTML5) שיוצגו מסביב לנגן הווידאו של בעל התוכן הדיגיטלי. מודעות נלוות מופיעות מסביב לנגן הווידאו בזמן שהסרטון מופעל, ונשארות גם אחרי שהסרטון מסתיים.

נכסי קריאייטיב שמכילים additional dimensions לא יכולים להיות קריאייטיבים נלווים.

השדה הזה נתמך רק עבור הcreativeType הבאים:

  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_VIDEO
skippable

boolean

האם המשתמש יכול לבחור לדלג על קריאייטיב וידאו.

השדה הזה נתמך רק עבור creativeType מהסוגים הבאים:

  • CREATIVE_TYPE_VIDEO
skipOffset

object (AudioVideoOffset)

משך הזמן להפעלת הסרטון לפני שלחצן הדילוג מופיע.

השדה הזה נדרש אם הערך של skippable הוא True.

השדה הזה נתמך רק עבור creativeType מהסוגים הבאים:

  • CREATIVE_TYPE_VIDEO
progressOffset

object (AudioVideoOffset)

משך הזמן הנדרש להפעלת הסרטון לפני ספירת צפייה.

השדה הזה נדרש אם הערך של skippable הוא True.

השדה הזה נתמך רק עבור creativeType מהסוגים הבאים:

  • CREATIVE_TYPE_VIDEO
universalAdId

object (UniversalAdId)

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

מזהה מודעה אוניברסלי הוא חלק מתקן VAST 4.0. תוכלו לשנות אותו אחרי יצירת הקריאייטיב.

השדה הזה נתמך רק עבור creativeType מהסוגים הבאים:

  • CREATIVE_TYPE_VIDEO
thirdPartyUrls[]

object (ThirdPartyUrl)

כתובות URL למעקב מצדדים שלישיים כדי לעקוב אחר אינטראקציות עם קריאייטיב וידאו.

השדה הזה נתמך רק עבור creativeType מהסוגים הבאים:

  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_VIDEO
  • CREATIVE_TYPE_NATIVE_VIDEO
transcodes[]

object (Transcode)

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

מערכת Display & Video 360 ממירה את הקידוד של הנכס הראשי לכמה גרסאות חלופיות שמשתמשות בפורמטים שונים של קבצים או שיש להן מאפיינים שונים (רזולוציה, קצב העברת נתונים של אודיו וקצב העברת נתונים של וידאו), שכל אחת מהן מיועדת לנגני וידאו או לרוחבי פס ספציפיים.

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

השדה הזה נתמך רק בcreativeType הבאים:

  • CREATIVE_TYPE_VIDEO
  • CREATIVE_TYPE_NATIVE_VIDEO
  • CREATIVE_TYPE_AUDIO
trackerUrls[]

string

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

כתובות ה-URL חייבות להתחיל ב-https (למעט במלאי שלא מחייב תאימות ל-SSL). אם אתם משתמשים בפקודות מאקרו בכתובת ה-URL, כדאי להשתמש רק בפקודות מאקרו שנתמכות על ידי Display & Video 360.

כתובות URL רגילות בלבד, ללא תגי צלם או script.

אפשר לכתוב את השדה הזה רק בcreativeType הבאים:

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
jsTrackerUrl

string

כתובת URL למדידה של JavaScript מספקי צד שלישי נתמכים לאימות (ComScore, DoubleVerify, IAS, Moat). אין תמיכה בתגי סקריפטים של HTML.

אפשר לכתוב את השדה הזה רק בcreativeType הבאים:

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
cmTrackingAd

object (CmTrackingAd)

מודעת המעקב ב-Campaign Manager 360 שמשויכת לקריאייטיב.

אופציונלי לcreativeType הבאים, כשנוצר על ידי מפרסם שמשתמש גם ב-Campaign Manager 360 וגם בהצגת מודעות של צד שלישי:

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE

פלט במקרים אחרים בלבד.

obaIcon

object (ObaIcon)

מציין את סמל OBA לקריאייטיב וידאו.

השדה הזה נתמך רק בcreativeType הבאים:

  • CREATIVE_TYPE_VIDEO
thirdPartyTag

string

זה שינוי אופציונלי. התג המקורי של צד שלישי ששימש ליצירת הקריאייטיב.

נדרש ותקף רק לקריאייטיבים של תגים של צד שלישי.

קריאייטיבים של תגים של צד שלישי הם קריאייטיבים עם הhostingSource הבאים:

  • HOSTING_SOURCE_THIRD_PARTY

בשילוב עם creativeType הערכים הבאים:

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_EXPANDABLE
requireMraid

boolean

זה שינוי אופציונלי. מציין שהקריאייטיב מחייב MRAID (מערכת הגדרות ממשק מודעות מדיה עשירה לנייד).

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

אופציונלי ותקף רק לקריאייטיבים של תגים של צד שלישי.

קריאייטיבים של תגים של צד שלישי הם קריאייטיבים עם הhostingSource הבאים:

  • HOSTING_SOURCE_THIRD_PARTY

בשילוב עם creativeType הערכים הבאים:

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_EXPANDABLE
requireHtml5

boolean

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

אופציונלי ותקף רק לקריאייטיבים של תגים של צד שלישי. קריאייטיבים של תגים של צד שלישי הם קריאייטיבים עם הhostingSource הבאים:

  • HOSTING_SOURCE_THIRD_PARTY

בשילוב עם creativeType הערכים הבאים:

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_EXPANDABLE
requirePingForAttribution

boolean

זה שינוי אופציונלי. מציין שהקריאייטיב ימתין לפינג חזרה לצורך שיוך.

תקף רק כשמשתמשים במודעת מעקב של Campaign Manager 360 עם פרמטר של שרת מודעות של צד שלישי ופקודת המאקרו ${DC_DBM_TOKEN}.

אופציונלי ותקף רק לקריאייטיבים של תגים של צד שלישי או לקריאייטיבים של תגי VAST של צד שלישי.

קריאייטיבים של תגים של צד שלישי הם קריאייטיבים עם הhostingSource הבאים:

  • HOSTING_SOURCE_THIRD_PARTY

בשילוב עם creativeType הערכים הבאים:

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_EXPANDABLE

קריאייטיבים של צד שלישי לתגי VAST הם נכסי קריאייטיב עם הhostingSource הבאים:

  • HOSTING_SOURCE_THIRD_PARTY

בשילוב עם creativeType הערכים הבאים:

  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_VIDEO
expandingDirection

enum (ExpandingDirection)

זה שינוי אופציונלי. מציין את כיוון ההרחבה של הקריאייטיב.

נדרש ותקף רק עבור קריאייטיבים מתרחבים של צד שלישי.

קריאייטיבים של צד שלישי שניתנים להרחבה הם קריאייטיבים עם מקור האירוח הבא:

  • HOSTING_SOURCE_THIRD_PARTY

בשילוב עם creativeType הערכים הבאים:

  • CREATIVE_TYPE_EXPANDABLE
expandOnHover

boolean

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

אופציונלי ותקף רק לקריאייטיבים של צד שלישי מתרחבים. קריאייטיבים של צד שלישי שניתנים להרחבה הם קריאייטיבים עם מקור האירוח הבא:

  • HOSTING_SOURCE_THIRD_PARTY

בשילוב עם creativeType הערכים הבאים:

  • CREATIVE_TYPE_EXPANDABLE
vastTagUrl

string

זה שינוי אופציונלי. כתובת ה-URL של תג ה-VAST לקריאייטיב של תג VAST של צד שלישי.

נדרש ותקף רק לקריאייטיבים של תגי VAST של צד שלישי.

קריאייטיבים של צד שלישי לתגי VAST הם נכסי קריאייטיב עם הhostingSource הבאים:

  • HOSTING_SOURCE_THIRD_PARTY

בשילוב עם creativeType הערכים הבאים:

  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_VIDEO
vpaid

boolean

פלט בלבד. מציין שקריאייטיב של תג VAST של צד שלישי דורש VPAID (ממשק מודעה של נגן וידאו דיגיטלי).

פלט בלבד ותקף רק לקריאייטיבים של תגי VAST של צד שלישי.

קריאייטיבים של צד שלישי לתגי VAST הם נכסי קריאייטיב עם הhostingSource הבאים:

  • HOSTING_SOURCE_THIRD_PARTY

בשילוב עם creativeType הערכים הבאים:

  • CREATIVE_TYPE_VIDEO
html5Video

boolean

פלט בלבד. מציין שקריאייטיב של תג VAST של צד שלישי דורש תמיכה בווידאו בפורמט HTML5.

פלט בלבד ותקף רק לקריאייטיבים של תגי VAST של צד שלישי.

קריאייטיבים של צד שלישי לתגי VAST הם נכסי קריאייטיב עם הhostingSource הבאים:

  • HOSTING_SOURCE_THIRD_PARTY

בשילוב עם creativeType הערכים הבאים:

  • CREATIVE_TYPE_VIDEO
lineItemIds[]

string (int64 format)

פלט בלבד. המזהים של הפריטים שאליהם הקריאייטיב הזה משויך.

כדי לשייך קריאייטיב לפריט, צריך להשתמש במקום זאת ב-LineItem.creative_ids.

mp3Audio

boolean

פלט בלבד. מציין שקריאייטיב האודיו של הצד השלישי תומך ב-MP3.

הפלט בלבד ותקף רק לקריאייטיבים של אודיו של צד שלישי.

קריאייטיבים של צד שלישי הם קריאייטיבים עם הhostingSource הבאים:

  • HOSTING_SOURCE_THIRD_PARTY

בשילוב עם creativeType הערכים הבאים:

  • CREATIVE_TYPE_AUDIO
oggAudio

boolean

פלט בלבד. מציין שקריאייטיב האודיו של הצד השלישי תומך ב-OGG.

הפלט בלבד ותקף רק לקריאייטיבים של אודיו של צד שלישי.

קריאייטיבים של צד שלישי הם קריאייטיבים עם הhostingSource הבאים:

  • HOSTING_SOURCE_THIRD_PARTY

בשילוב עם creativeType הערכים הבאים:

  • CREATIVE_TYPE_AUDIO

HostingSource

מקורות אפשריים לאירוח של קריאייטיב. מציין איפה הקריאייטיב נוצר ומארח.

טיפוסים בני מנייה (enum)
HOSTING_SOURCE_UNSPECIFIED מקור האירוח לא צוין או שאינו ידוע בגרסה הזו.
HOSTING_SOURCE_CM

הקריאייטיב שסונכרן מ-Campaign Manager 360.

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

HOSTING_SOURCE_THIRD_PARTY

קריאייטיב שמתארח בשרת מודעות של צד שלישי (3PAS).

שיטות יצירה ועדכון נתמכות בסוג האירוח הזה אם השדה creativeType הוא אחת מהאפשרויות הבאות:

  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_EXPANDABLE
  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO
HOSTING_SOURCE_HOSTED

קריאייטיב שנוצר ב-DV360 ומתארח ב-Campaign Manager 360.

שיטות יצירה ועדכון נתמכות בסוג האירוח הזה אם השדה creativeType הוא אחת מהאפשרויות הבאות:

  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO
HOSTING_SOURCE_RICH_MEDIA

קריאייטיב של מדיה עשירה שנוצר ב-Studio ומתארח ב-Campaign Manager 360.

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

CreativeAttribute

מאפיינים אפשריים של קריאייטיב.

טיפוסים בני מנייה (enum)
CREATIVE_ATTRIBUTE_UNSPECIFIED מאפיין הקריאייטיב לא צוין או שאינו ידוע בגרסה זו.
CREATIVE_ATTRIBUTE_VAST הקריאייטיב הוא קריאייטיב מסוג VAST.
CREATIVE_ATTRIBUTE_VPAID_LINEAR הקריאייטיב הוא קריאייטיב VPAID ליניארי.
CREATIVE_ATTRIBUTE_VPAID_NON_LINEAR הקריאייטיב הוא קריאייטיב VPAID לא ליניארי.

ReviewStatusInfo

בודקים את הסטטוסים של הקריאייטיב.

ייצוג JSON
{
  "approvalStatus": enum (ApprovalStatus),
  "creativeAndLandingPageReviewStatus": enum (ReviewStatus),
  "contentAndPolicyReviewStatus": enum (ReviewStatus),
  "exchangeReviewStatuses": [
    {
      object (ExchangeReviewStatus)
    }
  ],
  "publisherReviewStatuses": [
    {
      object (PublisherReviewStatus)
    }
  ]
}
שדות
approvalStatus

enum (ApprovalStatus)

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

creativeAndLandingPageReviewStatus

enum (ReviewStatus)

סטטוס הבדיקה של הקריאייטיב ושל דף הנחיתה.

contentAndPolicyReviewStatus

enum (ReviewStatus)

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

exchangeReviewStatuses[]

object (ExchangeReviewStatus)

החלפת סטטוסי הבדיקות של הקריאייטיב.

publisherReviewStatuses[]
(deprecated)

object (PublisherReviewStatus)

סטטוסי הבדיקות של הלייבל של הקריאייטיב.

ApprovalStatus

סוגים אפשריים של סטטוס אישור. זה הסיכום של creativeAndLandingPageReviewStatus ו-contentAndPolicyReviewStatus.

טיפוסים בני מנייה (enum)
APPROVAL_STATUS_UNSPECIFIED ערך הסוג לא צוין או שאינו ידוע בגרסה הזו.
APPROVAL_STATUS_PENDING_NOT_SERVABLE הקריאייטיב עדיין בבדיקה ואי אפשר להציג אותו.
APPROVAL_STATUS_PENDING_SERVABLE הקריאייטיב עבר את הבדיקה של הקריאייטיב ושל דף הנחיתה וניתן להציג אותו, אבל הוא ממתין לבדיקת תוכן ובדיקת תאימות נוספים למדיניות.
APPROVAL_STATUS_APPROVED_SERVABLE אושרו גם הבדיקות של הקריאייטיב ושל דפי הנחיתה, וגם של בדיקת התוכן ובדיקת התאימות למדיניות. הקריאייטיב ניתן להצגה.
APPROVAL_STATUS_REJECTED_NOT_SERVABLE יש בעיה בקריאייטיב שצריך לתקן כדי שאפשר יהיה להציג אותו.

ReviewStatus

סוגים אפשריים של סטטוס בדיקה.

טיפוסים בני מנייה (enum)
REVIEW_STATUS_UNSPECIFIED ערך הסוג לא צוין או שאינו ידוע בגרסה הזו.
REVIEW_STATUS_APPROVED הקריאייטיב אושר.
REVIEW_STATUS_REJECTED הקריאייטיב נדחה.
REVIEW_STATUS_PENDING הקריאייטיב בהמתנה לבדיקה.

ExchangeReviewStatus

החלפת סטטוס הבדיקה של הקריאייטיב.

ייצוג JSON
{
  "exchange": enum (Exchange),
  "status": enum (ReviewStatus)
}
שדות
exchange

enum (Exchange)

בורסת הפרסום בודקת את הקריאייטיב.

status

enum (ReviewStatus)

סטטוס הבדיקה של הבורסה.

PublisherReviewStatus

סטטוס הבדיקה של הקריאייטיב של המוציא לאור.

ייצוג JSON
{
  "publisherName": string,
  "status": enum (ReviewStatus)
}
שדות
publisherName

string

בעל התוכן הדיגיטלי בודק את הקריאייטיב.

status

enum (ReviewStatus)

הסטטוס של הביקורת של המוציא לאור.

AssetAssociation

שיוך הנכס לקריאייטיב.

ייצוג JSON
{
  "asset": {
    object (Asset)
  },
  "role": enum (AssetRole)
}
שדות
asset

object (Asset)

הנכס המשויך.

role

enum (AssetRole)

התפקיד של הנכס הזה בקריאייטיב.

הנכס

נכס יחיד.

ייצוג JSON
{
  "mediaId": string,
  "content": string
}
שדות
mediaId

string (int64 format)

מזהה המדיה של הנכס שהועלה. זהו מזהה ייחודי של הנכס. אפשר להעביר את המזהה הזה לקריאות אחרות ל-API, למשל creatives.create כדי לשייך את הנכס לקריאייטיב.

המרחב המשותף למזהה המדיה עודכן ב-5 באפריל 2023. כדי לעדכן מזהי מדיה שנשמרו במטמון לפני 5 באפריל 2023, צריך לאחזר את מזהה המדיה החדש ממשאבי הקריאייטיב המשויכים או להעלות מחדש את הנכס.

content

string

התוכן של הנכס. בנכסים שהועלו, התוכן הוא נתיב ההצגה.

AssetRole

התפקיד של הנכס הזה בקריאייטיב.

טיפוסים בני מנייה (enum)
ASSET_ROLE_UNSPECIFIED תפקיד הנכס לא צוין או לא ידוע בגרסה הזו.
ASSET_ROLE_MAIN הנכס הוא הנכס הראשי של הקריאייטיב.
ASSET_ROLE_BACKUP הנכס הוא נכס גיבוי של הקריאייטיב.
ASSET_ROLE_POLITE_LOAD הנכס הוא נכס טעינה מנומס של הקריאייטיב.
ASSET_ROLE_HEADLINE

כותרת של קריאייטיב מותאם.

השדה content חייב להיות בקידוד UTF-8 ובאורך של עד 25 תווים.

התפקיד הזה נתמך רק בcreativeType הבאים:

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_LONG_HEADLINE

כותרת ארוכה של קריאייטיב מותאם.

השדה content חייב להיות בקידוד UTF-8 ובאורך של עד 50 תווים.

התפקיד הזה נתמך רק בcreativeType הבאים:

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_BODY

טקסט הגוף של קריאייטיב מותאם.

השדה content חייב להיות בקידוד UTF-8 ובאורך של עד 90 תווים.

התפקיד הזה נתמך רק בcreativeType הבאים:

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_LONG_BODY

טקסט ארוך בגוף המודעה של קריאייטיב מותאם.

השדה content חייב להיות בקידוד UTF-8 ובאורך של עד 150 תווים.

התפקיד הזה נתמך רק בcreativeType הבאים:

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_CAPTION_URL

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

השדה content חייב להיות בקידוד UTF-8 ובאורך של עד 30 תווים.

לדוגמה, אם כתובת דף הנחיתה היא 'http://www.example.com/page', כתובת ה-URL של הכיתוב יכולה להיות 'example.com'. הפרוטוקול (http://) הוא אופציונלי, אבל כתובת ה-URL לא יכולה להכיל רווחים או תווים מיוחדים.

התפקיד הזה נתמך רק בcreativeType הבאים:

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_CALL_TO_ACTION

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

השדה content חייב להיות בקידוד UTF-8 ובאורך של עד 15 תווים.

התפקיד הזה נתמך רק בcreativeType הבאים:

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_ADVERTISER_NAME

הטקסט שמזהה את שם המפרסם או המותג.

השדה content חייב להיות בקידוד UTF-8 ובאורך של עד 25 תווים.

התפקיד הזה נתמך רק בcreativeType הבאים:

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_PRICE

מחיר הרכישה של האפליקציה בחנות Google Play או בחנות האפליקציות של iOS (למשל: $5.99).

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

השדה content חייב להיות בקידוד UTF-8 ובאורך של עד 15 תווים.

נכסים של התפקיד הזה הם לקריאה בלבד.

ASSET_ROLE_ANDROID_APP_ID

המזהה של אפליקציה ל-Android בחנות Google Play.

המזהה מופיע בכתובת ה-URL של האפליקציה בחנות Google Play אחרי המילה 'id'. לדוגמה, בכתובת https://play.google.com/store/apps/details?id=com.company.appname המזהה הוא com.company.appname.

נכסים של התפקיד הזה הם לקריאה בלבד.

ASSET_ROLE_IOS_APP_ID

המזהה של אפליקציה ל-iOS ב-Apple App Store.

המספר המזהה הזה מופיע בכתובת ה-URL של Apple App Store כמחרוזת המספרים מיד אחרי ה-id. לדוגמה, בכתובת https://apps.apple.com/us/app/gmail-email-by-google/id422689480 המזהה הוא 422689480.

נכסים של התפקיד הזה הם לקריאה בלבד.

ASSET_ROLE_RATING

הדירוג של אפליקציה בחנות Google Play או בחנות האפליקציות ל-iOS.

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

נכסים של התפקיד הזה הם לקריאה בלבד.

ASSET_ROLE_ICON

הסמל של קריאייטיב.

התפקיד הזה נתמך ונדרש רק בcreativeType הבאים:

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
ASSET_ROLE_COVER_IMAGE

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

התפקיד הזה נתמך ונדרש רק בcreativeType הבאים:

  • CREATIVE_TYPE_VIDEO

ExitEvent

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

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

enum (ExitEventType)

חובה. הסוג של אירוע היציאה.

url

string

חובה. כתובת ה-URL לקליקים של אירוע היציאה. הדרישה הזו נדרשת כשהערך של type הוא:

  • EXIT_EVENT_TYPE_DEFAULT
  • EXIT_EVENT_TYPE_BACKUP
name

string

השם של ה-click tag של אירוע היציאה.

השם חייב להיות ייחודי בקריאייטיב אחד.

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

reportingName

string

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

ExitEventType

הסוג של אירוע יציאה.

טיפוסים בני מנייה (enum)
EXIT_EVENT_TYPE_UNSPECIFIED סוג אירוע היציאה לא צוין או שאינו ידוע בגרסה הזו.
EXIT_EVENT_TYPE_DEFAULT אירוע היציאה הוא אירוע ברירת המחדל.
EXIT_EVENT_TYPE_BACKUP אירוע היציאה הוא אירוע יציאה לגיבוי. יכולים להיות כמה אירועי יציאה כגיבוי בקריאייטיב.

TimerEvent

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

ייצוג JSON
{
  "name": string,
  "reportingName": string
}
שדות
name

string

חובה. השם של אירוע הטיימר.

reportingName

string

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

CounterEvent

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

ייצוג JSON
{
  "name": string,
  "reportingName": string
}
שדות
name

string

חובה. שם האירוע הנגדית.

reportingName

string

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

AudioVideoOffset

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

ייצוג JSON
{

  // Union field offset can be only one of the following:
  "percentage": string,
  "seconds": string
  // End of list of possible types for union field offset.
}
שדות
שדה איחוד offset. ערך הקיזוז. offset יכול להיות רק אחת מהאפשרויות הבאות:
percentage

string (int64 format)

הסטייה באחוזים ממשך האודיו או הווידאו.

seconds

string (int64 format)

ההיסט בשניות מתחילת האודיו או הווידאו.

UniversalAdId

מזהה קריאייטיב שמסופק על ידי מרשם ייחודי בכל הפלטפורמות. זהו חלק מתקן VAST 4.0.

ייצוג JSON
{
  "id": string,
  "registry": enum (UniversalAdRegistry)
}
שדות
id

string

מזהה הקריאייטיב הייחודי.

registry

enum (UniversalAdRegistry)

המרשם מספק מזהי קריאייטיב ייחודיים.

UniversalAdRegistry

המרשם מספק מזהי קריאייטיב ייחודיים במזהה מודעה אוניברסלי.

טיפוסים בני מנייה (enum)
UNIVERSAL_AD_REGISTRY_UNSPECIFIED מרשם המודעות האוניברסלי לא צוין או שאינו מוכר בגרסה זו.
UNIVERSAL_AD_REGISTRY_OTHER שימוש בספק מותאם אישית כדי לספק את מזהה המודעה האוניברסלי.
UNIVERSAL_AD_REGISTRY_AD_ID משתמשים במזהה מודעה כדי לציין את מזהה המודעה האוניברסלי.
UNIVERSAL_AD_REGISTRY_CLEARCAST צריך להשתמש ב-clearcast.co.uk כדי לספק את מזהה המודעה האוניברסלי.
UNIVERSAL_AD_REGISTRY_DV360 משתמשים ב-Display & Video 360 כדי לציין את מזהה המודעה האוניברסלי.
UNIVERSAL_AD_REGISTRY_CM משתמשים ב-Campaign Manager 360 כדי לציין את מזהה הפרסום האוניברסלי.

ThirdPartyUrl

כתובות URL למעקב מצדדים שלישיים כדי לעקוב אחר אינטראקציות עם קריאייטיב של אודיו או וידאו.

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

enum (ThirdPartyUrlType)

כתובת ה-URL למעקב צריכה לעקוב אחרי סוג האינטראקציה

url

string

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

צריך לספק כתובת URL עם נתיב אופציונלי או מחרוזת שאילתה, שמתחילה ב-https:. לדוגמה, https://www.example.com/path

ThirdPartyUrlType

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

טיפוסים בני מנייה (enum)
THIRD_PARTY_URL_TYPE_UNSPECIFIED הסוג של כתובת ה-URL של הצד השלישי לא צוין או שאינו ידוע בגרסה הזו.
THIRD_PARTY_URL_TYPE_IMPRESSION משמש לספירת החשיפות של הקריאייטיב לאחר השלמת מאגר הנתונים הזמני של האודיו או הסרטון.
THIRD_PARTY_URL_TYPE_CLICK_TRACKING משמש למעקב אחרי קליקים של משתמשים על האודיו או הווידאו.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_START משמש למעקב אחרי מספר הפעמים שבהן משתמש מפעיל את האודיו או הווידאו.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_FIRST_QUARTILE משמש למעקב אחרי מספר הפעמים שבהן אודיו או וידאו מופעלים עד ל-25% מאורכו.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_MIDPOINT משמש למעקב אחרי מספר הפעמים שבהן אודיו או וידאו מופעלים עד ל-50% מאורכו.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_THIRD_QUARTILE משמש למעקב אחרי מספר הפעמים שבהן אודיו או וידאו מופעלים עד ל-75% מאורכו.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_COMPLETE משמש למעקב אחרי מספר הפעמים שבהן האודיו או הווידאו מופעלים עד הסוף.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_MUTE משמש למעקב אחרי מספר הפעמים שמשתמש השתיק את האודיו או הווידאו.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_PAUSE משמש למעקב אחרי מספר הפעמים שבהן משתמש משהה את האודיו או הווידאו.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_REWIND משמש למעקב אחרי מספר הפעמים שמשתמש הפעיל מחדש את האודיו או הווידאו.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_FULLSCREEN משמש למעקב אחרי מספר הפעמים שבהן משתמש מרחיב את הנגן לגודל מסך מלא.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_STOP משמש למעקב אחרי מספר הפעמים שבהן משתמש הפסיק את האודיו או הווידאו.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_CUSTOM משמש למעקב אחרי מספר הפעמים שמשתמש מבצע קליק בהתאמה אישית, למשל לחיצה על נקודה לשיתוף אינטרנט בסרטון.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_SKIP משמש למעקב אחרי מספר הפעמים שהמערכת דילגה על האודיו או הסרטון.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_PROGRESS משמש למעקב אחרי מספר הפעמים שאודיו או וידאו מופעלים עד היסט שנקבע על ידי progressOffset.

המרת קידוד

מייצג מידע על קובץ האודיו או הווידאו שהקידוד שלו הומר.

ייצוג JSON
{
  "name": string,
  "mimeType": string,
  "transcoded": boolean,
  "dimensions": {
    object (Dimensions)
  },
  "bitRateKbps": string,
  "frameRate": number,
  "audioBitRateKbps": string,
  "audioSampleRateHz": string,
  "fileSizeBytes": string
}
שדות
name

string

שם הקובץ שהקידוד שלו הומר.

mimeType

string

סוג ה-MIME של הקובץ שהקידוד שלו הומר.

transcoded

boolean

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

dimensions

object (Dimensions)

המידות של הסרטון שהקידוד שלו הומר.

bitRateKbps

string (int64 format)

קצב העברת הקידוד של הסרטון שעבר המרת קידוד, בקילובייט (KB) לשנייה.

frameRate

number

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

audioBitRateKbps

string (int64 format)

קצב העברת הנתונים של זרם האודיו של הסרטון שעבר המרת קידוד, או קצב העברת הנתונים של האודיו שהומרו בקילובייט (KB) לשנייה.

audioSampleRateHz

string (int64 format)

תדירות הדגימה של זרם האודיו של הסרטון שעבר המרת קידוד, או קצב הדגימה של האודיו לאחר המרת הקידוד, בהרץ.

fileSizeBytes

string (int64 format)

הגודל בבייטים של הקובץ שהקידוד שלו הומר.

CmTrackingAd

מודעת מעקב ב-Campaign Manager 360.

ייצוג JSON
{
  "cmPlacementId": string,
  "cmCreativeId": string,
  "cmAdId": string
}
שדות
cmPlacementId

string (int64 format)

מזהה מיקום המודעה של המודעה שעוקבת אחרי המודעה ב-Campaign Manager 360.

cmCreativeId

string (int64 format)

מזהה הקריאייטיב של המודעה לצורכי מעקב ב-Campaign Manager 360.

cmAdId

string (int64 format)

מזהה המודעה של המודעה שעוקבת אחרי המודעה ב-Campaign Manager 360.

ObaIcon

סמל OBA לקריאייטיב

ייצוג JSON
{
  "resourceUrl": string,
  "resourceMimeType": string,
  "position": enum (ObaIconPosition),
  "dimensions": {
    object (Dimensions)
  },
  "program": string,
  "landingPageUrl": string,
  "clickTrackingUrl": string,
  "viewTrackingUrl": string
}
שדות
resourceUrl

string

כתובת ה-URL של משאב הסמל של OBA.

resourceMimeType

string

סוג ה-MIME של משאב הסמל OBA.

position

enum (ObaIconPosition)

המיקום של סמל OBA בקריאייטיב.

dimensions

object (Dimensions)

המידות של סמל OBA.

program

string

התוכנית של סמל OBA. לדוגמה: 'AdChoices'.

landingPageUrl

string

חובה. כתובת דף הנחיתה של סמל ה-OBA.

רק כתובות URL של הדומיינים הבאים מותרות:

clickTrackingUrl

string

חובה. כתובת ה-URL למעקב אחר קליקים של סמל ה-OBA.

רק כתובות URL של הדומיינים הבאים מותרות:

viewTrackingUrl

string

חובה. כתובת ה-URL למעקב של סמל ה-OBA.

רק כתובות URL של הדומיינים הבאים מותרות:

ObaIconPosition

המיקום של סמל OBA בקריאייטיב.

טיפוסים בני מנייה (enum)
OBA_ICON_POSITION_UNSPECIFIED המיקום של סמל OBA לא צוין.
OBA_ICON_POSITION_UPPER_RIGHT בפינה השמאלית העליונה של הקריאייטיב.
OBA_ICON_POSITION_UPPER_LEFT בפינה הימנית העליונה של הקריאייטיב.
OBA_ICON_POSITION_LOWER_RIGHT בפינה השמאלית התחתונה של הקריאייטיב.
OBA_ICON_POSITION_LOWER_LEFT בפינה הימנית התחתונה של הקריאייטיב.

ExpandingDirection

הכיוון המתרחב של הקריאייטיב המתרחב של צד שלישי.

טיפוסים בני מנייה (enum)
EXPANDING_DIRECTION_UNSPECIFIED כיוון ההרחבה לא צוין.
EXPANDING_DIRECTION_NONE לא מתרחבת בשום כיוון.
EXPANDING_DIRECTION_UP הרחבה למעלה.
EXPANDING_DIRECTION_DOWN הרחבה למטה.
EXPANDING_DIRECTION_LEFT הרחבה ימינה.
EXPANDING_DIRECTION_RIGHT הרחבה ימינה.
EXPANDING_DIRECTION_UP_AND_LEFT מתרחב למעלה ושמאלה.
EXPANDING_DIRECTION_UP_AND_RIGHT מתרחב למעלה ולצד ימין.
EXPANDING_DIRECTION_DOWN_AND_LEFT מתרחב למטה ושמאלה.
EXPANDING_DIRECTION_DOWN_AND_RIGHT מתרחב למטה ולצד ימין.
EXPANDING_DIRECTION_UP_OR_DOWN מתרחבת למעלה או למטה.
EXPANDING_DIRECTION_LEFT_OR_RIGHT מתרחב לשמאל או לצד ימין.
EXPANDING_DIRECTION_ANY_DIAGONAL יכול להתרחב בכל כיוון אלכסון.

שיטות

create

יצירת קריאייטיב חדש.

delete

מוחק קריאייטיב.

get

יצירת קריאייטיב.

list

בתיבת הדו-שיח הזו מפורטים נכסי קריאייטיב של מפרסם.

patch

עדכון קריאייטיב קיים.