Order

Entidade do pedido. Observação: 1. Todas as strings em todos os níveis devem ter menos de 1.000 caracteres, a menos que seja especificado de outra forma. 2. Todos os campos repetidos em todos os níveis precisam ter menos de 50 campos, a menos que seja especificado de outra forma. 3. Todos os carimbos de data/hora em todos os níveis, se especificados, precisam ser carimbos de data/hora válidos.

Representação 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.
}
Campos
googleOrderId

string

ID do pedido atribuído pelo Google.
merchantOrderId

string

Obrigatório: ID do pedido interno atribuído pelo comerciante. Esse ID precisa ser exclusivo e necessário para operações de atualização de pedidos subsequentes. Esse ID pode ser definido como o googleOrderId fornecido ou qualquer outro valor exclusivo. O ID apresentado aos usuários é userVisibleOrderId, que pode ser um valor diferente e mais fácil de usar. O comprimento máximo permitido é de 128 caracteres.
userVisibleOrderId

string

O ID do usuário que faz referência ao pedido atual. Esse ID precisa ser consistente com o ID exibido para esse pedido em outros contextos, incluindo sites, apps e e-mails.
userVisibleStateLabel
(deprecated)

string

Obsoleto: use o status OrderExtensions. Marcador visível ao usuário para o estado deste pedido.
buyerInfo

object (UserInfo)

informações sobre o comprador.
image

object (Image)

Imagem associada ao pedido.
createTime

string (Timestamp format)

Obrigatório: data e hora em que o pedido foi criado.

É um carimbo de data/hora no formato UTC "Zulu" RFC3339, medido com precisão de nanossegundos. Exemplo: "2014-10-02T15:01:23.045123456Z".
lastUpdateTime

string (Timestamp format)

data e hora em que o pedido foi atualizado pela última vez. Obrigatório para OrderUpdate.

É um carimbo de data/hora no formato UTC "Zulu" RFC3339, medido com precisão de nanossegundos. Exemplo: "2014-10-02T15:01:23.045123456Z".
transactionMerchant

object (Merchant)

Comerciante que facilitou a finalização da compra. Ele pode ser diferente de um provedor no nível do item de linha. Exemplo: pedido da Expedia com item de linha da ANA.
contents

object (Contents)

Obrigatório: conteúdo do pedido, que é um grupo de itens de linha.
priceAttributes[]

object (PriceAttribute)

Preço, descontos, impostos e assim por diante.
followUpActions[]

object (Action)

Ações de acompanhamento no nível do pedido.
paymentData

object (PaymentData)

Dados relacionados ao pagamento do pedido.
termsOfServiceUrl

string

Um link para os Termos de Serviço que se aplicam ao pedido/pedido proposto.
note

string

Observações anexadas a um pedido.
promotions[]

object (Promotion)

Todas as promoções associadas a este pedido.
disclosures[]

object (Disclosure)

Declarações associadas a este pedido.
vertical
(deprecated)

object

Obsoleto: use indústrias. Essas propriedades serão aplicadas a todos os itens de linha, a menos que sejam substituídas em algum item de linha. Essa indústria precisa corresponder ao tipo de indústria no nível do item de linha. Valores possíveis: google.actions.orders.v3.verticals.purchase.PurchaseOrderExtension google.actions.orders.v3.verticals.ticket.TicketOrderExtension

Um objeto contendo campos de um tipo arbitrário. Um campo adicional "@type" contém uma URI que identifica o tipo. Exemplo: { "id": 1234, "@type": "types.example.com/standard/id" }.
Campo de união verticals. Essas propriedades serão aplicadas a todos os itens de linha, a menos que sejam substituídas em algum item de linha. Essa indústria precisa corresponder ao tipo de indústria no nível do item de linha. verticals pode ser apenas de um dos tipos a seguir:
purchase

object (PurchaseOrderExtension)

Ordem de compra
ticket

object (TicketOrderExtension)

Pedido de passagem

Índice

Wrapper para itens de linha.

Representação JSON 
{
  "lineItems": [
    {
      object (LineItem)
    }
  ]
}
Campos
lineItems[]

object (LineItem)

Lista de itens de linha do pedido. É necessário incluir pelo menos um item de linha e, no máximo, 50. Todos os itens de linha precisam pertencer à mesma indústria.

PaymentData

Dados de pagamento relacionados a um pedido.

Representação JSON 
{
  "paymentResult": {
    object (PaymentResult)
  },
  "paymentInfo": {
    object (PaymentInfo)
  }
}
Campos
paymentResult

object (PaymentResult)

Resultado do pagamento usado pelo integrador para concluir uma transação. Esse campo será preenchido por ações no Google se a experiência de finalização de compra for gerenciada pela plataforma.
paymentInfo

object (PaymentInfo)

Informações de pagamento sobre o pedido que sejam úteis para a interação do usuário.

PaymentResult

Resultado de pagamento usado pelo integrador para concluir uma transação.

Representação 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.
}
Campos
Campo de união result. Os dados de pagamento do Google ou a forma de pagamento do comerciante são fornecidos. result pode ser apenas de um dos tipos a seguir:
googlePaymentData

string

