Package google.cloud.foodorderingaiagent.v1beta

Índice

FoodOrderingService

FoodOrderingService proporciona una API para los agentes de pedidos de comida.

BidiProcessOrder

rpc BidiProcessOrder(BidiProcessOrderRequest) returns (BidiProcessOrderResponse)

Es una API de transmisión bidireccional que procesa entradas continuas del cliente en múltiples modalidades (p.ej., texto, audio) y genera flujos de salida multimodales en tiempo real.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta Authentication Overview.

MenuService proporciona APIs para administrar recursos relacionados con la marca, la tienda y el menú.

BatchDeleteStores

rpc BatchDeleteStores(BatchDeleteStoresRequest) returns (Empty)

Borra tiendas por lotes.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta Authentication Overview.

BatchGetMenuEntities

rpc BatchGetMenuEntities(BatchGetMenuEntitiesRequest) returns (BatchGetMenuEntitiesResponse)

Obtiene por lotes las entidades de un menú.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta Authentication Overview.

BatchUpdateStores

rpc BatchUpdateStores(BatchUpdateStoresRequest) returns (BatchUpdateStoresResponse)

Actualiza tiendas por lotes.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta Authentication Overview.

CreateBrand

rpc CreateBrand(CreateBrandRequest) returns (Brand)

Crea una marca.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta Authentication Overview.

CreateChannelConfig

rpc CreateChannelConfig(CreateChannelConfigRequest) returns (ChannelConfig)

Crea un ChannelConfig.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta Authentication Overview.

CreateConfigApplicationRule

rpc CreateConfigApplicationRule(CreateConfigApplicationRuleRequest) returns (ConfigApplicationRule)

Crea un objeto ConfigApplicationRule.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta Authentication Overview.

CreateMenu

rpc CreateMenu(CreateMenuRequest) returns (Menu)

Crea un menú.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta Authentication Overview.

CreateStore

rpc CreateStore(CreateStoreRequest) returns (Store)

Crea un almacén.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta Authentication Overview.

DeleteBrand

rpc DeleteBrand(DeleteBrandRequest) returns (Empty)

Borra la marca especificada.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta Authentication Overview.

DeleteBrandRevision

rpc DeleteBrandRevision(DeleteBrandRevisionRequest) returns (Empty)

Borra el BrandRevision especificado.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta Authentication Overview.

DeleteChannelConfig

rpc DeleteChannelConfig(DeleteChannelConfigRequest) returns (Empty)

Borra el ChannelConfig especificado.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta Authentication Overview.

DeleteChannelConfigRevision

rpc DeleteChannelConfigRevision(DeleteChannelConfigRevisionRequest) returns (Empty)

Borra el ChannelConfigRevision especificado.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta Authentication Overview.

DeleteConfigApplicationRule

rpc DeleteConfigApplicationRule(DeleteConfigApplicationRuleRequest) returns (Empty)

Borra el ConfigApplicationRule especificado.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta Authentication Overview.

DeleteConfigApplicationRuleRevision

rpc DeleteConfigApplicationRuleRevision(DeleteConfigApplicationRuleRevisionRequest) returns (Empty)

Borra el ConfigApplicationRuleRevision especificado.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta Authentication Overview.

DeleteMenu

rpc DeleteMenu(DeleteMenuRequest) returns (Empty)

Borra el menú especificado.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta Authentication Overview.

DeleteStore

rpc DeleteStore(DeleteStoreRequest) returns (Empty)

Borra el almacén especificado.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta Authentication Overview.

DeleteStoreRevision

rpc DeleteStoreRevision(DeleteStoreRevisionRequest) returns (Empty)

Borra el objeto StoreRevision especificado.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta Authentication Overview.

GetBrand

rpc GetBrand(GetBrandRequest) returns (Brand)

Obtiene una marca.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta Authentication Overview.

GetBrandRevision

rpc GetBrandRevision(GetBrandRevisionRequest) returns (BrandRevision)

Obtiene un objeto BrandRevision.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta Authentication Overview.

GetChannelConfig

rpc GetChannelConfig(GetChannelConfigRequest) returns (ChannelConfig)

Obtiene un ChannelConfig.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta Authentication Overview.

GetChannelConfigRevision

rpc GetChannelConfigRevision(GetChannelConfigRevisionRequest) returns (ChannelConfigRevision)

Obtiene un ChannelConfigRevision.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta Authentication Overview.

GetConfigApplicationRule

rpc GetConfigApplicationRule(GetConfigApplicationRuleRequest) returns (ConfigApplicationRule)

Obtiene un objeto ConfigApplicationRule.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta Authentication Overview.

GetConfigApplicationRuleRevision

rpc GetConfigApplicationRuleRevision(GetConfigApplicationRuleRevisionRequest) returns (ConfigApplicationRuleRevision)

Obtiene un ConfigApplicationRuleRevision.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta Authentication Overview.

GetMenu

rpc GetMenu(GetMenuRequest) returns (Menu)

Obtiene un menú.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta Authentication Overview.

GetStore

rpc GetStore(GetStoreRequest) returns (Store)

Obtiene un almacén.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta Authentication Overview.

GetStoreRevision

rpc GetStoreRevision(GetStoreRevisionRequest) returns (StoreRevision)

Obtiene un StoreRevision.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta Authentication Overview.

ListBrandRevisions

rpc ListBrandRevisions(ListBrandRevisionsRequest) returns (ListBrandRevisionsResponse)

Enumera las BrandRevisions.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta Authentication Overview.

ListBrands

rpc ListBrands(ListBrandsRequest) returns (ListBrandsResponse)

Enumera las marcas.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta Authentication Overview.

ListChannelConfigRevisions

rpc ListChannelConfigRevisions(ListChannelConfigRevisionsRequest) returns (ListChannelConfigRevisionsResponse)

Enumera las revisiones de ChannelConfig.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta Authentication Overview.

ListChannelConfigs

rpc ListChannelConfigs(ListChannelConfigsRequest) returns (ListChannelConfigsResponse)

Enumera ChannelConfigs.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta Authentication Overview.

ListConfigApplicationRuleRevisions

rpc ListConfigApplicationRuleRevisions(ListConfigApplicationRuleRevisionsRequest) returns (ListConfigApplicationRuleRevisionsResponse)

Enumera las revisiones de ConfigApplicationRule.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta Authentication Overview.

ListConfigApplicationRules

rpc ListConfigApplicationRules(ListConfigApplicationRulesRequest) returns (ListConfigApplicationRulesResponse)

Enumera ConfigApplicationRules.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta Authentication Overview.

ListMenus

rpc ListMenus(ListMenusRequest) returns (ListMenusResponse)

Enumera los menús.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta Authentication Overview.

ListStoreRevisions

rpc ListStoreRevisions(ListStoreRevisionsRequest) returns (ListStoreRevisionsResponse)

Enumera StoreRevisions.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta Authentication Overview.

ListStores

rpc ListStores(ListStoresRequest) returns (ListStoresResponse)

Muestra una lista de los almacenes.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta Authentication Overview.

PromoteChannelConfig

rpc PromoteChannelConfig(PromoteChannelConfigRequest) returns (PromoteChannelConfigResponse)

Promueve la configuración del canal especificado.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta Authentication Overview.

UpdateBrand

rpc UpdateBrand(UpdateBrandRequest) returns (Brand)

Actualiza la marca especificada.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta Authentication Overview.

UpdateChannelConfig

rpc UpdateChannelConfig(UpdateChannelConfigRequest) returns (ChannelConfig)

Actualiza el ChannelConfig especificado.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta Authentication Overview.

UpdateConfigApplicationRule

rpc UpdateConfigApplicationRule(UpdateConfigApplicationRuleRequest) returns (ConfigApplicationRule)

Actualiza el ConfigApplicationRule especificado.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta Authentication Overview.

UpdateStore

rpc UpdateStore(UpdateStoreRequest) returns (Store)

Actualiza el almacén especificado.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta Authentication Overview.

AgentAudio

Es la respuesta de audio del agente.

Campos
agent_audio

bytes

Son los datos de audio del agente.

AgentEvent

Es un evento especial del agente que requiere que el cliente realice una acción.

Campos
Campo de unión event. Es el evento del agente. event puede ser solo uno de los parámetros siguientes:
restart_order

RestartOrder

El cliente solicita reiniciar el pedido.

AgentText

Es la respuesta de texto del agente.

Campos
text

string

Es la respuesta de texto del agente.

AudioInput

Es la entrada de audio del cliente. El audio de entrada puede tener varios canales para el cliente, el equipo, etcétera. Todos deben estar sincronizados y en el formato especificado en la configuración. No se deben incluir encabezados de audio. De forma predeterminada, el audio debe usar la codificación de audio PCM lineal de 16 bits y una frecuencia de muestreo de 16,000 Hz. La cantidad total de bytes de todos los canales debe ser inferior a 25,600 bytes.

Campos
customer_audio

bytes

Obligatorio. Son los datos de audio del cliente.

crew_audio

bytes

Es opcional. Datos de audio del equipo. Este es un canal de audio opcional para el miembro del equipo que se encuentra en el mismo carril que el cliente y que se usa como audio de referencia para la cancelación de eco.

Disponibilidad

Define la disponibilidad de un artículo o modificador.

Campos
daypart_availability

DaypartAvailability

Es opcional. Es la información de disponibilidad a nivel de segmentos del día para este elemento. Si se omite, se ignorará la disponibilidad basada en partes del día.

menu_schedule_availability

MenuScheduleAvailability

Es opcional. Es la información de disponibilidad a nivel del programa del menú para este elemento. Si se omite, se ignora la disponibilidad basada en el programa del menú.

status

Status

Es opcional. Indica un estado que lleva a la no disponibilidad o que el elemento está disponible. Si se omite, el elemento estará disponible de forma predeterminada.

fulfillment_availability

FulfillmentMethodAvailability

Es opcional. Son los métodos de entrega para los que está disponible este artículo. Si se omite, el elemento estará disponible para todos los métodos de cumplimiento.

DaypartAvailability

Restringe la disponibilidad de esta entidad a los segmentos del día especificados.

Campos
daypart_ids[]

string

Obligatorio. Son los segmentos del día durante los que está disponible este elemento.

FulfillmentMethodAvailability

