Package google.cloud.foodorderingaiagent.v1beta

As lojas foram atualizadas.

BidiProcessOrderRequest

A mensagem de nível superior enviada pelo cliente para o método FoodOrderingService.BidiProcessOrder.

Campos
Campo de união `message`. A mensagem do cliente. O cliente precisa enviar uma mensagem de configuração antes de enviar qualquer outra mensagem. `message` pode ser apenas de um dos tipos a seguir:
`config`	`Config` A configuração das propriedades de sessão e pedido de comida.
`text_input`	`TextInput` A entrada de texto do cliente.
`audio_input`	`AudioInput` A entrada de áudio do cliente. O cliente precisa usar entrada de texto ou áudio, não ambas.
`event_input`	`EventInput` A entrada de evento do cliente.
`client_execution_result`	`ClientExecutionResult` O resultado de uma solicitação de execução do cliente.

BidiProcessOrderResponse

A mensagem de nível superior retornada do método FoodOrderingService.BidiProcessOrder.

Campos
Campo de união `response`. A resposta do agente. `response` pode ser apenas de um dos tipos a seguir:
`agent_audio`	`AgentAudio` A resposta em áudio do agente.
`speech_recognition`	`SpeechRecognition` O resultado do reconhecimento de fala do agente.
`legacy_order_state_response`	`Struct` A resposta do estado do pedido legado para uma sessão.
`interruption_signal`	`InterruptionSignal` Sinal de interrupção detectado na entrada de áudio.
`agent_event`	`AgentEvent` Evento do agente.
`client_execution_request`	`ClientExecutionRequest` A solicitação encaminhada ao cliente para execução. Usado para execução do lado do cliente, como adicionar um código ao pedido.
`updated_order_state`	`UpdatedOrderState` Indica uma atualização no estado do pedido. Inclui o estado completo do pedido.
`agent_text`	`AgentText` A resposta de texto do agente.
`suggested_options`	`SuggestedOptions` Opções para sugerir ao cliente.
`sentiment_measurement`	`SentimentMeasurement` A pontuação de sentimento em tempo real medida para esta vez.
`turn_completed`	`TurnCompleted` Mensagem de conclusão do turno.
`end_session`	`EndSession` Indica que a sessão está terminando e que esta será a última vez. O agente vai terminar de enviar as respostas pendentes da rodada atual e, em seguida, enviar uma mensagem final turn_completed. O agente não vai iniciar novas interações. Por exemplo, uma sessão de duas interações será assim: Turno 1 Entrada do cliente 1 ... respostas do agente e mensagens de estado do pedido turn_completed Turno 2 entrada do cliente 2 ... respostas do agente e mensagens de estado do pedido end_session ... mensagens pendentes de resposta do agente e de estado do pedido turn_completed
`recommended_orders`	`RecommendedOrders` Os pedidos recomendados do agente.

Marca

Uma marca, que pode ser uma rede de restaurantes ou um restaurante individual.

Campos
`name`	`string` Identificador. O nome da marca. Formato: projects/{project}/locations/{location}/brands/{brand}
`display_name`	`string` Opcional. Nome de exibição opcional e legível para essa marca em interfaces do usuário.
`create_time`	`Timestamp` Apenas saída. A data e a hora em que a marca foi criada.
`update_time`	`Timestamp` Apenas saída. A hora em que a marca foi atualizada pela última vez.

BrandRevision

Uma revisão de uma marca.

Campos
`name`	`string` Identificador. O nome do recurso da revisão da marca. Formato: projects/{project}/locations/{location}/brands/{brand}/revisions/{revision}
`snapshot`	`Brand` Apenas saída. O estado do recurso de marca nesta revisão.
`create_time`	`Timestamp` Apenas saída. Quando a revisão foi criada.
`created_by`	`string` Apenas saída. O e-mail do usuário que criou o recurso recentemente.
`alternate_ids[]`	`string` Apenas saída. IDs alternativos para esta revisão.
`action`	`RevisionAction` Apenas saída. A ação que criou esta revisão.

ChannelConfig

Uma configuração de canal representa uma configuração de estratégia operacional. Ciclo de vida da configuração do canal: * RASCUNHO: uma configuração está em estado de rascunho quando não tem regras de aplicação de configuração associadas e não está definida como a configuração padrão da marca. * ATIVA: uma configuração está ativa quando é associada a uma regra de aplicação de configuração ou definida como padrão da marca. * Quando ativo, o ambiente de execução aplica a configuração do canal às lojas correspondentes. Para garantir a flexibilidade, a relação entre a configuração do canal e a regra de aplicação da configuração é de um para muitos em cada nível de recurso: * No nível da marca, há uma relação de um para muitos entre as configurações de canal e as regras de aplicação da configuração. No nível da loja, há outra relação de um para muitos entre as configurações de canal e as regras de aplicação de configuração. Quando várias configurações de canal são aplicáveis, o tempo de execução determina a configuração a ser aplicada com base na seguinte ordem de precedência (a última substitui a anterior em caso de conflito): 1. Padrão 2 no nível da marca. Vinculação no nível da marca 3. Padrão no nível da loja 4. Vinculação no nível da loja

Campos
`name`	`string` Identificador. O nome da configuração do canal. Formato: projects/{project}/locations/{location}/brands/{brand}/channelConfigs/{channel_config}
`display_name`	`string` Opcional. Nome de exibição opcional para essa configuração de canal em interfaces do usuário. O valor é limitado a 63 caracteres.
`create_time`	`Timestamp` Apenas saída. A hora em que essa configuração de canal foi criada.
`update_time`	`Timestamp` Apenas saída. A hora em que essa configuração de canal foi atualizada pela última vez.
`state`	`State` Apenas saída. O status da configuração do canal.
`type`	`Type` Obrigatório. O tipo da configuração do canal.
`tone`	`Tone` Opcional. O tom do agente.
`config_application_rules[]`	`ConfigApplicationRule` Apenas saída. As regras de configuração do aplicativo associadas a essa configuração de canal.

Estado

Status da configuração do canal.

Tipos enumerados
`STATE_UNSPECIFIED`	O status não foi especificado.
`DRAFT`	A configuração do canal é um rascunho e ainda não está pronta para uso.
`ACTIVE`	A configuração do canal está ativa e pode ser usada.
`PROMOTED`	A configuração do canal é promovida.

Tom

O tom do agente.

Tipos enumerados
`TONE_UNSPECIFIED`	O tom não foi especificado.
`CONCISE_AND_DIRECT`	O tom do agente é conciso e direto.
`PROFESSIONAL_AND_FORMAL`	O tom do agente é profissional e formal.
`FRIENDLY`	O tom do agente é amigável.

Tipo

O tipo da configuração do canal.

Tipos enumerados
`TYPE_UNSPECIFIED`	Tipo não especificado.
`UPSELL_STRATEGY`	A configuração do canal é para a estratégia de upselling.
`AGENT_CUSTOMIZATION`	A configuração do canal é para personalização do agente.

ChannelConfigRevision

Uma revisão de uma configuração de canal.

Campos
`name`	`string` Identificador. O nome do recurso da revisão de configuração do canal. Formato: projects/{project}/locations/{location}/brands/{brand}/channelConfigs/{channel_config}/revisions/{revision}
`snapshot`	`ChannelConfig` Apenas saída. O estado do recurso de configuração do canal nesta revisão.
`create_time`	`Timestamp` Apenas saída. Quando a revisão foi criada.
`created_by`	`string` Apenas saída. O e-mail do usuário que criou o recurso recentemente.
`alternate_ids[]`	`string` Apenas saída. IDs alternativos para esta revisão.
`action`	`RevisionAction` Apenas saída. A ação que criou esta revisão.

