REST Resource: exchanges.orders.products

משאב: מוצר

מוצר

ייצוג ב-JSON 
{
  "name": string,
  "displayName": string,
  "externalDealId": string,
  "transactionType": enum (TransactionType),
  "pricingType": enum (PricingType),
  "updateTime": string,
  "startTime": string,
  "endTime": string,
  "rateDetails": {
    object (RateDetails)
  },
  "creativeConfig": [
    {
      object (CreativeConfig)
    }
  ],
  "makegood": boolean,
  "makegoodDetails": {
    object (MakegoodDetails)
  },
  "creativeSource": enum (CreativeSource),
  "mediumType": enum (MediumType),
  "audienceTargetingConfig": {
    object (AudienceTargetingConfig)
  },
  "targetingCriteria": {
    object (TargetingCriteria)
  },
  "forecastResult": {
    object (ForecastResult)
  },
  "errorDetails": {
    object (ErrorDetails)
  },
  "frequencyCap": {
    object (FrequencyCap)
  },
  "etag": string
}
שדות
name

string

שם המסלול היחסי של המוצר. נוצר על ידי השרת. לדוגמה: "exchanges/1234/orders/5678/products/abc". פלט בלבד.
displayName

string

השם המוצג של המוצר.

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

string

מזהה חיצוני. זהו מזהה העסקה במערכת ה-Exchange. עד 100 תווים. התווים המותרים הם אלפאנומריים, קו תחתון, מקף ונקודה. המזהה חייב להיות ייחודי לכל המוצרים. חובה.
transactionType

enum (TransactionType)

סוג העסקה של המוצר. חובה.
pricingType

enum (PricingType)

סוג התמחור של המוצר. חובה.
updateTime
(deprecated)

string (Timestamp format)

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

הפונקציה משתמשת ב-RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות חלקיות. אפשר להשתמש גם בהיסטים אחרים חוץ מ-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
startTime

string (Timestamp format)

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

הפונקציה משתמשת ב-RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות חלקיות. אפשר להשתמש גם בהיסטים אחרים חוץ מ-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

השעה שבה המוצר הזה מפסיק להיות פעיל. התאריך המאוחר ביותר שאפשר לבחור הוא 2036. חובה.

הפונקציה משתמשת ב-RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות חלקיות. אפשר להשתמש גם בהיסטים אחרים חוץ מ-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
rateDetails

object (RateDetails)

פרטי הדירוג. חובה.
creativeConfig[]

object (CreativeConfig)

הדרישות לגבי קריאייטיב של מוצר. חובה למוצר מסוג טרנזקציה מוזמנת.
makegood
(deprecated)

boolean

המאפיין מציין אם המוצר הוא מוצר פיצוי.
makegoodDetails
(deprecated)

object (MakegoodDetails)

פרטי הפיצוי על מוצר. חובה לציין אם המוצר הוא פיצוי.
creativeSource

enum (CreativeSource)

מקור הקריאייטיב של מוצר. אופציונלי, ברירת המחדל היא CREATIVE_SOURCE_ADVERTISER. אי אפשר לשנות את ההגדרה הזו אחרי שיוצרים את המוצר.
mediumType

enum (MediumType)

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

object (AudienceTargetingConfig)

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

object (TargetingCriteria)

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

object (ForecastResult)

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

object (ErrorDetails)

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

object (FrequencyCap)

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

string

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

CreativeConfig

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

ייצוג ב-JSON 
{
  "creativeType": enum (CreativeType),
  "dimensionCreativeConfig": {
    object (DimensionCreativeConfig)
  },
  "durationCreativeConfig": {
    object (DurationCreativeConfig)
  }
}
שדות
creativeType

enum (CreativeType)

סוג הקריאייטיב. חובה.
dimensionCreativeConfig

object (DimensionCreativeConfig)

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

השדה הזה לא נתמך בנכסי קריאייטיב מותאמים (CREATIVE_TYPE_NATIVE).
durationCreativeConfig

object (DurationCreativeConfig)

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

CreativeType

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

טיפוסים בני מנייה (enum)
CREATIVE_TYPE_UNSPECIFIED לא צוין סוג הקריאייטיב. ערך קלט לא תקין.
CREATIVE_TYPE_DISPLAY סוג הקריאייטיב של מודעה לרשת המדיה.
CREATIVE_TYPE_VIDEO סוג הקריאייטיב של הווידאו.
CREATIVE_TYPE_AUDIO סוג הקריאייטיב של האודיו.
CREATIVE_TYPE_NATIVE סוג הקריאייטיב של המודעה המותאמת.

