Esquema de ações de atendimento do pedido

O tipo deste objeto. Omita este campo se o objeto Cart pai fizer parte de ProposedOrder.

Valor: type.googleapis.com/google.actions.v2.orders.Cart

ID opcional do carrinho.

Comerciante afiliado a este carrinho.

Obrigatório.

Lista de bens ou serviços que o usuário está pedindo.

Não pode ter menos de 1 item.

Promoção aplicada a este carrinho. Apenas uma promoção é aceita no momento.

Observações sobre o pedido ou instruções de entrega.

Define detalhes sobre o usuário, como preferências de atendimento do pedido.

Nome da pessoa que vai receber o pedido, como você quer que ele seja exibido. Use este campo se firstName e lastName não forem especificados.

Exemplo: Lovefood Ordering

Endereço de e-mail da pessoa que vai receber o pedido.

Exemplo: ilovefood@example.com

Nome da pessoa que vai receber o pedido.

Exemplo: Lovefood

Sobrenome da pessoa que vai receber o pedido.

Exemplo: Ordering

Número de telefone da pessoa que vai receber o pedido, incluindo o código do país.

Exemplo: +16501234567

Indica se a pessoa que recebe o pedido fez login com a Conta do Google.

Obrigatório.

As informações do pedido foram atualizadas.

Tempo de entrega estimado, no formato de carimbo de data/hora ISO 8601: "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z" ou formato de duração: "P(n)Y(n)M(n)DT(n)H(n)M(n)S". Por exemplo, PT90M representa uma duração de 90 minutos. O valor padrão, "PT0M", indica que o tempo de entrega preferencial é o mais rápido possível. Referência: https://pt.wikipedia.org/wiki/ISO_8601 Use essa informação para atualizar o tempo de entrega estimado durante a resposta da finalização da compra.

Exemplo: PT90M

Obrigatório.

Para mostrar mensagens predefinidas de exoneração de responsabilidade durante a finalização da compra.

O parceiro cobrará do comerciante uma taxa de valor N por esse pedido.

O parceiro vai cobrar do restaurante uma taxa de N a M por pedido.

O parceiro cobrará do comerciante uma taxa de N% pelo pedido.

O parceiro cobrará do comerciante uma taxa de N% a M% por pedido.

Limite inferior do valor da taxa cobrada.

Limite superior do valor da taxa cobrada.

Limite inferior da porcentagem da taxa cobrada.

Limite superior da porcentagem da taxa cobrada.

Tipo de extensão. Esse campo está sempre definido como "type.googleapis.com/google.actions.v2.orders.FoodCartExtension".

Valor: type.googleapis.com/google.actions.v2.orders.FoodCartExtension

Dados de contato da pessoa que vai receber o pedido. Os detalhes incluem o nome, o número de telefone e o endereço de e-mail da pessoa.

Obrigatório.

Preferência de atendimento do usuário.

Na CheckoutRequestMessage, este campo especifica o endereço de entrega, obrigatório se o pedido for para entrega. No caso de pedidos para retirada ou retirada, esse campo não é incluído na mensagem.

Obrigatório.

Tipo de extensão.

Valor: type.googleapis.com/google.actions.v2.orders.FoodErrorExtension

Obrigatório.

Matriz de objetos FoodOrderError que descreve os erros que ocorreram. Recomendamos um erro por carrinho ou item.

Não pode ter menos de 1 item.

Obrigatório quando foodOrderErrors.error = "UNAVAILABLE_SLOT", "PROMO_EXPIRED", "PROMO_NOT_APPLICABLE", "PROMO_NOT_RECOGNIZED", "PROMO_ORDER_INELIGIBLE", "PROMO_USER_INELIGIBLE", "AVAILABILITY_CHANGED", "INCORRECT_PRICE", "INVALID", "NOT_FOUND", or "PRICE_CHANGED":

Um novo ProposedOrder com correções. Retorne esse objeto se houver erros recuperáveis no ProposedOrder original. Por exemplo, uma alteração no preço de um ou mais itens de linha no carrinho é um erro recuperável. Os erros recuperáveis com um ProposedOrder válido passam para o estágio de confirmação, em vez de exigir que o usuário revise o carrinho.