Restringe la disponibilidad de esta entidad a los métodos de cumplimiento especificados.

Campos
fulfillment_methods[]

FulfillmentMethod

Obligatorio. Son los métodos de entrega para los que está disponible este artículo.

Restringe la disponibilidad de esta entidad al programa de menú especificado.

Campos
menu_schedule_ids[]

string

Obligatorio. Son los horarios del menú durante los que está disponible este elemento.

Estado

Es el estado de disponibilidad.

Enums
STATUS_UNSPECIFIED El estado no es válido. CreateMenu fallará si algún elemento o modificador tiene este estado.
STATUS_AVAILABLE Indica que el elemento está disponible para la compra.
STATUS_UNAVAILABLE Indica que el elemento no está disponible por motivos ambiguos.
STATUS_OUT_OF_STOCK Indica que el artículo no está disponible en este momento, pero es posible que lo esté en el futuro cercano.
STATUS_DISCONTINUED Indica que el artículo se descontinuó y que no estará disponible en el futuro cercano.

BatchDeleteStoresRequest

Mensaje de solicitud para MenuService.BatchDeleteStores.

Campos
parent

string

Obligatorio. Es el recurso principal que comparten todos los almacenes que se borran. Formato: projects/{project}/locations/{location}/brands/{brand}

names[]

string

Obligatorio. Nombres de los almacenes que se borrarán. Se puede borrar un máximo de 1,000 tiendas en un lote. Formato: projects/{project}/locations/{location}/brands/{brand}/stores/{store}

BatchGetMenuEntitiesRequest

Mensaje de solicitud para MenuService.BatchGetMenuEntities.

Campos
parent

string

Obligatorio. Nombre del menú del que se recuperarán las entidades. Formato: projects/{project}/locations/{location}/menus/{menu}

item_ids[]

string

Es opcional. Son los IDs de los elementos que se recuperarán.

modifier_ids[]

string

Es opcional. Son los IDs de los modificadores que se recuperarán.

modifier_group_ids[]

string

Es opcional. Son los IDs de los grupos de modificadores que se recuperarán.

category_ids[]

string

Es opcional. Son los IDs de las categorías que se recuperarán.

BatchGetMenuEntitiesResponse

Mensaje de respuesta para MenuService.BatchGetMenuEntities.

Campos
items[]

Item

Son los elementos solicitados.

modifiers[]

Modifier

Son los modificadores solicitados.

modifier_groups[]

ModifierGroup

Son los grupos de modificadores solicitados.

categories[]

MenuCategory

Son las categorías solicitadas.

BatchUpdateStoresRequest

Mensaje de solicitud para MenuService.BatchUpdateStores.

Campos
parent

string

Obligatorio. Es el recurso principal que comparten todas las tiendas que se actualizan. Formato: projects/{project}/locations/{location}/brands/{brand}. Si se configura este campo, el elemento superior de todos los comercios especificados en requests debe coincidir con este campo.

requests[]

UpdateStoreRequest

Obligatorio. Es el mensaje de solicitud que especifica los recursos que se actualizarán. Se puede modificar un máximo de 1,000 tiendas en un lote.

BatchUpdateStoresResponse

Mensaje de respuesta para MenuService.BatchUpdateStores.

Campos
stores[]

Store

Se actualizaron las tiendas.

BidiProcessOrderRequest

Es el mensaje de nivel superior que envía el cliente para el método FoodOrderingService.BidiProcessOrder.

Campos
Campo de unión message. Es el mensaje del cliente. El cliente debe enviar un mensaje de configuración primero, antes de enviar cualquier otro mensaje. message puede ser solo uno de los parámetros siguientes:
config

Config

Es la configuración de las propiedades de la sesión y los pedidos de comida.

text_input

TextInput

Es la entrada de texto del cliente.

audio_input

AudioInput

Es la entrada de audio del cliente. El cliente debe usar la entrada de texto o de audio, no ambas.

event_input

EventInput

Es la entrada del evento del cliente.

client_execution_result

ClientExecutionResult

Es el resultado de una solicitud de ejecución del cliente.

BidiProcessOrderResponse

Es el mensaje de nivel superior que muestra el método FoodOrderingService.BidiProcessOrder.

Campos
Campo de unión response. Es la respuesta del agente. response puede ser solo uno de los parámetros siguientes:
agent_audio

AgentAudio

Es la respuesta de audio del agente.

speech_recognition

SpeechRecognition

Es el resultado del reconocimiento de voz del agente.

legacy_order_state_response

Struct

Es la respuesta del estado del pedido heredado para una sesión.

interruption_signal

InterruptionSignal

Se detectó una señal de interrupción en la entrada de audio.

agent_event

AgentEvent

Es el evento del agente.

client_execution_request

ClientExecutionRequest

Es la solicitud que se reenvía al cliente para que la ejecute. Se usa para la ejecución del cliente, como agregar un código al pedido.

updated_order_state

UpdatedOrderState

Indica una actualización del estado del pedido. Incluye el estado completo del pedido.

agent_text

AgentText

Es la respuesta de texto del agente.

suggested_options

SuggestedOptions

Son las opciones que se le sugieren al cliente.

sentiment_measurement

SentimentMeasurement

Es la puntuación de opinión en tiempo real medida para este turno.

turn_completed

TurnCompleted

Mensaje de turno completado.

end_session

EndSession

Indica que la sesión está finalizando y que este será el último turno.

El agente terminará de enviar las respuestas pendientes del turno actual y, luego, enviará un mensaje final de turn_completed. El agente no iniciará ningún turno nuevo. Por ejemplo, una sesión de 2 turnos se verá de la siguiente manera:

  • Turno 1
  • entrada del cliente 1
  • … mensajes de respuesta del agente y de estado del pedido
  • turn_completed
  • Turno 2
  • entrada del cliente 2
  • … mensajes de respuesta del agente y de estado del pedido
  • end_session
  • … mensajes de estado del pedido y respuesta del agente pendientes
  • turn_completed
recommended_orders

RecommendedOrders

Son los pedidos recomendados del agente.

Marca

Marca, que puede ser una cadena de restaurantes o un restaurante individual.

Campos
name

string

Es el identificador. Es el nombre de la marca. Formato: projects/{project}/locations/{location}/brands/{brand}

display_name

string

Es opcional. Es el nombre visible opcional y legible por humanos de esta marca para las interfaces de usuario.

create_time

Timestamp

Solo salida. Fecha y hora en que se creó esta marca.

update_time

Timestamp

Solo salida. Fecha y hora en la que se actualizó esta marca por última vez.

BrandRevision

Es una revisión de una marca.

Campos
name

string

Es el identificador. Es el nombre del recurso de la revisión de la marca. Formato: projects/{project}/locations/{location}/brands/{brand}/revisions/{revision}

snapshot

Brand

Solo salida. Es el estado del recurso de marca en esta revisión.

create_time

Timestamp

Solo salida. Fecha y hora en que se creó la revisión.

created_by

string

Solo salida. Es el correo electrónico del usuario que creó el recurso recientemente.

alternate_ids[]

string

Solo salida. Son los IDs alternativos para esta revisión.

ChannelConfig

Una configuración del canal representa una configuración de estrategia operativa. Ciclo de vida de la configuración del canal: * DRAFT: Una configuración está en estado de borrador cuando no tiene reglas de aplicación de configuración asociadas y no se establece como la configuración predeterminada de la marca. * ACTIVE: Una configuración está en estado activo cuando se asocia con alguna regla de aplicación de configuración o se establece como la predeterminada de la marca. * Cuando está activo, el tiempo de ejecución aplica la configuración del canal a las tiendas coincidentes. Para garantizar la flexibilidad, la relación entre la configuración del canal y la regla de aplicación de la configuración es de uno a varios en cada nivel de recursos: * En el nivel de la marca, existe una relación de uno a varios entre las configuraciones del canal y las reglas de aplicación de la configuración. * A nivel de la tienda, existe otra relación de uno a varios entre las configuraciones del canal y las reglas de aplicación de la configuración. Cuando se pueden aplicar varias configuraciones de canales, el tiempo de ejecución determina la configuración que se aplicará según el siguiente orden de prioridad (la última anula la anterior en caso de conflicto): 1. Es el valor predeterminado a nivel de la marca 2. Vinculación a nivel de la marca 3. El valor predeterminado a nivel de la tienda es 4. Vinculación a nivel de la tienda

Campos
name

string

Es el identificador. Es el nombre de la configuración del canal. Formato: projects/{project}/locations/{location}/brands/{brand}/channelConfigs/{channel_config}

display_name

string

Es opcional. Es el nombre visible opcional de esta configuración del canal para las interfaces de usuario. El valor tiene un límite de 63 caracteres.

create_time

Timestamp

Solo salida. Es la fecha y hora en que se creó esta configuración del canal.

update_time

Timestamp

Solo salida. Fecha y hora en que se actualizó por última vez la configuración de este canal.

state

State

Solo salida. Es el estado de la configuración del canal.

type

Type

Obligatorio. Es el tipo de configuración del canal.

tone

Tone

Es opcional. Es el tono del agente.

config_application_rules[]

ConfigApplicationRule

Solo salida. Son las reglas de configuración de la aplicación asociadas con esta configuración del canal.

Estado

Es el estado de la configuración del canal.

Enums
STATE_UNSPECIFIED El estado no está especificado.
DRAFT La configuración del canal es un borrador y aún no está lista para usarse.
ACTIVE La configuración del canal está activa y se puede usar.
PROMOTED Se promueve la configuración del canal.

Tono

Es el tono del agente.

Enums
TONE_UNSPECIFIED No se especifica el tono.
CONCISE_AND_DIRECT El tono del agente es conciso y directo.
PROFESSIONAL_AND_FORMAL El tono del agente es profesional y formal.
FRIENDLY El tono del agente es amigable.

Tipo

Es el tipo de configuración del canal.

Enums
TYPE_UNSPECIFIED El tipo no está especificado.
UPSELL_STRATEGY La configuración del canal es para la estrategia de ventas sugeridas.
AGENT_CUSTOMIZATION La configuración del canal es para la personalización del agente.

ChannelConfigRevision

Es una revisión de la configuración de un canal.

Campos
name

string

Es el identificador. Es el nombre del recurso de la revisión de la configuración del canal. Formato: projects/{project}/locations/{location}/brands/{brand}/channelConfigs/{channel_config}/revisions/{revision}

