- משאב: Product
- CreativeConfig
- CreativeType
- DimensionCreativeConfig
- DurationCreativeConfig
- DurationMatchType
- SkippableMatchType
- MakegoodDetails
- CreativeSource
- AudienceTargetingConfig
- AudienceType
- TargetingCriteria
- SelectedTargetingOption
- TargetingType
- AudienceSelection
- OrGroup
- TargetingSelection
- ForecastResult
- תחזית
- ForecastCategory
- CpmRange
- ForecastBreakdownData
- ForecastBreakdown
- ErrorDetails
- InstantDealErrorStatus
- FrequencyCap
- TimeUnit
- Methods
מקור מידע: מוצר
מוצר
| ייצוג ב-JSON |
|---|
{ "name": string, "displayName": string, "externalDealId": string, "transactionType": enum ( |
| שדות | |
|---|---|
name |
שם המשאב היחסי של המוצר. נוצר על ידי השרת. לדוגמה: "exchanges/1234/orders/5678/products/abc". פלט בלבד. |
displayName |
השם המוצג של המוצר. הערך חייב להיות מקודד ב-UTF-8 ובגודל של עד 240 בייטים. חובה. |
externalDealId |
מזהה חיצוני. זהו מספר העסקה במערכת Exchange. עד 100 תווים. התווים המותרים הם תווים אלפאנומריים, קו תחתון, מקף ונקודה. המזהה חייב להיות ייחודי בכל המוצרים. חובה. |
transactionType |
סוג העסקה של המוצר. חובה. |
pricingType |
סוג התמחור של המוצר. חובה. |
updateTime |
חותמת הזמן של מועד העדכון האחרון של המוצר. השימוש הוא ב-RFC 3339, שבו הפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: |
startTime |
השעה שבה המוצר הזה הופך לפעיל. חייב להיות מוקדם יותר מ-endTime. שעת ההתחלה לא יכולה להיות בעוד יותר משנה. חובה. השימוש הוא ב-RFC 3339, שבו הפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: |
endTime |
המועד שבו המוצר הזה הופך ללא פעיל. התאריך לא יכול להיות אחרי שנת 2036. חובה. השימוש הוא ב-RFC 3339, שבו הפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: |
rateDetails |
פרטי התעריף. חובה. |
creativeConfig[] |
הדרישות בנוגע לקריאייטיב של מוצר. חובה למוצרים מסוג עסקה שמורה. |
makegood |
מציין אם המוצר הוא מוצר פיצוי. |
makegoodDetails |
פרטי הצגה חוזרת לפיצוי על מוצר. חובה כשהמוצר הוא הצגה חוזרת לפיצוי. |
creativeSource |
מקור הקריאייטיב של מוצר. אופציונלי, ברירת המחדל היא CREATIVE_SOURCE_ADVERTISER. אי אפשר לשנות את ההגדרה הזו אחרי שיוצרים את המוצר. |
mediumType |
סוג המדיה של המוצר. אם לא מציינים ערך, ברירת המחדל היא DIGITAL, כדי לשמור על תאימות לדורות קודמים. אי אפשר לשנות את ההגדרה הזו אחרי שיוצרים את המוצר. |
audienceTargetingConfig |
אופציונלי. הגדרת הטירגוט לפי קהל הוחלה ברמת העסקה בבורסה. |
targetingCriteria |
פלט בלבד. הפניות לקריטריונים לטירגוט מוצרים. רלוונטי רק לתרחישים של עסקה מיידית. |
forecastResult |
תוצאות של תחזית מוצרים. חובה כשהקריטריונים לטירגוט לא ריקים והתחזית לא מסופקת. רלוונטי רק לתרחישים של עסקה מיידית. |
errorDetails |
אם אי אפשר לעדכן שדות ספציפיים של מוצרים, צריך לציין את פרטי השגיאה. חובה כשאי אפשר לספק את תוצאת התחזית בגלל קריטריון טירגוט, או כשאי אפשר לעדכן את המוצר. רלוונטי רק לתרחישים של עסקה מיידית. |
frequencyCap |
פלט בלבד. מכסת התדירות שהקונה בחר. רלוונטי רק לתרחישים של עסקה מיידית. |
program |
פלט בלבד. התוכנית שבה הקונה יצר את העסקה המיידית. אם אתם רוצים שההחלפה תתבצע כרגיל, אל תמלאו את השדה הזה. רלוונטי רק לתרחישים של עסקה מיידית. |
buyerCustomParameters |
פלט בלבד. פרמטרים מותאמים אישית של מפתח/ערך שהקונה הגדיר בבקשה לעסקה מיידית. רלוונטי רק לתרחישים של עסקה מיידית. אובייקט שמכיל רשימה של זוגות |
etag |
תג ישות (etag) שצריך לציין כשמעדכנים מוצר. צריך לציין אותו רק לעדכון אם השדה etag לא ריק. רלוונטי רק לתרחישים של עסקאות מיידיות. |
CreativeConfig
הגדרת דרישות הקריאייטיב למוצר.
| ייצוג ב-JSON |
|---|
{ "creativeType": enum ( |
| שדות | |
|---|---|
creativeType |
סוג הקריאייטיב. חובה. |
dimensionCreativeConfig |
ההגדרות של הקריאייטיבים לרשת המדיה. השדה הזה לא נתמך בקריאייטיבים מותאמים (CREATIVE_TYPE_NATIVE). |
durationCreativeConfig |
ההגדרות של נכסי הקריאייטיב בווידאו. |
CreativeType
סוגי קריאייטיב אפשריים.
| טיפוסים בני מנייה (enum) | |
|---|---|
CREATIVE_TYPE_UNSPECIFIED |
לא צוין סוג הקריאייטיב. ערך הקלט לא חוקי. |
CREATIVE_TYPE_DISPLAY |
סוג הקריאייטיב של המודעה לרשת המדיה. |
CREATIVE_TYPE_VIDEO |
סוג הקריאייטיב של הסרטון. |
CREATIVE_TYPE_AUDIO |
סוג הקריאייטיב של האודיו. |
CREATIVE_TYPE_NATIVE |
סוג הקריאייטיב של המודעה המותאמת. אין תמיכה במוצרים עם סוג העסקה RESERVED. |
DimensionCreativeConfig
מידות הקריאייטיב לרשת המדיה בפיקסלים.
| ייצוג ב-JSON |
|---|
{ "width": integer, "height": integer } |
| שדות | |
|---|---|
width |
רוחב הקריאייטיב לרשת המדיה. חובה. |
height |
גובה הקריאייטיב לרשת המדיה. חובה. |
DurationCreativeConfig
ההגדרה של משך הקריאייטיב.
| ייצוג ב-JSON |
|---|
{ "duration": string, "durationMatchType": enum ( |
| שדות | |
|---|---|
duration |
משך הזמן של קריאייטיב הווידאו בשניות. חובה משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב-" |
durationMatchType |
קריטריוני ההתאמה של משך הזמן. |
skippableMatchType |
הסוג של קריאייטיב וידאו שניתן לדלג עליו. |
DurationMatchType
קריטריונים להתאמה של משך הקריאייטיב של הווידאו.
| טיפוסים בני מנייה (enum) | |
|---|---|
DURATION_MATCH_TYPE_UNSPECIFIED |
הקריטריון להתאמת משך הזמן לא צוין או לא ידוע בגרסה הזו. ערך הקלט לא חוקי. |
DURATION_MATCH_TYPE_EQUAL_TO |
משך הקריאייטיב צריך להיות זהה למשך הנדרש. |
DURATION_MATCH_TYPE_LESS_THAN_OR_EQUAL_TO |
משך הקריאייטיב צריך להיות זהה למשך הנדרש או קצר ממנו. |
SkippableMatchType
קריטריונים להתאמה שקובעים אם אפשר לדלג על קריאייטיב של מודעת וידאו.
| טיפוסים בני מנייה (enum) | |
|---|---|
SKIPPABLE_MATCH_TYPE_UNSPECIFIED |
סוג הניתן לדילוג לא צוין או לא ידוע בגרסה הזו. ערך הקלט לא חוקי. |
SKIPPABLE_MATCH_TYPE_SKIPPABLE |
הקריאייטיב צריך להיות ניתן לדילוג. |
SKIPPABLE_MATCH_TYPE_NOT_SKIPPABLE |
הקריאייטיב צריך להיות ללא אפשרות דילוג. |
SKIPPABLE_MATCH_TYPE_ANY |
הקריאייטיב יכול להיות ניתן לדילוג או לא ניתן לדילוג. |
MakegoodDetails
ההגדרות של פרטי הפיצוי.
| ייצוג ב-JSON |
|---|
{ "originalExternalDealId": string, "reason": string } |
| שדות | |
|---|---|
originalExternalDealId |
מספר העסקה החיצוני המקורי שבו נדרש פיצוי. עד 100 תווים. התווים המותרים הם תווים אלפאנומריים, קו תחתון, מקף ונקודה. חובה. |
reason |
סיבת ההצגה החוזרת לפיצוי ביוזמת בית העסק. עד 250 תווים. חובה. |
CreativeSource
מקור הקריאייטיב: המקום שממנו יוצגו נכסי הקריאייטיב.
| טיפוסים בני מנייה (enum) | |
|---|---|
CREATIVE_SOURCE_UNSPECIFIED |
מקור הקריאייטיב לא צוין או לא ידוע בגרסה הזו. ערך הקלט לא חוקי. |
CREATIVE_SOURCE_ADVERTISER |
נכסי הקריאייטיב יוצגו על ידי DV3. |
CREATIVE_SOURCE_PUBLISHER |
בעל האפליקציה יציג את נכסי הקריאייטיב. בשלב הזה אין תמיכה בקריאייטיבים שמתארחים אצל בעל התוכן הדיגיטלי. כל בקשה להגדיר את מקור הקריאייטיב כ-CREATIVE_SOURCE_PUBLISHER תיכשל. |
AudienceTargetingConfig
ההגדרות של הטירגוט לפי קהל.
| ייצוג ב-JSON |
|---|
{
"audienceType": enum ( |
| שדות | |
|---|---|
audienceType |
סוג הקהל. חובה. |
AudienceType
סוג הקהל.
| טיפוסים בני מנייה (enum) | |
|---|---|
AUDIENCE_TYPE_UNSPECIFIED |
סוג הקהל לא צוין. הקלט לא תקין. |
AUDIENCE_TYPE_COMMERCE |
סוג קהל מסחרי. |
TargetingCriteria
קריטריונים של טירגוט שצוינו.
| ייצוג ב-JSON |
|---|
{
"selectedTargetingOptions": [
{
object ( |
| שדות | |
|---|---|
selectedTargetingOptions[] |
האפשרויות שנבחרו. |
SelectedTargetingOption
אפשרות הטירגוט או אפשרויות הטירגוט שנבחרו לסוג טירגוט אחד.
| ייצוג ב-JSON |
|---|
{ "type": enum ( |
| שדות | |
|---|---|
type |
סוג הטירגוט שמשויך לאפשרויות שנבחרו. |
אפשר לכלול רק סוג אחד של בחירה. האפשרות שנבחרה צריכה להתאים ל-TargetingType שנבחר בשדה type. זו רשימה של שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים: |
|
audienceSelection |
הקהל שבחרת. |
targetingSelection |
קבוצה כללית של מזהי אפשרויות שנבחרו. |
| סוף השדות שמוציאים זה את זה. | |
TargetingType
סוגי טירגוט.
| טיפוסים בני מנייה (enum) | |
|---|---|
TARGETING_TYPE_UNSPECIFIED |
סוג הטירגוט לא צוין, לא חוקי לקלט. |
TARGETING_TYPE_AUDIENCE |
קהל מסוג טירגוט. |
TARGETING_TYPE_COUNTRY |
סוג טירגוט: מדינה. |
TARGETING_TYPE_DMA |
סוג הטירגוט: אזור מטרופולין (DMA). |
TARGETING_TYPE_PROGRAMMER |
סוג הטירגוט: מתכנת. |
TARGETING_TYPE_BRAND |
סוג הטירגוט: מותג. |
TARGETING_TYPE_CONTENT_GENRE |
סוג הטירגוט: ז'אנר התוכן. |
TARGETING_TYPE_DEVICE |
סוג הטירגוט: מכשיר. |
TARGETING_TYPE_OPERATING_SYSTEM |
סוג הטירגוט: מערכת הפעלה. |
TARGETING_TYPE_RATING |
דירוג סוג הטירגוט. |
TARGETING_TYPE_ENVIRONMENT |
סביבת סוג הטירגוט. |
TARGETING_TYPE_LANGUAGE |
שפת סוג הטירגוט. |
TARGETING_TYPE_GEO |
סוג הטירגוט: מיקום גיאוגרפי. |
TARGETING_TYPE_AGE |
סוג הטירגוט: גיל. |
TARGETING_TYPE_GENDER |
סוג הטירגוט: מגדר. |
TARGETING_TYPE_CONTEXTUAL_SEGMENT |
פלח הקשרי של סוג הטירגוט. |
TARGETING_TYPE_REQUEST_FORMAT |
פורמט הבקשה של סוג הטירגוט. |
TARGETING_TYPE_PUBLISHER |
סוג הטירגוט של בעל התוכן הדיגיטלי. |
TARGETING_TYPE_INVENTORY_SIZE |
גודל סוג הטירגוט. |
TARGETING_TYPE_NETWORK |
רשת מסוג טירגוט. |
TARGETING_TYPE_PLATFORM |
פלטפורמה של סוג טירגוט. |
TARGETING_TYPE_VIDEO_DELIVERY_TYPE |
סוג טירגוט: סוג של הצגת סרטונים. |
TARGETING_TYPE_VIDEO_MINIMUM_PLAYER_SIZE |
גודל מינימלי של נגן הווידאו לפי סוג הטירגוט. |
TARGETING_TYPE_VIDEO_COMPLETION |
סוג הטירגוט: מיקום מודעת וידאו. |
TARGETING_TYPE_VIEWABILITY |
ניראות לפי סוג הטירגוט. |
TARGETING_TYPE_REWARDED |
סוג הטירגוט: מודעות מתגמלות. |
TARGETING_TYPE_VIDEO_AD_DURATION_THRESHOLD_SEC |
סוג הטירגוט: סף משך הזמן של מודעת הווידאו בשניות. |
TARGETING_TYPE_VIDEO_PLACEMENT |
סוג הטירגוט: מיקום מודעת וידאו. |
TARGETING_TYPE_VIDEO_PLAYBACK_METHOD |
שיטת הפעלת הסרטון לפי סוג הטירגוט. |
TARGETING_TYPE_APP_ID |
מזהה האפליקציה של סוג הטירגוט. |
TARGETING_TYPE_DOMAIN_URL |
כתובת ה-URL של הדומיין של סוג הטירגוט. |
TARGETING_TYPE_CTR |
שיעור הקליקים לפי סוג הטירגוט. |
TARGETING_TYPE_DEMOGRAPHICS |
סוג טירגוט: קבוצות דמוגרפיות. |
TARGETING_TYPE_RESTRICTED_CATEGORY |
קטגוריה מוגבלת של סוג טירגוט. |
TARGETING_TYPE_AD_POSITION |
מיקום המודעה בדף לפי סוג הטירגוט. |
TARGETING_TYPE_DAY_AND_TIME |
סוג הטירגוט, היום והשעה. |
TARGETING_TYPE_RETAIL_MEDIA_AUDIENCE |
סוג הטירגוט: קהל של שיווק בנקודת רכישה. |
AudienceSelection
אפשרויות נבחרות של טירגוט לפי קהל.
| ייצוג ב-JSON |
|---|
{
"includedOrGroups": [
{
object ( |
| שדות | |
|---|---|
includedOrGroups[] |
האפשרויות הכלולות מקושרות באמצעות AND, וכל אפשרות כלולה יכולה להיות אפשרות נפרדת או קבוצה של אפשרויות שמקושרות באמצעות OR. |
excludedOptionIds[] |
האפשרויות שהוחרגו מקושרות באמצעות OR. |
OrGroup
קבוצה של אפשרויות שנבחרו, עם הקשר של OR.
| ייצוג ב-JSON |
|---|
{ "optionIds": [ string ] } |
| שדות | |
|---|---|
optionIds[] |
מזהי האפשרויות שנבחרו. |
TargetingSelection
אפשרויות טירגוט שנבחרו והוחרגו, שרלוונטיות לרוב סוגי הטירגוט.
| ייצוג ב-JSON |
|---|
{ "optionIds": [ string ], "externalIds": [ string ], "excludedOptionIds": [ string ], "excludedExternalIds": [ string ] } |
| שדות | |
|---|---|
optionIds[] |
פלט בלבד. מזהי אפשרויות הטירגוט שנבחרו ב-DV360 ושותפו עם הבורסה. יכול להיות שיוחזר לצד |
externalIds[] |
פלט בלבד. מזהי אפשרויות הטירגוט שנבחרו, שסופקו על ידי הבורסה. יכול להיות שיוחזר לצד |
excludedOptionIds[] |
פלט בלבד. מזהי אפשרויות הטירגוט של DV3 שלא נכללים, ששותפו עם בורסת הפרסום. יכול להיות שיוחזר לצד |
excludedExternalIds[] |
פלט בלבד. מזהים של אפשרויות טירגוט שהוחרגו, שסופקו על ידי ה-Exchange. יכול להיות שיוחזר לצד |
ForecastResult
תוצאת התחזית שצוינה.
| ייצוג ב-JSON |
|---|
{
"forecasts": [
{
object ( |
| שדות | |
|---|---|
forecasts[] |
תחזית. הערך של |
תחזית
תחזית של קטגוריית התחזית שצוינה.
| ייצוג ב-JSON |
|---|
{ "forecastCategory": enum ( |
| שדות | |
|---|---|
forecastCategory |
קטגוריית התחזית שצוינה, שהנתון הסטטיסטי של התחזית מייצג. |
אפשר לכלול רק סוג אחד של נתונים סטטיסטיים. הנתונים שמאוכלסים צריכים להתאים לשדה forecastCategory. זו רשימה של שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים: |
|
number |
נתונים מספריים. |
percentage |
נתונים באחוזים. |
cpmPrice |
נתוני מחירים של עלות לאלף חשיפות. |
cpmRange |
נתונים על טווח המחירים של עלות לאלף חשיפות. |
forecastBreakdownData |
נתוני פירוט התחזית. |
| סוף השדות שמוציאים זה את זה. | |
ForecastCategory
קטגוריית התחזית.
| טיפוסים בני מנייה (enum) | |
|---|---|
FORECAST_CATEGORY_UNSPECIFIED |
קטגוריה לא מוגדרת. הקלט לא תקין. |
FORECAST_CATEGORY_TOTAL_OPPORTUNITIES |
סה"כ הזדמנויות. נתונים מספריים. |
FORECAST_CATEGORY_TOTAL_AUDIENCE |
כל הקהל. נתונים מספריים. |
FORECAST_CATEGORY_DIGITAL_TRP |
נקודות רייטינג בקהל היעד בדיגיטל. נתונים באחוזים. |
FORECAST_CATEGORY_SUGGESTED_CPM |
הצעה לעלות לאלף חשיפות. טווח עלות לאלף חשיפות או נתוני מחיר של עלות לאלף חשיפות. |
FORECAST_CATEGORY_UNIQUE_REACH |
תחזית של היקף החשיפה למשתמשים ייחודיים. נתונים מספריים. |
FORECAST_CATEGORY_FORECAST_BREAKDOWN |
פירוט התחזית. נתוני פירוט התחזית. |
CpmRange
טווח העלות לאלף חשיפות מכיל את העלות המינימלית והמקסימלית לאלף חשיפות.
| ייצוג ב-JSON |
|---|
{ "minCpm": { object ( |
| שדות | |
|---|---|
minCpm |
הגבול התחתון של טווח העלות לאלף חשיפות. |
maxCpm |
הגבול העליון של טווח העלות לאלף חשיפות. |
ForecastBreakdownData
נתוני פירוט התחזית מכילים רשימה של פירוט התחזית.
| ייצוג ב-JSON |
|---|
{
"forecastBreakdowns": [
{
object ( |
| שדות | |
|---|---|
forecastBreakdowns[] |
רשימה של פירוטי תחזיות. |
ForecastBreakdown
פירוט התחזית של אפשרות הטירגוט שנבחרה.
| ייצוג ב-JSON |
|---|
{
"selectedTargetingOption": {
object ( |
| שדות | |
|---|---|
selectedTargetingOption |
אפשרות הטירגוט או אפשרויות הטירגוט שנבחרו לסוג טירגוט אחד. |
| אפשר לכלול רק סוג אחד של נתוני פירוט. זו רשימה של שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים: | |
impressions |
תחזית חשיפות. |
| סוף השדות שמוציאים זה את זה. | |
ErrorDetails
פרטי השגיאה שצוינו כשיש שגיאות בעדכון.
| ייצוג ב-JSON |
|---|
{
"message": string,
"instantDealErrorStatus": enum ( |
| שדות | |
|---|---|
message |
ההודעה שמוצגת כשיש שגיאות בעדכון. |
instantDealErrorStatus |
סטטוס השגיאה שמופיע כשיש שגיאות בעדכון של העסקאות המיידיות. |
InstantDealErrorStatus
סטטוס השגיאה שמוצג כשיש שגיאות בעדכון המיידי של העסקה.
| טיפוסים בני מנייה (enum) | |
|---|---|
INSTANT_DEAL_ERROR_STATUS_UNSPECIFIED |
סטטוס שגיאה לא מזוהה. |
INSTANT_DEAL_ERROR_STATUS_INVENTORY_UNAVAILABLE |
סטטוס השגיאה מציין שהמלאי לא זמין. |
INSTANT_DEAL_ERROR_STATUS_FORECAST_UNAVAILABLE |
סטטוס השגיאה מציין שהתחזית לא זמינה. |
INSTANT_DEAL_ERROR_STATUS_INVALID_INPUT |
סטטוס השגיאה מציין שיש שדות להזנת קלט לא תקינים. |
FrequencyCap
מספר הפעמים שבהן משתמש יכול לראות את אותה מודעה במהלך תקופה נתונה
| ייצוג ב-JSON |
|---|
{
"timeUnit": enum ( |
| שדות | |
|---|---|
timeUnit |
יחידת הזמן שבה תוחל מכסת התדירות. |
maxImpressions |
מספר הפעמים המקסימלי שבו המודעה תוצג למשתמש במהלך התקופה הזו. |
TimeUnit
יחידת הזמן שבה תוחל מכסת התדירות.
| טיפוסים בני מנייה (enum) | |
|---|---|
TIME_UNIT_UNSPECIFIED |
לא צוינה יחידת זמן. |
TIME_UNIT_LIFETIME |
מכסת התדירות תחול על כל משך החיים של הקמפיין. |
TIME_UNIT_MONTHS |
מכסת התדירות תחול על מספר חודשים. |
TIME_UNIT_WEEKS |
מכסת התדירות תוחל על מספר שבועות. |
TIME_UNIT_DAYS |
מכסת התדירות תחול על מספר ימים. |
Methods |
|
|---|---|
|
יצירת מוצר. |
|
קבלת מוצר. |
|
רשימת מוצרים. |
|
עדכון מוצר. |