Obrigatório quando foodOrderErrors.error = "UNAVAILABLE_SLOT", "PROMO_EXPIRED", "PROMO_NOT_APPLICABLE", "PROMO_NOT_RECOGNIZED", "PROMO_ORDER_INELIGIBLE", "PROMO_USER_INELIGIBLE", "AVAILABILITY_CHANGED", "INCORRECT_PRICE", "INVALID", "NOT_FOUND", or "PRICE_CHANGED":

Opções de pagamento padrão selecionadas para o usuário.

Opções de pagamento alternativas disponíveis para o usuário.

Obrigatório.

Tipo de extensão. Esse campo está sempre definido como "type.googleapis.com/google.actions.v2.orders.FoodItemExtension".

Valor: type.googleapis.com/google.actions.v2.orders.FoodItemExtension

Uma opção pode ser um item de complemento ou um grupo de complementos com um conjunto de complementos.

ID exclusivo atribuído pelo Google. Ao enviar um FoodOrderError ou AsyncOrderUpdateRequest, use este campo para fazer a diferenciação nos casos em que um carrinho contém mais de um item com o mesmo offerId.

Exemplo: 39231093

ID da oferta do item.

Exemplo: 912835081

O nome da opção.

Exemplo: Honey Mustard

Observação relacionada à opção.

Para opções que são itens, o número de itens.

Exemplo: 3

Subopções da opção, se houver.

Exemplo: [ { "id": "71283712", "offerId": "51209121", "name": "BBQ Sauce", "price": { "currencyCode": "USD", "units": "3", "nanos": 780000000 }, "quantity": 2 }, { "id": "102941024", "offerId": "12084102", "name": "Ketchup", "price": { "currencyCode": "USD", "units": "2", "nanos": 980000000 }, "quantity": 6 } ]

Obrigatório.

Obrigatório quando error = "AVAILABILITY_CHANGED", "INCORRECT_PRICE", "PRICE_CHANGED", "INVALID", or "NOT_FOUND":

Este campo é obrigatório para erros no nível do item. Ele é o Order.id atribuído pelo Google para os itens de menu e o FoodItemOption.id para os complementos.

Descrição do erro. Essa descrição se destina à geração de registros internos e não é visível aos usuários.

Obrigatório quando error = "PRICE_CHANGED":

Novo preço de um item que causou o erro. Isso é necessário somente quando o erro é "PRICE_CHANGED".

Obrigatório quando error = "INVALID", or "NOT_FOUND":

Nova quantidade disponível do item que causou o erro. Isso é necessário apenas quando o erro é "INVALID" ou "NOT_FOUND". O valor deve ser zero para "INVALID" e "NOT_FOUND".

Tipo de extensão. Esse campo está sempre definido como "type.googleapis.com/google.actions.v2.orders.FoodOrderExtension".

Valor: type.googleapis.com/google.actions.v2.orders.FoodOrderExtension

Representa as opções de atendimento do pedido disponíveis.

Solicitação do usuário para ativar seus canais de marketing. Por padrão, não é possível enviar conteúdo de marketing sem o consentimento do usuário. Se optinForRemarketing for verdadeiro, você poderá inscrever o usuário. Se optinForRemarketing for falso ou não estiver presente, você deverá manter o status da inscrição no seu sistema como está. Os usuários não podem desativar o recurso no Google, somente por meio de uma função de cancelamento de assinatura fornecida nos seus canais de marketing. Essa sinalização só está presente em SubmitOrderRequestMessage.

Identificador exclusivo dessa opção de fulfillment, se houver.

Obrigatório.

Horário em que essa opção de atendimento do pedido expira.

Custo dessa opção.

Se presente, indica a ordem de entrega.

Obrigatório.

URL da imagem. A imagem precisa ter, no mínimo, 72 x 72 pixels. Para melhores resultados, use uma imagem de pelo menos 216 x 216 pixels. A imagem precisa ter menos de 6 MB e 64 megapixels.

Obrigatório quando type = "REGULAR":

