Method: orders.patch

עדכון ההזמנה מ-3p ל-AOG. הפונקציה מחזירה את הערך INVALID_ARGUMENT אם מזהה ההזמנה ריק או לא שווה להזמנה קיימת.

בקשת HTTP

PATCH https://actions.googleapis.com/v3/orders/{orderUpdate.order.merchantOrderId}

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.

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

פרמטרים
orderUpdate.order.merchantOrderId

string

חובה: מזהה הזמנה פנימי שהוקצה על ידי המוכר. המזהה הזה חייב להיות ייחודי והוא נדרש לפעולות הבאות של עדכון הזמנה. אפשר להגדיר את המזהה הזה כ-googleOrderId שסופק או כערך ייחודי אחר. חשוב לשים לב שהמזהה שמוצג למשתמשים הוא userViewOrderId, שיכול להיות ערך אחר וידידותי יותר למשתמש. האורך המקסימלי הוא 64 תווים.

גוף הבקשה

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

ייצוג JSON 
{
  "header": {
    object (OrderRequestHeader)
  },
  "orderUpdate": {
    "type": enum (Type),
    "order": {
      "googleOrderId": string,
      "userVisibleOrderId": string,
      "userVisibleStateLabel": string,
      "buyerInfo": {
        object (UserInfo)
      },
      "image": {
        object (Image)
      },
      "createTime": string,
      "lastUpdateTime": string,
      "transactionMerchant": {
        object (Merchant)
      },
      "contents": {
        object (Contents)
      },
      "priceAttributes": [
        {
          object (PriceAttribute)
        }
      ],
      "followUpActions": [
        {
          object (Action)
        }
      ],
      "paymentData": {
        object (PaymentData)
      },
      "termsOfServiceUrl": string,
      "note": string,
      "promotions": [
        {
          object (Promotion)
        }
      ],
      "disclosures": [
        {
          object (Disclosure)
        }
      ],
      "vertical": {
        "@type": string,
        field1: ...,
        ...
      },

      // Union field verticals can be only one of the following:
      "purchase": {
        object (PurchaseOrderExtension)
      },
      "ticket": {
        object (TicketOrderExtension)
      }
      // End of list of possible types for union field verticals.
    },
    "updateMask": string,
    "userNotification": {
      object (UserNotification)
    },
    "reason": string
  }
}
שדות
header

object (OrderRequestHeader)

כותרת של הבקשה לעדכון ההזמנה.

orderUpdate.type
(deprecated)

enum (Type)

הוצא משימוש: במקומו, אפשר להשתמש ב-OrderUpdate.update_mask. אם הסוג = SNAPSHOT, הערך של OrderUpdate.order צריך להיות שלמות ההזמנה. אם type = ORDER_STATUS, זהו שינוי הסטטוס ברמת ההזמנה. בוחרים רק את הפרמטר order.last_update_time והסטטוס האנכי הזה. הערה: הפרמטר type.ORDER_STATUS תומך רק בעדכוני סטטוס של PurcahaseOrderExtension, ואין תוכנית להרחיב את התמיכה הזו. במקום זאת, מומלץ להשתמש ב-updateMask כי היא שיטה כללית יותר, ניתנת להרחבה ואפשר להשתמש בה בכל הענפים.

orderUpdate.order.googleOrderId

string

מזהה ההזמנה ש-Google הקצתה.

orderUpdate.order.userVisibleOrderId

string

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

orderUpdate.order.userVisibleStateLabel
(deprecated)

string

הוצא משימוש: יש להשתמש בסטטוס Orderתוספים במקום זאת. תווית גלויה למשתמש של מצב ההזמנה הזו.

orderUpdate.order.buyerInfo

object (UserInfo)

מידע על הקונה.

orderUpdate.order.image

object (Image)

תמונה שמשויכת להזמנה.

orderUpdate.order.createTime

string (Timestamp format)

חובה: התאריך והשעה שבהם ההזמנה נוצרה.

חותמת זמן בפורמט 'Zulu' של UTC לפי RFC3339, עם דיוק של ננו-שניות. דוגמה: "2014-10-02T15:01:23.045123456Z"
orderUpdate.order.lastUpdateTime

string (Timestamp format)

התאריך והשעה שבהם ההזמנה עודכנה לאחרונה. נדרש עבור OrderUpdate.

חותמת זמן ב-RFC3339 UTC 'Zulu' , מדויק לננו-שניות. דוגמה: "2014-10-02T15:01:23.045123456Z"
orderUpdate.order.transactionMerchant

object (Merchant)

המוכר שאימץ את תהליך התשלום. זה יכול להיות שונה מספק ברמת הפריט. דוגמה: הזמנת Expedia עם פריט מ-ANA.

orderUpdate.order.contents

object (Contents)

חובה: תוכן ההזמנה הוא קבוצה של פריטים.

orderUpdate.order.priceAttributes[]

