- משאב: Creative
- HostingSource
- CreativeAttribute
- ReviewStatusInfo
- ApprovalStatus
- ReviewStatus
- ExchangeReviewStatus
- AssetAssociation
- נכס
- AssetRole
- ExitEvent
- ExitEventType
- TimerEvent
- CounterEvent
- AudioVideoOffset
- UniversalAdId
- UniversalAdRegistry
- ThirdPartyUrl
- ThirdPartyUrlType
- Transcode
- CmTrackingAd
- ObaIcon
- ObaIconPosition
- ExpandingDirection
- Methods
משאב: קריאייטיב
קריאייטיב יחיד.
| ייצוג ב-JSON |
|---|
{ "name": string, "advertiserId": string, "creativeId": string, "cmPlacementId": string, "displayName": string, "entityStatus": enum ( |
| שדות | |
|---|---|
name |
פלט בלבד. שם המשאב של הקריאייטיב. |
advertiserId |
פלט בלבד. המזהה הייחודי של המפרסם שהקריאייטיב שייך אליו. |
creativeId |
פלט בלבד. המזהה הייחודי של הקריאייטיב. הוקצה על ידי המערכת. |
cmPlacementId |
פלט בלבד. המזהה הייחודי של מיקום המודעה ב-Campaign Manager 360 שמשויך לקריאייטיב. השדה הזה רלוונטי רק לנכסי קריאייטיב שמסונכרנים מ-Campaign Manager. |
displayName |
חובה. השם המוצג של הקריאייטיב. הקידוד חייב להיות UTF-8, והגודל המקסימלי הוא 240 בייטים. |
entityStatus |
חובה. המדיניות הזו קובעת אם אפשר להציג את הקריאייטיב. הערכים הקבילים הם:
|
updateTime |
פלט בלבד. חותמת הזמן של העדכון האחרון של הקריאייטיב, על ידי המשתמש או המערכת (למשל, בדיקת קריאייטיב). הוקצה על ידי המערכת. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. דוגמאות: |
createTime |
פלט בלבד. חותמת הזמן שבה נוצר הקריאייטיב. הוקצה על ידי המערכת. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. דוגמאות: |
creativeType |
חובה. אי אפשר לשנות. סוג הקריאייטיב. |
hostingSource |
חובה. מציין איפה הקריאייטיב מתארח. |
dynamic |
פלט בלבד. הערך מציין אם הקריאייטיב הוא דינמי. |
dimensions |
חובה. המאפיינים העיקריים של הקריאייטיב. ההגדרה הזו רלוונטית לכל סוגי הקריאייטיב. ערך ברירת המחדל של
|
additionalDimensions[] |
אופציונלי. מאפיינים נוספים. המאפיין רלוונטי אם הערך של
אם מציינים את השדה הזה, חובה לציין גם את השדות |
mediaDuration |
פלט בלבד. משך המדיה של הקריאייטיב. המאפיין רלוונטי אם הערך של
משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב- |
creativeAttributes[] |
פלט בלבד. רשימה של מאפייני הקריאייטיב שנוצרת על ידי המערכת. |
reviewStatus |
פלט בלבד. הסטטוס הנוכחי של תהליך בדיקת הקריאייטיב. |
assets[] |
חובה. נכסים שמשויכים לקריאייטיב הזה. |
exitEvents[] |
חובה. אירועי יציאה מהקריאייטיב הזה. יציאה (נקראת גם click tag) היא כל אזור בקריאייטיב שמישהו יכול ללחוץ עליו או להקיש עליו כדי לפתוח דף נחיתה של מפרסם. כל נכס קריאייטיב חייב לכלול לפחות יציאה אחת. אפשר להוסיף יציאה לנכס הקריאייטיב בכל אחת מהדרכים הבאות:
|
timerEvents[] |
אופציונלי. אירועים מותאמים אישית של טיימר לקריאייטיב מסוג מדיה עשירה. הטיימרים עוקבים אחרי הזמן שבו משתמש צופה בחלק מסוים של קריאייטיב מסוג מדיה עשירה ומבצע איתו אינטראקציה. קריאייטיב יכול לכלול כמה אירועי טיימר, שכל אחד מהם מתוזמן באופן עצמאי. אם הקריאייטיב מכיל נכסי תמונות בלבד, צריך להשאיר את השדה הזה ריק או לא להגדיר אותו. |
counterEvents[] |
אופציונלי. אירועים של מונה לקריאייטיב מסוג מדיה עשירה. המונים עוקבים אחרי מספר הפעמים שמשתמש מקיים אינטראקציה עם חלק כלשהו של קריאייטיב מסוג מדיה עשירה בדרך מסוימת (העברת העכבר מעל, כיווץ מודעה באמצעות עכבר, קליקים, הקשות, טעינת נתונים, הזנות מהמקלדת וכו'). כל אירוע שאפשר לתעד בנכס הקריאייטיב יכול להיות מתועד כמונה. אם הקריאייטיב מכיל נכסי תמונות בלבד, צריך להשאיר את השדה הזה ריק או לא להגדיר אותו. |
appendedTag |
אופציונלי. תג מעקב HTML של צד שלישי שיוצמד לתג הקריאייטיב. |
integrationCode |
אופציונלי. פרטי המזהה שמשמשים לקישור הקריאייטיב הזה למערכת חיצונית. הערך צריך להיות מקודד ב-UTF-8, והאורך שלו לא יכול להיות יותר מ-10,000 תווים. |
notes |
אופציונלי. הערות משתמש לגבי הקריאייטיב הזה. הקידוד צריך להיות UTF-8 והאורך לא יכול להיות יותר מ-20,000 תווים. |
iasCampaignMonitoring |
אופציונלי. מציין אם מופעל מעקב אחרי קמפיינים של Integral Ad Science (IAS). כדי להפעיל את התכונה הזו בנכס הקריאייטיב, צריך לוודא שהפרמטר |
companionCreativeIds[] |
אופציונלי. המזהים של קריאייטיבים נלווים לקריאייטיב של וידאו. אפשר להקצות נכסי קריאייטיב קיימים לרשת המדיה (עם נכסי תמונה או HTML5) להצגה מסביב לנגן הווידאו של בעל התוכן הדיגיטלי. מודעות נלוות מוצגות מסביב לנגן הווידאו בזמן שהסרטון פועל, ונשארות גם אחרי שהסרטון מסתיים. נכסי קריאייטיב שמכילים השדה הזה נתמך רק ב
|
skippable |
אופציונלי. האם המשתמש יכול לבחור לדלג על קריאייטיב וידאו. השדה הזה נתמך רק ב
|
skipOffset |
אופציונלי. משך הזמן שצריך לצפות בסרטון לפני שמופיע לחצן הדילוג. חובה למלא את השדה הזה אם הערך של השדה הזה נתמך רק ב
|
progressOffset |
אופציונלי. משך הזמן שצריך לצפות בסרטון כדי שהצפייה תיספר. חובה למלא את השדה הזה אם הערך של השדה הזה נתמך רק ב
|
universalAdId |
אופציונלי. מזהה קריאייטיב אופציונלי שסופק על ידי מאגר מידע, והוא ייחודי בכל הפלטפורמות. מזהה מודעה אוניברסלי הוא חלק מהתקן VAST 4.0. אפשר לשנות את ההגדרה הזו אחרי שיוצרים את הקריאייטיב. השדה הזה נתמך רק ב
|
thirdPartyUrls[] |
אופציונלי. כתובות URL למעקב מצד שלישי כדי לעקוב אחרי אינטראקציות עם קריאייטיב וידאו. השדה הזה נתמך רק ב
|
transcodes[] |
פלט בלבד. קידוד מחדש של אודיו או וידאו. ב-Display & Video 360 מתבצע טרנסקוד של נכס המדיה הראשי למספר גרסאות חלופיות שמשתמשות בפורמטים שונים של קבצים או שיש להן מאפיינים שונים (רזולוציה, קצב העברת נתונים של אודיו וקצב העברת נתונים של וידאו). כל גרסה מיועדת לנגני וידאו או לרוחבי פס ספציפיים. הקידודים מחדש האלה מספקים למערכת של בעל האתר יותר אפשרויות לבחירה לכל חשיפה בסרטון שלכם, ומבטיחים שהקובץ המתאים יוצג על סמך החיבור של הצופה וגודל המסך שלו. השדה הזה נתמך רק ב
|
trackerUrls[] |
אופציונלי. כתובות אתרים למעקב של ספקי שירותי ניתוח נתונים או ספקי צד שלישי של טכנולוגיות פרסום. כתובות ה-URL חייבות להתחיל ב- רק כתובות URL רגילות, ללא תגי IMG או SCRIPT. אפשר לכתוב בשדה הזה רק ב-
|
jsTrackerUrl |
אופציונלי. כתובת URL למדידה באמצעות JavaScript מספקי אימות נתמכים של צד שלישי (ComScore, DoubleVerify, IAS, Moat). אין תמיכה בתגי סקריפט של HTML. אפשר לכתוב בשדה הזה רק ב-
|
cmTrackingAd |
אופציונלי. מודעת המעקב ב-Campaign Manager 360 שמשויכת לקריאייטיב. אופציונלי עבור
פלט בלבד במקרים אחרים. |
obaIcon |
אופציונלי. מציינת את סמל ה-OBA של קריאייטיב של סרטון. השדה הזה נתמך רק ב
|
thirdPartyTag |
אופציונלי. התג המקורי של הצד השלישי שמשמש לקריאייטיב. חובה, ותקף רק לגבי נכסי קריאייטיב של תגי צד שלישי. קריאייטיבים עם תג של צד שלישי הם קריאייטיבים עם המאפיינים הבאים
בשילוב עם
|
requireMraid |
אופציונלי. מציין שהקריאייטיב דורש MRAID (מערכת Mobile Rich Media Ad Interface Definitions). צריך להגדיר את הערך הזה אם הקריאייטיב מסתמך על מחוות בנייד לאינטראקטיביות, כמו החלקה או הקשה. אופציונלי ותקף רק לנכסי קריאייטיב של תג של צד שלישי. קריאייטיבים עם תג של צד שלישי הם קריאייטיבים עם המאפיינים הבאים
בשילוב עם
|
requireHtml5 |
אופציונלי. מציין שהקריאייטיב מסתמך על HTML5 כדי להציג את עצמו בצורה תקינה. אופציונלי ותקף רק לנכסי קריאייטיב של תג של צד שלישי. קריאייטיבים עם תג של צד שלישי הם קריאייטיבים עם המאפיינים הבאים
בשילוב עם
|
requirePingForAttribution |
אופציונלי. מציין שהקריאייטיב ימתין לפינג חוזר לצורך שיוך. הפרמטר הזה תקף רק כשמשתמשים במודעה למעקב ב-Campaign Manager 360 עם פרמטר של שרת מודעות של צד שלישי ועם פקודת המאקרו ${DC_DBM_TOKEN}. אופציונלי, ותקף רק לגבי נכסי קריאייטיב של תגים של צד שלישי או נכסי קריאייטיב של תגי VAST של צד שלישי. קריאייטיבים עם תג של צד שלישי הם קריאייטיבים עם המאפיינים הבאים
בשילוב עם
קריאייטיבים של תגי VAST של צד שלישי הם קריאייטיבים עם המאפיינים הבאים
בשילוב עם
|
expandingDirection |
אופציונלי. מציין את כיוון ההרחבה של הקריאייטיב. נדרש ותקף רק לגבי נכסי קריאייטיב של צד שלישי שאפשר להרחיב. קריאייטיבים מתרחבים של צד שלישי הם קריאייטיבים עם מקור האירוח הבא:
בשילוב עם
|
expandOnHover |
אופציונלי. מציין שהקריאייטיב יורחב אוטומטית כשמציבים מעליו את הסמן. אופציונלי, ותקף רק לגבי קריאייטיבים של צד שלישי שאפשר להרחיב. קריאייטיבים מתרחבים של צד שלישי הם קריאייטיבים עם מקור האירוח הבא:
בשילוב עם
|
vastTagUrl |
אופציונלי. כתובת ה-URL של תג VAST עבור קריאייטיב של תג VAST של צד שלישי. מאפיין נדרש שתקף רק לנכסי קריאייטיב של תגי VAST של צד שלישי. קריאייטיבים של תגי VAST של צד שלישי הם קריאייטיבים עם המאפיינים הבאים
בשילוב עם
|
vpaid |
פלט בלבד. מציין שהקריאייטיב של תג VAST של צד שלישי דורש VPAID (ממשק מודעות של נגן וידאו דיגיטלי). פלט בלבד, ותקף רק לנכסי קריאייטיב של תגי VAST של צד שלישי. קריאייטיבים של תגי VAST של צד שלישי הם קריאייטיבים עם המאפיינים הבאים
בשילוב עם
|
html5Video |
פלט בלבד. מציין שנדרשת תמיכה בסרטוני HTML5 בנכס הקריאייטיב של תג VAST של צד שלישי. פלט בלבד, ותקף רק לנכסי קריאייטיב של תגי VAST של צד שלישי. קריאייטיבים של תגי VAST של צד שלישי הם קריאייטיבים עם המאפיינים הבאים
בשילוב עם
|
lineItemIds[] |
פלט בלבד. המזהים של פריטי הקמפיין שהקריאייטיב הזה משויך אליהם. כדי לשייך קריאייטיב לפריט, משתמשים במקום זאת בתג |
mp3Audio |
פלט בלבד. מציין שקריאייטיב האודיו של הצד השלישי תומך ב-MP3. פלט בלבד, ותקף רק לנכסי קריאייטיב של אודיו של צד שלישי. קריאייטיבים של אודיו מצד שלישי הם קריאייטיבים עם המאפיינים הבאים
בשילוב עם
|
oggAudio |
פלט בלבד. מציין שקריאייטיב האודיו של הצד השלישי תומך ב-OGG. פלט בלבד, ותקף רק לנכסי קריאייטיב של אודיו של צד שלישי. קריאייטיבים של אודיו מצד שלישי הם קריאייטיבים עם המאפיינים הבאים
בשילוב עם
|
syntheticContentAttestationStatus |
אופציונלי. האם להוסיף לנכס הקריאייטיב תווית שמציינת שהוא נוצר או נערך באמצעות AI כשהוא מוצג באזורים שבהם יש תקנות מקומיות בנושא תיוג של AI. |
HostingSource
מקורות אפשריים לאירוח נכסי קריאייטיב. מציין איפה הקריאייטיב נוצר ומתארח.
| טיפוסים בני מנייה (enum) | |
|---|---|
HOSTING_SOURCE_UNSPECIFIED |
מקור האירוח לא צוין או לא ידוע בגרסה הזו. |
HOSTING_SOURCE_CM |
קריאייטיב שסונכרן מ-Campaign Manager 360. אין תמיכה בשיטות ליצירה ולעדכון של סוג האירוח הזה. |
HOSTING_SOURCE_THIRD_PARTY |
קריאייטיב שמתארח בשרת מודעות של צד שלישי (3PAS). שיטות ליצירה ולעדכון נתמכות בסוג האירוח הזה אם
|
HOSTING_SOURCE_HOSTED |
קריאייטיב שנוצר ב-DV360 ומאוחסן ב-Campaign Manager 360. שיטות ליצירה ולעדכון נתמכות בסוג האירוח הזה אם
|
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 |
סטטוס הבדיקה של הקריאייטיב ודף הנחיתה של הקריאייטיב. |
contentAndPolicyReviewStatus |
סטטוס בדיקת התוכן והמדיניות של הקריאייטיב. |
exchangeReviewStatuses[] |
סטטוסי הבדיקה של הקריאייטיב בבורסה. |
סטטוס אישור
סוגים אפשריים של סטטוס אישור. זהו סיכום של 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 |
הסטטוס של בדיקת ההחלפה. |
AssetAssociation
שיוך נכסים לקריאייטיב.
| ייצוג ב-JSON |
|---|
{ "asset": { object ( |
| שדות | |
|---|---|
asset |
אופציונלי. הנכס המשויך. |
role |
אופציונלי. התפקיד של הנכס הזה בקריאייטיב. |
נכס
נכס יחיד.
| ייצוג ב-JSON |
|---|
{ "mediaId": string, "content": string } |
| שדות | |
|---|---|
mediaId |
מזהה המדיה של הנכס שהועלה. זהו מזהה ייחודי של הנכס. אפשר להעביר את המזהה הזה לקריאות אחרות ל-API, למשל מרחב מזהי המדיה עודכן ב-5 באפריל 2023. כדי לעדכן מזהי מדיה ששמורים במטמון לפני 5 באפריל 2023, צריך לאחזר את מזהה המדיה החדש ממקורות קריאייטיב משויכים או להעלות מחדש את הנכס. |
content |
תוכן הנכס. בנכסים שהועלו, התוכן הוא נתיב ההצגה. |
AssetRole
התפקיד של הנכס הזה בקריאייטיב.
| טיפוסים בני מנייה (enum) | |
|---|---|
ASSET_ROLE_UNSPECIFIED |
התפקיד של הנכס לא צוין או לא ידוע בגרסה הזו. |
ASSET_ROLE_MAIN |
הנכס הוא הנכס העיקרי של הקריאייטיב. |
ASSET_ROLE_BACKUP |
הנכס הוא נכס גיבוי של הקריאייטיב. |
ASSET_ROLE_POLITE_LOAD |
הנכס הוא נכס של טעינה תוך כדי השהיית האתר של הקריאייטיב. |
ASSET_ROLE_HEADLINE |
כותרת של קריאייטיב מותאם. המחרוזת התפקיד הזה נתמך רק ב
|
ASSET_ROLE_LONG_HEADLINE |
כותרת ארוכה של קריאייטיב מותאם. הערך התפקיד הזה נתמך רק ב
|
ASSET_ROLE_BODY |
הטקסט של תוכן הקריאייטיב המותאם. הערך התפקיד הזה נתמך רק ב
|
ASSET_ROLE_LONG_BODY |
טקסט ארוך של קריאייטיב מותאם. השדה התפקיד הזה נתמך רק ב
|
ASSET_ROLE_CAPTION_URL |
גרסה קצרה וידידותית של כתובת דף הנחיתה שתוצג בקריאייטיב. כתובת ה-URL הזו נותנת לאנשים מושג לגבי הדף שאליו הם יגיעו אחרי שהם ילחצו על הקריאייטיב. הערך לדוגמה, אם כתובת דף הנחיתה היא 'http://www.example.com/page', כתובת ה-URL של הכיתוב יכולה להיות 'example.com'. הפרוטוקול (http://) הוא אופציונלי, אבל כתובת ה-URL לא יכולה להכיל רווחים או תווים מיוחדים. התפקיד הזה נתמך רק ב
|
ASSET_ROLE_CALL_TO_ACTION |
הטקסט שיופיע בכפתור הקריאה לפעולה בנכס קריאייטיב מותאם. המחרוזת התפקיד הזה נתמך רק ב
|
ASSET_ROLE_ADVERTISER_NAME |
הטקסט שמזהה את המפרסם או את שם המותג. המחרוזת התפקיד הזה נתמך רק ב
|
ASSET_ROLE_PRICE |
מחיר הרכישה של האפליקציה בחנות Google Play או ב-iOS App Store (לדוגמה, 5.99$). הערה: הערך הזה לא מסונכרן אוטומטית עם הערך בפועל שמופיע בחנות. הערך שיוחזר תמיד יהיה הערך שצוין כששמרתם את הקריאייטיב. המחרוזת הנכסים של התפקיד הזה הם לקריאה בלבד. |
ASSET_ROLE_ANDROID_APP_ID |
המזהה של אפליקציה ל-Android בחנות Google Play. אפשר למצוא את המזהה הזה בכתובת ה-URL של האפליקציה בחנות Google Play אחרי 'id'. לדוגמה, בכתובת הנכסים של התפקיד הזה הם לקריאה בלבד. |
ASSET_ROLE_IOS_APP_ID |
המזהה של אפליקציה ל-iOS ב-App Store של אפל. מספר המזהה הזה מופיע בכתובת ה-URL של האפליקציה ב-App Store של אפל כמחרוזת המספרים שמיד אחרי 'id'. לדוגמה, במזהה הנכסים של התפקיד הזה הם לקריאה בלבד. |
ASSET_ROLE_RATING |
הדירוג של אפליקציה בחנות Google Play או בחנות האפליקציות של iOS. הערה: הערך הזה לא מסונכרן אוטומטית עם הדירוג בפועל בחנות. הערך שיוחזר תמיד יהיה הערך שצוין כששמרתם את הקריאייטיב. הנכסים של התפקיד הזה הם לקריאה בלבד. |
ASSET_ROLE_ICON |
הסמל של קריאייטיב. התפקיד הזה נתמך ונדרש רק ב-
|
ASSET_ROLE_COVER_IMAGE |
תמונת סרטון סטטית של קריאייטיב וידאו מובנה. התפקיד הזה נתמך ונדרש רק ב-
|
ASSET_ROLE_BACKGROUND_COLOR |
הצבע הראשי שבו משתמשים בקריאייטיב. התפקיד הזה נתמך ונדרש רק ב-
|
ASSET_ROLE_ACCENT_COLOR |
הצבע המשני לשימוש בקריאייטיב. התפקיד הזה נתמך ונדרש רק ב-
|
ASSET_ROLE_REQUIRE_LOGO |
האם הקריאייטיב חייב להשתמש בנכס לוגו. התפקיד הזה נתמך ונדרש רק ב-
|
ASSET_ROLE_REQUIRE_IMAGE |
האם חובה להשתמש בנכס תמונה בקריאייטיב. התפקיד הזה נתמך ונדרש רק ב-
|
ASSET_ROLE_ENABLE_ASSET_ENHANCEMENTS |
האם אפשר להחיל שיפורי נכסים על הקריאייטיב. התפקיד הזה נתמך ונדרש רק ב-
|
ExitEvent
אירוע היציאה של הקריאייטיב.
| ייצוג ב-JSON |
|---|
{
"type": enum ( |
| שדות | |
|---|---|
type |
חובה. סוג אירוע היציאה. |
url |
חובה. כתובת היעד של הקליק על אירוע היציאה. הפעולה הזו נדרשת אם הערך של
|
name |
אופציונלי. השם של תג הקליק של אירוע היציאה. השם חייב להיות ייחודי בתוך קריאייטיב אחד. אם הקריאייטיב מכיל נכסי תמונות בלבד, צריך להשאיר את השדה הזה ריק או לא להגדיר אותו. |
reportingName |
אופציונלי. השם שמשמש לזיהוי האירוע הזה בדוחות. אם הקריאייטיב מכיל נכסי תמונות בלבד, צריך להשאיר את השדה הזה ריק או לא להגדיר אותו. |
ExitEventType
סוג אירוע היציאה.
| טיפוסים בני מנייה (enum) | |
|---|---|
EXIT_EVENT_TYPE_UNSPECIFIED |
סוג אירוע היציאה לא צוין או לא ידוע בגרסה הזו. |
EXIT_EVENT_TYPE_DEFAULT |
אירוע היציאה הוא ברירת המחדל. |
EXIT_EVENT_TYPE_BACKUP |
אירוע היציאה הוא אירוע יציאה לגיבוי. יכולים להיות כמה אירועי יציאה מגיבוי בקריאייטיב. |
TimerEvent
אירוע טיימר של הקריאייטיב.
| ייצוג ב-JSON |
|---|
{ "name": string, "reportingName": string } |
| שדות | |
|---|---|
name |
חובה. שם אירוע הטיימר. |
reportingName |
חובה. השם שמשמש לזיהוי אירוע הטיימר הזה בדוחות. |
CounterEvent
אירוע נגדי של הקריאייטיב.
| ייצוג ב-JSON |
|---|
{ "name": string, "reportingName": string } |
| שדות | |
|---|---|
name |
חובה. השם של אירוע המונה. |
reportingName |
חובה. השם שמשמש לזיהוי אירוע המונה הזה בדוחות. |
AudioVideoOffset
האורך של קטע אודיו או סרטון שהופעל.
| ייצוג ב-JSON |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "percentage": string, "seconds": string // End of mutually exclusive fields. } |
| שדות | |
|---|---|
| ערך ההסטה. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות: | |
percentage |
אופציונלי. ההיסט באחוזים של משך האודיו או הסרטון. |
seconds |
אופציונלי. ההיסט בשניות מתחילת האודיו או הסרטון. |
| סוף השדות הבלעדיים. | |
UniversalAdId
מזהה קריאייטיב שסופק על ידי מאגר מידע וייחודי לכל הפלטפורמות. התכונה הזו היא חלק מתקן VAST 4.0.
| ייצוג ב-JSON |
|---|
{
"id": string,
"registry": enum ( |
| שדות | |
|---|---|
id |
אופציונלי. המזהה הייחודי של הקריאייטיב. |
registry |
אופציונלי. המאגר מספק מזהים ייחודיים של קריאייטיבים. |
UniversalAdRegistry
המאגר מספק מזהים ייחודיים של קריאייטיבים במזהה מודעה אוניברסלי.
| טיפוסים בני מנייה (enum) | |
|---|---|
UNIVERSAL_AD_REGISTRY_UNSPECIFIED |
רישום המודעות האוניברסלי לא צוין או לא ידוע בגרסה הזו. |
UNIVERSAL_AD_REGISTRY_OTHER |
משתמשים בספק מותאם אישית כדי לספק את מזהה המודעה האוניברסלי. |
UNIVERSAL_AD_REGISTRY_AD_ID |
משתמשים ב-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 ( |
| שדות | |
|---|---|
type |
אופציונלי. סוג האינטראקציה שצריך לעקוב אחריה באמצעות כתובת ה-URL למעקב |
url |
אופציונלי. כתובת ה-URL למעקב שמשמשת למעקב אחר האינטראקציה. מזינים כתובת URL עם נתיב או מחרוזת שאילתה אופציונליים, שמתחילה ב- |
ThirdPartyUrlType
סוג האינטראקציה צריך להיות במעקב של כתובת אתר למעקב של צד שלישי.
| טיפוסים בני מנייה (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 ( |
| שדות | |
|---|---|
name |
אופציונלי. השם של הקובץ שעבר המרה. |
mimeType |
אופציונלי. סוג ה-MIME של הקובץ שעבר המרה. |
transcoded |
אופציונלי. מציין אם הקידוד מחדש בוצע בהצלחה. |
dimensions |
אופציונלי. המידות של הסרטון שהקידוד שלו הומר. |
bitRateKbps |
אופציונלי. קצב העברת הנתונים של הסרטון שהקידוד שלו הומר, בקילוביט לשנייה. |
frameRate |
אופציונלי. קצב הפריימים של הסרטון שהקידוד שלו הומר, בפריימים לשנייה. |
audioBitRateKbps |
אופציונלי. קצב העברת הנתונים בביטים של זרם האודיו של הסרטון שהקידוד שלו הומר, או קצב העברת הנתונים בביטים של האודיו שהקידוד שלו הומר, בקילוביטים לשנייה. |
audioSampleRateHz |
אופציונלי. תדירות הדגימה של שידור האודיו של הסרטון שהקידוד שלו הומר, או תדירות הדגימה של האודיו שהקידוד שלו הומר, בהרץ. |
fileSizeBytes |
אופציונלי. גודל הקובץ שעבר המרה, בבייטים. |
CmTrackingAd
מודעת מעקב ב-Campaign Manager 360.
| ייצוג ב-JSON |
|---|
{ "cmPlacementId": string, "cmCreativeId": string, "cmAdId": string } |
| שדות | |
|---|---|
cmPlacementId |
אופציונלי. מזהה מיקום המודעה של מודעת המעקב ב-Campaign Manager 360. |
cmCreativeId |
אופציונלי. מזהה הקריאייטיב של מודעת המעקב ב-Campaign Manager 360. |
cmAdId |
אופציונלי. מזהה המודעה של מודעת המעקב ב-Campaign Manager 360. |
ObaIcon
סמל OBA לקריאייטיב
| ייצוג ב-JSON |
|---|
{ "resourceUrl": string, "resourceMimeType": string, "position": enum ( |
| שדות | |
|---|---|
resourceUrl |
אופציונלי. כתובת ה-URL של מקור הסמל של OBA. |
resourceMimeType |
אופציונלי. סוג ה-MIME של משאב הסמל של OBA. |
position |
אופציונלי. המיקום של סמל ה-OBA בקריאייטיב. |
dimensions |
אופציונלי. המידות של סמל ה-OBA. |
program |
אופציונלי. התוכנית של סמל ה-OBA. לדוגמה: AdChoices. |
landingPageUrl |
חובה. כתובת דף הנחיתה של סמל ה-OBA. מותרות רק כתובות URL של הדומיינים הבאים:
|
clickTrackingUrl |
חובה. כתובת ה-URL למעקב אחרי קליקים של סמל ה-OBA. מותרות רק כתובות URL של הדומיינים הבאים:
|
viewTrackingUrl |
חובה. כתובת ה-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 |
יכולים להתרחב בכל כיוון אלכסוני. |
Methods |
|
|---|---|
|
יוצר נכס קריאייטיב חדש. |
|
מחיקת קריאייטיב. |
|
מקבל קריאייטיב. |
|
מציג רשימה של נכסי קריאייטיב במפרסם. |
|
עדכון של קריאייטיב קיים. |