Order

ישות ההזמנה. הערה: 1. כל המחרוזות בכל הרמות חייבות להיות באורך של פחות מ-1,000 תווים, אלא אם צוין אחרת. 2. מספר השדות החוזרים בכל הרמות חייב להיות קטן מ-50, אלא אם צוין אחרת. 3. כל חותמות הזמן בכל הרמות, אם צוינו, חייבות להיות חותמות זמן חוקיות.

ייצוג JSON
{
  "googleOrderId": string,
  "merchantOrderId": 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.
}
שדות
googleOrderId

string

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

merchantOrderId

string

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

userVisibleOrderId

string

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

userVisibleStateLabel
(deprecated)

string

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

buyerInfo

object (UserInfo)

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

image

object (Image)

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

createTime

string (Timestamp format)

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

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

lastUpdateTime

string (Timestamp format)

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

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

transactionMerchant

object (Merchant)

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

contents

object (Contents)

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

priceAttributes[]

object (PriceAttribute)

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

followUpActions[]

object (Action)

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

paymentData

object (PaymentData)

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

termsOfServiceUrl

string

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

note

string

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

promotions[]

object (Promotion)

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

disclosures[]

object (Disclosure)

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

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

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

object (PurchaseOrderExtension)

הזמנת רכש

ticket

object (TicketOrderExtension)

הזמנת כרטיס

תוכן עניינים

wrapper של פריטים.

ייצוג JSON
{
  "lineItems": [
    {
      object (LineItem)
    }
  ]
}
שדות
lineItems[]

object (LineItem)

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

PaymentData

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

ייצוג JSON
{
  "paymentResult": {
    object (PaymentResult)
  },
  "paymentInfo": {
    object (PaymentInfo)
  }
}
שדות
paymentResult

object (PaymentResult)

תוצאת תשלום שמשמשת את מבצע השילוב להשלמת עסקה. השדה הזה יאוכלס בפעולות ב-Google אם חוויית התשלום מנוהלת על ידי Actions-on-Google.

paymentInfo

object (PaymentInfo)

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

PaymentResult

תוצאת התשלום שמשמשת את מבצע השילוב להשלמת עסקה.

ייצוג JSON
{

  // Union field result can be only one of the following:
  "googlePaymentData": string,
  "merchantPaymentMethodId": string
  // End of list of possible types for union field result.
}
שדות
שדה איחוד result. קיבלנו את נתוני התשלום של Google או את אמצעי התשלום של המוכר. result יכול להיות רק אחת מהאפשרויות הבאות:
googlePaymentData

string

נתונים של אמצעי התשלום שסופקו על ידי Google. אם ספק שירותי התשלומים שלך רשום כאן בתור ספק שירותי תשלומים שנתמך על ידי Google: https://developers.google.com/pay/api/ כדי לקבל פרטים נוספים, אפשר לעבור אל ספק שירותי התשלומים דרך הקישור. אחרת, אפשר לעיין במסמכים הבאים לקבלת פרטים על המטען הייעודי (payload). https://developers.google.com/pay/api/payment-data-cryptography

merchantPaymentMethodId

string

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

PaymentInfo

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

ייצוג JSON
{
  "paymentMethodDisplayInfo": {
    object (PaymentMethodDisplayInfo)
  },
  "paymentMethodProvenance": enum (PaymentMethodProvenance)
}
שדות
paymentMethodDisplayInfo

object (PaymentMethodDisplayInfo)

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

paymentMethodProvenance

enum (PaymentMethodProvenance)

המקור של אמצעי התשלום ששימש לביצוע העסקה. יכול להיות שהמשתמש רשם את אותו אמצעי תשלום גם ב-Google וגם ב-Merchant.

PaymentMethodDisplayInfo

תוצאת התשלום שמשמשת את מבצע השילוב להשלמת עסקה.

ייצוג JSON
{
  "paymentType": enum (PaymentType),
  "paymentMethodDisplayName": string
}
שדות
paymentType

enum (PaymentType)

סוג התשלום.

paymentMethodDisplayName

string

השם הגלוי למשתמש של אמצעי התשלום. לדוגמה, VISA **** 1234 בדיקה חשבון **** 5678

קידום מכירות

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