snapshot

ChannelConfig

Solo salida. Es el estado del recurso de configuración del canal en esta revisión.

create_time

Timestamp

Solo salida. Fecha y hora en que se creó la revisión.

created_by

string

Solo salida. Es el correo electrónico del usuario que creó el recurso recientemente.

alternate_ids[]

string

Solo salida. Son los IDs alternativos para esta revisión.

ClientAppInfo

Es información sobre el entorno del dispositivo y la aplicación cliente. Se usa principalmente para el registro, las estadísticas y la depuración.

Campos
device_model

string

Es opcional. Modelo del dispositivo del cliente (p. ej., "iPhone 13", "Pixel 7", "Kiosk v2")

os_version

string

Es opcional. Es la versión del sistema operativo del cliente (p.ej., "iOS 16.1", "Android 13").

sdk_version

string

Es opcional. Es la versión del SDK del cliente o del software de la aplicación.

ClientExecutionRequest

Es una solicitud para que el cliente ejecute un comando.

Campos
execution_id

string

Obligatorio. Es un ID único para esta solicitud de ejecución.

Campo de unión request. Es la solicitud específica que se ejecutará. request puede ser solo uno de los parámetros siguientes:
finalize_order_request

FinalizeOrderRequest

Es una solicitud para finalizar el pedido.

submit_order_request

SubmitOrderRequest

Es una solicitud para enviar el pedido.

ClientExecutionResult

Es el resultado de una solicitud de ejecución del cliente.

Campos
execution_id

string

Obligatorio. Es el ID de la solicitud de ejecución para la que se muestra este resultado.

Campo de unión response. Es el resultado específico de la ejecución. response puede ser solo uno de los parámetros siguientes:
finalize_order_response

FinalizeOrderResponse

Es el resultado de la finalización del pedido.

submit_order_response

SubmitOrderResponse

Es el resultado del envío del pedido.

Configuración

Es la configuración de una sesión y las propiedades de pedidos de comida. Al comienzo de cada conexión, el cliente primero debe enviar un mensaje de configuración. Esto debe ocurrir antes de cualquier otra solicitud para iniciar la sesión. Si el cliente se desconecta, debe repetir el mismo mensaje de configuración cuando se vuelva a conectar.

Campos
session

string

Obligatorio. Es la sesión del pedido. Formato: projects/{project}/locations/{location}/sessions/{session}

store

string

Obligatorio. Es la tienda para la que se realiza el pedido. Formato: projects/{project}/locations/{location}/brands/{brand}/stores/{store}

lane_id

string

Es opcional. Es el ID de un carril específico de una tienda con acceso vehicular.

enable_echo_cancellation

bool

Es opcional. Indica si se debe habilitar la cancelación de eco para la sesión. Si está habilitado, el cliente debe proporcionar customer_audio y crew_audio en AudioInput.

daypart_id

string

Es opcional. Es la parte del día del menú de comida, que incluye el desayuno, el almuerzo, la cena, etcétera. Se usa para determinar el menú que se usará para el pedido.

user_info

UserInfo

Es opcional. Es la información personal del usuario final que se comparte con el agente.

order_type
(deprecated)

OrderType

Es opcional. Obsoleto: Usa initial_order.fulfillment.fulfillment_type en su lugar. Es el tipo de orden que se colocará.

initial_order

Order

Es opcional. Es el pedido inicial antes de iniciar la sesión del agente. Si se proporciona, el agente lo usará como el estado inicial del pedido.

feature_gate

FeatureGate

Es opcional. Son los interruptores de funciones de la sesión. Se usa para habilitar o inhabilitar funciones para la sesión.

initial_utterance

string

Es opcional. Es la primera expresión del cliente para iniciar la conversación. Si se proporciona, el agente lo usará como la primera expresión del usuario y no comenzará con un mensaje de saludo.

client_app_info

ClientAppInfo

Es opcional. Es la información sobre el entorno del dispositivo y la aplicación cliente.

ConfigApplicationRule

Es una regla que representa las condiciones para aplicar configuraciones del agente.

Campos
name

string

Es el identificador. Es el nombre de la regla de aplicación de la configuración. Formato: projects/{project}/locations/{location}/brands/{brand}/configApplicationRules/{config_application_rule}

display_name

string

Es opcional. Nombre visible opcional para esta regla de configuración de la aplicación para interfaces de usuario. El valor tiene un límite de 63 caracteres.

create_time

Timestamp

Solo salida. Es la fecha y hora en que se creó esta regla de aplicación de la configuración.

update_time

Timestamp

Solo salida. Fecha y hora en que se actualizó por última vez esta regla de aplicación de la configuración.

ConfigApplicationRuleRevision

Es una revisión de una regla de configuración de la aplicación.

Campos
name

string

Es el identificador. Es el nombre del recurso de la revisión de la regla de configuración de la aplicación. Formato: projects/{project}/locations/{location}/brands/{brand}/configApplicationRules/{config_application_rule}/revisions/{revision}

snapshot

ConfigApplicationRule

Solo salida. Es el estado del recurso de regla de aplicación de la configuración en esta revisión.

create_time

Timestamp

Solo salida. Fecha y hora en que se creó la revisión.

created_by

string

Solo salida. Es el correo electrónico del usuario que creó el recurso recientemente.

alternate_ids[]

string

Solo salida. Son los IDs alternativos para esta revisión.

CreateBrandRequest

Mensaje de solicitud para MenuService.CreateBrand.

Campos
parent

string

Obligatorio. Es el elemento superior, que es propietario de esta colección de marcas. Formato: projects/{project}/locations/{location}

brand

Brand

Obligatorio. Es la marca que se creará.

brand_id

string

Es opcional. Es el ID que se usará para la marca, que se convertirá en el componente final del nombre del recurso de la marca.

Este valor solo debe contener letras minúsculas, números y guiones, con el primer y el último carácter como una letra o un número, y un máximo de 63 caracteres.

CreateChannelConfigRequest

Mensaje de solicitud para MenuService.CreateChannelConfig.

Campos
parent

string

Obligatorio. Es la marca principal, que es propietaria de esta colección de configuraciones de canales. Formato: projects/{project}/locations/{location}/brands/{brand}

channel_config

ChannelConfig

Obligatorio. Es la configuración del canal que se creará.

channel_config_id

string

Es opcional. Es el ID que se usará para la configuración del canal, que se convertirá en el componente final del nombre del recurso de la configuración del canal.

Este valor solo debe contener letras en minúscula, números y guiones, con un máximo de 63 caracteres. El primer carácter debe ser una letra y el último debe ser una letra o un número.

CreateConfigApplicationRuleRequest

Mensaje de solicitud para MenuService.CreateConfigApplicationRule.

Campos
parent

string

Obligatorio. Es la marca principal, que es propietaria de esta colección de reglas de aplicación de la configuración. Formato: projects/{project}/locations/{location}/brands/{brand}

config_application_rule

ConfigApplicationRule

Obligatorio. Es la regla de configuración de la aplicación que se creará.

config_application_rule_id

string

Es opcional. Es el ID que se usará para la regla de aplicación de la configuración, que se convertirá en el componente final del nombre del recurso de la regla de aplicación de la configuración.

Este valor solo debe contener letras minúsculas, números y guiones, con el primer y el último carácter como una letra o un número, y un máximo de 63 caracteres.

CreateMenuRequest

Mensaje de solicitud para MenuService.CreateMenu.

Campos
parent

string

Obligatorio. Es el elemento superior, que es propietario de esta colección de menús. Formato: projects/{project}/locations/{location}

menu_id

string

Es opcional. Es el ID que se usará para el menú, que se convertirá en el componente final del nombre del recurso del menú.

Este valor solo debe contener letras minúsculas, números y guiones, con el primer y el último carácter como una letra o un número, y un máximo de 63 caracteres.

menu

Menu

Obligatorio. Es el menú que se creará.

CreateStoreRequest

Mensaje de solicitud para MenuService.CreateStore.

Campos
parent

string

Obligatorio. Es la marca principal, que es propietaria de esta colección de tiendas. Formato: projects/{project}/locations/{location}/brands/{brand}

store_id

string

Es opcional. Es el ID de la tienda que se usará para la tienda, que se convertirá en el componente final del nombre del recurso de la tienda.

Este valor solo debe contener letras minúsculas, números y guiones, con el primer y el último carácter como una letra o un número, y un máximo de 63 caracteres.

store

Store

Obligatorio. Es el almacén que se creará.

DateRange

Representa un período, incluidos ambos extremos.

Campos
start_date

Date

Obligatorio. Fecha de inicio del período, inclusive.

end_date

Date

Obligatorio. Es la fecha de finalización del rango, incluida.

DeleteBrandRequest

Mensaje de solicitud para MenuService.DeleteBrand.

Campos
name

string

Obligatorio. Es el nombre de la marca que se borrará. Formato: projects/{project}/locations/{location}/brands/{brand}

DeleteBrandRevisionRequest

Mensaje de solicitud para MenuService.DeleteBrandRevision.

Campos
name

string

Obligatorio. Es el nombre de la revisión de la marca que se borrará. Formato: projects/{project}/locations/{location}/brands/{brand}/revisions/{revision}

DeleteChannelConfigRequest

Mensaje de solicitud para MenuService.DeleteChannelConfig.

Campos
name

string

Obligatorio. Es el nombre de la configuración del canal que se borrará. Formato: projects/{project}/locations/{location}/brands/{brand}/channelConfigs/{channel_config}

DeleteChannelConfigRevisionRequest

Mensaje de solicitud para MenuService.DeleteChannelConfigRevision.

Campos
name

string

Obligatorio. Es el nombre de la revisión de la configuración del canal que se borrará. Formato: projects/{project}/locations/{location}/brands/{brand}/channelConfigs/{channel_config}/revisions/{revision}

DeleteConfigApplicationRuleRequest

Mensaje de solicitud para MenuService.DeleteConfigApplicationRule.

Campos
name

string

Obligatorio. Es el nombre de la regla de configuración de la aplicación que se borrará. Formato: projects/{project}/locations/{location}/brands/{brand}/configApplicationRules/{config_application_rule}

DeleteConfigApplicationRuleRevisionRequest

Mensaje de solicitud para MenuService.DeleteConfigApplicationRuleRevision.

Campos
name

string

