Order

موجودیت سفارش. توجه: 1. تمام رشته ها در تمام سطوح باید کمتر از 1000 کاراکتر باشند مگر اینکه طور دیگری مشخص شده باشد. 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

منسوخ شده: به جای آن از وضعیت OrderExtensions استفاده کنید. برچسب قابل مشاهده توسط کاربر برای وضعیت این سفارش.

buyerInfo

object ( UserInfo )

اطلاعات در مورد خریدار

image

object ( Image )

تصویر مرتبط با سفارش

createTime

string ( Timestamp format)

مورد نیاز: تاریخ و زمان ایجاد سفارش.

یک مهر زمانی در قالب RFC3339 UTC "Zulu"، با دقت نانوثانیه. مثال: "2014-10-02T15:01:23.045123456Z" .

lastUpdateTime

string ( Timestamp format)

تاریخ و زمان آخرین به روز رسانی سفارش برای به روز رسانی سفارش مورد نیاز است.

یک مهر زمانی در قالب 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 )

سفارش بلیط

فهرست

لفاف برای اقلام خط.

نمایندگی JSON
{
  "lineItems": [
    {
      object (LineItem)
    }
  ]
}
زمینه های
lineItems[]

object ( LineItem )

لیست اقلام خط سفارش حداقل 1 خط مورد نیاز است و حداکثر 50 مورد مجاز است. همه موارد خط باید به یک عمود تعلق داشته باشند.

داده های پرداخت

داده های پرداخت مربوط به یک سفارش.

نمایندگی JSON
{
  "paymentResult": {
    object (PaymentResult)
  },
  "paymentInfo": {
    object (PaymentInfo)
  }
}
زمینه های
paymentResult

object ( PaymentResult )

نتیجه پرداخت که توسط یکپارچه ساز برای تکمیل تراکنش استفاده می شود. اگر تجربه تسویه‌حساب توسط Actions-on-Google مدیریت شود، این فیلد با کنش‌هایی در Google پر می‌شود.

paymentInfo

object ( PaymentInfo )

اطلاعات پرداخت مربوط به سفارش که برای تعامل با کاربر مفید است.

نتیجه پرداخت

نتیجه پرداخت که توسط یکپارچه ساز برای تکمیل تراکنش استفاده می شود.

نمایندگی 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/ برای اطلاع از جزئیات بیشتر، از طریق پیوند به پردازشگر پرداخت خود بروید. در غیر این صورت، برای جزئیات بار به اسناد زیر مراجعه کنید. https://developers.google.com/pay/api/payment-data-cryptography

merchantPaymentMethodId

string

تاجر/عملی روش پرداختی را که کاربر انتخاب کرده است ارائه کرده است.

اطلاعات پرداخت

اطلاعات پرداخت در مورد سفارش در حال انجام. این پروتو اطلاعاتی را می گیرد که برای تعامل با کاربر مفید است.

نمایندگی JSON
{
  "paymentMethodDisplayInfo": {
    object (PaymentMethodDisplayInfo)
  },
  "paymentMethodProvenance": enum (PaymentMethodProvenance)
}
زمینه های
paymentMethodDisplayInfo

object ( PaymentMethodDisplayInfo )

نمایش اطلاعات روش پرداخت مورد استفاده برای تراکنش.

paymentMethodProvenance

enum ( PaymentMethodProvenance )

منشأ روش پرداخت مورد استفاده برای معامله. کاربر ممکن است روش پرداخت یکسانی را در گوگل و تاجر ثبت کرده باشد.

PaymentMethodDisplayInfo

نتیجه پرداخت که توسط یکپارچه ساز برای تکمیل تراکنش استفاده می شود.

نمایندگی JSON
{
  "paymentType": enum (PaymentType),
  "paymentMethodDisplayName": string
}
زمینه های
paymentType

enum ( PaymentType )

نوع پرداخت.

paymentMethodDisplayName

string

نام قابل مشاهده توسط کاربر روش پرداخت. به عنوان مثال، VISA **** 1234 Checking acct **** 5678

ترویج

تبلیغات/پیشنهادهایی که به سبد خرید اضافه شدند.

نمایندگی JSON
{
  "coupon": string
}
زمینه های
coupon

string

الزامی: کد کوپن اعمال شده در این پیشنهاد.

PurchaseOrder Extension

پسوند سفارش برای خرید عمودی. این ویژگی‌ها برای همه موارد خط داخل سفارش قابل اعمال هستند، مگر اینکه در یک آیتم خطی لغو شوند.

نمایندگی 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

هر فیلد اضافی رد و بدل شده بین تاجر و گوگل.

یک شی حاوی فیلدهایی از نوع دلخواه. یک فیلد اضافی "@type" حاوی یک URI است که نوع را مشخص می کند. مثال: { "id": 1234, "@type": "types.example.com/standard/id" } .

purchaseLocationType

enum ( PurchaseLocationType )

محل خرید (در فروشگاه / آنلاین)

errors[]

object ( 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.

TicketOrder Extension

سفارش محتویات برای سفارش بلیط مانند فیلم، ورزش و غیره.

نمایندگی 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

آدرس اینترنتی اطلاعات رویداد.

location

object ( Location )

مکانی که رویداد در آن رخ می دهد، یا یک سازمان در آن واقع شده است.

eventCharacters[]

object ( EventCharacter )

شخصیت های مرتبط با این رویداد. این می تواند کارگردان یا بازیگر یک رویداد سینمایی یا مجری یک کنسرت و غیره باشد.

startDate

object ( Time )

زمان شروع.

endDate

object ( Time )

زمان پایان.

doorTime

object ( Time )

زمان ورود، که ممکن است با زمان شروع رویداد متفاوت باشد. به عنوان مثال رویداد از ساعت 9 صبح شروع می شود، اما زمان ورود 8:30 صبح است.

شخصیت رویداد

یک شخصیت رویداد، به عنوان مثال سازمان دهنده، مجری و غیره.

نمایندگی JSON
{
  "type": enum (Type),
  "name": string,
  "image": {
    object (Image)
  }
}
زمینه های
type

enum ( Type )

نوع شخصیت رویداد، به عنوان مثال بازیگر یا کارگردان.

name

string

نام شخصیت

image

object ( Image )

تصاویر شخصیت