ייצוג JSON
{
  "coupon": string
}
שדות
coupon

string

נדרש: קוד השובר שהוחל על המבצע הזה.

PurchaseOrderExtension

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

ייצוג JSON
{
  "status": enum (PurchaseStatus),
  "userVisibleStatusLabel": string,
  "type": enum (PurchaseType),
  "returnsInfo": {
    object (PurchaseReturnsInfo)
  },
  "fulfillmentInfo": {
    object (PurchaseFulfillmentInfo)
  },
  "extension": {
    "@type": string,
    field1: ...,
    ...
  },
  "purchaseLocationType": enum (PurchaseLocationType),
  "errors": [
    {
      object (PurchaseError)
    }
  ]
}
שדות
status

enum (PurchaseStatus)

חובה: הסטטוס הכללי של ההזמנה.

userVisibleStatusLabel

string

תווית/מחרוזת גלויה למשתמש עבור הסטטוס. האורך המקסימלי המותר הוא 50 תווים.

type

enum (PurchaseType)

חובה: סוג רכישה.

returnsInfo

object (PurchaseReturnsInfo)

פרטי ההחזרה של ההזמנה.

fulfillmentInfo

object (PurchaseFulfillmentInfo)

מידע על אספקה של ההזמנה.

extension

object

כל שדה מיותר שהוחלף בין המוכר ל-Google.

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

purchaseLocationType

enum (PurchaseLocationType)

מיקום הרכישה (בחנות או באינטרנט)

errors[]

object (PurchaseError)

אופציונלי: שגיאות שבגללן ההזמנה הזו נדחתה.

PurchaseError

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

ייצוג JSON
{
  "type": enum (ErrorType),
  "description": string,
  "entityId": string,
  "updatedPrice": {
    object (PriceAttribute)
  },
  "availableQuantity": integer
}
שדות
type

enum (ErrorType)

חובה: מייצג את הסיבה המפורטת לכך שהמוכר דחה הזמנה.

description

string

תיאור שגיאה נוסף.

entityId

string

מזהה הישות שתואם לשגיאה. דוגמה לכך יכולה להתאים ל-LineItemId / ItemOptionId.

updatedPrice

object (PriceAttribute)

רלוונטי במקרה של סוג השגיאה PRICE_CHANGED / INCORRECT_PRICE.

availableQuantity

integer

כמות זמינה עכשיו. רלוונטי במקרה של AVAILABILITY_CHANGED.

TicketOrderExtension

תוכן של הזמנות כרטיסים, כמו סרטים, ספורט וכו'

ייצוג JSON
{
  "ticketEvent": {
    object (TicketEvent)
  }
}
שדות
ticketEvent

object (TicketEvent)

האירוע הזה חל על כל הכרטיסים בפריטים.

TicketEvent

מייצג אירוע יחיד.

ייצוג JSON
{
  "type": enum (Type),
  "name": string,
  "description": string,
  "url": string,
  "location": {
    object (Location)
  },
  "eventCharacters": [
    {
      object (EventCharacter)
    }
  ],
  "startDate": {
    object (Time)
  },
  "endDate": {
    object (Time)
  },
  "doorTime": {
    object (Time)
  }
}
שדות
type

enum (Type)

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

name

string

חובה: שם האירוע. לדוגמה, אם האירוע הוא סרט, הוא צריך להיות שם הסרט.

description

string

בתיאור האירוע.

url

string

כתובת URL לפרטי האירוע.

location

object (Location)

המיקום שבו מתקיים האירוע או המיקום של הארגון.

eventCharacters[]

object (EventCharacter)

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

startDate

object (Time)

שעת התחלה.

endDate

object (Time)

שעת סיום.

doorTime

object (Time)

שעת הכניסה, שעשויה להיות שונה משעת ההתחלה של האירוע. לדוגמה האירוע מתחיל ב-9:00 אבל שעת הכניסה היא 8:30.

EventCharacter

תו אירוע אחד, למשל מארגן, מבצע וכו'.

ייצוג JSON
{
  "type": enum (Type),
  "name": string,
  "image": {
    object (Image)
  }
}
שדות
type

enum (Type)

סוג תו האירוע, למשל שחקן או במאי.

name

string

שם התו.

image

object (Image)

התמונות של הדמות.