Para um item de linha em um carrinho (ProposedOrder.cart.lineItems[0].id), este é o ID exclusivo criado pelo Google ao criar o pedido. Para um item de linha em um ProposedOrder (ProposedOrder.otherItems[0].id), que é usado para adicionar itens como taxas de entrega e impostos, o valor de id é definido pelo fornecedor. Por exemplo, em um carrinho há dois itens iguais com instruções de preparação diferentes (como duas pizzas médias com diferentes conjuntos de coberturas). Nesse caso, os dois itens têm o mesmo offerId base. Ao enviar uma solicitação de atualização de pedido para indicar que um item foi rejeitado, use esse ID como desambiguador. Em outras palavras, se uma das pizzas for rejeitada porque não tem um recheio específico, o ID vai ajudar o Google a determinar a qual item do pedido você está se referindo. Este campo é obrigatório, exceto em otherItems.

Obrigatório.

É o nome do item de linha. Essa é uma string visível para o usuário e precisa ser escrita com a primeira letra maiúscula quando possível (como "Taxa de entrega", "Taxa de serviço", "Tributo"). Este campo está truncado em 100 caracteres para os usuários.

Obrigatório.

Obrigatório quando type = "REGULAR":

Número de itens incluídos. Não aplicável a ProposedOrder.otherItems.

Descrição do item.

Obrigatório.

O preço dos itens. Esse valor reflete o preço total de todos os produtos ou serviços do item de linha. Em outras palavras, adicione o custo de todos os complementos e multiplique pela quantidade. Por exemplo: se um item de R $10 tiver a quantidade 3, o preço será de R $30. Para uma pizza com preço base de R $5 e um complemento de R $1, o preço seria de R $6. Para duas pizzas (quantidade = 2) com preço base de R $5 e cada uma com complemento de R $1, o preço será de R $12. Cada item de linha deve ter um preço, mesmo que seja "0". Quando o tipo for DESCONTO, especifique o valor como negativo (por exemplo, "-2").

Opcional e válido somente se o tipo for "REGULAR". Uma observação específica do item do usuário pode ser enviada nesse campo na solicitação de checkout e na solicitação de envio do pedido. Garantir que o comerciante receba a nota quando ela for fornecida. Ele estará na solicitação como subLines[0].note, que é o único valor fornecido nesse campo quando está presente em uma solicitação.

Não pode haver mais de 1 item.

Obrigatório quando type = "REGULAR":

O ID da oferta do MenuItem do item. Não aplicável a ProposedOrder.otherItems.

Define complementos para alimentos.

Exibir o endereço do local.

Exemplo: 1350 CHARLESTON ROAD, MOUNTAIN VIEW, CA, United States

Exemplo: 90210

O nome da cidade.

Exemplo: Los Angeles

Observações sobre o local, como códigos do portão. Ele deve ter 500 caracteres ou menos.

Exemplo: Gate code is #111

O ID do comerciante. Se especificado, corresponde a Restaurant.@id no feed de restaurante.

Exemplo: https://www.exampleprovider.com/merchant/id1

Obrigatório.

Nome do comerciante visível para o usuário.

Exemplo: Falafel Bite

Obrigatório.

Um código de moeda de três letras no formato ISO 4217.

Exemplo: USD

As unidades inteiras do montante. Por exemplo, se o currencyCode for "USD", então "1" unidade é um dólar americano.

Exemplo: 36

Número de unidades nano (10^-9) do montante. O valor precisa estar entre -999.999.999 e +999.999.999. Use as seguintes regras: se "units" for positivo, "nanos" deverá ser positivo ou zero. Se "units" for zero, "nanos" poderá ser positivo, zero ou negativo. Se "units" for negativo, "nanos" deverá ser negativo ou zero. Por exemplo,$-1,75 é representado como unidades = -1 e nanos = -750.000.000.

Exemplo: 730000000

Obrigatório.

O pedido proposto que gerou o pedido.

Obrigatório.

ID do pedido atribuído pelo Google. Esse ID precisa ser estável durante todo o ciclo de vida de um pedido. Esse ID não fica visível para o usuário final.