ChannelType

O tipo de canal usado para a comunicação do agente. Esse tipo enumerado não está congelado, e novos valores podem ser adicionados no futuro.

Tipos enumerados
`CHANNEL_TYPE_UNSPECIFIED`	Tipo de canal não especificado.
`CHANNEL_TYPE_DRIVE_THROUGH`	Drive-through.
`CHANNEL_TYPE_MOBILE_APP`	Canal de apps para dispositivos móveis.

ClientAppInfo

Informações sobre o aplicativo cliente e o ambiente do dispositivo. Isso é usado principalmente para geração de registros, análise e depuração.

Campos

device_model

string

Opcional. O modelo do dispositivo do cliente (por exemplo, "iPhone 13", "Pixel 7", "Kiosk v2").

os_version

string

Opcional. A versão do sistema operacional do cliente (por exemplo, "iOS 16.1", "Android 13").

sdk_version

string

Opcional. A versão do SDK cliente ou do software aplicativo.

ClientExecutionRequest

Uma solicitação para o lado do cliente executar um comando.

Campos
`execution_id`	`string` Obrigatório. Um ID exclusivo para esta solicitação de execução.
Campo de união `request`. A solicitação específica a ser executada. `request` pode ser apenas de um dos tipos a seguir:
`finalize_order_request`	`FinalizeOrderRequest` Uma solicitação para finalizar o pedido.
`submit_order_request`	`SubmitOrderRequest` Uma solicitação para enviar o pedido.

ClientExecutionResult

O resultado de uma solicitação de execução do cliente.

Campos
`execution_id`	`string` Obrigatório. O ID da solicitação de execução para a qual este é um resultado.
Campo de união `response`. O resultado específico da execução. `response` pode ser apenas de um dos tipos a seguir:
`finalize_order_response`	`FinalizeOrderResponse` O resultado da finalização do pedido.
`submit_order_response`	`SubmitOrderResponse` O resultado do envio do pedido.

Configuração

A configuração de uma sessão e propriedades de pedidos de comida. No início de cada conexão, o cliente precisa enviar uma mensagem de configuração. Isso precisa acontecer antes de qualquer outra solicitação para iniciar a sessão. Se o cliente se desconectar, ele precisará repetir a mesma mensagem de configuração ao se reconectar.

Campos
`session`	`string` Obrigatório. A sessão do pedido. Formato: `projects/{project}/locations/{location}/sessions/{session}`
`store`	`string` Obrigatório. A loja em que o pedido está sendo feito. Formato: `projects/{project}/locations/{location}/brands/{brand}/stores/{store}`
`lane_id`	`string` Opcional. O ID de uma faixa de drive-thru específica.
`enable_echo_cancellation`	`bool` Opcional. Define se o cancelamento de eco será ativado para a sessão. Se ativado, o cliente precisa fornecer customer_audio e crew_audio no AudioInput.
`daypart_id`	`string` Opcional. Período do dia do cardápio, incluindo café da manhã, almoço, jantar etc. Usado para determinar o cardápio a ser usado no pedido.
`user_info`	`UserInfo` Opcional. As informações pessoais do usuário final compartilhadas com o agente.
`order_type (deprecated)`	`OrderType` Este item foi descontinuado. Opcional. Descontinuado: use initial_order.fulfillment.fulfillment_type. O tipo de pedido a ser feito.
`initial_order`	`Order` Opcional. O pedido inicial antes de iniciar a sessão do agente. Se fornecido, o agente vai usá-lo como o estado inicial do pedido.
`feature_gate`	`FeatureGate` Opcional. Os feature gates da sessão. Usado para ativar ou desativar recursos da sessão.
`initial_utterance`	`string` Opcional. O enunciado inicial do cliente para iniciar a conversa. Se fornecido, o agente vai usar isso como a primeira declaração do usuário e não vai começar com uma mensagem de saudação.
`client_app_info`	`ClientAppInfo` Opcional. As informações sobre o aplicativo cliente e o ambiente do dispositivo.
`channel_type`	`ChannelType` Opcional. O tipo de canal usado para a comunicação do agente.

ConfigApplicationRule

Uma regra que representa condições para quando aplicar configurações do agente.

Campos
`name`	`string` Identificador. O nome da regra de aplicativo de configuração. Formato: projects/{project}/locations/{location}/brands/{brand}/configApplicationRules/{config_application_rule}
`display_name`	`string` Opcional. Nome de exibição opcional para essa regra de aplicativo de configuração em interfaces do usuário. O valor é limitado a 63 caracteres.
`create_time`	`Timestamp` Apenas saída. O horário em que essa regra de aplicação de configuração foi criada.
`update_time`	`Timestamp` Apenas saída. A hora em que essa regra de aplicação de configuração foi atualizada pela última vez.

ConfigApplicationRuleRevision

Uma revisão de uma regra de aplicativo de configuração.

Campos
`name`	`string` Identificador. O nome do recurso da revisão da regra de aplicativo de configuração. Formato: projects/{project}/locations/{location}/brands/{brand}/configApplicationRules/{config_application_rule}/revisions/{revision}
`snapshot`	`ConfigApplicationRule` Apenas saída. O estado do recurso de regra de aplicativo de configuração nesta revisão.
`create_time`	`Timestamp` Apenas saída. Quando a revisão foi criada.
`created_by`	`string` Apenas saída. O e-mail do usuário que criou o recurso recentemente.
`alternate_ids[]`	`string` Apenas saída. IDs alternativos para esta revisão.
`action`	`RevisionAction` Apenas saída. A ação que criou esta revisão.

CreateBrandRequest

Mensagem de solicitação para MenuService.CreateBrand.

Campos

parent

string

Obrigatório. O pai, que tem essa coleção de marcas. Formato: projects/{project}/locations/{location}

brand

Brand

Obrigatório. A marca a ser criada.

brand_id

string

Opcional. O ID a ser usado na marca, que se tornará o componente final do nome do recurso da marca.

Esse valor só pode conter letras minúsculas, números e hífens. O primeiro e o último caractere precisam ser uma letra ou um número, e o máximo é de 63 caracteres.

CreateChannelConfigRequest

Mensagem de solicitação para MenuService.CreateChannelConfig.

Campos

parent

string

Obrigatório. A marca principal, que tem essa coleção de configurações de canal. Formato: projects/{project}/locations/{location}/brands/{brand}

channel_config

ChannelConfig

Obrigatório. A configuração do canal a ser criada.

channel_config_id

string

Opcional. O ID a ser usado na configuração do canal, que se tornará o componente final do nome do recurso da configuração do canal.

Esse valor só pode conter letras minúsculas, números e hifens, com um máximo de 63 caracteres. O primeiro caractere precisa ser uma letra, e o último caractere precisa ser uma letra ou um número.

CreateConfigApplicationRuleRequest

Mensagem de solicitação para MenuService.CreateConfigApplicationRule.

Campos

parent

string

Obrigatório. A marca principal, que tem essa coleção de regras de aplicação de configuração. Formato: projects/{project}/locations/{location}/brands/{brand}