Obligatorio. Es el nombre de la revisión de la regla de configuración de la aplicación que se borrará. Formato: projects/{project}/locations/{location}/brands/{brand}/configApplicationRules/{config_application_rule}/revisions/{revision}

DeleteMenuRequest

Mensaje de solicitud para MenuService.DeleteMenu.

Campos
name

string

Obligatorio. Es el nombre del menú que se borrará. Formato: projects/{project}/locations/{location}/menus/{menu}

DeleteStoreRequest

Mensaje de solicitud para MenuService.DeleteStore.

Campos
name

string

Obligatorio. Es el nombre del almacén que se borrará. Formato: projects/{project}/locations/{location}/brands/{brand}/stores/{store}

DeleteStoreRevisionRequest

Mensaje de solicitud para MenuService.DeleteStoreRevision.

Campos
name

string

Obligatorio. Es el nombre de la revisión del almacén que se borrará. Formato: projects/{project}/locations/{location}/brands/{brand}/stores/{store}/revisions/{revision}

EndSession

Indica que el agente finalizó la sesión, ya sea porque se completó correctamente (p.ej., el usuario dice "¡Adiós!") ) o una derivación al agente.

Campos
type

EndType

Es el tipo de evento de finalización de sesión.

reason

string

Es el motivo por el que se finalizó la sesión.

EndType

Es el tipo de evento de finalización de sesión.

Enums
END_TYPE_UNSPECIFIED No se especificó el tipo de finalización.
DRIVE_OFF El cliente se fue.
AGENT_ESCALATION El agente derivó la sesión a un agente humano.
CREW_INTERJECTION Un miembro del equipo interrumpió la sesión.
ORDER_COMPLETED El pedido se completó correctamente y no se requiere ninguna otra acción.
PAYMENT_FLOW_SUCCESS El flujo de pago se completó correctamente y no es necesario realizar ninguna otra acción.
PAYMENT_FLOW_FAILURE Se produjo un error en el flujo de pago.
CLIENT_ESCALATION El cliente derivó la sesión a un agente humano.
CALLER_HANGUP El cliente cortó la llamada antes de tiempo.

EventInput

Es la entrada del evento del cliente. Se usa para activar eventos específicos dentro del agente.

Campos
Campo de unión event. ID siguiente: 9. Es el evento que se activará. event puede ser solo uno de los parámetros siguientes:
drive_off_event

DriveOffEvent

Es el evento de inicio de la conducción.

crew_interjection_event

CrewInterjectionEvent

Es el evento de interrupción del equipo.

update_order_state_event

OrderStateUpdateEvent

Es una actualización del estado del pedido del cliente.

client_escalation_event

ClientEscalationEvent

Es un evento de derivación del cliente.

customized_input_event

CustomizedInputEvent

Es un evento de entrada personalizado.

caller_hangup_event

CallerHangupEvent

Es opcional. Es un evento de corte de llamada.

CallerHangupEvent

Este tipo no tiene campos.

Indica que el cliente cortó la llamada antes de tiempo (p.ej., aversión a la IA).

ClientEscalationEvent

Indica que el cliente está derivando la sesión a un agente humano.

Campos
reason

string

Es opcional. Es el motivo de la derivación del cliente, p.ej., "payment-declined", "pos-error", "integration-error", etcétera.

CrewInterjectionEvent

Es el evento de interrupción del equipo. Esto indica que un miembro del equipo interrumpió la sesión. La sesión se cerrará después de este evento.

Campos
mode

string

Es opcional. Es el modo en el que intervino el miembro del equipo, p.ej., "auriculares", "pos".

CustomizedInputEvent

Este campo permite que un cliente de IA para alimentos envíe un evento personalizado al agente. De forma predeterminada, no realiza ninguna operación. Comunícate con el equipo de asistencia al cliente para habilitar esta función.

Campos
input

Struct

Obligatorio. Es la entrada del cliente al agente.

DriveOffEvent

Es el evento de inicio de la conducción. Indica que el cliente se fue. La sesión se cerrará después de este evento.

Campos
reason

string

Es opcional. Es el motivo por el que el vehículo se alejó, p.ej., "pedido completado", "alejamiento inesperado".

OrderStateUpdateEvent

Es la solicitud para actualizar el estado del pedido. Este evento se debe enviar cuando se actualiza el pedido en el cliente, p.ej., cuando se agrega o quita un elemento a través de una interfaz táctil tradicional.

Campos
order

Order

Obligatorio. Es el estado actualizado del pedido asociado a esta sesión.

FeatureGate

Son los interruptores de funciones de la sesión. Se usa para habilitar o inhabilitar funciones para la sesión.

Campos
trigger_offer_engine_on_demand

bool

Es opcional. Solo para público limitado: Si se configura, el motor de ofertas será opcional en el flujo de pagos y solo se activará cuando los usuarios lo soliciten.

trigger_loyalty_on_demand

bool

Es opcional. Solo para público limitado: Si se configura, la lealtad será opcional en el flujo de pago y solo se activará cuando los usuarios la soliciten.

trigger_order_media_assistant_on_demand

bool

Es opcional. Solo para público limitado. Si se configura, el asistente de medios para pedidos será opcional y solo se activará cuando los usuarios lo soliciten.

menu_response_enabled

bool

Es opcional. Devuelve los datos del menú al cliente en BidiProcessOrderResponse si se configura.

revamped_payment_flow_enabled

bool

Es opcional. Solo para público limitado. Si se configura, se usará una versión renovada del flujo de pagos.

FinalizeOrderRequest

Este tipo no tiene campos.

Es una solicitud para finalizar el pedido.

FinalizeOrderResponse

Es el resultado de la finalización del pedido.

Campos
payment_flow_enabled

bool

Es opcional. Indica si se debe habilitar el flujo de procesamiento de pagos en el agente.

payment_info

PaymentInfo

Es opcional. Es la información de pago del cliente. No se realiza ninguna operación si payment_flow_enabled es falso.

total_amount_due

Money

Es opcional. Es el importe total adeudado del pedido.

FulfillmentMethod

Es el método de cumplimiento de un pedido.

Enums
FULFILLMENT_METHOD_UNSPECIFIED No se especificó el método de cumplimiento.
FULFILLMENT_METHOD_DINE_IN Es un pedido que el cliente consumirá en la tienda.
FULFILLMENT_METHOD_PICKUP Es un pedido que el cliente retirará en la tienda.
FULFILLMENT_METHOD_DRIVE_THRU Un pedido realizado en un servicio de pedidos desde el auto.
FULFILLMENT_METHOD_DELIVERY Es un pedido que se entregará al cliente.
FULFILLMENT_METHOD_CURBSIDE Es un pedido para retirar en la puerta. El cliente estacionará su automóvil en un lugar designado fuera de la tienda, y se le acercará el pedido.

GetBrandRequest

Mensaje de solicitud para MenuService.GetBrand.

Campos
name

string

Obligatorio. Es el nombre de la marca que se recuperará. Formato: projects/{project}/locations/{location}/brands/{brand}

GetBrandRevisionRequest

Mensaje de solicitud para MenuService.GetBrandRevision.

Campos
name

string

Obligatorio. Es el nombre de la revisión de la marca que se recuperará. Formato: projects/{project}/locations/{location}/brands/{brand}/revisions/{revision}

GetChannelConfigRequest

Mensaje de solicitud para MenuService.GetChannelConfig.

Campos
name

string

Obligatorio. Es el nombre de la configuración del canal que se recuperará. Formato: projects/{project}/locations/{location}/brands/{brand}/channelConfigs/{channel_config}

GetChannelConfigRevisionRequest

Mensaje de solicitud para MenuService.GetChannelConfigRevision.

Campos
name

string

Obligatorio. Es el nombre de la revisión de la configuración del canal que se recuperará. Formato: projects/{project}/locations/{location}/brands/{brand}/channelConfigs/{channel_config}/revisions/{revision}

GetConfigApplicationRuleRequest

Mensaje de solicitud para MenuService.GetConfigApplicationRule.

Campos
name

string

Obligatorio. Es el nombre de la regla de configuración de la aplicación que se recuperará. Formato: projects/{project}/locations/{location}/brands/{brand}/configApplicationRules/{config_application_rule}

GetConfigApplicationRuleRevisionRequest

Mensaje de solicitud para MenuService.GetConfigApplicationRuleRevision.

Campos
name

string

Obligatorio. Es el nombre de la revisión de la regla de configuración de la aplicación que se recuperará. Formato: projects/{project}/locations/{location}/brands/{brand}/configApplicationRules/{config_application_rule}/revisions/{revision}

GetMenuRequest

Mensaje de solicitud para MenuService.GetMenu.

Campos
name

string

Obligatorio. Nombre del menú que se recuperará. Formato: projects/{project}/locations/{location}/menus/{menu}

GetStoreRequest

Mensaje de solicitud para MenuService.GetStore.

Campos
name

string

Obligatorio. Es el nombre del almacén que se recuperará. Formato: projects/{project}/locations/{location}/brands/{brand}/stores/{store}

GetStoreRevisionRequest

Mensaje de solicitud para MenuService.GetStoreRevision.

Campos
name

string

Obligatorio. Es el nombre de la revisión del almacén que se recuperará. Formato: projects/{project}/locations/{location}/brands/{brand}/stores/{store}/revisions/{revision}

Imagen

Es la imagen que se mostrará para una entidad de menú.

Campos
source_uri

string

Obligatorio. Es el URI de origen de la imagen.

InterruptionSignal

Este tipo no tiene campos.

Indica que se interrumpió la respuesta de audio del agente (p.ej., por una interrupción del usuario final). El cliente debe detener la reproducción de inmediato.

Elemento

El elemento representa una entidad de menú que solo es válida como elemento de nivel superior dentro de un pedido. El elemento puede representar un solo alimento, bebida, servicio, promoción o comida combinada que se puede modificar con varias opciones.

Campos
id

string

Obligatorio. Es el identificador de este elemento, que es único dentro del menú.

semantic_name

string

Es opcional. Nombre conciso y legible que identifica este elemento de forma clara y distintiva. Debe ser único entre los elementos del menú.

display_name

string

Obligatorio. Nombre legible de este elemento que se usará en las interfaces de usuario.

category_ids[]

string

Es opcional. Es la categoría del elemento.

description

string

Es opcional. Es una descripción legible por humanos.

image

Image

