Method: exchanges.orders.products.patch

עדכון מוצר.

בקשת HTTP

PATCH https://dv360seller.googleapis.com/v1beta1/{product.name=exchanges/*/orders/*/products/*}

כתובת ה-URL כתובה בתחביר של gRPC Transcoding.

פרמטרים של הנתיב

פרמטרים
product.name

string

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

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג ב-JSON 
{
  "product": {
    "name": string,
    "displayName": string,
    "externalDealId": string,
    "transactionType": enum (TransactionType),
    "pricingType": enum (PricingType),
    "updateTime": string,
    "startTime": string,
    "endTime": string,
    "rateDetails": {
      "rateType": enum (RateType),
      "rate": {
        object (Money)
      },
      "unitsPurchasedCount": string
    },
    "creativeConfig": [
      {
        "creativeType": enum (CreativeType),
        "dimensionCreativeConfig": {
          object (DimensionCreativeConfig)
        },
        "durationCreativeConfig": {
          object (DurationCreativeConfig)
        }
      }
    ],
    "makegood": boolean,
    "makegoodDetails": {
      "originalExternalDealId": string,
      "reason": string
    },
    "creativeSource": enum (CreativeSource),
    "mediumType": enum (MediumType),
    "audienceTargetingConfig": {
      "audienceType": enum (AudienceType)
    },
    "targetingCriteria": {
      "selectedTargetingOptions": [
        {
          object (SelectedTargetingOption)
        }
      ]
    },
    "forecastResult": {
      "forecasts": [
        {
          object (Forecast)
        }
      ]
    },
    "errorDetails": {
      "message": string,
      "instantDealErrorStatus": enum (InstantDealErrorStatus)
    },
    "frequencyCap": {
      "timeUnit": enum (TimeUnit),
      "maxImpressions": string
    },
    "program": string,
    "buyerCustomParameters": {
      string: string,
      ...
    },
    "etag": string
  },
  "updateMask": string
}
שדות
product.displayName

string

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

הערך חייב להיות מקודד ב-UTF-8 ובגודל של עד 240 בייטים. חובה.
product.externalDealId

string

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

enum (TransactionType)

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

enum (PricingType)

סוג התמחור של המוצר. חובה.
product.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".
product.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".
product.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".
product.rateDetails

object (RateDetails)

פרטי התעריף. חובה.
product.creativeConfig[]

object (CreativeConfig)

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

boolean

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

object (MakegoodDetails)

פרטי הצגה חוזרת לפיצוי על מוצר. חובה כשהמוצר הוא הצגה חוזרת לפיצוי.
product.creativeSource

enum (CreativeSource)

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

enum (MediumType)

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

object (AudienceTargetingConfig)

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

object (TargetingCriteria)

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

object (ForecastResult)

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

object (ErrorDetails)

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

object (FrequencyCap)

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

string

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

map (key: string, value: string)

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

אובייקט שמכיל רשימה של זוגות "key": value. לדוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
product.etag

string

תג ישות (etag) שצריך לציין כשמעדכנים מוצר. צריך לציין אותו רק לעדכון אם השדה etag לא ריק. רלוונטי רק לתרחישים של עסקה מיידית.
updateMask

string (FieldMask format)

המסכה שקובעת אילו שדות לעדכן. חובה.

זוהי רשימה מופרדת בפסיקים של שמות שדות שמוגדרים במלואם. דוגמה: "user.displayName,photo"

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע של Product.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/doubleclickbidmanager

ניתן למצוא מידע נוסף כאן: OAuth 2.0 Overview.