DimensionCreativeConfig

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

ייצוג ב-JSON 
{
  "width": integer,
  "height": integer
}
שדות
width

integer

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

integer

גובה הקריאייטיב. חובה.

DurationCreativeConfig

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

ייצוג ב-JSON 
{
  "duration": string,
  "durationMatchType": enum (DurationMatchType),
  "skippableMatchType": enum (SkippableMatchType)
}
שדות
duration

string (Duration format)

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

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

enum (DurationMatchType)

קריטריון ההתאמה של משך הזמן.
skippableMatchType

enum (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

string

מזהה העסקה החיצוני המקורי שעבורו נשלחת בקשה לפיצוי. עד 100 תווים. התווים המותרים הם אלפאנומריים, קו תחתון, מקף ונקודה. חובה.
reason

string

סיבת הצגה חוזרת לפיצוי ביוזמת המוכר. עד 250 תווים. חובה.

CreativeSource

מקור הקריאייטיב; המקום שממנו יוצגו הקריאייטיבים.

טיפוסים בני מנייה (enum)
CREATIVE_SOURCE_UNSPECIFIED מקור הקריאייטיב לא צוין או לא ידוע בגרסה הזו. ערך קלט לא תקין.
CREATIVE_SOURCE_ADVERTISER הקריאייטיבים יוצגו על ידי DV3.
CREATIVE_SOURCE_PUBLISHER הקריאייטיבים יוצגו על ידי בעל התוכן הדיגיטלי. בשלב הזה אין תמיכה בקריאייטיבים שמתארחים באתר של בעל האתר. כל בקשה שמנסה להגדיר את מקור הקריאייטיב ל-CREATIVE_SOURCE_PUBLISHER תיכשל.

AudienceTargetingConfig

ההגדרה של הטירגוט לפי קהל.

ייצוג ב-JSON 
{
  "audienceType": enum (AudienceType)
}
שדות
audienceType

enum (AudienceType)

סוג הקהל. חובה.

AudienceType

סוג קהל.

טיפוסים בני מנייה (enum)
AUDIENCE_TYPE_UNSPECIFIED סוג הקהל לא צוין. לא תקף כקלט.
AUDIENCE_TYPE_COMMERCE סוג קהל מסחרי.

TargetingCriteria

צוינו קריטריונים לטירגוט.

ייצוג ב-JSON 
{
  "selectedTargetingOptions": [
    {
      object (SelectedTargetingOption)
    }
  ]
}
שדות
selectedTargetingOptions[]

object (SelectedTargetingOption)

האפשרויות שנבחרו.

SelectedTargetingOption

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

ייצוג ב-JSON 
{
  "type": enum (TargetingType),

  // Union field value can be only one of the following:
  "audienceSelection": {
    object (AudienceSelection)
  },
  "targetingSelection": {
    object (TargetingSelection)
  }
  // End of list of possible types for union field value.
}
שדות
type

enum (TargetingType)

סוג הטירגוט שמשויך לאפשרויות שנבחרו.
שדה איחוד value. אפשר לכלול רק סוג אחד של בחירה. הבחירה צריכה להתאים ל-TargetingType שנבחר בשדה 'סוג'. הערך value יכול להיות רק אחד מהבאים:
audienceSelection

object (AudienceSelection)

הקהל שנבחר.
targetingSelection

object (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 סוג הטירגוט 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 גודל מינימלי של נגן וידאו לפי סוג טירגוט.

AudienceSelection

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

ייצוג ב-JSON 
{
  "includedOrGroups": [
    {
      object (OrGroup)
    }
  ],
  "excludedOptionIds": [
    string
  ]
}
שדות
includedOrGroups[]

object (OrGroup)

האפשרויות הכלולות מחוברות באמצעות AND, וכל אפשרות כלולה יכולה להיות אפשרות נפרדת או קבוצת אפשרויות שמחוברות באמצעות OR.
excludedOptionIds[]

string (int64 format)

האפשרויות שהוחרגו מחוברות באמצעות OR.

OrGroup

קבוצה של אפשרויות שנבחרו שמחוברות באמצעות OR.

ייצוג ב-JSON 
{
  "optionIds": [
    string
  ]
}
שדות
optionIds[]

string (int64 format)

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

TargetingSelection

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

ייצוג ב-JSON 
{
  "optionIds": [
    string
  ]
}
שדות
optionIds[]

string (int64 format)

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

ForecastResult

תוצאת התחזית שצוינה.

ייצוג ב-JSON 
{
  "forecasts": [
    {
      object (Forecast)
    }
  ]
}
שדות
forecasts[]

object (Forecast)

תחזית. הערך של forecastCategory חייב להיות ייחודי לכל רכיב שצוין.

תחזית

תחזית של קטגוריית התחזית שצוינה.

ייצוג ב-JSON 
{
  "forecastCategory": enum (ForecastCategory),

  // Union field forecast_data can be only one of the following:
  "number": string,
  "percentage": integer,
  "cpmPrice": {
    object (Money)
  },
  "cpmRange": {
    object (CpmRange)
  },
  "forecastBreakdownData": {
    object (ForecastBreakdownData)
  }
  // End of list of possible types for union field forecast_data.
}
שדות
forecastCategory

enum (ForecastCategory)

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

string (int64 format)

נתונים מספריים.
percentage

integer

נתונים באחוזים.
cpmPrice

object (Money)

נתוני מחירים של עלות לאלף חשיפות.
cpmRange

object (CpmRange)

נתונים של טווח מחירים לאלף חשיפות.
forecastBreakdownData

object (ForecastBreakdownData)

נתוני פירוט של תחזיות.

ForecastCategory

קטגוריית התחזית.

טיפוסים בני מנייה (enum)
FORECAST_CATEGORY_UNSPECIFIED קטגוריה לא מוגדרת. לא תקף כקלט.
FORECAST_CATEGORY_TOTAL_OPPORTUNITIES מספר ההזדמנויות הכולל. נתונים מספריים.
FORECAST_CATEGORY_TOTAL_AUDIENCE כל הקהל. נתונים מספריים.
FORECAST_CATEGORY_DIGITAL_TRP נקודות רייטינג בקהל היעד (TRP) בתוכן דיגיטלי. נתונים באחוזים.
FORECAST_CATEGORY_SUGGESTED_CPM הצעה למחיר עלות לאלף חשיפות. נתוני טווח עלות לאלף חשיפות או מחיר עלות לאלף חשיפות.
FORECAST_CATEGORY_UNIQUE_REACH תחזית של היקף החשיפה למשתמשים ייחודיים. נתונים מספריים.
FORECAST_CATEGORY_FORECAST_BREAKDOWN פירוט של התחזית. נתוני פירוט של תחזיות.

CpmRange

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

ייצוג ב-JSON 
{
  "minCpm": {
    object (Money)
  },
  "maxCpm": {
    object (Money)
  }
}
שדות
minCpm

object (Money)

הגבול התחתון של טווח העלות לאלף חשיפות.
maxCpm

object (Money)

הגבול העליון של טווח ה-CPM.

ForecastBreakdownData

נתוני פירוט התחזית מכילים רשימה של פירוט התחזית.

ייצוג ב-JSON 
{
  "forecastBreakdowns": [
    {
      object (ForecastBreakdown)
    }
  ]
}
שדות
forecastBreakdowns[]

object (ForecastBreakdown)

רשימה של פירוטים של תחזיות.

ForecastBreakdown

פירוט התחזית של אפשרות הטירגוט שנבחרה.

ייצוג ב-JSON 
{
  "selectedTargetingOption": {
    object (SelectedTargetingOption)
  },

  // Union field breakdown_data can be only one of the following:
  "impressions": string
  // End of list of possible types for union field breakdown_data.
}
שדות
selectedTargetingOption

object (SelectedTargetingOption)

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

string (int64 format)

תחזית חשיפות.

ErrorDetails

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

ייצוג ב-JSON 
{
  "message": string,
  "instantDealErrorStatus": enum (InstantDealErrorStatus)
}
שדות
message

string

ההודעה מציינת מתי יש שגיאות בעדכון.
instantDealErrorStatus

enum (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": string
}
שדות
timeUnit

enum (TimeUnit)

יחידת הזמן שבה תוגדר מכסת התדירות.
maxImpressions

string (int64 format)

מספר הפעמים המקסימלי שבהן המודעה תוצג למשתמש במהלך התקופה הזו.

TimeUnit

יחידת הזמן שבה תוגדר מכסת התדירות.

טיפוסים בני מנייה (enum)
TIME_UNIT_UNSPECIFIED יחידת זמן לא מוגדרת.
TIME_UNIT_LIFETIME מכסת התדירות תחול על כל משך החיים.
TIME_UNIT_MONTHS מכסת התדירות תחול על מספר חודשים.
TIME_UNIT_WEEKS מכסת התדירות תחול על מספר שבועות.
TIME_UNIT_DAYS מכסת התדירות תחול על מספר ימים.

Methods

create

 יצירת מוצר.

get

 מקבל מוצר.

list

 פרסום מוצר.

patch

 עדכון מוצר.