config_application_rule

ConfigApplicationRule

Obrigatório. A regra de aplicativo de configuração a ser criada.

config_application_rule_id

string

Opcional. O ID a ser usado na regra de aplicação da configuração, que se tornará o componente final do nome do recurso da regra de aplicação da configuração.

Esse valor só pode conter letras minúsculas, números e hífens. O primeiro e o último caractere precisam ser uma letra ou um número, e o máximo é de 63 caracteres.

CreateMenuRequest

Mensagem de solicitação para MenuService.CreateMenu.

Campos

parent

string

Obrigatório. O pai, que tem essa coleção de menus. Formato: projects/{project}/locations/{location}

menu_id

string

Opcional. O ID a ser usado no menu, que se tornará o componente final do nome do recurso do menu.

Esse valor só pode conter letras minúsculas, números e hífens. O primeiro e o último caractere precisam ser uma letra ou um número, e o máximo é de 63 caracteres.

menu

Menu

Obrigatório. O menu a ser criado.

CreateStoreRequest

Mensagem de solicitação para MenuService.CreateStore.

Campos

parent

string

Obrigatório. A marca principal, que tem essa coleção de lojas. Formato: projects/{project}/locations/{location}/brands/{brand}

store_id

string

Opcional. O ID da loja a ser usado, que se tornará o componente final do nome do recurso da loja.

Esse valor só pode conter letras minúsculas, números e hífens. O primeiro e o último caractere precisam ser uma letra ou um número, e o máximo é de 63 caracteres.

store

Obrigatório. A loja a ser criada.

DateRange

Representa um período, incluindo as duas extremidades.

Campos

start_date

Indica que o agente encerrou a sessão devido à conclusão bem-sucedida (por exemplo, o usuário diz "Tchau!" ) ou um encaminhamento para um agente.

Campos

type

EndType

O tipo de evento de encerramento da sessão.

reason

string

O motivo para encerrar a sessão.

EndType

Tipo de evento de fim de sessão.

Tipos enumerados
`END_TYPE_UNSPECIFIED`	O tipo de fim não foi especificado.
`DRIVE_OFF`	O cliente foi embora.
`AGENT_ESCALATION`	O agente encaminhou a sessão para um agente humano.
`CREW_INTERJECTION`	Um membro da equipe interrompeu a sessão.
`ORDER_COMPLETED`	O pedido foi concluído e nenhuma outra ação é necessária.
`PAYMENT_FLOW_SUCCESS`	O fluxo de pagamento foi concluído, e você não precisa fazer mais nada.
`PAYMENT_FLOW_FAILURE`	O fluxo de pagamento falhou.
`CLIENT_ESCALATION`	O cliente encaminhou a sessão para um agente humano.
`CALLER_HANGUP`	O cliente encerrou a ligação antes do tempo.

EventInput

A entrada de evento do cliente. Isso é usado para acionar eventos específicos no agente.

Campos
Campo de união `event`. Próximo ID: 9 O evento a ser acionado. `event` pode ser apenas de um dos tipos a seguir:
`drive_off_event`	`DriveOffEvent` O evento de saída do veículo.
`crew_interjection_event`	`CrewInterjectionEvent` O evento de interjeição da equipe.
`update_order_state_event`	`OrderStateUpdateEvent` Uma atualização do lado do cliente no estado do pedido.
`client_escalation_event`	`ClientEscalationEvent` Um evento de encaminhamento do lado do cliente.
`customized_input_event`	`CustomizedInputEvent` Um evento de entrada personalizado.
`caller_hangup_event`	`CallerHangupEvent` Opcional. Um evento de desligamento do autor da chamada.

order

Obrigatório. O estado atualizado do pedido associado a esta sessão.

FeatureGate

Os feature gates da sessão. Usado para ativar ou desativar recursos da sessão.

Campos
`trigger_offer_engine_on_demand`	`bool` Opcional. Para público-alvo limitado, se definido, o mecanismo de ofertas será opcional no fluxo de pagamento e só será acionado quando os usuários solicitarem.
`trigger_loyalty_on_demand`	`bool` Opcional. Somente para público-alvo limitado, se definido, a fidelidade será opcional no fluxo de pagamento e só será acionada quando os usuários solicitarem.
`trigger_order_media_assistant_on_demand`	`bool` Opcional. Para público-alvo limitado, se definido, o assistente de mídia de pedidos será opcional e só será acionado quando os usuários solicitarem.
`menu_response_enabled`	`bool` Opcional. Retorna os dados do menu para o cliente em BidiProcessOrderResponse, se definido.
`revamped_payment_flow_enabled`	`bool` Opcional. Somente para público-alvo limitado. Se definido, uma versão reformulada do fluxo de pagamento será usada.
`updated_order_state_enabled`	`bool` Opcional. Se definido, updated_order_state será retornado em vez de legacy_order_state_response.

FinalizeOrderRequest

Esse tipo não tem campos.

Uma solicitação para finalizar o pedido. Normalmente, essa mensagem é enviada pelo agente quando o cliente indica que terminou de fazer o pedido e quer pagar.

FinalizeOrderResponse

O resultado da finalização do pedido.

Campos

payment_flow_enabled

bool

Opcional. Se o fluxo de processamento de pagamentos será ativado no agente.

payment_info

PaymentInfo

Opcional. As informações de pagamento do cliente. Não faz nada se "payment_flow_enabled" for "false".

total_amount_due

StreamIntegrationAttributes

Opcional. O valor total devido pelo pedido.

FulfillmentMethod

O método de atendimento de um pedido.

Tipos enumerados
`FULFILLMENT_METHOD_UNSPECIFIED`	Método de fulfillment não especificado.
`FULFILLMENT_METHOD_DINE_IN`	Um pedido que será consumido pelo cliente na loja.
`FULFILLMENT_METHOD_PICKUP`	Um pedido que será retirado pelo cliente na loja.
`FULFILLMENT_METHOD_DRIVE_THRU`	Um pedido feito em um drive-thru.
`FULFILLMENT_METHOD_DELIVERY`	Um pedido que será entregue ao cliente.
`FULFILLMENT_METHOD_CURBSIDE`	Um pedido para retirada. O cliente estaciona o carro em um local designado fora da loja, e o pedido é entregue a ele.

GetStoreRevisionRequest

Mensagem de solicitação para MenuService.GetStoreRevision.

Campos

name

string

Obrigatório. O nome da revisão do repositório a ser recuperada. Formato: projects/{project}/locations/{location}/brands/{brand}/stores/{store}/revisions/{revision}

HistoryEntry

Entrada de histórico para uma revisão de recurso.

Campos
`commit_time`	`Timestamp` O horário em que a revisão foi criada.
`created_by`	`string` O usuário ou serviço que criou a revisão.
`revision_name`	`string` O nome completo do recurso da revisão.
`resource_type`	`string` O tipo do recurso de base (por exemplo, "Brand", "Store", "ChannelConfig").
Campo de união `resource_revision`. A revisão do recurso. `resource_revision` pode ser apenas de um dos tipos a seguir:
`brand`	`Brand` A marca no momento da confirmação.
`store`	`Store` O repositório no momento do commit.
`channel_config`	`ChannelConfig` A configuração do canal no momento do commit.
`config_application_rule`	`ConfigApplicationRule` A regra de aplicativo de configuração no momento do commit.

Imagem

Imagem a ser mostrada para uma entidade de menu.