Obrigatório.

Data e hora em que o pedido foi criado.

Obrigatório.

Informações de pagamento correspondentes ao pagamento desse pedido.

Obrigatório.

ID exclusivo do pedido no sistema do integrador usado para identificar o pedido de envio da atualização. Se recibo.user_visible_order_id não for fornecido pelo menos uma vez em OrderUpdate para um "CREATED" pedido, esse será o ID visível do usuário inserido e exibido no card do pedido do Google.

Obrigatório.

O novo estado do pedido.

Obrigatório.

A hora em que o pedido foi atualizado.

Ações pós-pedido, como entrar em contato com o suporte e visualizar detalhes do pedido.

Deve ter pelo menos 1 item e no máximo 6 itens.

Obrigatório quando orderState.state = "REJECTED":

Obrigatório quando orderState.state = "CANCELLED":

O uso desse campo foi descontinuado.

O uso desse campo foi descontinuado.

Obrigatório quando orderState.state = "CONFIRMED", "IN_PREPARATION", or "READY_FOR_PICKUP":

Forneça o código do pedido visível ao usuário em um recibo.

Preço total do pedido.

Define mais detalhes da atualização do pedido, como o intervalo de entrega ou retirada estimada.

Horário estimado de retirada, no formato de carimbo de data/hora ISO 8601: "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z" ou formato de duração: "P(n)Y(n)M(n)DT(n)H(n)M(n)S". Por exemplo, PT90M representa uma duração de 90 minutos. O valor padrão, "PT0M", indica que o horário de embarque preferencial é o mais rápido possível. Referência: https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations (em inglês). Use essa informação para atualizar o tempo estimado de retirada durante a resposta da finalização da compra.

Exemplo: PT90M

Obrigatório.

Um código de país com duas letras.

Exemplo: US

É o código postal.

Exemplo: 94043

A maior subdivisão administrativa que é usada para endereços postais de um país ou uma região. Pode ser um estado, uma província, uma oblast ou um município.

Exemplo: CA

A cidade deste local. Em regiões do mundo onde as localidades não são bem definidas ou não se encaixam nesta estrutura, não especifique a localidade e use o campo addressLines.

Exemplo: Mountain View

Uma ou mais linhas que você pode usar para especificar o endereço. Este campo não deve ser modificado porque pode conter localidades pouco claras.

Exemplo: [ "1350 Charleston Road" ]

Lista dos destinatários de um pedido. Esse campo só está disponível no billingAddress.

Obrigatório.

Código do cupom promocional.

Obrigatório.

Obrigatório.

Código do cupom promocional.

ID opcional do pedido proposto.

Obrigatório.

Itens do usuário.

Itens adicionados pelo fornecedor, como taxas de entrega, outras taxas e tributos. otherItems também podem conter gratificações e/ou descontos adicionados pelo usuário.

Não pode haver mais de 10 itens.

Imagem associada ao pedido proposto.

Obrigatório.

Preço total do pedido proposto.

Obrigatório.

Define informações de atendimento para pedidos de comida.

Corresponde a mensagens de exoneração de responsabilidade que serão exibidas na interface antes do pedido ser feito.

Obrigatório.

Obrigatório.

Pedido a ser feito com detalhes de pagamento.

Indica se as transações subsequentes são feitas em um ambiente de sandbox.

Obrigatório.

Contém os argumentos esperados para finalizar a compra de um carrinho.

É preciso ter exatamente 1 item.

Obrigatório.

ID exclusivo da conversa.

Obrigatório.

Defina como "actions.foodordering.intent.CHECKOUT" para a mensagem de solicitação de finalização de compra OU "actions.intent.TRANSACTION_DECISION" para a mensagem de solicitação de envio do pedido.

Obrigatório.

Contém o carrinho a ser comprado ou o pedido a ser feito

É preciso ter exatamente 1 item.

Detalha os alimentos que o usuário quer finalizar.

Defina como falso.

Valor: False

Obrigatório.

Contém sua resposta ao pagamento do carrinho.

Obrigatório.

