Method: exchanges.orders.patch

עדכון הזמנה.

בקשת HTTP

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

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

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

פרמטרים
order.name

string

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

גוף הבקשה

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

ייצוג JSON
{
  "order": {
    "name": string,
    "displayName": string,
    "partnerId": [
      string
    ],
    "publisherEmail": string,
    "publisherName": string,
    "budget": {
      "budgetType": enum (BudgetType),

      // The following is a list of mutually exclusive fields. At most one of the
      // fields will be set in a response:
      "impressions": string,
      "money": {
        object (Money)
      }
      // End of mutually exclusive fields.
    },
    "status": enum (OrderStatus),
    "wseatConfig": {
      "exchangeWseatStatus": enum (WSeatStatus),
      "exchangeWseatIds": [
        string
      ],
      "updateTime": string
    },
    "updateTime": string,
    "buyerInfo": {
      "partner": {
        object (PartnerInfo)
      },
      "advertisers": [
        {
          object (AdvertiserInfo)
        }
      ]
    }
  },
  "updateMask": string
}
שדות
order.displayName

string

השם של ההזמנה שמוצג לקונה. עד 250 תווים. אופציונלי.

order.partnerId[]

string (int64 format)

מזהה השותף ב-Google Display & Video 360, שנקרא בעבר Doubleclick Bid Manager‏(DBM). אפשר להזין רק מזהה שותף אחד. חובה.

order.publisherEmail

string

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

order.publisherName

string

שם המוציא לאור. עד 250 תווים. חובה.

order.budget

object (Budget)

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

order.status

enum (OrderStatus)

סטטוס ההזמנה. הסטטוס יכול להשתנות אחרי שמשתמשי DV3 מאשרים, מבטלים או מעבירים לארכיון הזמנה. בנוסף, תהיה תמיכה בעדכון לסטטוס 'בוטלה' אחרי היצירה ב-API, כדי לציין שההזמנה הזו בוטלה בבורסה.

order.wseatConfig

object (WSeatConfig)

אופציונלי. ‫WSeat Configuration: מציין את הגדרת ה-WSeat בצד של Exchange. בורסות שמשתמשות בעסקאות עם כמה מושבים צפויות להמשיך לאכלס את השדה הזה ולעדכן אותו.

order.updateTime

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".

order.buyerInfo

object (BuyerInfo)

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

updateMask

string (FieldMask format)

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

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

גוף התשובה

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

היקפי הרשאות

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

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

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