Es opcional. Imagen que se mostrará para este elemento en la IU.

availability

Availability

Es opcional. Disponibilidad del artículo.

base_price

Money

Es opcional. Es el precio base del artículo. Esto puede verse afectado por los modificadores seleccionados.

integration_attributes

ItemIntegrationAttributes

Es opcional. Son los metadatos asociados a esta entidad que se usan para las integraciones posteriores.

modifier_groups[]

ModifierGroupReference

Es opcional. Son referencias a los grupos de modificadores que se aplican a este elemento.

modifier_constraints

ModifierConstraints

Es opcional. Restringe qué modificadores se pueden o deben aplicar a este elemento en los ModifierGroups a los que se hace referencia.

ItemIntegrationAttributes

Son los metadatos asociados con un elemento que se usa para las integraciones posteriores.

Campos
custom_integration_attributes

Struct

Es opcional. Son metadatos arbitrarios que se asocian a una entidad y se usan para crear integraciones posteriores, es decir, identificadores o información de esquema para construir un pedido que se enviará a una API de punto de venta de terceros.

stream_attributes

StreamIntegrationAttributes

Es opcional. Representa los metadatos asociados a este elemento que se usan para la integración de transmisiones. Si la integración de Stream no está habilitada para la tienda, este campo se ignora.

toast_attributes

ToastIntegrationAttributes

Es opcional. Representa los metadatos asociados a este elemento que se usan para la integración de Toast. Si la integración de Toast no está habilitada para la tienda, se ignora este campo.

StreamIntegrationAttributes

Representa los atributos de un elemento de un menú de transmisión.

Campos
taxes[]

Tax

Es opcional. Representa los porcentajes de impuestos que se aplican a este elemento.

item_family_id

string

Es opcional. Representa la familia de artículos que contiene esta variante del artículo en el menú de Stream.

Impuesto

Es la información de la tasa impositiva asociada a este artículo.

Campos
stream_id

string

Obligatorio. ID del impuesto en el menú Stream

is_inclusive

bool

Es opcional. Determina si el importe del impuesto ya está incluido en el precio del artículo.

rate

float

Obligatorio. Es la tasa del impuesto como porcentaje.

display_name

string

Es opcional. Es el nombre del impuesto.

is_default

bool

Es opcional. Indica si el impuesto es el predeterminado.

ToastIntegrationAttributes

Representa los atributos de un elemento de un menú de aviso.

Campos
menu_group_guid

string

Es opcional. Representa el GUID del grupo de menú del elemento en el menú de Toast.

ListBrandRevisionsRequest

Mensaje de solicitud para MenuService.ListBrandRevisions.

Campos
parent

string

Obligatorio. Es la marca principal, que es propietaria de esta colección de revisiones. Formato: projects/{project}/locations/{location}/brands/{brand}

page_size

int32

Es opcional. Es la cantidad máxima de revisiones que se devolverán. El servicio puede mostrar menos que este valor.

page_token

string

Es opcional. Un token de página, recibido desde una llamada ListBrandRevisions anterior. Proporciona esto para recuperar la página siguiente.

ListBrandRevisionsResponse

Mensaje de respuesta para MenuService.ListBrandRevisions.

Campos
brand_revisions[]

BrandRevision

Son las revisiones de la marca de la colección especificada.

next_page_token

string

Un token, que se puede enviar como page_token para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.

ListBrandsRequest

Mensaje de solicitud para MenuService.ListBrands.

Campos
parent

string

Obligatorio. Es el elemento superior, que es propietario de esta colección de marcas. Formato: projects/{project}/locations/{location}

page_size

int32

Es opcional. Es la cantidad máxima de marcas que se devolverán. El servicio puede mostrar menos que este valor.

page_token

string

Es opcional. Un token de página, recibido desde una llamada ListBrands anterior. Proporciona esto para recuperar la página siguiente.

ListBrandsResponse

Mensaje de respuesta para MenuService.ListBrands.

Campos
brands[]

Brand

Son las marcas de la colección especificada.

next_page_token

string

Un token, que se puede enviar como page_token para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.

ListChannelConfigRevisionsRequest

Mensaje de solicitud para MenuService.ListChannelConfigRevisions.

Campos
parent

string

Obligatorio. Es la configuración del canal principal, que es propietario de esta colección de revisiones. Formato: projects/{project}/locations/{location}/brands/{brand}/channelConfigs/{channel_config}

page_size

int32

Es opcional. Es la cantidad máxima de revisiones que se devolverán. El servicio puede mostrar menos que este valor.

page_token

string

Es opcional. Un token de página, recibido desde una llamada ListChannelConfigRevisions anterior. Proporciona esto para recuperar la página siguiente.

ListChannelConfigRevisionsResponse

Mensaje de respuesta para MenuService.ListChannelConfigRevisions.

Campos
channel_config_revisions[]

ChannelConfigRevision

Son las revisiones de la configuración del canal de la colección especificada.

next_page_token

string

Un token, que se puede enviar como page_token para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.

ListChannelConfigsRequest

Mensaje de solicitud para MenuService.ListChannelConfigs.

Campos
parent

string

Obligatorio. Es la marca principal, que es propietaria de esta colección de configuraciones de canales. Formato: projects/{project}/locations/{location}/brands/{brand}

page_size

int32

Es opcional. Es la cantidad máxima de configuraciones de canales que se devolverán. El servicio puede mostrar menos que este valor.

page_token

string

Es opcional. Un token de página, recibido desde una llamada ListChannelConfigs anterior. Proporciona esto para recuperar la página siguiente.

filter

string

Es opcional. Es una expresión de filtro que filtra los resultados. La sintaxis de la expresión se documenta en https://google.aip.dev/160.

Se admiten los siguientes campos: - type

Ejemplos: - type="AGENT_CUSTOMIZATION"

ListChannelConfigsResponse

Mensaje de respuesta para MenuService.ListChannelConfigs.

Campos
channel_configs[]

ChannelConfig

Son los parámetros de configuración del canal de la colección especificada.

next_page_token

string

Un token, que se puede enviar como page_token para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.

ListConfigApplicationRuleRevisionsRequest

Mensaje de solicitud para MenuService.ListConfigApplicationRuleRevisions.

Campos
parent

string

Obligatorio. Es la regla de aplicación de la configuración principal, que es propietaria de esta colección de revisiones. Formato: projects/{project}/locations/{location}/brands/{brand}/configApplicationRules/{config_application_rule}

page_size

int32

Es opcional. Es la cantidad máxima de revisiones que se devolverán. El servicio puede mostrar menos que este valor.

page_token

string

Es opcional. Un token de página, recibido desde una llamada ListConfigApplicationRuleRevisions anterior. Proporciona esto para recuperar la página siguiente.

ListConfigApplicationRuleRevisionsResponse

Mensaje de respuesta para MenuService.ListConfigApplicationRuleRevisions.

Campos
config_application_rule_revisions[]

ConfigApplicationRuleRevision

Son las revisiones de la regla de aplicación de la configuración de la colección especificada.

next_page_token

string

Un token, que se puede enviar como page_token para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.

ListConfigApplicationRulesRequest

Mensaje de solicitud para MenuService.ListConfigApplicationRules.

Campos
parent

string

Obligatorio. Es la marca principal, que es propietaria de esta colección de reglas de aplicación de la configuración. Formato: projects/{project}/locations/{location}/brands/{brand}

page_size

int32

Es opcional. Es la cantidad máxima de reglas de aplicación de la configuración que se devolverán. El servicio puede mostrar menos que este valor.

page_token

string

Es opcional. Un token de página, recibido desde una llamada ListConfigApplicationRules anterior. Proporciona esto para recuperar la página siguiente.

ListConfigApplicationRulesResponse

Mensaje de respuesta para MenuService.ListConfigApplicationRules.

Campos
config_application_rules[]

ConfigApplicationRule

Son las reglas de configuración de la aplicación de la colección especificada.

next_page_token

string

Un token, que se puede enviar como page_token para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.

ListMenusRequest

Mensaje de solicitud para MenuService.ListMenus.

Campos
parent

string

Obligatorio. Es el elemento superior, que es propietario de esta colección de menús. Formato: projects/{project}/locations/{location}

page_size

int32

Es opcional. Es la cantidad máxima de menús que se devolverán. El servicio puede mostrar menos que este valor.

page_token

string

Es opcional. Un token de página, recibido desde una llamada ListMenus anterior. Proporciona esto para recuperar la página siguiente.

filter

string

Es opcional. Es una expresión de filtro que filtra los resultados. La sintaxis de la expresión se documenta en https://google.aip.dev/160.

Se admiten los siguientes campos: - store

store=projects/my-project/locations/us-central1/brands/my-brand/stores/my-store

view

MenuView

Es opcional. Es la vista que se devolverá para los menús.

ListMenusResponse

Mensaje de respuesta para MenuService.ListMenus.

Campos
menus[]

Menu

Son los menús de la colección especificada.

next_page_token

string

Un token, que se puede enviar como page_token para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.

ListStoreRevisionsRequest

Mensaje de solicitud para MenuService.ListStoreRevisions.

Campos
parent

string

Obligatorio. Es el almacén principal, que es propietario de esta colección de revisiones. Formato: projects/{project}/locations/{location}/brands/{brand}/stores/{store}

page_size

int32

Es opcional. Es la cantidad máxima de revisiones que se devolverán. El servicio puede mostrar menos que este valor.

page_token

string

Es opcional. Un token de página, recibido desde una llamada ListStoreRevisions anterior. Proporciona esto para recuperar la página siguiente.

ListStoreRevisionsResponse

Mensaje de respuesta para MenuService.ListStoreRevisions.

Campos
store_revisions[]

StoreRevision

Son las revisiones de la tienda de la colección especificada.

next_page_token

string

Un token, que se puede enviar como page_token para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.

ListStoresRequest

Mensaje de solicitud para MenuService.ListStores.

Campos
parent

string

Obligatorio. Es la marca principal, que es propietaria de esta colección de tiendas. Formato: projects/{project}/locations/{location}/brands/{brand}

page_size

int32

Es opcional. Es la cantidad máxima de menús que se devolverán. El servicio puede mostrar menos que este valor.

page_token

string

Es opcional. Un token de página, recibido desde una llamada ListMenus anterior. Proporciona esto para recuperar la página siguiente.

filter

string