Dados da forma de pagamento fornecidos pelo Google. Caso seu processador de pagamentos esteja listado como aceito pelo Google aqui: https://developers.google.com/pay/api/, acesse o processador de pagamentos pelo link para saber mais detalhes. Caso contrário, consulte a documentação a seguir para mais detalhes sobre o payload. https://developers.google.com/pay/api/payment-data-cryptography
merchantPaymentMethodId

string

Forma de pagamento fornecida pelo comerciante/ação escolhida pelo usuário.

PaymentInfo

Informações de pagamento relacionadas ao pedido que está sendo feito. Esse proto captura informações úteis para a interação voltada ao usuário.

Representação JSON 
{
  "paymentMethodDisplayInfo": {
    object (PaymentMethodDisplayInfo)
  },
  "paymentMethodProvenance": enum (PaymentMethodProvenance)
}
Campos
paymentMethodDisplayInfo

object (PaymentMethodDisplayInfo)

As informações de exibição da forma de pagamento usada para a transação.
paymentMethodProvenance

enum (PaymentMethodProvenance)

Procedência da forma de pagamento usada para a transação. Talvez o usuário tenha registrado a mesma forma de pagamento no Google e no comerciante.

PaymentMethodDisplayInfo

Resultado de pagamento usado pelo integrador para concluir uma transação.

Representação JSON 
{
  "paymentType": enum (PaymentType),
  "paymentMethodDisplayName": string
}
Campos
paymentType

enum (PaymentType)

O tipo de pagamento.
paymentMethodDisplayName

string

Nome da forma de pagamento visível para o usuário. Por exemplo, VISA **** 1234 Conta corrente **** 5678

Promoção

Promoções/ofertas que foram adicionadas ao carrinho.

Representação JSON 
{
  "coupon": string
}
Campos
coupon

string

Obrigatório: código do cupom aplicado a esta oferta.

PurchaseOrderExtension

Extensão de pedido para a indústria de compras. Essas propriedades são aplicáveis a todos os itens de linha dentro do pedido, a menos que sejam substituídas em um item de linha.

Representação 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)
    }
  ]
}
Campos
status

enum (PurchaseStatus)

Obrigatório: status geral do pedido.
userVisibleStatusLabel

string

Rótulo/string visível para o usuário para o status. O comprimento máximo permitido é de 50 caracteres.
type

enum (PurchaseType)

Obrigatório: tipo de compra.
returnsInfo

object (PurchaseReturnsInfo)

Devolver informações do pedido.
fulfillmentInfo

object (PurchaseFulfillmentInfo)

Informações de atendimento do pedido.
extension

object

Todos os campos extras trocados entre o comerciante e o Google.

Um objeto contendo campos de um tipo arbitrário. Um campo adicional "@type" contém uma URI que identifica o tipo. Exemplo: { "id": 1234, "@type": "types.example.com/standard/id" }.
purchaseLocationType

enum (PurchaseLocationType)

Local da compra (na loja / on-line)
errors[]

object (PurchaseError)

Opcional: erros que resultaram na rejeição do pedido.

PurchaseError

Erros que podem causar rejeição de ordens de compra.

Representação JSON 
{
  "type": enum (ErrorType),
  "description": string,
  "entityId": string,
  "updatedPrice": {
    object (PriceAttribute)
  },
  "availableQuantity": integer
}
Campos
type

enum (ErrorType)

Obrigatório: representa o motivo granular de um pedido ser recusado pelo comerciante.
description

string

Descrição adicional do erro.
entityId

string

ID da entidade correspondente ao erro. Exemplo que pode corresponder a OrderId / ItemOptionId.
updatedPrice

object (PriceAttribute)

Relevante no caso do tipo de erro PRICE_CHANGED / INCORRECT_PRICE.
availableQuantity

integer

Quantidade disponível agora. Aplicável no caso de AVAILABILITY_CHANGED.

TicketOrderExtension

Itens para compra de ingressos, como filmes, esportes etc.

Representação JSON 
{
  "ticketEvent": {
    object (TicketEvent)
  }
}
Campos
ticketEvent

object (TicketEvent)

O evento aplicado a todos os ingressos de item de linha.

TicketEvent

Representa um único evento.

Representação 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)
  }
}
Campos
type

enum (Type)

Obrigatório: tipo de evento de ingresso, por exemplo, filme, show.
name

string

Obrigatório: nome do evento. Por exemplo, se o evento for um filme, deverá ser o nome do filme.
description

string

descrição do evento.
url

string

URL para as informações do evento.
location

object (Location)

O local onde o evento vai acontecer ou a localização de uma organização.
eventCharacters[]

object (EventCharacter)

Os caracteres relacionados a este evento. Pode ser diretores ou atores de um evento cinematográfico ou artistas de um show etc.
startDate

object (Time)

Horário de início.
endDate

object (Time)

Horário de término.
doorTime

object (Time)

Horário de entrada, que pode ser diferente do horário de início do evento. Por exemplo: o evento começa às 9h, mas o horário de entrada é 8h30.

EventCharacter

Um caractere de evento, por exemplo, organizador, artista etc.

Representação JSON 
{
  "type": enum (Type),
  "name": string,
  "image": {
    object (Image)
  }
}
Campos
type

enum (Type)

tipo do caractere de evento, por exemplo, ator ou diretor.
name

string

é o nome do personagem.
image

object (Image)

Imagens do personagem.