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 «Зулу» с точностью до наносекунд. Пример: "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 )

Список позиций заказа. Требуется как минимум 1 элемент строки, допускается не более 50. Все позиции должны относиться к одной тематике.

Платежные данные

Платежные данные, относящиеся к заказу.

JSON-представление
{
  "paymentResult": {
    object (PaymentResult)
  },
  "paymentInfo": {
    object (PaymentInfo)
  }
}
Поля
paymentResult

object ( PaymentResult )

Результат платежа, который используется интегратором для завершения транзакции. Это поле будет заполнено действиями в Google, если процесс оформления заказа управляется Actions-on-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/pay-data-cryptography

merchantPaymentMethodId

string

Продавец/Действие предоставил способ оплаты, выбранный пользователем.

Информация о платеже

Платежная информация по выполняемому заказу. Этот прототип собирает информацию, полезную для взаимодействия с пользователем.

JSON-представление
{
  "paymentMethodDisplayInfo": {
    object (PaymentMethodDisplayInfo)
  },
  "paymentMethodProvenance": enum (PaymentMethodProvenance)
}
Поля
paymentMethodDisplayInfo

object ( PaymentMethodDisplayInfo )

Отображаемая информация о способе оплаты, использованном для транзакции.

paymentMethodProvenance

enum ( PaymentMethodProvenance )

Происхождение способа оплаты, использованного для транзакции. Пользователь мог зарегистрировать один и тот же способ оплаты как в Google, так и в продавце.

Метод оплатыDisplayInfo

Результат платежа, используемый интегратором для завершения транзакции.

JSON-представление
{
  "paymentType": enum (PaymentType),
  "paymentMethodDisplayName": string
}
Поля
paymentType

enum ( PaymentType )

Тип платежа.

paymentMethodDisplayName

string

Видимое пользователю название способа оплаты. Например, VISA **** 1234 Проверка счета **** 5678

Повышение

Акции/предложения, добавленные в корзину.

JSON-представление
{
  "coupon": string
}
Поля
coupon

string

Обязательно: код купона, примененный к этому предложению.

Расширение заказа на покупку

Расширение заказа для вертикальной покупки. Эти свойства применимы ко всем позициям внутри заказа, если они не переопределены в позиции.

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 )

Необязательно: ошибки, из-за которых этот заказ был отклонен.

Ошибка покупки

Ошибки, из-за которых заказ на поставку может быть отклонен.

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.

Расширение заказа билета

Содержание заказа для заказов билетов, таких как кино, спорт и т. д.

JSON-представление
{
  "ticketEvent": {
    object (TicketEvent)
  }
}
Поля
ticketEvent

object ( 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 утра, но время входа — 8:30 утра.

СобытиеПерсонаж

Один персонаж мероприятия, например, организатор, исполнитель и т. д.

JSON-представление
{
  "type": enum (Type),
  "name": string,
  "image": {
    object (Image)
  }
}
Поля
type

enum ( Type )

тип персонажа события, например актер или режиссер.

name

string

имя персонажа.

image

object ( Image )

Изображения персонажей.