Method: exchanges.orders.products.patch

עדכון מוצר.

בקשת HTTP

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

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

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

פרמטרים
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
    },
    "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. אפשר להשתמש גם בשינויים (offsets) אחרים מלבד 'Z'. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
product.startTime

string (Timestamp format)

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

הפורמט הזה משתמש ב-RFC 3339, שבו הפלט שנוצר תמיד יהיה מנורמלי לפי Z וישמש בספרות עשרוניות של 0, 3, 6 או 9. אפשר להשתמש גם בשינויים (offsets) אחרים מלבד '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. אפשר להשתמש גם בשינויים (offsets) אחרים מלבד '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)

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

object (TargetingCriteria)

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

object (ForecastResult)

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

object (ErrorDetails)

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

object (FrequencyCap)

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

string

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

string (FieldMask format)

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

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

גוף התשובה

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

היקפי הרשאה

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

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

מידע נוסף זמין בOAuth 2.0 Overview.