Campos

source_uri

string

Obrigatório. O URI de origem da imagem.

InterruptionSignal

Esse tipo não tem campos.

Indica que a resposta de áudio do agente foi interrompida (por exemplo, por invasão do usuário final). O cliente precisa interromper a reprodução imediatamente.

Item

O item representa uma entidade de menu válida apenas como um item de nível superior em um pedido. O item pode representar um único alimento, bebida, serviço, promoção ou refeição combinada que pode ser modificada com várias opções.

Campos
`id`	`string` Obrigatório. Identificador exclusivo do item no menu.
`semantic_name`	`string` Opcional. Nome conciso e legível que identifica claramente e de forma distinta este item. Precisa ser exclusivo entre os itens do menu.
`display_name`	`string` Obrigatório. Nome legível para humanos deste item a ser usado em interfaces do usuário.
`category_ids[]`	`string` Opcional. Categoria do item.
`description`	`string` Opcional. Descrição legível por humanos.
`image`	`Image` Opcional. Imagem a ser mostrada para este item na UI.
`availability`	`Availability` Opcional. Disponibilidade do item.
`base_price`	`Money` Opcional. O preço base do item. Isso pode ser afetado pelos modificadores selecionados.
`integration_attributes`	`ItemIntegrationAttributes` Opcional. Metadados associados a essa entidade usada para integrações downstream.
`modifier_groups[]`	`ModifierGroupReference` Opcional. Referências a grupos de modificadores que se aplicam a este item.
`modifier_constraints`	`ModifierConstraints` Opcional. Restringe quais modificadores podem / devem ser aplicados a este item em todos os ModifierGroups referenciados.

ItemIntegrationAttributes

Metadados associados a um item usado para integrações downstream.

Campos

custom_integration_attributes

Struct

Opcional. Metadados arbitrários a serem associados a uma entidade, usados para criar integrações downstream, ou seja, identificadores ou informações de esquema para construir um pedido de envio a uma API de ponto de venda de terceiros.

stream_attributes

Opcional. Representa os metadados associados a este item usado para integração de stream. Se a integração de streaming não estiver ativada para a loja, esse campo será ignorado.

toast_attributes

ToastIntegrationAttributes

Opcional. Representa metadados associados a este item usados para integração do Toast. Se a integração do Toast não estiver ativada para a loja, esse campo será ignorado.

StreamIntegrationAttributes

Representa atributos de um item de um menu de stream.

Campos

taxes[]

Tax

Opcional. Representa as alíquotas de tributos aplicáveis a este item.

item_family_id

string

Opcional. Representa a família de itens que contém esta variante no menu do Stream.

Tributo

Informações sobre a taxa de tributos associadas a este item.

Campos
`stream_id`	`string` Obrigatório. O ID do tributo no menu "Fluxo".
`is_inclusive`	`bool` Opcional. Determina se o valor do tributo já está incluído no preço do item.
`rate`	`float` Obrigatório. A taxa do tributo em porcentagem.
`display_name`	`string` Opcional. O nome do tributo.
`is_default`	`bool` Opcional. Indica se o tributo é o padrão.

ToastIntegrationAttributes

Representa atributos de um item de um menu de toast.

Campos

menu_group_guid

string

Opcional. Representa o GUID do grupo de menus do item no menu do Toast.

ListBrandHistoryRequest

Mensagem de solicitação para MenuService.ListBrandHistory.

Campos
`parent`	`string` Obrigatório. A marca para listar o histórico. Formato: projects/{project}/locations/{location}/brands/{brand}
`page_size`	`int32` Opcional. O número máximo de entradas do histórico a serem retornadas.
`page_token`	`string` Opcional. Um token de página recebido de uma chamada `ListBrandHistory` anterior.
`filter`	`string` Opcional. Uma expressão de filtro para filtrar os resultados. Filtros compatíveis: - `user`: filtra por usuário criador de conteúdo. - `timestamp`: filtre por hora do commit. - `resource_type`: filtre por tipo de recurso.

ListBrandHistoryResponse

Mensagem de resposta para MenuService.ListBrandHistory.

Campos

brand_history[]

HistoryEntry

As entradas do histórico.

next_page_token

string

Um token, que pode ser enviado como page_token para recuperar a próxima página.

ListBrandRevisionsRequest

Mensagem de solicitação para MenuService.ListBrandRevisions.

Campos

parent

string

Obrigatório. A marca principal, que é proprietária dessa coleção de revisões. Formato: projects/{project}/locations/{location}/brands/{brand}

page_size

int32

Opcional. O número máximo de revisões a serem retornadas. O serviço pode retornar um valor inferior a este.

page_token

string

Opcional. Um token de página recebido de uma chamada ListBrandRevisions anterior. Forneça isso para recuperar a página subsequente.

ListBrandRevisionsResponse

Mensagem de resposta para MenuService.ListBrandRevisions.

Campos

brand_revisions[]

BrandRevision

As revisões de marca da coleção especificada.

next_page_token

string

Um token, que pode ser enviado como page_token para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

ListBrandsRequest

Mensagem de solicitação para MenuService.ListBrands.

Campos

parent

string

Obrigatório. O pai, que tem essa coleção de marcas. Formato: projects/{project}/locations/{location}

page_size

int32

Opcional. O número máximo de marcas a serem retornadas. O serviço pode retornar um valor inferior a este.

page_token

string

Opcional. Um token de página recebido de uma chamada ListBrands anterior. Forneça isso para recuperar a página subsequente.

ListBrandsResponse

Mensagem de resposta para MenuService.ListBrands.

Campos

brands[]

Brand

As marcas da coleção especificada.

next_page_token

string

Um token, que pode ser enviado como page_token para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

ListChannelConfigRevisionsRequest

Mensagem de solicitação para MenuService.ListChannelConfigRevisions.

Campos

parent

string

Obrigatório. A configuração do canal principal, que é proprietária dessa coleção de revisões. Formato: projects/{project}/locations/{location}/brands/{brand}/channelConfigs/{channel_config}

page_size

int32

Opcional. O número máximo de revisões a serem retornadas. O serviço pode retornar um valor inferior a este.

page_token

Mensagem de resposta para MenuService.ListConfigApplicationRuleRevisions.

Campos

config_application_rule_revisions[]

ConfigApplicationRuleRevision

As revisões de regras de aplicativos de configuração da coleção especificada.

next_page_token

string

Um token, que pode ser enviado como page_token para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

ListConfigApplicationRulesRequest

Mensagem de solicitação para MenuService.ListConfigApplicationRules.

Campos

parent

string

Obrigatório. A marca principal, que tem essa coleção de regras de aplicação de configuração. Formato: projects/{project}/locations/{location}/brands/{brand}

page_size

int32

Opcional. O número máximo de regras de aplicação de configuração a serem retornadas. O serviço pode retornar um valor inferior a este.

page_token

Mensagem de resposta para MenuService.ListStoreRevisions.

Campos

store_revisions[]

StoreRevision

As revisões da loja da coleção especificada.

next_page_token

string

Um token, que pode ser enviado como page_token para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

ListStoresRequest

Mensagem de solicitação para MenuService.ListStores.