object (PriceAttribute)

מחיר, הנחות, מיסים וכו'.

orderUpdate.order.followUpActions[]

object (Action)

פעולות המשך ברמת ההזמנה.

orderUpdate.order.paymentData

object (PaymentData)

נתונים שקשורים לתשלום בהזמנה.

orderUpdate.order.termsOfServiceUrl

string

קישור לתנאים ולהגבלות שחלים על ההזמנה או על ההזמנה המוצעת.

orderUpdate.order.note

string

פתקים שמצורפים להזמנה.

orderUpdate.order.promotions[]

object (Promotion)

כל המבצעים שמשויכים להזמנה הזו.

orderUpdate.order.disclosures[]

object (Disclosure)

גילוי נאות שמשויך להזמנה הזו.

orderUpdate.order.vertical
(deprecated)

object

הוצא משימוש: במקום זאת, יש להשתמש בפורמט אנכי. המאפיינים האלה יחולו על כל הפריטים, אלא אם תתבצע שינוי בפריט מסוים. הקטגוריה הזו צריכה להתאים לסוג האנכי ברמת הפריט. ערכים אפשריים: google.actions.orders.v3.verticals.purchase.PurchaseOrderExtension google.actions.orders.v3.verticals.ticket.TicketOrderExtension

אובייקט שמכיל שדות מסוג שרירותי. שדה נוסף "@type" מכיל URI המזהה את הסוג. לדוגמה: { "id": 1234, "@type": "types.example.com/standard/id" }.
orderUpdate.updateMask

string (FieldMask format)

הערה: יש כמה שיקולים או המלצות לגבי השדות המיוחדים הבאים: 1. השדה order.last_update_time תמיד יתעדכן כחלק מבקשת העדכון. המערכת תתעלם מ-order.create_time, order.google_order_id ו-order.merchant_order_id אם יסופק כחלק מ-updateMask.

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

object (UserNotification)

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

orderUpdate.reason

string

הסיבה לשינוי או לעדכון.

שדה איחוד verticals. המאפיינים האלה יחולו על כל הפריטים, אלא אם הם יבוטלו בפריט מסוים. הקטגוריה הזו צריכה להתאים לסוג האנכי ברמת הפריט. verticals יכול להיות רק אחת מהאפשרויות הבאות:
orderUpdate.order.purchase

object (PurchaseOrderExtension)

הזמנת רכש

orderUpdate.order.ticket

object (TicketOrderExtension)

הזמנת כרטיס

גוף התשובה

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

OrderUpdate

צריך לעדכן את ההזמנה.

ייצוג JSON 
{
  "type": enum (Type),
  "order": {
    object (Order)
  },
  "updateMask": string,
  "userNotification": {
    object (UserNotification)
  },
  "reason": string
}
שדות
type
(deprecated)

enum (Type)

האפשרות הזו הוצאה משימוש: במקום זאת, יש להשתמש ב-OrderUpdate.update_mask. אם type = SNAPSHOT, השדה OrderUpdate.order צריך לכלול את ההזמנה כולה. אם הסוג = ORDER_STATUS, זהו השינוי בסטטוס ההזמנה. בוחרים רק את הפרמטר order.last_update_time והסטטוס האנכי הזה. הערה: type.ORDER_STATUS תומך רק בעדכוני סטטוס של PucahaseOrderExtension ואין תוכנית להרחיב את התמיכה הזו. במקום זאת, מומלץ להשתמש ב-updateMask כי היא שיטה כללית יותר, ניתנת להרחבה ואפשר להשתמש בה בכל הענפים.
order

object (Order)
updateMask

string (FieldMask format)

הערה: יש שיקולים/המלצות נוספים בשדות המיוחדים הבאים: 1. order.last_update_time יעודכן תמיד כחלק מבקשת העדכון. המערכת תתעלם מ-order.create_time, order.google_order_id ו-order.merchant_order_id אם יסופק כחלק מ-updateMask.

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

object (UserNotification)

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

reason

string

הסיבה לשינוי או לעדכון.

סוג

הוצא משימוש: במקומו, אפשר להשתמש ב-OrderUpdate.update_mask. עדכונים מותרים להזמנה.

טיפוסים בני מנייה (enum)
TYPE_UNSPECIFIED סוג לא צוין, אין להגדיר זאת באופן מפורש.
ORDER_STATUS יש לעדכן רק את סטטוס ההזמנה.
SNAPSHOT עדכון תמונת המצב של ההזמנה.

UserNotification

הודעה אופציונלית למשתמש שתוצג כחלק מעדכון ההזמנה.

ייצוג JSON 
{
  "title": string,
  "text": string
}
שדות
title

string

הכותרת של ההתראה למשתמש. האורך המקסימלי המותר הוא 30 תווים.

text

string

תוכן ההתראה. האורך המקסימלי המותר הוא 100 תווים.