Es opcional. Es una expresión de filtro basada en AIP-160. Permite filtrar tiendas según varios atributos. Campos de filtro admitidos:

  • status (String): Es el estado de la tienda. Operadores: =, != Ejemplo: status = "ACTIVE" (valor de enumeración)

  • update_time (Timestamp): Es la fecha y hora de la última actualización de la tienda. Las marcas de tiempo esperan una cadena con formato RFC-3339 (p.ej., 2012-04-21T11:30:00-04:00). Se admiten los operadores de desplazamiento de UTC: =, !=, >, >=, <, <= Ejemplo: update_time >= "2025-10-01T00:00:00Z"

  • etiquetas (cadena): Son las etiquetas asociadas con la tienda. Operador: : (HAS) Ejemplo: tags:"store-tag"

  • city (cadena): La ciudad de la tienda. Operadores: =, != Ejemplo: city = "Mountain View"

  • state (cadena): Es el estado de la dirección de la tienda. Operadores: =, != Ejemplo: state = "CA"

Operadores lógicos:

Las condiciones se pueden combinar con AND, OR y NOT. Los paréntesis () se pueden usar para agrupar expresiones y controlar el orden de evaluación. Ejemplo: status = "ACTIVE" AND state = "CA"

ListStoresResponse

Mensaje de respuesta para MenuService.ListStores.

Campos
stores[]

Store

Son las tiendas de la colección especificada.

next_page_token

string

Un token, que se puede enviar como page_token para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.

LoyaltyAmount

Representa el importe de lealtad de un cliente.

Campos
units

int64

Obligatorio. Son los puntos de lealtad.

LoyaltyInfo

Representa la información de lealtad de un cliente.

Campos
loyalty_amount

LoyaltyAmount

Obligatorio. Es el importe de lealtad. Puede ser un saldo de lealtad o lealtad consumida.

Define un menú de lo que se puede pedir en un restaurante.

Campos
name

string

Es el identificador. Es el nombre del menú. Formato: projects/{project}/locations/{location}/menus/{menu}

store

string

Es opcional. Es el nombre del recurso de la tienda con la que se asocia este menú. Formato: projects/{project}/locations/{location}/brands/{brand}/stores/{store}

display_name

string

Es opcional. Nombre visible opcional y legible por humanos para este menú en las interfaces de usuario.

items[]

Item

Es opcional. Son los elementos de este menú.

modifiers[]

Modifier

Es opcional. Son los modificadores de elementos en este menú.

modifier_groups[]

ModifierGroup

Es opcional. Son los grupos de modificadores en este menú.

categories[]

MenuCategory

Es opcional. Son las categorías del menú.

create_time

Timestamp

Solo salida. Es la fecha y hora en que se creó este menú.

update_time

Timestamp

Solo salida. Fecha y hora en la que se actualizó este menú por última vez.

labels[]

MenuLabel

Es opcional. Son las etiquetas de este menú.

menu_schedules[]

MenuSchedule

Es opcional. Programas de menú en este menú.

Define una categoría que contiene elementos o modificadores. Las categorías se usan para organizar elementos en las interfaces de usuario y para agrupar semánticamente la comprensión del agente.

Campos
id

string

Obligatorio. Es el identificador de esta categoría del menú, que es único dentro del menú.

display_name

string

Es opcional. Nombre legible de esta categoría del menú que se usará en las interfaces de usuario.

description

string

Es opcional. Es una descripción legible por humanos.

parent_id

string

Es opcional. Es el ID de la categoría del menú principal. Si está vacío, se trata de una categoría de nivel superior.

Son etiquetas de cadena para describir un menú en las IU.

Campos
name

string

Obligatorio. Nombre de la etiqueta.

Define el programa del menú para los elementos y los modificadores.

Campos
id

string

Es opcional. Es el ID de la programación, por ejemplo, "BREAKFAST", "LUNCH", etcétera.

schedules[]

Schedule

Es opcional. Programar las horas activas

display_name

string

Es opcional. Especifica un nombre visible opcional para este programa.

Especifica el nivel de detalle que se mostrará para los menús.

Enums
MENU_VIEW_UNSPECIFIED Es el valor predeterminado o no establecido. La API usará la vista FULL de forma predeterminada.
MENU_VIEW_BASIC Incluye metadatos básicos sobre el menú.
MENU_VIEW_NAME_ONLY Solo incluye el nombre del menú.
MENU_VIEW_FULL Incluye todo. Este es el valor predeterminado.

Modificador

Define las opciones de modificación realizadas en los elementos o en otros modificadores, a través de las relaciones definidas por ModifierGroup.

Campos
id

string

Obligatorio. Identificador de este modificador, que es único dentro del menú.

display_name

string

Obligatorio. Nombre legible de este elemento que se usará en las interfaces de usuario.

description

string

Es opcional. Es una descripción legible por humanos.

image

Image

Es opcional. Imagen que se mostrará para este elemento en la IU.

semantic_name

string

Es opcional. Nombre conciso y legible que identifica de forma clara y distintiva este modificador. Debe ser único entre los modificadores de los ModifierGroups en los que existe este modificador.

category_ids[]

string

Es opcional. Es la categoría del modificador.

availability

Availability

Es opcional. Es la disponibilidad de este modificador.

price_adjustment

Money

Es opcional. Es un ajuste aditivo que se aplica al precio del elemento de nivel superior cuando se selecciona este modificador. Déjalo vacío si el modificador no afecta el precio.

integration_attributes

ModifierIntegrationAttributes

Es opcional. Son los metadatos asociados a esta entidad que se usan para las integraciones posteriores.

modifier_groups[]

ModifierGroupReference

Es opcional. Son referencias a los grupos de modificadores que se aplican a este modificador.

modifier_constraints

ModifierConstraints

Es opcional. Restringe qué modificadores se pueden o deben aplicar a este modificador en los ModifierGroups a los que se hace referencia.

ModifierAction

Define una acción que se puede realizar en los modificadores.

Campos
name

string

Obligatorio. Nombre de la acción del modificador, p.ej., "NO", "SIDE", "ADD", "EXTRA".

ModifierConstraints

Restringe qué modificadores se pueden o deben aplicar a una entidad en los ModifierGroups a los que se hace referencia.

Campos
min_quantity

int32

Es opcional. Es la cantidad mínima de modificadores que se deben aplicar en los ModifierGroups a los que se hace referencia directamente. Si no se especifica, no se aplicará ningún mínimo.

max_quantity

int32

Es opcional. Es la cantidad máxima de modificadores que se pueden aplicar en todos los ModifierGroups a los que se hace referencia directamente. Si no se especifica, no se aplica ningún máximo.

ModifierGroup

Define un grupo de modificadores entre los que se pueden realizar selecciones.

Campos
id

string

Obligatorio. Es el identificador de este grupo de modificadores, que es único dentro de su menú.

display_name

string

Obligatorio. Nombre del grupo de modificadores, p.ej., "Coberturas (sándwich)" o "Guarnición para combo mediano".

semantic_name

string

Es opcional. Nombre del grupo de modificadores, p.ej., "Coberturas (sándwich)" o "Guarnición para combo".

modifier_ids[]

string

Obligatorio. Son los IDs de los modificadores que forman parte de este grupo.

modifier_actions[]

ModifierAction

Es opcional. Son las acciones que se pueden realizar en los modificadores de este grupo.

min_selection_count

int32

Es opcional. Es la cantidad mínima de modificadores del grupo al que se hace referencia que se deben seleccionar para que el elemento sea válido. Si no se configura, no hay un mínimo. Para un grupo en el que se requiere exactamente una selección, este valor debe ser 1.

max_selection_count

int32

Es opcional. Es la cantidad máxima de modificadores totales del grupo al que se hace referencia que se pueden seleccionar. Si no se establece, no hay un valor máximo. Para un grupo en el que se requiere exactamente una selección, este valor debe ser 1.

max_selection_count_per_modifier

int32

Es opcional. Limita la cantidad de veces que se puede aplicar cada modificador dentro de este grupo. Si no se establece, el valor predeterminado es 1.

integration_attributes

ModifierGroupIntegrationAttributes

Es opcional. Son los metadatos asociados a esta entidad que se usan para las integraciones posteriores.

ModifierGroupIntegrationAttributes

Son los metadatos asociados a un grupo de modificadores que se usan para las integraciones posteriores.

Campos
custom_integration_attributes

Struct

Es opcional. Son metadatos arbitrarios que se asocian a una entidad y se usan para crear integraciones posteriores, es decir, identificadores o información de esquema para construir un pedido que se enviará a una API de punto de venta de terceros.

toast_attributes

ToastModifierGroupIntegrationAttributes

Es opcional. Representa los metadatos asociados con este grupo de modificadores que se usan para la integración de Toast. Si la integración de Toast no está habilitada para la tienda, se ignora este campo.

ToastModifierGroupIntegrationAttributes

Representa los atributos de un ModifierGroup de un menú de Toast.

Campos
guid

string

Es opcional. Representa el GUID del grupo de menú del elemento en el menú de Toast.

is_pre_modifier_group

bool

Es opcional. Si es verdadero, este grupo de modificadores representa un ToastPreModifierGroup.

ModifierGroupReference

Es una referencia a un grupo de modificadores.

Campos
id

string

Obligatorio. Es el ID del grupo de modificadores.

default_modifiers[]

DefaultModifierSelection

Es opcional. Es el conjunto de modificadores que se aplican de forma predeterminada.

min_selection_count

int32

Es opcional. Es la cantidad mínima de modificadores del ModifierGroup al que se hace referencia que se deben seleccionar. Si este valor se establece tanto en ModifierGroupReference como en ModifierGroup, se aplican ambas restricciones. Si no se configura, no hay un mínimo.

max_selection_count

int32

Es opcional. Es la cantidad máxima de modificadores totales del grupo al que se hace referencia que se pueden seleccionar. Si este valor se establece tanto en ModifierGroupReference como en ModifierGroup, se aplican ambas restricciones. Si no se establece, no hay un valor máximo.

DefaultModifierSelection

Especifica la selección predeterminada de un modificador dentro de un ModifierGroup.

Campos
id

string

Obligatorio. Es el ID del modificador.

quantity

int32

Es opcional. Cantidad de este modificador que se aplicará. Si se omite, se considera que la referencia tiene una cantidad de 1.

ModifierIntegrationAttributes

