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

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

buyerInfo

object (UserInfo)

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

image

object (Image)

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

createTime

string (Timestamp format)

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

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

lastUpdateTime

string (Timestamp format)

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

חותמת זמן בפורמט "זולו" RFC3339 UTC, מדויקת לננו-שניות. דוגמה: "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)

הזמנת כרטיסים

תוכן עניינים

ראפ לפריטים.

ייצוג 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 וגם במוכר.

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_Change / INCORRECT_PRICE.

availableQuantity

integer

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

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)

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