Campos
`parent`	`string` Obrigatório. A marca principal, que tem essa coleção de lojas. Formato: projects/{project}/locations/{location}/brands/{brand}
`page_size`	`int32` Opcional. O número máximo de menus a serem retornados. O serviço pode retornar um valor inferior a este.
`page_token`	`string` Opcional. Um token de página recebido de uma chamada `ListMenus` anterior. Forneça isso para recuperar a página subsequente.
`filter`	`string` Opcional. Expressão de filtro com base no AIP-160. Permite filtrar lojas com base em vários atributos. Campos de filtro aceitos: status (String): o status do repositório. Operadores: =, != Exemplo: `status = "ACTIVE"` (valor de enumeração) update_time (carimbo de data/hora): a última atualização da loja. Os carimbos de data/hora esperam uma string formatada em RFC-3339 (por exemplo, 2012-04-21T11:30:00-04:00). Operadores de fusos horários em relação ao UTC aceitos: =, !=, >, >=, <, <= Exemplo: `update_time >= "2025-10-01T00:00:00Z"` tags (String): tags associadas à loja. Operador: : (HAS) Exemplo: `tags:"store-tag"` city (String): a cidade da loja. Operadores: =, != Exemplo: `city = "Mountain View"` state (String): o estado do endereço da loja. Operadores: =, != Exemplo: `state = "CA"` Operadores lógicos: As condições podem ser combinadas usando `AND`, `OR` e `NOT`. Os parênteses `()` podem ser usados para agrupar expressões e controlar a ordem de avaliação. Exemplo: `status = "ACTIVE" AND state = "CA"`

ListStoresResponse

Mensagem de resposta para MenuService.ListStores.

Campos

stores[]

ToastModifierGroupIntegrationAttributes

As lojas da coleção especificada.

next_page_token

string

Um token, que pode ser enviado como page_token para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

LoyaltyAmount

Representa o valor de fidelidade de um cliente.

Campos

units

int64

Obrigatório. Os pontos de fidelidade.

LoyaltyInfo

Representa as informações de fidelidade de um cliente.

Campos

loyalty_amount

LoyaltyAmount

Obrigatório. O valor da fidelidade. Pode ser um saldo de fidelidade ou um consumo de fidelidade.

Campos
`name`	`string` Identificador. O nome do menu. Formato: projects/{project}/locations/{location}/menus/{menu}
`store`	`string` Opcional. O nome do recurso da loja a que este menu está associado. Formato: projects/{project}/locations/{location}/brands/{brand}/stores/{store}
`display_name`	`string` Opcional. Nome de exibição opcional e legível para humanos deste menu em interfaces do usuário.
`items[]`	`Item` Opcional. Itens neste menu.
`modifiers[]`	`Modifier` Opcional. Modificadores de itens neste menu.
`modifier_groups[]`	`ModifierGroup` Opcional. Grupos de modificadores neste menu.
`categories[]`	`MenuCategory` Opcional. Categorias do cardápio neste menu.
`create_time`	`Timestamp` Apenas saída. A hora em que esse menu foi criado.
`update_time`	`Timestamp` Apenas saída. A hora em que o menu foi atualizado pela última vez.
`labels[]`	`MenuLabel` Opcional. Rótulos para este menu.
`menu_schedules[]`	`MenuSchedule` Opcional. Programações de menu neste menu.

MenuCategory

Define uma categoria que contém itens ou modificadores. As categorias são usadas para organizar itens em interfaces do usuário e para agrupamento semântico para o entendimento do agente.

Campos
`id`	`string` Obrigatório. Identificador desta categoria de menu, exclusivo no menu.
`display_name`	`string` Opcional. Nome legível para humanos desta categoria de menu a ser usado em interfaces do usuário.
`description`	`string` Opcional. Descrição legível por humanos.
`parent_id`	`string` Opcional. O ID da categoria do menu principal. Se estiver vazio, será uma categoria de nível superior.

MenuLabel

Rótulos de string para descrever um menu em interfaces.

Campos

name

string

Obrigatório. Nome do marcador.

MenuSchedule

Define a programação do menu para itens e modificadores.

Campos

id

string

Opcional. O ID da programação, por exemplo, "BREAKFAST", "LUNCH" etc.

schedules[]

Schedule

Opcional. Programe o horário ativo.

display_name

string

Opcional. Especifica um nome de exibição opcional para essa programação.

MenuView

Especifica o nível de detalhe a ser retornado para os menus.

Tipos enumerados
`MENU_VIEW_UNSPECIFIED`	O valor padrão / não definido. O padrão da API será a visualização FULL.
`MENU_VIEW_BASIC`	Inclua metadados básicos sobre o menu.
`MENU_VIEW_NAME_ONLY`	Incluir apenas o nome do menu
`MENU_VIEW_FULL`	Incluir tudo. Esse é o valor padrão.

Modificador

Define opções de modificação feitas em itens ou outros modificadores, por meio de relações definidas por ModifierGroup.

Campos
`id`	`string` Obrigatório. Identificador exclusivo do modificador no menu.
`display_name`	`string` Obrigatório. Nome legível para humanos deste item a ser usado em interfaces do usuário.
`description`	`string` Opcional. Descrição legível por humanos.
`image`	`Image` Opcional. Imagem a ser mostrada para este item na UI.
`semantic_name`	`string` Opcional. Nome conciso e legível que identifica claramente e de forma distinta este modificador. Precisa ser exclusivo entre os modificadores nos ModifierGroups em que este modificador existe.
`category_ids[]`	`string` Opcional. Categoria do modificador.
`availability`	`Availability` Opcional. Disponibilidade para este modificador.
`price_adjustment`	`Money` Opcional. Um ajuste aditivo aplicado ao preço do item de nível superior quando este modificador é selecionado. Deixe em branco se o modificador não afetar o preço.
`integration_attributes`	`ModifierIntegrationAttributes` Opcional. Metadados associados a essa entidade usada para integrações downstream.
`modifier_groups[]`	`ModifierGroupReference` Opcional. Referências a grupos de modificadores que se aplicam a este modificador.
`modifier_constraints`	`ModifierConstraints` Opcional. Restringe quais modificadores podem / devem ser aplicados a esse modificador em ModifierGroups referenciados.

ModifierAction

Define uma ação que pode ser realizada em modificadores.

Campos

name

string

Obrigatório. O nome da ação do modificador, por exemplo, "NO", "SIDE", "ADD", "EXTRA".

ModifierConstraints

Restringe quais modificadores podem ou precisam ser aplicados a uma entidade em todos os ModifierGroups referenciados.

Campos

min_quantity

int32

Opcional. O número mínimo de modificadores que precisam ser aplicados em ModifierGroups referenciados diretamente. Se não for especificado, não haverá um mínimo.

max_quantity

int32

Opcional. O número máximo de modificadores que podem ser aplicados em ModifierGroups referenciados diretamente. Se não for especificado, não haverá um valor máximo.

ModifierGroup

Define um grupo de modificadores em que as seleções podem ser feitas.