Son los metadatos asociados con un modificador que se usa para las integraciones posteriores.

Campos
custom_integration_attributes

Struct

Es opcional. Son metadatos arbitrarios que se asocian a una entidad y se usan para crear integraciones posteriores, es decir, identificadores o información de esquema para construir un pedido que se enviará a una API de punto de venta de terceros.

toast_attributes

ToastModifierIntegrationAttributes

Es opcional. Representa los metadatos asociados con este modificador que se usan para la integración de Toast. Si la integración de Toast no está habilitada para la tienda, se ignora este campo.

ToastModifierIntegrationAttributes

Representa los atributos de un modificador del menú de Toast.

Campos
guid

string

Es opcional. Representa el GUID de la opción de modificador del elemento en el menú de Toast.

is_pre_modifier

bool

Es opcional. Si es verdadero, este modificador representa un ToastPreModifier.

Pedido

El pedido representa el contenido de un pedido en curso o completado de un usuario.

Campos
items[]

OrderItem

Es opcional. Son los artículos del pedido.

metadata

OrderMetadata

Es opcional. Otros metadatos recopilados o inferidos durante el pedido.

fulfillment

OrderFulfillment

Es opcional. Es la información de preparación del pedido.

price_info

OrderPriceInfo

Es opcional. Es la información del precio del pedido.

external_order_id

string

Solo salida. Es el identificador externo de este pedido. Se propaga solo si se habilita una integración de punto de venta.

order_payment

OrderPayment

Es opcional. Es el estado de pago asociado a este pedido.

OrderFulfillment

OrderFulfillment contiene información sobre el cumplimiento del pedido.

Campos
fulfillment_method

FulfillmentMethod

Es opcional. Es el método de cumplimiento del pedido.

create_time

Timestamp

Solo salida. Fecha y hora en que se creó el pedido.

target_fulfillment_time

Timestamp

Es opcional. Es la fecha y hora en que se programó el cumplimiento del pedido, que se usa para la función "Pedir por adelantado". Si no se proporciona, se supone que el pedido es para "lo antes posible".

OrderItem

OrderItem especifica el estado de un elemento que forma parte de un pedido.

Campos
uid

string

Es opcional. Es un identificador único asignado por el sistema para este elemento.

item_id

string

Obligatorio. Es el identificador de un elemento del menú, que es único dentro de su menú.

display_name

string

Solo salida. Nombre legible por humanos de este concepto que se mostrará en las interfaces de usuario.

image

Image

Solo salida. Imagen que se mostrará para este elemento en la IU.

base_price

Money

Solo salida. Es el precio base del artículo. Esto puede verse afectado por los modificadores seleccionados. Es el precio por unidad del artículo.

integration_attributes

ItemIntegrationAttributes

Solo salida. Son los metadatos asociados a esta entidad que se usan para las integraciones posteriores.

modifier_groups[]

OrderModifierGroup

Es opcional. Son los ModifierGroups aplicados a este elemento.

quantity

int32

Es opcional. Es la cantidad de este artículo en el pedido.

OrderMetadata

OrderMetadata contiene otros metadatos recopilados o inferidos durante el pedido.

Campos
collected_customer_name

string

Es opcional. Nombre del cliente, recopilado durante la toma del pedido. Solo se completa cuando el agente está configurado para recopilar el nombre del cliente. Esta información se puede recopilar de forma verbal y podría contener errores ortográficos o de transcripción, por lo que se debe tener cuidado al mostrarla a los usuarios y no se debe confiar en ella como, por ejemplo, información de pago.

caller_phone_number

string

Es opcional. Es el número de teléfono del cliente que realiza el pedido.

OrderModifier

OrderModifier especifica el estado de un modificador que forma parte de un OrderModifierGroup.

Campos
uid

string

Es opcional. Es un identificador único asignado por el sistema para este modificador.

modifier_id

string

Obligatorio. Identificador de este modificador, que es único dentro del menú.

display_name

string

Solo salida. Es el nombre visible del modificador que se mostrará en las interfaces de usuario.

price_adjustment

Money

Solo salida. Es el ajuste de precio asociado a este modificador, si corresponde. Es el precio por unidad del modificador.

quantity

int32

Es opcional. Es la cantidad de esta acción del modificador que se aplicó.

modifier_action

OrderModifierAction

Es opcional. Es la acción del modificador que se aplica a este modificador.

image

Image

Solo salida. Es la imagen que se mostrará para este modificador en la IU.

integration_attributes

ModifierIntegrationAttributes

Solo salida. Son los metadatos asociados a esta entidad que se usan para las integraciones posteriores.

modifier_groups[]

OrderModifierGroup

Es opcional. Son los grupos de modificadores anidados que se aplican a este modificador.

OrderModifierAction

OrderModifierAction especifica el ModifierAction asociado a un OrderModifier aplicado.

Campos
name

string

Es opcional. Nombre de la acción del modificador, p.ej., "NO", "SIDE", "ADD", "EXTRA".

OrderModifierGroup

OrderModifierGroup especifica el estado de un ModifierGroup que forma parte de un OrderItem.

Campos
modifier_group_id

string

Obligatorio. Es el identificador de este grupo de modificadores, que es único dentro de su menú.

display_name

string

Solo salida. Nombre del grupo de modificadores, p.ej., "Coberturas (sándwich)" o "Guarnición para combo mediano".

integration_attributes

ModifierGroupIntegrationAttributes

Solo salida. Son los metadatos asociados a esta entidad que se usan para las integraciones posteriores.

modifiers[]

OrderModifier

Es opcional. Son los modificadores aplicados a este grupo de modificadores.

OrderPayment

Es la información relacionada con el pago de un pedido.

Campos
tipping_info

TippingInfo

Es opcional. Información sobre propinas

loyalty_consumed

LoyaltyAmount

Es opcional. Es el importe de lealtad que se consumió para el pago.

payment_info

PaymentInfo

Es opcional. Es la información sobre la forma de pago utilizada.

OrderPriceInfo

OrderPriceInfo encapsula los distintos componentes de precio de un pedido.

Campos
total_price

Money

Es opcional. Es el precio total final después de que se aplican todos los impuestos, las comisiones y los descuentos.

subtotal_price

Money

Es opcional. Es el precio del subtotal de todos los artículos y modificadores, antes de los impuestos y los descuentos.

tax_price

Money

Es opcional. Es el importe de impuestos aplicado al pedido.

OrderType

Es el tipo de orden que se colocará.

Enums
ORDER_TYPE_UNSPECIFIED No se especificó el tipo de pedido.
ORDER_TYPE_DRIVE_THROUGH El pedido es para retirar en el automóvil.
ORDER_TYPE_CARRY_OUT El pedido es para llevar.
ORDER_TYPE_DELIVERY El pedido es para entrega.

PastOrder

Es el pedido anterior del usuario.

Campos
order

Order

Obligatorio. Es el pedido original de la IA de comida.

PaymentInfo

Es la información de pago del usuario.

Campos
credit_card_last_four_digits

string

Es opcional. Los últimos cuatro dígitos de la tarjeta de crédito Se usa para verificar el número de tarjeta de crédito en la etapa de pago.

credit_card_cvv

string

Es opcional. Es el CVV de la tarjeta de crédito.

payment_method

PaymentMethod

Es opcional. Es el tipo de forma de pago que se usó.

PaymentMethod

Es el tipo de forma de pago.

Enums
PAYMENT_METHOD_UNSPECIFIED Forma de pago sin especificar.
PAYMENT_METHOD_CREDIT_CARD Tarjeta de crédito

PromoteChannelConfigRequest

Mensaje de solicitud para MenuService.PromoteChannelConfig.

Campos
name

string

Obligatorio. Es el nombre de la configuración del canal que se promocionará. Formato: projects/{project}/locations/{location}/brands/{brand}/channelConfigs/{channel_config}

destination_brand

string

Es opcional. Es la marca de destino a la que se promocionará la configuración del canal. Formato: projects/{project}/locations/{location}/brands/{brand}

Si se proporciona destination_brand y es diferente de la marca en name, se creará una copia de la configuración del canal en destination_brand. De lo contrario, no se realizará ninguna copia.

PromoteChannelConfigResponse

Mensaje de respuesta para MenuService.PromoteChannelConfig.

Campos
channel_config

ChannelConfig

Es la configuración del canal promocionado.

RecommendedOrder

Es un pedido que el agente le recomienda al usuario.

Campos
order

Order

Es el orden recomendado que se mostrará al usuario.

RecommendedOrders

Es una lista de pedidos recomendados por el agente al usuario.

Campos
recommended_orders[]

RecommendedOrder

Son los pedidos recomendados que se mostrarán al usuario.

RestartOrder

El cliente solicita reiniciar el pedido.

Campos
confirmation_step

bool

El agente le pide al cliente que confirme la solicitud de reinicio.

Programar

Es un programa configurable para un día de la semana o una fecha específica.

Campos
days[]

DayOfWeek

Es opcional. Son los días de la semana en los que se aplicará la programación.

date_ranges[]

DateRange

Es opcional. Son los períodos para los que se aplicará la programación. Si se configura, la programación solo estará activa en estos períodos específicos. Si se configuran tanto los días como los rangos de fechas, la programación estará activa cuando se cumplan ambas condiciones. Por ejemplo, si days es [LUNES] y date_ranges es [2026-01-01, 2026-01-31], la programación estará activa todos los lunes de enero.

time_ranges[]

TimeOfDayRange

Es opcional. Son los intervalos del día en los que se aplica el programa. Si se configura, la programación solo estará activa durante estos períodos.

SentimentMeasurement

Es la puntuación de opinión en tiempo real medida para este turno.

Campos
score

float

Es opcional. Es la puntuación de opinión entre -1.0 (opinión negativa) y 1.0 (opinión positiva).

magnitude

float

Es opcional. Es la magnitud del sentimiento, independientemente de la puntuación.

SpeechRecognition

Es el resultado del reconocimiento de voz del agente.

Campos
transcript

string

Es el texto transcrito de la entrada de audio en el idioma detectado.

language_code

string

Es el código de idioma de la transcripción. El código de idioma debe estar en formato BCP-47, como "en-US".

Tienda

Es una tienda individual de una marca.

Campos
name

string

Es el identificador. Es el nombre de la tienda. Formato: projects/{project}/locations/{location}/brands/{brand}/stores/{store}

create_time