Contém sua resposta para CheckoutRequestMessage ou SubmitOrderRequestMessage.

Obrigatório.

Pedido proposto a ser usado para a transação.

Obrigatório.

Opção de pagamento padrão selecionada para o usuário.

Opções de pagamento alternativas disponíveis para o usuário.

Obrigatório.

Obrigatório.

É preciso ter exatamente 1 item.

Itens comprados, impostos e descontos.

Indica que o pedido para o qual esta atualização foi enviada é um pagamento de sandbox.

Obrigatório.

Contém o OrderUpdate da solicitação.

Obrigatório.

O rótulo de exibição. Use letras maiúsculas de até 30 caracteres para garantir uma renderização adequada.

Exemplo: Contact us

Obrigatório.

Obrigatório.

Motivo do texto que pode ser exibido para a rejeição quando OrderState.state é "CANCELLED".

Exemplo: Restaurant closed

Tipo de extensão. Esse campo está sempre definido como "type.googleapis.com/google.actions.v2.orders.FoodOrderUpdateExtension".

Valor: type.googleapis.com/google.actions.v2.orders.FoodOrderUpdateExtension

O tempo estimado para que o pedido seja entregue ou esteja pronto para retirada. A string precisa estar no formato ISO 8601 e corresponder a um intervalo em vez de um único horário fixo. As convenções aceitáveis são: intervalos, durações e datas/horas. Este campo pode ser enviado em SubmitOrderResponseMessage ou AsyncOrderUpdateRequestMessage quando as informações ficam disponíveis ou há uma alteração, como chegadas antecipadas ou atrasadas.

Exemplo: 2017-07-17T13:00:00Z/2017-07-17T13:30:00Z

Descreve os erros que ocorreram após o pedido. Recomendamos um erro por carrinho ou item. Use FoodOrderUpdateExtension.FoodOrderErrors para erros não cobertos por RejeitarionInfo.

Não pode ter menos de 1 item.

Use predictedFulfillmentTimeIso8601 na mensagem FoodOrderingUpdateExtension

Use predictedFulfillmentTimeIso8601 na mensagem FoodOrderingUpdateExtension

O motivo da alteração. Obrigatório para alterações de preço.

Obrigatório.

A ação acionada ao clicar ou tocar no botão. A lista de prefixos aplicáveis depende do orderManagementActionType. "EMAIL": o prefixo precisa ser "mailto". "CALL": o prefixo precisa ser "tel". "CUSTOMER_SERVICE": o prefixo deve ser "mailto", "tel", "http" ou "https".

Exemplo: https://www.google.com

Obrigatório.

Obrigatório.

Obrigatório.

Obrigatório.

A string de exibição visível ao usuário para o estado. Use letra maiúscula apenas na primeira palavra.

Exemplo: Your order has been received

Obrigatório.

Obrigatório se o pedido for "CONFIRMED", "IN_Transition" ou "FULFILLED". Este campo é o ID único do usuário para esse pedido (geralmente o código do pedido do restaurante), exibido no recibo do integrador e no cartão do pedido do Google. O usuário precisa conseguir usar esse ID para consultar o pedido de atendimento ao cliente com o provedor e o integrador. Você só precisa fornecer esse ID uma vez em cada OrderUpdate. Até que seja fornecido, o actionOrderId é o userVisibleOrderId. Por exemplo, não é possível ter um userVisibleOrderId até que o pedido seja confirmado pelo restaurante. Após a confirmação, é necessário enviar uma AsyncOrderUpdateRequestMessage com um OrderUpdate e um Receipt.

Obrigatório.

Motivo da rejeição usado para geração de registros internos. Este campo não é visível para os usuários.

Obrigatório.

Obrigatório.

Nome do instrumento de pagamento exibido no recibo.

Exemplo: Taco Points Total

Dados adicionais para o tipo de pagamento "ON_FULFILLMENT". Por exemplo, é possível usar esse campo para especificar se dinheiro ou cartão é aceito no processamento do pedido.

Formato do endereço de faturamento necessário para concluir a transação. MÍNIMO: nome, código do país e código postal. COMPLETO: nome, endereço, localização, região, código do país e código postal.