Campos
`id`	`string` Obrigatório. Identificador exclusivo do grupo de modificadores no menu.
`display_name`	`string` Obrigatório. O nome do grupo de modificadores, por exemplo, "Coberturas (sanduíche)" ou "Acompanhamento para combo médio".
`semantic_name`	`string` Opcional. O nome do grupo de modificadores, por exemplo, "Coberturas (sanduíche)" ou "Acompanhamento para combo".
`modifier_ids[]`	`string` Obrigatório. Os IDs dos modificadores que fazem parte deste grupo.
`modifier_actions[]`	`ModifierAction` Opcional. As ações que podem ser realizadas nos modificadores deste grupo.
`min_selection_count`	`int32` Opcional. O número mínimo de modificadores do grupo referenciado que precisam ser selecionados para que o item seja válido. Se não for definido, não haverá valor mínimo. Para um grupo em que exatamente uma seleção é necessária, esse valor deve ser 1.
`max_selection_count`	`int32` Opcional. O número máximo de modificadores totais do grupo referenciado que podem ser selecionados. Se não for definido, não haverá valor máximo. Para um grupo em que exatamente uma seleção é necessária, esse valor deve ser 1.
`max_selection_count_per_modifier`	`int32` Opcional. Limita o número de vezes que cada modificador pode ser aplicado dentro deste grupo. Se não for definido, o padrão será 1.
`integration_attributes`	`ModifierGroupIntegrationAttributes` Opcional. Metadados associados a essa entidade usada para integrações downstream.

ModifierGroupIntegrationAttributes

Metadados associados a um grupo de modificadores usado para integrações downstream.

Campos

custom_integration_attributes

Struct

toast_attributes

Opcional. Representa metadados associados a este grupo de modificadores usado para integração de Toast. Se a integração do Toast não estiver ativada para a loja, esse campo será ignorado.

ToastModifierGroupIntegrationAttributes

Representa atributos de um ModifierGroup de um menu de toast.

Campos

guid

string

Opcional. Representa o GUID do grupo de menus do item no menu do Toast.

is_pre_modifier_group

bool

Opcional. Se for "true", esse grupo de modificadores vai representar um Toast PreModifierGroup.

ModifierGroupReference

Uma referência a um grupo de modificadores.

Campos
`id`	`string` Obrigatório. O ID do grupo de modificadores.
`default_modifiers[]`	`DefaultModifierSelection` Opcional. O conjunto de modificadores aplicados por padrão.
`min_selection_count`	`int32` Opcional. A contagem mínima de modificadores do ModifierGroup referenciado que precisam ser selecionados. Se esse valor for definido em ModifierGroupReference e ModifierGroup, as duas restrições serão aplicadas. Se não for definido, não haverá valor mínimo.
`max_selection_count`	`int32` Opcional. O número máximo de modificadores totais do grupo referenciado que podem ser selecionados. Se esse valor for definido em ModifierGroupReference e ModifierGroup, as duas restrições serão aplicadas. Se não for definido, não haverá valor máximo.

DefaultModifierSelection

Especifica a seleção padrão de um modificador em um ModifierGroup.

Campos

id

string

Obrigatório. O ID do modificador.

quantity

int32

Opcional. A quantidade desse modificador a ser aplicada. Se omitida, a referência será tratada como tendo uma quantidade de 1.

ModifierIntegrationAttributes

Metadados associados a um modificador usado para integrações downstream.

Campos

custom_integration_attributes

Struct

toast_attributes

ToastModifierIntegrationAttributes

Opcional. Representa metadados associados a este modificador usado para integração de Toast. Se a integração do Toast não estiver ativada para a loja, esse campo será ignorado.

ToastModifierIntegrationAttributes

Representa atributos de um modificador em um menu de toast.

Campos

guid

string

Opcional. Representa o GUID da opção de modificador do item no menu do Toast.

is_pre_modifier

bool

Opcional. Se for verdadeiro, esse modificador vai representar um Toast PreModifier.

Pedido

O pedido representa o conteúdo de um pedido em andamento ou concluído de um usuário.

Campos
`items[]`	`OrderItem` Opcional. Os itens no pedido.
`metadata`	`OrderMetadata` Opcional. Outros metadados coletados ou inferidos durante o pedido.
`fulfillment`	`OrderFulfillment` Opcional. As informações de atendimento do pedido.
`price_info`	`OrderPriceInfo` Opcional. Informações sobre o preço do pedido.
`external_order_id`	`string` Apenas saída. O identificador externo deste pedido. Preenchido apenas se uma integração de ponto de venda estiver ativada.
`order_payment`	`OrderPayment` Opcional. O estado de pagamento associado a este pedido.

OrderFulfillment

OrderFulfillment contém informações sobre o atendimento do pedido.

Campos

fulfillment_method

FulfillmentMethod

Opcional. O método de atendimento do pedido.

create_time

Timestamp

Apenas saída. A hora em que o pedido foi criado.

target_fulfillment_time

Timestamp

Opcional. O horário em que o pedido está programado para ser atendido, usado para "pedir com antecedência". Se não for fornecido, o pedido será considerado "o mais rápido possível".

OrderItem

OrderItem especifica o estado de um Item que faz parte de um Pedido.

Campos
`uid`	`string` Opcional. Um identificador exclusivo atribuído pelo sistema para este item.
`item_id`	`string` Obrigatório. Identificador de um item no menu, exclusivo no menu.
`display_name`	`string` Apenas saída. Nome legível por humanos para este item de linha que será mostrado nas interfaces do usuário.
`image`	`Image` Apenas saída. Imagem a ser mostrada para este item na UI.
`base_price`	`Money` Apenas saída. O preço base do item. Isso pode ser afetado pelos modificadores selecionados. É o preço por unidade do item.
`integration_attributes`	`ItemIntegrationAttributes` Apenas saída. Metadados associados a essa entidade usada para integrações downstream.
`modifier_groups[]`	`OrderModifierGroup` Opcional. ModifierGroups aplicados a este item.
`quantity`	`int32` Opcional. A quantidade deste item no pedido.

OrderMetadata

OrderMetadata contém outros metadados coletados ou inferidos durante o pedido.

Campos

collected_customer_name

string

Opcional. Nome do cliente, coletado ao receber o pedido. Preenchido apenas quando o agente está configurado para coletar o nome do cliente. Esses dados podem ser coletados verbalmente e conter erros de ortografia ou transcrição. Portanto, tome cuidado ao mostrar essas informações aos usuários e não confie nelas como informações de pagamento, por exemplo.

caller_phone_number

string

Opcional. O número de telefone do cliente que está fazendo o pedido.

OrderModifier

OrderModifier especifica o estado de um Modifier que faz parte de um OrderModifierGroup.

Campos
`uid`	`string` Opcional. Um identificador exclusivo atribuído pelo sistema para este modificador.
`modifier_id`	`string` Obrigatório. Identificador exclusivo do modificador no menu.
`display_name`	`string` Apenas saída. O nome de exibição do modificador a ser mostrado nas interfaces do usuário.
`price_adjustment`	`Money` Apenas saída. O ajuste de preço associado a esse modificador, se houver. É o preço por unidade do modificador.
`quantity`	`int32` Opcional. A quantidade dessa ação de modificador aplicada.
`modifier_action`	`OrderModifierAction` Opcional. A ação do modificador aplicada a este modificador.
`image`	`Image` Apenas saída. Imagem a ser exibida para este modificador na UI.
`integration_attributes`	`ModifierIntegrationAttributes` Apenas saída. Metadados associados a essa entidade usada para integrações downstream.
`modifier_groups[]`	`OrderModifierGroup` Opcional. Grupos de modificadores aninhados aplicados a este modificador.

OrderModifierAction

OrderModifierAction especifica o ModifierAction associado a um OrderModifier aplicado.

Campos

name

string

Opcional. O nome da ação do modificador, por exemplo, "NO", "SIDE", "ADD", "EXTRA".