Timestamp

Solo salida. Es la fecha y hora en que se creó esta tienda.

update_time

Timestamp

Solo salida. Fecha y hora en la que se actualizó esta tienda por última vez.

status

StoreStatus

Obligatorio. Es el estado de la tienda.

time_zone

TimeZone

Obligatorio. Es la zona horaria de la tienda. Se usa para determinar qué parte del día del menú se debe usar para la tienda en un momento determinado y para cualquier anulación basada en el tiempo.

store_metadata

StoreMetadata

Es opcional. Son los metadatos de la tienda.

tags[]

string

Es opcional. Son las etiquetas asociadas con la tienda.

StoreHours

Es el horario de atención de la tienda.

Campos
fulfillment_method

FulfillmentMethod

Es opcional. Es el método de cumplimiento del horario de la tienda, por ejemplo, "PICKUP", "DELIVERY", etcétera. Si no se especifica, se supone que el horario de la tienda se aplica a todos los métodos de cumplimiento.

schedules[]

Schedule

Es opcional. Son los horarios de atención de la tienda para el fulfillment_method especificado.

StoreMetadata

Son los metadatos de la tienda.

Campos
display_name

string

Es opcional. Es el nombre visible de la tienda que se usará en la IU y en los elementos visibles para el cliente.

contact_email

string

Es opcional. Es la dirección de correo electrónico de la tienda que se proporcionará a los clientes.

address

Address

Es opcional. Es la información de la dirección de la tienda.

store_hours[]

StoreHours

Es opcional. Es el horario de atención de la tienda.

dayparts[]

Daypart

Es opcional. Son los segmentos del día definidos para la tienda.

phone_number

string

Es opcional. Es el número de teléfono principal de la tienda para tomar pedidos, solicitar catering, hacer consultas generales y realizar reservas.

Dirección

Es la información de la dirección de la tienda.

Campos
street_address

string

Es opcional. Dirección de la tienda

city

string

Es opcional. Es la ciudad de la tienda.

state

string

Es opcional. Es el estado de la tienda.

country

string

Es opcional. Es el país de la tienda.

postal_code

string

Es opcional. Es el código postal de la tienda.

latitude

double

Es opcional. Es la latitud de la tienda.

longitude

double

Es opcional. Es la longitud de la tienda.

google_maps_url

string

Es opcional. Es la URL de Google Maps de la tienda.

Segmentación del día

Es un segmento del día para la tienda.

Campos
id

string

Es opcional. Es el ID de la parte del día, por ejemplo, "BREAKFAST", "LUNCH", etcétera.

schedules[]

Schedule

Es opcional. Horas activas de la segmentación por horario.

display_name

string

Es opcional. Especifica un nombre visible opcional para este período del día.

StoreRevision

Es una revisión de una tienda.

Campos
name

string

Es el identificador. Es el nombre del recurso de la revisión de la tienda. Formato: projects/{project}/locations/{location}/brands/{brand}/stores/{store}/revisions/{revision}

snapshot

Store

Solo salida. Es el estado del recurso de la tienda en esta revisión.

create_time

Timestamp

Solo salida. Fecha y hora en que se creó la revisión.

created_by

string

Solo salida. Es el correo electrónico del usuario que creó el recurso recientemente.

alternate_ids[]

string

Solo salida. Son los IDs alternativos para esta revisión.

StoreStatus

Es el estado de la tienda.

Campos
state

State

Es opcional. Es el estado de la tienda.

Estado

Es el estado de la tienda.

Enums
STATE_UNSPECIFIED La tienda se encuentra en un estado no especificado.
ACTIVE La tienda está activa.
DISABLED La tienda está inhabilitada.

SubmitOrderRequest

Es una solicitud para enviar el pedido, con toda la información de pago requerida recopilada del cliente.

Campos
payment_info

PaymentInfo

Obligatorio. Es la información de pago del pedido.

loyalty_info

LoyaltyInfo

Es opcional. Es la lealtad que se consumió para el pedido.

tip_amount

Money

Es opcional. Es el importe de la propina del pedido.

SubmitOrderResponse

Es el resultado del envío del pedido.

Campos
success

bool

Obligatorio. Indica si el pedido se envió correctamente.

estimated_ready_duration

Duration

Es opcional. Es la duración estimada hasta que el pedido esté listo.

SuggestedItem

Es un elemento para sugerirle al cliente.

Campos
item_id

string

Es el ID del elemento del menú.

display_name

string

Nombre legible por humanos de este elemento que se mostrará en las interfaces de usuario.

image

Image

Imagen que se mostrará para este elemento en la IU.

base_price

Money

Es el precio base del artículo. Esto puede verse afectado por los modificadores seleccionados. Es el precio por unidad del artículo.

integration_attributes

ItemIntegrationAttributes

Son los metadatos asociados a esta entidad que se usan para las integraciones posteriores.

SuggestedItems

Es una lista de elementos para sugerirle al cliente.

Campos
items[]

SuggestedItem

Son los artículos que se le sugieren al cliente.

SuggestedModifier

Es un modificador para sugerirle al cliente.

Campos
modifier_id

string

ID del modificador en el menú.

modifier_group_id

string

ID del grupo de modificadores al que se debe agregar este modificador si se acepta la sugerencia.

display_name

string

Nombre legible por humanos de este elemento que se mostrará en las interfaces de usuario.

image

Image

Imagen que se mostrará para este elemento en la IU.

price_adjustment

Money

Es el ajuste de precio asociado a este modificador, si corresponde. Es el precio por unidad del modificador.

integration_attributes

ModifierIntegrationAttributes

Son los metadatos asociados a esta entidad que se usan para las integraciones posteriores.

SuggestedModifiers

Es una lista de modificadores para sugerirle al cliente.

Campos
modifiers[]

SuggestedModifier

Son los modificadores que se sugieren al cliente.

parent_uid

string

Es el identificador único del elemento principal o modificador al que se aplicarán los modificadores.

SuggestedOptions

Son las opciones que se le sugieren al cliente.

Campos
Campo de unión suggested_options. Las opciones sugeridas. suggested_options puede ser solo uno de los parámetros siguientes:
suggested_items

SuggestedItems

Es una lista de elementos para sugerirle al cliente.

suggested_modifiers

SuggestedModifiers

Es una lista de modificadores para sugerirle al cliente.

TextInput

Es la entrada de texto del cliente. En lugar de audio, el cliente también puede enviar entrada de texto al agente. Un cliente debe usar la entrada de texto o de audio, no ambas.

Campos
text

string

Obligatorio. Es el enunciado de texto del cliente.

TimeOfDayRange

Representa un período entre dos horas del día en una fecha no especificada. Por ejemplo, el horario de atención, como de 9:00 a 17:00.

Campos
start_time

TimeOfDay

Obligatorio. Es el inicio del período, incluido.

end_time

TimeOfDay

Obligatorio. Es el final del período, sin incluirlo. Si end_time es anterior a start_time, significa que end_time es al día siguiente.

TippingInfo

Es información sobre las propinas.

Campos
Campo de unión tip_type. Es el importe o el porcentaje de la propina. tip_type puede ser solo uno de los parámetros siguientes:
amount

Money

Es opcional. Es una cantidad de dinero específica para la propina.

percentage_bps

int32

Es opcional. Es el porcentaje en puntos básicos, p.ej., 450 = 4.5%.

TurnCompleted

Este tipo no tiene campos.

Indica que el agente de IA de comida detectó el final del turno de conversación actual y no proporcionará más resultados para este turno.

UpdateBrandRequest

Mensaje de solicitud para MenuService.UpdateBrand.

Campos
brand

Brand

Obligatorio. Es la marca que se actualizará.

El campo name de la marca se usa para identificar la marca que se actualizará. Formato: projects/{project}/locations/{location}/brands/{brand}

update_mask

FieldMask

Es opcional. Lista de campos que se actualizarán

UpdateChannelConfigRequest

Mensaje de solicitud para MenuService.UpdateChannelConfig.

Campos
channel_config

ChannelConfig

Obligatorio. Es la configuración del canal que se actualizará.

El campo name de la configuración del canal se usa para identificar la configuración del canal que se actualizará. Formato: projects/{project}/locations/{location}/brands/{brand}/channelConfigs/{channel_config}

update_mask

FieldMask

Es opcional. Lista de campos que se actualizarán

UpdateConfigApplicationRuleRequest

Mensaje de solicitud para MenuService.UpdateConfigApplicationRule.

Campos
config_application_rule

ConfigApplicationRule

Obligatorio. Es la regla de configuración de la aplicación que se actualizará.

El campo name de la regla de aplicación de la configuración se usa para identificar la regla de aplicación de la configuración que se actualizará. Formato: projects/{project}/locations/{location}/brands/{brand}/configApplicationRules/{config_application_rule}

update_mask

FieldMask

Es opcional. Lista de campos que se actualizarán

UpdateStoreRequest

Mensaje de solicitud para MenuService.UpdateStore.

Campos
store

Store

Obligatorio. Es la tienda que se actualizará.

El campo name de la tienda se usa para identificar la tienda que se actualizará. Formato: projects/{project}/locations/{location}/brands/{brand}/stores/{store}

update_mask

FieldMask

Es opcional. Lista de campos que se actualizarán

allow_missing

bool

Es opcional. Si se establece como verdadero y no se encuentra la tienda, se creará una nueva. En esta situación, se ignora update_mask.

UpdatedOrderState

Es el evento que devuelve el agente y que representa una actualización del estado del pedido.

Campos
order

Order

Es el estado actualizado del pedido asociado a esta sesión.

UserInfo

Es la información personal del usuario final que se comparte con el agente de IA de comida.

Campos
preferred_name

string

Es opcional. Es el nombre del usuario que el agente debe usar para dirigirse a él. El cliente de IA de comida es responsable de seleccionar el nombre preferido según el perfil del usuario y asegurarse de que se alinee con la convención de la marca, p.ej., usar el nombre o el nombre completo.

payment_info

PaymentInfo

Es opcional. Es la información de pago del usuario.

delivery_address

string

Es opcional. Es la dirección de entrega guardada del usuario.

past_orders[]

PastOrder

Es opcional. Es el historial de pedidos del usuario.

loyalty_info

LoyaltyInfo

Es opcional. Es la información de lealtad del usuario.

phone_number

string

Es opcional. Es el número de teléfono del usuario.