Obrigatório.

Campos aceitos para autenticar uma transação de cartão.

Não pode ter menos de 1 item.

Obrigatório.

Uma ou mais redes de cartões aceitas por você e pela API Google Pay.

Não pode ter menos de 1 item.

Defina como "true" se você precisar de um endereço de faturamento. Solicite um endereço de faturamento apenas se for necessário para processar a transação. Outras solicitações de dados podem aumentar o atrito no processo de finalização da compra e gerar taxas de conversão mais baixas.

Os campos esperados retornados se billingAddressRequired está definido como verdadeiro.

Defina como verdadeiro se estiver usando TimesofMoney, como falso para todos os outros processadores de pagamento.

Obrigatório.

String codificada de base 64 contendo o token de pagamento para cobrar o usuário com um processador do Google Pay participante, de acordo com o GoogleProvidedPaymentOptions especificado anteriormente.

Endereço de faturamento para o pagamento.

Um JSON PaymentDataRequest como uma string. Use esse objeto para configurar a compatibilidade do seu site com a API Google Pay.

Em vez disso, use facilitationSpecification. Tipo de redes de cartões aceitas pelo agente.

O uso desse campo foi descontinuado.

Em vez disso, use facilitationSpecification. Se um cartão pré-pago é permitido como tipo de pagamento.

O uso desse campo foi descontinuado.

Em vez disso, use facilitationSpecification. Se um endereço de faturamento é necessário ou não.

O uso desse campo foi descontinuado.

O uso desse campo foi descontinuado.

O identificador do comerciante do Google emitido para você pelo Google Pay.

Obrigatório.

Nome do comerciante codificado como UTF-8. O nome do comerciante é processado na página de pagamento.

Lista de opções de pagamento disponíveis para o usuário no momento da conclusão do pedido.

Obrigatório.

Exemplo: braintree

Obrigatório.

Versão principal da API.

Valor: 2

Obrigatório.

Versão secundária da API.

Valor: 0

Obrigatório.

(ID do comerciante do Google Pay) Informações sobre o comerciante que solicita dados de pagamento.

Obrigatório.

Especifica a compatibilidade com uma ou mais formas de pagamento compatíveis com a API Google Pay.

Obrigatório.

Detalhes sobre a autorização da transação, dependendo de o usuário concordar ou não com ela. Esse campo inclui o preço total e o status do preço.

Obrigatório.

Nome visível para o usuário do instrumento de pagamento a ser exibido no recibo.

Obrigatório.

Token que pode ser usado pela ação. Só especifique isso se você especificou GoogleProvidedPaymentOptions como uma opção de pagamento em CheckoutResponseMessage.

Obrigatório.

Identificador curto da forma de pagamento aceita. No momento, apenas CARD é aceito.

Valor: CARD

Obrigatório.

Parâmetros necessários para configurar o tipo de forma de pagamento fornecido.

Obrigatório.

Configure uma conta ou um provedor de descriptografia para receber informações de pagamento. Esta propriedade é obrigatória para a forma de pagamento CARD.

Mutuamente exclusivo com actionProvidedOptions. Use essa opção para fazer pagamentos on-line com o gPay.

Obrigatório.

Em vez disso, use facilitationSpecification. Tipo de tokens aceitável.

Em vez disso, use facilitationSpecification.

Obrigatório.

Obrigatório.

Obrigatório.

Código de moeda ISO 4217 em ordem alfabética.

ID exclusivo que identifica uma tentativa de transação. Os comerciantes podem usar um ID existente ou gerar um ID específico para as tentativas de transação do Google Pay. Esse campo é obrigatório quando você envia callbacks para a API Transaction Events do Google.

Obrigatório.

Usar "ESTIMATED" como padrão. O preço total pode ser ajustado com base nos detalhes da resposta, como o tributo sobre vendas coletado com base em um endereço de faturamento.

Valor: ESTIMATED

Obrigatório.

Valor monetário total da transação com uma precisão decimal opcional de duas casas decimais. Esse campo deve ter o mesmo valor que cart.totalPrice.