- JSON 表示法
- 目录
- PaymentData
- PaymentResult
- PaymentInfo
- PaymentMethodDisplayInfo
- 促销
- PurchaseOrderExtension
- PurchaseError
- TicketOrderExtension
- TicketEvent
- EventCharacterEventCharacter
订单实体。注意:1. 除非另有说明,否则所有级别的所有字符串均不得超过 1000 个字符。2. 除非另有说明,否则所有级别的所有重复字段的计数都必须少于 50。3. 所有级别的所有时间戳(如果指定)都必须是有效的时间戳。
JSON 表示法 | |
---|---|
{ "googleOrderId": string, "merchantOrderId": string, "userVisibleOrderId": string, "userVisibleStateLabel": string, "buyerInfo": { object ( |
字段 | ||
---|---|---|
googleOrderId |
Google 分配的订单 ID。 |
|
merchantOrderId |
必填:由商家分配的内部订单 ID。此 ID 必须是唯一的,并且是后续订单更新操作所必需的。此 ID 可以设置为提供的 googleOrderId 或任何其他唯一值。请注意,向用户显示的 ID 是 userVisibleOrderId,该值可能是另一个更方便使用的值。允许的长度上限为 128 个字符。 |
|
userVisibleOrderId |
引用当前订单的面向用户的 ID。此 ID 应与在其他环境(包括网站、应用和电子邮件)中为该订单显示的 ID 一致。 |
|
userVisibleStateLabel |
已弃用:请改用 OrderExtensions 状态。此订单状态的用户可见标签。 |
|
buyerInfo |
买方的相关信息 |
|
image |
与订单相关联的图片。 |
|
createTime |
必填:订单的创建日期和时间。 时间戳采用 RFC3339 世界协调时间(UTC,即“祖鲁时”)格式,精确到纳秒。示例: |
|
lastUpdateTime |
上次更新订单的日期和时间。对于 OrderUpdate 是必需的。 时间戳采用 RFC3339 世界协调时间(UTC,即“祖鲁时”)格式,精确到纳秒。示例: |
|
transactionMerchant |
协助完成结账的商家。该提供商可能不同于订单项级提供商。示例:包含来自 ANA 的订单项的 Expedia 订单。 |
|
contents |
必需:订单内容,即一组订单项。 |
|
priceAttributes[] |
价格、折扣、税费等。 |
|
followUpActions[] |
订单级的跟进操作。 |
|
paymentData |
订单的付款相关数据。 |
|
termsOfServiceUrl |
指向适用于订单/提议订单的服务条款的链接。 |
|
note |
附加到订单的备注。 |
|
promotions[] |
与此订单相关联的所有促销活动。 |
|
disclosures[] |
与此订单相关的披露信息。 |
|
vertical |
已弃用:请改用行业。除非这些属性在某些订单项中被替换,否则它们会应用于所有订单项。此行业必须与订单项级行业类型一致。可能的值: 可以包含任意类型字段的对象。附加字段 |
|
联合字段 verticals 。除非这些属性在某些订单项中被替换,否则它们会应用于所有订单项。此行业必须与订单项级行业类型一致。verticals 只能是下列其中一项: |
||
purchase |
采购订单 |
|
ticket |
门票订单 |
目录
订单项的封装容器。
JSON 表示法 | |
---|---|
{
"lineItems": [
{
object ( |
字段 | |
---|---|
lineItems[] |
订单订单项列表。必须提供至少 1 个订单项,但最多允许提供 50 个。所有订单项都必须属于同一行业。 |
PaymentData
与订单相关的付款数据。
JSON 表示法 | |
---|---|
{ "paymentResult": { object ( |
字段 | |
---|---|
paymentResult |
集成商用于完成交易的付款结果。如果结账体验由 Actions-on-Google 管理,此字段将由 Google 上的操作填充。 |
paymentInfo |
有关订单的付款信息,可用于面向用户的互动。 |
PaymentResult
集成商用于完成交易的付款结果。
JSON 表示法 | |
---|---|
{ // Union field |
字段 | ||
---|---|---|
联合字段 result 。提供了 Google 付款数据或商家付款方式。result 只能是下列其中一项: |
||
googlePaymentData |
Google 提供的付款方式数据。如果您的付款处理方被列为 Google 支持的付款处理方,请访问:https://developers.google.com/pay/api/ 请通过链接前往您的付款处理方,以了解更多详情。否则,请参阅以下文档,了解载荷详情:https://developers.google.com/pay/api/payment-data-cryptography |
|
merchantPaymentMethodId |
用户选择的商家/操作提供的付款方式。 |
PaymentInfo
有关所下订单的付款信息。此 proto 会捕获对面向用户的互动有用的信息。
JSON 表示法 | |
---|---|
{ "paymentMethodDisplayInfo": { object ( |
字段 | |
---|---|
paymentMethodDisplayInfo |
交易所用付款方式的显示信息。 |
paymentMethodProvenance |
交易所用付款方式的出处。用户可能在 Google 和商家处注册了同一付款方式。 |
PaymentMethodDisplayInfo
集成商用于完成交易的付款结果。
JSON 表示法 | |
---|---|
{
"paymentType": enum ( |
字段 | |
---|---|
paymentType |
付款的类型。 |
paymentMethodDisplayName |
用户可见的付款方式名称。例如,VISA **** 1234 支票账户 **** 5678 |
促销
已添加到购物车的促销/优惠。
JSON 表示法 | |
---|---|
{ "coupon": string } |
字段 | |
---|---|
coupon |
必填:应用于此优惠的优惠券代码。 |
PurchaseOrderExtension
适用于购买行业的订单附加信息。这些属性适用于订单中的所有订单项,除非它们在订单项中被替换。
JSON 表示法 | |
---|---|
{ "status": enum ( |
字段 | |
---|---|
status |
必需:订单的整体状态。 |
userVisibleStatusLabel |
用户可见的状态标签/字符串。允许的长度上限为 50 个字符。 |
type |
必填:购买交易的类型。 |
returnsInfo |
退货信息。 |
fulfillmentInfo |
订单的履单信息。 |
extension |
商家与 Google 之间交换的任何额外字段。 可以包含任意类型字段的对象。附加字段 |
purchaseLocationType |
购买地点(实体店 / 线上) |
errors[] |
可选:此订单遭到拒绝的错误。 |
PurchaseError
采购订单可能因错误而遭拒。
JSON 表示法 | |
---|---|
{ "type": enum ( |
字段 | |
---|---|
type |
必需:此属性表示订单被商家拒绝的详细原因。 |
description |
更多错误说明。 |
entityId |
与错误对应的实体 ID。例如,它可以对应于 LineItemId / ItemOptionId。 |
updatedPrice |
适用于 PRICE_CHANGED / INORRECT_PRICE 错误类型。 |
availableQuantity |
目前可售的数量。适用于 AVAILABILITY_CHANGED 的情况。 |
TicketOrderExtension
订购电影票、体育赛事等票券的内容
JSON 表示法 | |
---|---|
{
"ticketEvent": {
object ( |
字段 | |
---|---|
ticketEvent |
该事件适用于所有订单项工单。 |
TicketEvent
表示单个事件。
JSON 表示法 | |
---|---|
{ "type": enum ( |
字段 | |
---|---|
type |
必需:门票活动的类型,例如电影、音乐会。 |
name |
必填:事件的名称。例如,如果事件是一部电影,则应填写电影名称。 |
description |
事件说明。 |
url |
活动信息的网址。 |
location |
活动地点或组织所在的位置。 |
eventCharacters[] |
与此活动相关的字符。可以是电影活动的导演或演员,也可以是音乐会的表演者等。 |
startDate |
开始时间。 |
endDate |
结束时间。 |
doorTime |
进入时间,可能与活动开始时间不同。例如,活动在上午 9 点开始,但进入时间为上午 8:30。 |
EventCharacter
一个活动角色,例如组织者、表演者等。
JSON 表示法 | |
---|---|
{ "type": enum ( |
字段 | |
---|---|
type |
活动角色的类型,例如演员或导演。 |
name |
字符的名称。 |
image |
角色的图片。 |