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),

      // Union field budget can be only one of the following:
      "impressions": string,
      "money": {
        object (Money)
      }
      // End of list of possible types for union field budget.
    },
    "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, כדי לציין שההזמנה הזו בוטלה ב-Exchange.
order.wseatConfig

object (WSeatConfig)

אופציונלי. ‫WSeat Configuration Specifies the WSeat configuration on the exchange side. בורסות שמשתמשות בעסקאות עם כמה מושבים צפויות להמשיך לאכלס את השדה הזה ולעדכן אותו.
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.