עדכון ההזמנה מ-3p ל-AOG. הפונקציה מחזירה את הערך INVALID_ARGUMENT אם מזהה ההזמנה ריק או לא שווה להזמנה קיימת.
בקשת HTTP
PATCH https://actions.googleapis.com/v3/orders/{orderUpdate.order.merchantOrderId}
בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.
פרמטרים של נתיב
פרמטרים | |
---|---|
orderUpdate.order.merchantOrderId |
חובה: מזהה הזמנה פנימי הוקצה למוכר. המזהה הזה חייב להיות ייחודי והוא נדרש לפעולות הבאות של עדכון הזמנה. המזהה הזה יכול להיות מוגדר ל-googleOrderId שצוין, או לכל ערך ייחודי אחר. לתשומת ליבכם: המזהה שמוצג למשתמשים הוא uservisibleOrderId, שיכול להיות ערך אחר וידידותי יותר למשתמש. האורך המקסימלי הוא 64 תווים. |
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
ייצוג JSON | |
---|---|
{ "header": { object ( |
שדות | ||
---|---|---|
header |
כותרת של הבקשה לעדכון ההזמנה. |
|
orderUpdate.type |
הוצא משימוש: במקומו, אפשר להשתמש ב-OrderUpdate.update_mask. אם הסוג = SNAPSHOT, הערך של OrderUpdate.order צריך להיות שלמות ההזמנה. אם הסוג = ORDER_STATUS, זהו השינוי בסטטוס ההזמנה. בוחרים רק את הפרמטר order.last_update_time והסטטוס האנכי הזה. הערה: type.ORDER_STATUS תומך רק בעדכוני סטטוס של PucahaseOrderExtension ואין תוכנית להרחיב את התמיכה הזו. במקום זאת, מומלץ להשתמש ב-updateMask כי היא שיטה כללית יותר, ניתנת להרחבה ואפשר להשתמש בה בכל הענפים. |
|
orderUpdate.order.googleOrderId |
מזהה ההזמנה ש-Google הקצתה. |
|
orderUpdate.order.userVisibleOrderId |
המזהה שגלוי למשתמש שמתייחס להזמנה הנוכחית. המזהה הזה צריך להיות תואם למזהה שמוצג להזמנה הזו בהקשרים אחרים, כולל אתרים, אפליקציות ואימייל. |
|
orderUpdate.order.userVisibleStateLabel |
הוצא משימוש: יש להשתמש בסטטוס Orderתוספים במקום זאת. תווית גלויה למשתמש של מצב ההזמנה הזו. |
|
orderUpdate.order.buyerInfo |
מידע על הקונה. |
|
orderUpdate.order.image |
תמונה שמשויכת להזמנה. |
|
orderUpdate.order.createTime |
חובה: התאריך והשעה שבהם ההזמנה נוצרה. חותמת זמן ב-RFC3339 UTC 'Zulu' , מדויק לננו-שניות. דוגמה: |
|
orderUpdate.order.lastUpdateTime |
התאריך והשעה שבהם ההזמנה עודכנה לאחרונה. נדרש עבור OrderUpdate. חותמת זמן ב-RFC3339 UTC 'Zulu' , מדויק לננו-שניות. דוגמה: |
|
orderUpdate.order.transactionMerchant |
המוכר שאימץ את תהליך התשלום. זה יכול להיות שונה מספק ברמת הפריט. דוגמה: הזמנת Expedia עם פריט מ-ANA. |
|
orderUpdate.order.contents |
חובה: תוכן ההזמנה הוא קבוצה של פריטים. |
|
orderUpdate.order.priceAttributes[] |
מחיר, הנחות, מיסים וכו'. |
|
orderUpdate.order.followUpActions[] |
פעולות המשך ברמת ההזמנה. |
|
orderUpdate.order.paymentData |
נתונים שקשורים לתשלום בהזמנה. |
|
orderUpdate.order.termsOfServiceUrl |
קישור לתנאים ולהגבלות שחלים על ההזמנה/ההצעה. |
|
orderUpdate.order.note |
פתקים שמצורפים להזמנה. |
|
orderUpdate.order.promotions[] |
כל המבצעים שמשויכים להזמנה הזו. |
|
orderUpdate.order.disclosures[] |
גילוי נאות שמשויך להזמנה הזו. |
|
orderUpdate.order.vertical |
הוצא משימוש: במקום זאת, יש להשתמש בפורמט אנכי. המאפיינים האלה יחולו על כל הפריטים, אלא אם הם יבוטלו בפריט מסוים. הקטגוריה הזו צריכה להתאים לסוג האנכי ברמת הפריט. ערכים אפשריים: אובייקט שמכיל שדות מסוג שרירותי. שדה נוסף |
|
orderUpdate.updateMask |
הערה: יש שיקולים/המלצות נוספים בשדות המיוחדים הבאים: 1. order.last_update_time יעודכן תמיד כחלק מבקשת העדכון. המערכת תתעלם מ-order.create_time, order.google_order_id ו-order.merchant_order_id אם יסופק כחלק מ-updateMask. רשימה מופרדת בפסיקים של שמות שדות שמוגדרים במלואם. דוגמה: |
|
orderUpdate.userNotification |
אם צוין, הצגת התראה למשתמש עם הכותרת והטקסט שצוינו. ציון התראה הוא הצעה להודיע, ולא בטוח שהפעולה הזו תוביל לשליחת התראה. |
|
orderUpdate.reason |
הסיבה לשינוי או לעדכון. |
|
שדה איחוד verticals . המאפיינים האלה יחולו על כל הפריטים, אלא אם הם יבוטלו בפריט מסוים. הקטגוריה הזו צריכה להתאים לסוג האנכי ברמת הפריט. verticals יכול להיות רק אחת מהאפשרויות הבאות: |
||
orderUpdate.order.purchase |
הזמנת רכש |
|
orderUpdate.order.ticket |
הזמנת כרטיס |
גוף התשובה
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול מופע של Order
.
OrderUpdate
צריך לעדכן את ההזמנה.
ייצוג JSON | |
---|---|
{ "type": enum ( |
שדות | |
---|---|
type |
הוצא משימוש: במקומו, אפשר להשתמש ב-OrderUpdate.update_mask. אם הסוג = SNAPSHOT, הערך של OrderUpdate.order צריך להיות שלמות ההזמנה. אם הסוג = ORDER_STATUS, זהו השינוי בסטטוס ההזמנה. בוחרים רק את הפרמטר order.last_update_time והסטטוס האנכי הזה. הערה: type.ORDER_STATUS תומך רק בעדכוני סטטוס של PucahaseOrderExtension ואין תוכנית להרחיב את התמיכה הזו. במקום זאת, מומלץ להשתמש ב-updateMask כי היא שיטה כללית יותר, ניתנת להרחבה ואפשר להשתמש בה בכל הענפים. |
order |
|
updateMask |
הערה: יש שיקולים/המלצות נוספים בשדות המיוחדים הבאים: 1. order.last_update_time יעודכן תמיד כחלק מבקשת העדכון. המערכת תתעלם מ-order.create_time, order.google_order_id ו-order.merchant_order_id אם יסופק כחלק מ-updateMask. רשימה מופרדת בפסיקים של שמות שדות שמוגדרים במלואם. דוגמה: |
userNotification |
אם צוין, הצגת התראה למשתמש עם הכותרת והטקסט שצוינו. ציון התראה הוא הצעה להודיע, ולא בטוח שהפעולה הזו תוביל לשליחת התראה. |
reason |
הסיבה לשינוי או לעדכון. |
סוג
הוצא משימוש: במקומו, אפשר להשתמש ב-OrderUpdate.update_mask. אישרו עדכונים של הזמנה.
טיפוסים בני מנייה (enum) | |
---|---|
TYPE_UNSPECIFIED |
סוג לא צוין, אין להגדיר זאת באופן מפורש. |
ORDER_STATUS |
יש לעדכן רק את סטטוס ההזמנה. |
SNAPSHOT |
עדכון תמונת המצב של ההזמנה. |
UserNotification
הודעה אופציונלית למשתמש שתוצג כחלק מעדכון ההזמנה.
ייצוג JSON | |
---|---|
{ "title": string, "text": string } |
שדות | |
---|---|
title |
הכותרת של ההודעה למשתמש. האורך המקסימלי הוא 30 תווים. |
text |
תוכן ההתראה. האורך המקסימלי המותר הוא 100 תווים. |