OrderModifierGroup

OrderModifierGroup especifica o estado de um ModifierGroup que faz parte de um OrderItem.

Campos
`modifier_group_id`	`string` Obrigatório. Identificador exclusivo do grupo de modificadores no menu.
`display_name`	`string` Apenas saída. O nome do grupo de modificadores, por exemplo, "Coberturas (sanduíche)" ou "Acompanhamento para combo médio".
`integration_attributes`	`ModifierGroupIntegrationAttributes` Apenas saída. Metadados associados a essa entidade usada para integrações downstream.
`modifiers[]`	`OrderModifier` Opcional. Os modificadores aplicados a este grupo de modificadores.

OrderPayment

As informações relacionadas ao pagamento de um pedido.

Campos

tipping_info

TippingInfo

Opcional. Informações sobre gorjetas.

loyalty_consumed

LoyaltyAmount

Opcional. Valor da fidelidade consumido para o pagamento.

payment_info

PaymentInfo

Opcional. Informações sobre a forma de pagamento usada.

OrderPriceInfo

OrderPriceInfo encapsula os vários componentes de preço de um pedido.

Campos

total_price

Opcional. O preço total final após a aplicação de todos os tributos, taxas e descontos.

subtotal_price

Opcional. O preço subtotal de todos os itens e modificadores, antes de tributos e descontos.

tax_price

Opcional. O valor dos tributos aplicados ao pedido.

OrderType

O tipo de pedido a ser feito.

Tipos enumerados
`ORDER_TYPE_UNSPECIFIED`	O tipo de pedido não foi especificado.
`ORDER_TYPE_DRIVE_THROUGH`	O pedido é para drive-thru.
`ORDER_TYPE_CARRY_OUT`	O pedido é para retirada.
`ORDER_TYPE_DELIVERY`	O pedido é para entrega.

PastOrder

O pedido anterior do usuário.

Campos

order

Obrigatório. O pedido original da IA de comida.

PaymentInfo

Informações de pagamento do usuário.

Campos

credit_card_last_four_digits

string

Opcional. Os últimos quatro dígitos do cartão de crédito. Isso é usado para verificar o número do cartão de crédito na etapa de pagamento.

credit_card_cvv

string

Opcional. CVV do cartão de crédito.

payment_method

PaymentMethod

Opcional. O tipo de forma de pagamento usada.

PaymentMethod

O tipo de forma de pagamento.

Tipos enumerados
`PAYMENT_METHOD_UNSPECIFIED`	Forma de pagamento não especificada.
`PAYMENT_METHOD_CREDIT_CARD`	Cartão de crédito.

PromoteChannelConfigRequest

Mensagem de solicitação para MenuService.PromoteChannelConfig.

Campos

name

string

Obrigatório. O nome da configuração de canal a ser promovida. Formato: projects/{project}/locations/{location}/brands/{brand}/channelConfigs/{channel_config}

destination_brand

string

Opcional. A marca de destino para promover a configuração do canal. Formato: projects/{project}/locations/{location}/brands/{brand}

Se destination_brand for fornecido e for diferente da marca em name, uma cópia da configuração do canal será criada em destination_brand. Caso contrário, nenhuma cópia será feita.

PromoteChannelConfigResponse

Mensagem de resposta para MenuService.PromoteChannelConfig.

Campos

channel_config

ChannelConfig

A configuração do canal promovido.

RecommendedOrder

Um pedido recomendado pelo agente ao usuário.

Campos

order

A ordem recomendada para exibição ao usuário.

RecommendedOrders

Uma lista de pedidos recomendados pelo agente ao usuário.

Campos

recommended_orders[]

RecommendedOrder

Os pedidos recomendados a serem exibidos para o usuário.

RestartOrder

O cliente pede para começar o pedido de novo.

Campos

confirmation_step

bool

O agente está pedindo para o cliente confirmar o pedido de reinicialização.

RevisionAction

A ação que criou uma revisão.

Tipos enumerados
`REVISION_ACTION_UNSPECIFIED`	Ação não especificada.
`CREATE`	A revisão foi criada porque o recurso foi criado.
`UPDATE`	A revisão foi criada porque o recurso foi atualizado.

Programar

Uma programação configurável para um dia da semana ou uma data específica.

Campos

days[]

DayOfWeek

Opcional. Os dias da semana em que a programação será aplicada.

date_ranges[]

DateRange

Opcional. Os períodos em que a programação será aplicada. Se definido, a programação só fica ativa nesses períodos específicos. Se os dois forem definidos, a programação será ativada quando ambas as condições forem atendidas. Por exemplo, se "days" for [MONDAY] e "date_ranges" for [2026-01-01, 2026-01-31], a programação vai estar ativa em todas as segundas-feiras de janeiro.

time_ranges[]

TimeOfDayRange

Opcional. Os intervalos de horário do dia em que a programação será aplicada. Se definido, o agendamento só fica ativo durante esses períodos.

SentimentMeasurement

A pontuação de sentimento em tempo real medida para esta vez.

Campos

score

float

Opcional. Sentimento entre -1,0 (sentimento negativo) e 1,0 (sentimento positivo).

magnitude

float

Opcional. Magnitude do sentimento, independente da pontuação.

SpeechRecognition

O resultado do reconhecimento de fala do agente.

Campos

transcript

string

Texto transcrito da entrada de áudio no idioma detectado.

language_code

string

O código do idioma da transcrição. O código de idioma precisa estar no formato BCP-47, como "en-US".

Loja

Uma loja individual de uma marca.

Campos
`name`	`string` Identificador. O nome da loja. Formato: projects/{project}/locations/{location}/brands/{brand}/stores/{store}
`create_time`	`Timestamp` Apenas saída. A hora em que a loja foi criada.
`update_time`	`Timestamp` Apenas saída. A hora em que a loja foi atualizada pela última vez.
`status`	`StoreStatus` Obrigatório. O status da loja.
`time_zone`	`TimeZone` Obrigatório. O fuso horário da loja. Isso é usado para determinar qual parte do dia do menu usar para a loja em um determinado momento e para substituições baseadas em tempo.
`store_metadata`	`StoreMetadata` Opcional. Metadados da loja.
`tags[]`	`string` Opcional. Tags associadas à loja.

StoreHours

O horário de funcionamento da loja.

Campos

fulfillment_method

FulfillmentMethod

Opcional. O método de atendimento do horário de funcionamento da loja, por exemplo, "RETIRADA", "ENTREGA" etc. Se não for especificado, o horário de funcionamento da loja será considerado aplicável a todos os métodos de atendimento.

schedules[]

Schedule

Opcional. O horário de funcionamento da loja para o fulfillment_method especificado.

StoreMetadata

Metadados da loja.

Campos
`display_name`	`string` Opcional. O nome de exibição da loja a ser usado na UI e em elementos voltados ao cliente.
`contact_email`	`string` Opcional. O endereço de e-mail da loja que será fornecido aos clientes.
`address`	`Address` Opcional. As informações de endereço da loja.
`store_hours[]`	`StoreHours` Opcional. O horário de funcionamento da loja.
`dayparts[]`	`Daypart` Opcional. Períodos do dia definidos para a loja.
`phone_number`	`string` Opcional. O número de telefone principal da loja para receber pedidos, solicitar catering, fazer consultas gerais e reservas.

Endereço

As informações de endereço da loja.

Campos
`street_address`	`string` Opcional. O endereço da loja.
`city`	`string` Opcional. A cidade da loja.
`state`	`string` Opcional. O estado da loja.
`country`	`string` Opcional. O país da loja.
`postal_code`	`string` Opcional. O código postal da loja.
`latitude`	`double` Opcional. A latitude da loja.
`longitude`	`double` Opcional. A longitude da loja.
`google_maps_url`	`string` Opcional. O URL do Google Maps para a loja.

Período do dia

Um período do dia para a loja.

Campos

id

string

Opcional. O ID da parte do dia, por exemplo, "BREAKFAST", "LUNCH" etc.

schedules[]

Schedule

Opcional. Horário ativo por período do dia.

display_name

string

Opcional. Especifica um nome de exibição opcional para esse período do dia.

StoreRevision

Uma revisão de uma loja.

Campos
`name`	`string` Identificador. O nome do recurso da revisão da loja. Formato: projects/{project}/locations/{location}/brands/{brand}/stores/{store}/revisions/{revision}
`snapshot`	`Store` Apenas saída. O estado do recurso do repositório nesta revisão.
`create_time`	`Timestamp` Apenas saída. Quando a revisão foi criada.
`created_by`	`string` Apenas saída. O e-mail do usuário que criou o recurso recentemente.
`alternate_ids[]`	`string` Apenas saída. IDs alternativos para esta revisão.
`action`	`RevisionAction` Apenas saída. A ação que criou esta revisão.

StoreStatus

O status da loja.

Campos

state

State

Opcional. O estado da loja.

Estado

O status da loja.

Tipos enumerados
`STATE_UNSPECIFIED`	A loja está em um estado não especificado.
`ACTIVE`	A loja está ativa.
`DISABLED`	A loja está desativada.

SubmitOrderRequest

Uma solicitação para enviar o pedido, com todas as informações de pagamento necessárias coletadas do cliente.

Campos

payment_info

PaymentInfo

Obrigatório. As informações de pagamento do pedido.

loyalty_info

LoyaltyInfo

Opcional. A fidelidade consumida no pedido.

tip_amount

Opcional. O valor da gorjeta do pedido.

SubmitOrderResponse

O resultado do envio do pedido.

Campos

success

bool

Obrigatório. Se o pedido foi enviado.

estimated_ready_duration

Duration

Opcional. A duração estimada até que o pedido esteja pronto.

SuggestedItem

Um item para sugerir ao cliente.

Campos
`item_id`	`string` ID do item no menu.
`display_name`	`string` Nome legível por humanos para ser mostrado nas interfaces do usuário.
`image`	`Image` Imagem a ser mostrada para este item na UI.
`base_price`	`Money` O preço base do item. Isso pode ser afetado pelos modificadores selecionados. É o preço por unidade do item.
`integration_attributes`	`ItemIntegrationAttributes` Metadados associados a essa entidade usada para integrações downstream.

SuggestedItems

Uma lista de itens para sugerir ao cliente.

Campos

items[]

SuggestedItem

Os itens a serem sugeridos ao cliente.

SuggestedModifier

Um modificador para sugerir ao cliente.

Campos
`modifier_id`	`string` ID do modificador no menu.
`modifier_group_id`	`string` ID do grupo de modificadores a que este modificador será adicionado se a sugestão for aceita.
`display_name`	`string` Nome legível por humanos para ser mostrado nas interfaces do usuário.
`image`	`Image` Imagem a ser mostrada para este item na UI.
`price_adjustment`	`Money` O ajuste de preço associado a esse modificador, se houver. É o preço por unidade do modificador.
`integration_attributes`	`ModifierIntegrationAttributes` Metadados associados a essa entidade usada para integrações downstream.

SuggestedModifiers

Uma lista de modificadores para sugerir ao cliente.

Campos

modifiers[]

SuggestedModifier

Os modificadores a serem sugeridos ao cliente.

parent_uid

string

O identificador exclusivo do item/modificador principal a que os modificadores serão aplicados.

SuggestedOptions

Opções para sugerir ao cliente.

Campos

Campo de união suggested_options. As opções sugeridas. suggested_options pode ser apenas de um dos tipos a seguir:

suggested_items

SuggestedItems

Uma lista de itens para sugerir ao cliente.

suggested_modifiers

SuggestedModifiers

Uma lista de modificadores para sugerir ao cliente.

TextInput

A entrada de texto do cliente. Em vez de áudio, o cliente pode enviar entrada de texto para o agente. Um cliente precisa usar entrada de texto ou áudio, não ambas.

Campos

text

string

Obrigatório. A expressão de texto do cliente.

TimeOfDayRange

Representa um período entre dois horários do dia em uma data não especificada. Por exemplo, horário de funcionamento das 9h às 17h.

Campos

start_time

TimeOfDay

Obrigatório. O início do período, inclusive.

end_time

TimeOfDay

Obrigatório. O fim do período, exclusivo. Se end_time for anterior a start_time, isso significa que endtime é no dia seguinte.

TippingInfo

Informações sobre gorjetas.

Campos

Campo de união tip_type. O valor ou a porcentagem da gorjeta. tip_type pode ser apenas de um dos tipos a seguir:

amount

Opcional. Um valor específico para a gorjeta.

percentage_bps

int32

Opcional. Porcentagem em pontos base, por exemplo, 450 = 4,5%.

TurnCompleted

Esse tipo não tem campos.

Indica que o agente de IA de alimentos detectou o fim da conversa atual e não vai fornecer mais respostas para essa vez.

UpdateBrandRequest

Mensagem de solicitação para MenuService.UpdateBrand.

Campos

brand

Brand

Obrigatório. A marca a ser atualizada.

O campo name da marca é usado para identificar a marca a ser atualizada. Formato: projects/{project}/locations/{location}/brands/{brand}

update_mask

Opcional. A lista de campos a serem atualizados

UpdateChannelConfigRequest

Mensagem de solicitação para MenuService.UpdateChannelConfig.

Campos

channel_config

ChannelConfig

Obrigatório. A configuração do canal a ser atualizada.

O campo name da configuração do canal é usado para identificar a configuração a ser atualizada. Formato: projects/{project}/locations/{location}/brands/{brand}/channelConfigs/{channel_config}

update_mask

Opcional. A lista de campos a serem atualizados

UpdateConfigApplicationRuleRequest

Mensagem de solicitação para MenuService.UpdateConfigApplicationRule.

Campos

config_application_rule

ConfigApplicationRule

Obrigatório. A regra de aplicativo de configuração a ser atualizada.

O campo name da regra de aplicativo de configuração é usado para identificar a regra a ser atualizada. Formato: projects/{project}/locations/{location}/brands/{brand}/configApplicationRules/{config_application_rule}

update_mask

Opcional. A lista de campos a serem atualizados

UpdateStoreRequest

Mensagem de solicitação para MenuService.UpdateStore.

Campos

store

Obrigatório. A loja a ser atualizada.

O campo name da loja é usado para identificar a loja a ser atualizada. Formato: projects/{project}/locations/{location}/brands/{brand}/stores/{store}

update_mask

Opcional. A lista de campos a serem atualizados

allow_missing

bool

Opcional. Se definido como "true" e a loja não for encontrada, uma nova loja será criada. Nesse caso, update_mask é ignorado.

UpdatedOrderState

Evento retornado pelo agente que representa uma atualização no estado do pedido.

Campos

order