- Representación JSON
- Información de usuario
- PhoneNumber
- Imagen
- Comercio
- Ubicación
- LatLng
- PostalAddress
- Contenido
- elemento de una sola línea
- Representación JSON
Entidad de pedido. Nota: 1. Todas las cadenas de todos los niveles deben tener menos de 1,000 caracteres, a menos que se especifique lo contrario. 2. Todos los campos repetidos en todos los niveles deben tener un tamaño inferior a 50, a menos que se especifique lo contrario. 3. Si se especifican, todas las marcas de tiempo de todos los niveles deben ser marcas de tiempo válidas.
Representación JSON | |
---|---|
{ "googleOrderId": string, "merchantOrderId": string, "userVisibleOrderId": string, "userVisibleStateLabel": string, "buyerInfo": { object ( |
Campos | ||
---|---|---|
googleOrderId |
Es el ID de pedido asignado por Google. |
|
merchantOrderId |
Obligatorio: ID de pedido interno asignado por el comercio. Este ID debe ser único y se requiere para las operaciones posteriores de actualización de pedidos. Este ID se puede establecer en el googleOrderId proporcionado o cualquier otro valor único. Ten en cuenta que el ID que se muestra a los usuarios es userVisibleOrderId, que puede ser un valor diferente y más fácil de usar. La longitud máxima permitida es de 128 caracteres. |
|
userVisibleOrderId |
El ID visible para el usuario que hace referencia al pedido actual. Este ID debe ser coherente con el que se muestra para este pedido en otros contextos, como sitios web, aplicaciones y correo electrónico. |
|
userVisibleStateLabel |
Obsoleto: usa el estado OrderExtensions en su lugar. Etiqueta visible para el usuario para el estado de este pedido. |
|
buyerInfo |
Información sobre el comprador. |
|
image |
Imagen asociada con el pedido. |
|
createTime |
Obligatorio: Fecha y hora en que se creó el pedido. Es una marca de tiempo en el formato RFC3339 UTC "Zulu", con precisión de nanosegundos. Ejemplo: |
|
lastUpdateTime |
Fecha y hora en que se actualizó el pedido por última vez. Obligatorio para OrderUpdate. Es una marca de tiempo en el formato RFC3339 UTC "Zulu", con precisión de nanosegundos. Ejemplo: |
|
transactionMerchant |
Comercio que facilitó la confirmación de la compra. Puede ser diferente de la de un proveedor a nivel de la línea de pedido. Ejemplo: Pedido de Expedia con un elemento de una sola línea de ANA. |
|
contents |
Obligatorio: El contenido del pedido es un grupo de líneas de pedido. |
|
priceAttributes[] |
Precio, descuentos, impuestos, etc. |
|
followUpActions[] |
Haz un seguimiento de las acciones a nivel del pedido. |
|
paymentData |
Datos relacionados con el pago del pedido. |
|
termsOfServiceUrl |
Un vínculo a las condiciones del servicio que se aplican al pedido/pedido propuesto. |
|
note |
Notas adjuntas a un pedido |
|
promotions[] |
Son todas las promociones asociadas a este pedido. |
|
disclosures[] |
Divulgaciones asociadas con este pedido. |
|
vertical |
Obsoleto: Usa verticales en su lugar. Estas propiedades se aplicarán a todas las líneas de pedido, a menos que se anulen en alguna. Esta vertical debe coincidir con el tipo de vertical a nivel de la línea de pedido. Valores posibles: Un objeto que contiene campos de un tipo arbitrario. Un campo adicional |
|
Campo de unión verticals . Estas propiedades se aplicarán a todas las líneas de pedido, a menos que se anulen en alguna. Esta vertical debe coincidir con el tipo de vertical a nivel de la línea de pedido. Las direcciones (verticals ) solo pueden ser una de las siguientes opciones: |
||
purchase |
Orden de compra |
|
ticket |
Pedido de entrada |
UserInfo
Información sobre el usuario. Se usa para representar la información del usuario asociada con un pedido.
Representación JSON | |
---|---|
{
"email": string,
"firstName": string,
"lastName": string,
"displayName": string,
"phoneNumbers": [
{
object ( |
Campos | |
---|---|
email |
Correo electrónico del usuario, p. ej.: janedoe@gmail.com. |
firstName |
Es el nombre del usuario. |
lastName |
Apellido del usuario. |
displayName |
El nombre visible del usuario puede ser diferente del nombre o del apellido. |
phoneNumbers[] |
Números de teléfono del usuario. |
Númerotelefónico
Representación estándar de números de teléfono.
Representación JSON | |
---|---|
{ "e164PhoneNumber": string, "extension": string, "preferredDomesticCarrierCode": string } |
Campos | |
---|---|
e164PhoneNumber |
Número de teléfono en formato E.164, como se define en la Recomendación E.164 de la Unión Internacional de Telecomunicaciones (UIT). Vínculo de Wikipedia: https://en.wikipedia.org/wiki/E.164 |
extension |
La extensión no está estandarizada en las recomendaciones de ITU, excepto que se define como una serie de números con una longitud máxima de 40 dígitos. Aquí, se define como una cadena para adaptarse al posible uso de un cero inicial en la extensión (las organizaciones tienen total libertad para hacerlo, ya que no hay un estándar definido). Además de los dígitos, otros caracteres de marcación, como "," (lo que indica un tiempo de espera) puede almacenarse aquí. Por ejemplo, en los casos xxx-xxx-xxxx, 123, “123” es la extensión. |
preferredDomesticCarrierCode |
Es el código de selección del operador que se prefiere cuando se llama a este número de teléfono nacional. Esto también incluye los códigos que se deben marcar en algunos países para llamar de un teléfono fijo a un celular, o viceversa. Por ejemplo, en Colombia, el número "3" debe marcarse antes que el número de teléfono cuando se llama desde un celular a un teléfono fijo doméstico y viceversa. https://en.wikipedia.org/wiki/Telephone_numbers_in_Colombia https://en.wikipedia.org/wiki/Brazilian_Carrier_Selection_Code Ten en cuenta que esta es la opción “preferida”. código, lo que significa que otros códigos también pueden funcionar. |
Imagen
Se muestra una imagen en la tarjeta.
Representación JSON | |
---|---|
{ "url": string, "accessibilityText": string, "height": number, "width": number } |
Campos | |
---|---|
url |
Es la URL de origen de la imagen. Las imágenes pueden ser JPG, PNG y GIF (animadas y no animadas). Por ejemplo, |
accessibilityText |
Una descripción de texto de la imagen que se usará con fines de accesibilidad, p.ej., lectores de pantalla. Obligatorio. |
height |
La altura de la imagen en píxeles. Opcional. |
width |
El ancho de la imagen en píxeles. Opcional. |
Merchant
Comercio del carrito, pedido o línea de pedido.
Representación JSON | |
---|---|
{ "id": string, "name": string, "image": { object ( |
Campos | |
---|---|
id |
Es el ID opcional asignado al comercio, si corresponde. |
name |
Es el nombre del comercio, como "Panera Bread". |
image |
Es la imagen asociada con el comercio. |
phoneNumbers[] |
Números de teléfono del comercio. |
address |
Dirección del comercio. |
Ubicación
Contenedor que representa una ubicación.
Representación JSON | |
---|---|
{ "coordinates": { object ( |
Campos | |
---|---|
coordinates |
Coordenadas geográficas Requiere el dispositivo [DEVICE_PRECISE_LOCATION] el permiso [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION]. |
formattedAddress |
Dirección visible, p.ej., “1600 Amphitheatre Pkwy, Mountain View, CA 94043”. Requiere el dispositivo [DEVICE_PRECISE_LOCATION] el permiso [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION]. |
zipCode |
Código postal Requiere el dispositivo [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] o [DEVICE_COARSE_LOCATION] el permiso [google.actions.v2.Permission.DEVICE_COARSE_LOCATION]. |
city |
Ciudad. Requiere el dispositivo [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] o [DEVICE_COARSE_LOCATION] el permiso [google.actions.v2.Permission.DEVICE_COARSE_LOCATION]. |
postalAddress |
Dirección postal. Requiere el dispositivo [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] o [DEVICE_COARSE_LOCATION] el permiso [google.actions.v2.Permission.DEVICE_COARSE_LOCATION]. |
name |
Es el nombre del lugar. |
phoneNumber |
Número de teléfono de la ubicación, p.ej., número de contacto de la ubicación de la empresa o el número de teléfono de la ubicación de entrega. |
notes |
Notas sobre la ubicación |
placeId |
placeId se usa con la API de Places para recuperar detalles de un lugar. Consulta https://developers.google.com/places/web-service/place-id. |
LatLng
Un objeto que representa un par latitud-longitud. Esto se expresa como un par de números de punto flotante de doble precisión que representan los grados de latitud y longitud. A menos que se especifique lo contrario, debe coincidir con el sistema WGS84. Los valores deben pertenecer a rangos normalizados.
Representación JSON | |
---|---|
{ "latitude": number, "longitude": number } |
Campos | |
---|---|
latitude |
La latitud expresada en grados. Debe pertenecer al rango [-90.0, +90.0]. |
longitude |
La longitud expresada en grados. Debe pertenecer al rango [-180.0, +180.0]. |
PostalAddress
Representa una dirección postal, p. ej., para envíos postales o direcciones de pago. Si se proporciona una dirección postal, un servicio postal puede enviar artículos a las instalaciones, a la casilla postal o a otras ubicaciones similares. No está diseñado para modelar ubicaciones geográficas (caminos, pueblos, montañas).
En el uso común, una dirección se crearía a través de una entrada del usuario o a partir de la importación de datos existentes, según el tipo de proceso.
Consejos sobre el ingreso o la edición de direcciones: - Usa un widget de dirección compatible con i18n, como https://github.com/google/libaddressinput). - Los usuarios no deben ver elementos de la IU para ingresar o editar campos fuera de países en los que se usa ese campo.
Para obtener orientación sobre cómo usar este esquema, consulta https://support.google.com/business/answer/6397478
Representación JSON | |
---|---|
{ "revision": number, "regionCode": string, "languageCode": string, "postalCode": string, "sortingCode": string, "administrativeArea": string, "locality": string, "sublocality": string, "addressLines": [ string ], "recipients": [ string ], "organization": string } |
Campos | |
---|---|
revision |
La revisión del esquema de Todas las revisiones nuevas deben ser compatibles con las revisiones anteriores. |
regionCode |
Obligatorio Código de región de CLDR para el país o la región de la dirección. Nunca se infiere y depende del usuario garantizar que el valor sea correcto. Consulta http://cldr.unicode.org/ y http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html para obtener detalles. Ejemplo: "CH" para Suiza. |
languageCode |
Opcional: Código de idioma BCP-47 de los contenidos de esta dirección (si se conoce). Suele ser el idioma de la IU del formulario de entrada o se espera que coincida con uno de los idiomas usados en la región o el país de la dirección, o sus transliteraciones equivalentes. Esto puede afectar el formato en ciertos países, pero no es fundamental para la precisión de los datos y nunca afectará una validación o alguna otra operación no relacionada con el formato. Si este valor es desconocido, se debe omitir (en lugar de especificar una configuración predeterminada posiblemente incorrecta). Ejemplos: "zh-Hant", "ja", "ja-Latn", "en". |
postalCode |
Opcional: Código postal de la dirección. No todos los países usan o exigen la presencia de códigos postales, pero en los lugares donde se usan, es posible que activen una validación adicional con otras partes de la dirección (p. ej., validación del código postal o el estado en EE.UU.). |
sortingCode |
Opcional: Código de ordenamiento adicional específico para cada país. No se usa en la mayoría de las regiones. Cuando se utiliza, el valor es una cadena como "CEDEX", opcionalmente seguida de un número (p.ej., "CEDEX 7"), o solo un número, que representa el "código de sector" (Jamaica), "indicador del área de entrega" (Malaui) o "indicador de oficina de correos" (p.ej., Costa de Marfil). |
administrativeArea |
Opcional. División administrativa más alta que se usa para las direcciones postales de un país o una región. Por ejemplo, puede ser un estado, una provincia, una óblast o una prefectura. Específicamente, en el caso de España, corresponde a la provincia y no a la comunidad autónoma (p.ej., "Barcelona" y no "Cataluña"). Muchos países no usan un área administrativa en las direcciones postales. P. ej., en Suiza se dejaría vacío. |
locality |
Opcional: Por lo general, se refiere a la parte de la dirección que indica la ciudad o el pueblo. Ejemplos: ciudad de EE.UU., comuna de Italia o ciudad postal en el Reino Unido. En regiones del mundo donde las localidades no están bien definidas o no coinciden bien con esta estructura, deja la localidad vacía y usa addressLines. |
sublocality |
Opcional: Sublocalidad de la dirección. Por ejemplo, pueden ser barrios, vecindarios o distritos. |
addressLines[] |
Líneas de dirección no estructuradas que describen los niveles más bajos de una dirección. Debido a que los valores de addressLines no tienen información de tipo y, en ocasiones, pueden contener varios valores en un solo campo (p.ej., "Austin, TX"), es importante que el orden de las líneas sea claro. El orden de las líneas de dirección debe ser el "orden de sobre" que se usa en el país o la región de la dirección. En lugares donde esto puede variar, (p. ej., Japón), address_language se usa para hacerlo explícito (p. ej., "ja" para ordenar de mayor a menor en "ja-Latn" o "en" para indicar de menor a mayor). De esta manera, se puede seleccionar la línea más específica de una dirección a partir del idioma. La representación estructural mínima que se permite para una dirección consiste en un regionCode con toda la información restante incluida en addressLines. Sería posible dar un formato a una dirección así de manera muy aproximada sin codificación geográfica, pero no podría realizarse un análisis semántico de ningún componente de la dirección hasta que se resuelva, al menos, de manera parcial. Crear una dirección que solo contiene regionCode y addressLines, y luego realizar la codificación geográfica es la manera recomendada de controlar direcciones sin estructura alguna (en lugar de inferir qué partes de la dirección deben ser localidades o áreas administrativas). |
recipients[] |
Opcional: El destinatario en la dirección. Es posible que este campo contenga varias líneas de información en ciertas circunstancias. Por ejemplo, puede contener información sobre la entrega "por medio de". |
organization |
Opcional: El nombre de la organización de la dirección. |
Contenido
Envoltorio para líneas de pedido.
Representación JSON | |
---|---|
{
"lineItems": [
{
object ( |
Campos | |
---|---|
lineItems[] |
Lista de líneas de pedido. Se requiere al menos 1 line_item y se permiten 50 como máximo. Todas las líneas de pedido deben pertenecer a la misma vertical. |
LineItem
Una línea de pedido contiene una vertical. Un pedido o carrito puede tener varias líneas de pedido de la misma vertical. Las sublíneas de pedido, los complementos, etc., deben definirse en prototipos verticales según sus casos de uso. Nota: 1. Todas las cadenas de todos los niveles deben tener menos de 1,000 caracteres, a menos que se especifique lo contrario. 2. Todos los campos repetidos en todos los niveles deben tener un tamaño inferior a 50, a menos que se especifique lo contrario. 3. Si se especifican, todas las marcas de tiempo de todos los niveles deben ser marcas de tiempo válidas.
Representación JSON | |
---|---|
{ "id": string, "name": string, "userVisibleStateLabel": string, "provider": { object ( |
Campos | ||
---|---|---|
id |
Obligatorio: Identificador asignado por el comercio para la línea de pedido. Se usa para identificar líneas de pedido existentes en la aplicación de actualizaciones parciales. La longitud máxima permitida es de 64 caracteres. |
|
name |
Es el nombre de la línea de pedido como aparece en el recibo. La longitud máxima permitida es de 100 caracteres. |
|
userVisibleStateLabel |
Obsoleta. En su lugar, usa el estado de nivel vertical. Por ejemplo, para compras, usa PurchaseOrderExtension.status. Es la etiqueta visible del usuario para el estado de esta línea de pedido. |
|
provider |
El proveedor de la línea de pedido en particular, si es diferente del pedido general. Ejemplo: Pedido de Expedia con el proveedor de líneas de pedido ANA. |
|
priceAttributes[] |
Precio y ajustes a nivel de la línea de pedido. |
|
followUpActions[] |
Hace un seguimiento de las acciones en la línea de pedido. |
|
recipients[] |
los clientes a nivel de la línea de pedido, puede ser diferente del comprador a nivel del pedido. Ejemplo: El usuario X realizó una reserva en un restaurante con el nombre del usuario Y. |
|
image |
Imagen pequeña asociada con este elemento, si corresponde. |
|
description |
Descripción de la línea de pedido. |
|
notes[] |
Notas adicionales aplicables a esta línea de pedido en particular, como la política de cancelación. |
|
disclosures[] |
Son divulgaciones asociadas a esta línea de pedido. |
|
vertical |
Obsoleto: Usa verticales en su lugar. Obligatorio: Contenido semántico de la línea de pedido en función de su tipo o vertical. Cada vertical debe incluir sus propios detalles de entrega. Debe ser uno de los siguientes valores: Un objeto que contiene campos de un tipo arbitrario. Un campo adicional |
|
Campo de unión verticals . Obligatorio: Contenido semántico de la línea de pedido en función de su tipo o vertical. Cada vertical debe incluir sus propios detalles de entrega. Las direcciones (verticals ) solo pueden ser una de las siguientes opciones: |
||
purchase |
Órdenes de compra como productos, comida, etcétera |
|
reservation |
Pedidos de reservación como restaurante, corte de pelo, etc. |
PriceAttribute
Atributo de precio de un pedido o una línea de pedido.
Representación JSON | |
---|---|
{ "type": enum ( |
Campos | ||
---|---|---|
type |
Obligatorio: Tipo de atributo de dinero. |
|
name |
Obligatorio: El usuario muestra la cadena del atributo precio. El comercio envía y localiza esta información. |
|
state |
Obligatorio: Estado del precio: Estimación vs. real. |
|
taxIncluded |
Si el precio está incluido en los impuestos |
|
Campo de unión spec . Representa el importe monetario o el porcentaje en milésimas de segundo. Las direcciones (spec ) solo pueden ser una de las siguientes opciones: |
||
amount |
Importe monetario |
|
amountMillipercentage |
La especificación de porcentaje, hasta 1/1,000 de un porcentaje. P. ej., 8.750% se representa como 8,750 y los porcentajes negativos representan descuentos porcentuales. Este campo dejará de estar disponible. Puedes considerar volver a agregarlo cuando se requiera un caso de uso sólido. |
Tipo
Representa el tipo de dinero.
Enumeraciones | |
---|---|
TYPE_UNSPECIFIED |
No se especifica el tipo. Los clientes no deberían tener que configurarlo de forma explícita. |
REGULAR |
Es el precio visible normal, antes de que se apliquen los descuentos, etcétera. |
DISCOUNT |
Se restará del subtotal. |
TAX |
Se agregará al subtotal. |
DELIVERY |
Se agregará al subtotal. |
SUBTOTAL |
Subtotal antes de que se agreguen algunas tarifas. |
FEE |
Cualquier Tarifa adicional. |
GRATUITY |
Se agregará al subtotal. |
TOTAL |
Es el precio del pedido o la línea de pedido que se muestra. |
Estado
Representa el estado del precio.
Enumeraciones | |
---|---|
STATE_UNSPECIFIED |
No se especifica. |
ESTIMATE |
El precio es solo una estimación. |
ACTUAL |
El precio real que se cobrará por el usuario. |
Dinero
Representa un importe de dinero con su tipo de moneda.
Representación JSON | |
---|---|
{ "currencyCode": string, "amountInMicros": string } |
Campos | |
---|---|
currencyCode |
El código de moneda de 3 letras definido en el estándar ISO 4217. |
amountInMicros |
Importe en micros Por ejemplo, este campo se debe configurar como 1990000 para $1.99. |
Acción
Una acción de seguimiento asociada con el pedido o la línea de pedido.
Representación JSON | |
---|---|
{ "type": enum ( |
Campos | |
---|---|
type |
Obligatorio: Tipo de acción. |
title |
Título o etiqueta de la acción que se muestra al usuario. La longitud máxima permitida es de 100 caracteres. |
openUrlAction |
Acción que se debe realizar. |
actionMetadata |
Metadatos asociados con una acción |
Tipo
Posibles acciones de seguimiento.
Enumeraciones | |
---|---|
TYPE_UNSPECIFIED |
Acción no especificada. |
VIEW_DETAILS |
Ver la acción de detalles del pedido. |
MODIFY |
Acción Modify order. |
CANCEL |
Acción para cancelar pedido. |
RETURN |
Acción de devolución del pedido. |
EXCHANGE |
Acción de pedido de intercambio. |
EMAIL |
Acción de correo electrónico. Los tipos EMAIL y CALL dejaron de estar disponibles. openUrlAction.url se puede utilizar como un número de teléfono o un correo electrónico. |
CALL |
Acción de llamada. |
REORDER |
Reordenar la acción. |
REVIEW |
Revisar acción del pedido. |
CUSTOMER_SERVICE |
Comunícate con atención al cliente. |
FIX_ISSUE |
Dirígete al sitio o la app del comercio para solucionar el problema. |
DIRECTION |
Vínculo de instrucciones sobre cómo llegar. |
OpenUrlAction
Abre la URL proporcionada.
Representación JSON | |
---|---|
{ "url": string, "androidApp": { object ( |
Campos | |
---|---|
url |
El campo de URL puede ser cualquiera de los siguientes: - URLs HTTP/HTTPS para abrir una aplicación vinculada a la aplicación o una página web |
androidApp |
Información sobre la app para Android si se prevé que una app para Android complete la URL. |
urlTypeHint |
Indica una sugerencia para el tipo de URL. |
AndroidApp
Especificación de la app para Android para restricciones de entrega
Representación JSON | |
---|---|
{
"packageName": string,
"versions": [
{
object ( |
Campos | |
---|---|
packageName |
Nombre del paquete Se debe indicar el nombre del paquete cuando se especifique la entrega de Android. |
versions[] |
Cuando se especifican varios filtros, cualquier coincidencia de filtro activará la app. |
VersionFilter
Se debe incluir VersionFilter si se requieren versiones específicas de la app.
Representación JSON | |
---|---|
{ "minVersion": number, "maxVersion": number } |
Campos | |
---|---|
minVersion |
Código de versión mínimo o 0 inclusive. |
maxVersion |
Código de versión máximo, inclusive. El rango considerado es [minVersion:maxVersion]. Un rango nulo implica cualquier versión. Ejemplos: Para especificar una sola versión, usa [target_version:target_version]. Para especificar cualquier versión, deja minVersion y maxVersion sin especificar. Para especificar todas las versiones hasta maxVersion, deja minVersion sin especificar. Para especificar todas las versiones de minVersion, deja maxVersion sin especificar. |
UrlTypeHint
Diferentes tipos de sugerencias de URL.
Enumeraciones | |
---|---|
URL_TYPE_HINT_UNSPECIFIED |
Sin especificar |
AMP_CONTENT |
URL que dirige directamente al contenido de AMP o a una URL canónica que hace referencia al contenido de AMP mediante <link rel="amphtml">. |
ActionMetadata
Metadatos relacionados por acción.
Representación JSON | |
---|---|
{ "expireTime": string } |
Campos | |
---|---|
expireTime |
Hora en la que vencerá esta acción. Es una marca de tiempo en el formato RFC3339 UTC "Zulu", con precisión de nanosegundos. Ejemplo: |
Divulgación
Es una divulgación sobre un producto, un servicio o una política que se puede presentar al usuario.
Representación JSON | |
---|---|
{ "title": string, "disclosureText": { object ( |
Campos | |
---|---|
title |
Título de la divulgación. Ejemplo: "Información de seguridad". |
disclosureText |
Contenido de la divulgación. Se permiten los vínculos web. |
presentationOptions |
Opciones de presentación para la divulgación. |
DisclosureText
Representa un texto sin formato con vínculos web.
Representación JSON | |
---|---|
{
"template": string,
"textLinks": [
{
object ( |
Campos | |
---|---|
template |
Texto para mostrar que contiene marcadores de posición como "{0}" y "{1}" para cada vínculo de texto que debe insertarse. Ejemplo: "ADVERTENCIA: Este producto puede exponerte a productos químicos que, según el estado de California, causan cáncer. Para obtener más información, visita {0}." Este texto de divulgación no debe incluir ningún contenido promocional ni similar a un anuncio. |
textLinks[] |
Vínculos de texto que se deben reemplazar en la plantilla. El primero reemplazará por "{0}". en la cadena de plantilla, la segunda para "{1}", etc. |
TextLink
Un vínculo de texto que se debe sustituir en la plantilla.
Representación JSON | |
---|---|
{ "displayText": string, "url": string } |
Campos | |
---|---|
displayText |
Es el texto que se debe mostrar a los usuarios. |
url |
URL a la que se debe dirigir a los usuarios cuando se activa el vínculo. |
DisclosurePresentationOptions
Opciones para la presentación de una divulgación.
Representación JSON | |
---|---|
{
"presentationRequirement": enum ( |
Campos | |
---|---|
presentationRequirement |
Requisito de presentación de la divulgación |
initiallyExpanded |
Si el contenido de la divulgación debe expandirse inicialmente De forma predeterminada, está contraído inicialmente. |
PresentationRequirement
Requisito para presentar la divulgación.
Enumeraciones | |
---|---|
REQUIREMENT_UNSPECIFIED |
Requisito no especificado. No se debería establecer esto de forma explícita. |
REQUIREMENT_OPTIONAL |
La divulgación es opcional. Se puede omitir si el dispositivo no permite mostrar divulgaciones. |
REQUIREMENT_REQUIRED |
La divulgación es obligatoria. Si el dispositivo no permite mostrar divulgaciones, se enviará una conversación por teléfono. |
PurchaseItemExtension
Contenido de la línea de pedido de la vertical de compras.
Representación JSON | |
---|---|
{ "status": enum ( |
Campos | |
---|---|
status |
Obligatorio: Estado a nivel de la línea de pedido. |
userVisibleStatusLabel |
Obligatorio: Etiqueta o cadena visible para el usuario para el estado. La longitud máxima permitida es de 50 caracteres. |
type |
Obligatorio: Tipo de compra. |
productId |
Es el ID de oferta o producto asociado con esta línea de pedido. |
quantity |
Es la cantidad del artículo. |
unitMeasure |
Unidad de medida. Especifica el tamaño del elemento en las unidades elegidas. El tamaño, junto con el precio activo, se usan para determinar el precio unitario. |
returnsInfo |
Muestra información de esta línea de pedido. Si no la estableces, esta línea de pedido hereda la información de devoluciones a nivel del pedido. |
fulfillmentInfo |
Información de entrega para esta línea de pedido. Si no la estableces, esta línea de pedido hereda la información de entrega a nivel del pedido. |
itemOptions[] |
Complementos o subelementos adicionales. |
extension |
Cualquier campo adicional que se intercambie entre el comercio y Google Un objeto que contiene campos de un tipo arbitrario. Un campo adicional |
productDetails |
Detalles sobre el producto. |
PurchaseStatus
Es el estado de compra asociado con una orden de compra o una línea de pedido en particular.
Enumeraciones | |
---|---|
PURCHASE_STATUS_UNSPECIFIED |
Estado sin especificar. |
READY_FOR_PICKUP |
Listo para retirar. |
SHIPPED |
Enviado. |
DELIVERED |
Entregado. |
OUT_OF_STOCK |
Agotado. |
IN_PREPARATION |
“IN_PREPARATION” podrían tener un significado diferente en un contexto diferente. Para pedidos de COMIDA, podría ser la comida que se está preparando. En el caso de la venta minorista, puede ser que un artículo esté empaquetado. |
CREATED |
Se crea el pedido. |
CONFIRMED |
El comercio confirmó el pedido. |
REJECTED |
El comercio rechazó el pedido o la línea de pedido. |
RETURNED |
El usuario devolvió el elemento. |
CANCELLED |
El usuario canceló el pedido o la línea de pedido. |
CHANGE_REQUESTED |
El usuario solicitó un cambio en el pedido, y el integrador está procesando el cambio. El pedido debe moverse a otro estado después de que se procesa la solicitud. |
PurchaseType
Indica la categoría de compra.
Enumeraciones | |
---|---|
PURCHASE_TYPE_UNSPECIFIED |
Valor desconocido. |
RETAIL |
Incluye compras como bienes físicos. |
FOOD |
Incluye la compra de pedidos de comida. |
GROCERY |
Compra de alimentos. |
MOBILE_RECHARGE |
Compra de recarga móvil prepagada. |
MerchantUnitMeasure
Medida de precio por unidad del comercio.
Representación JSON | |
---|---|
{
"measure": number,
"unit": enum ( |
Campos | |
---|---|
measure |
Valor (Value): ejemplo 1.2 |
unit |
Unidad: Ejemplo POUND, GRAM. |
Unidad
Enumeraciones | |
---|---|
UNIT_UNSPECIFIED |
Unidad sin especificar. |
MILLIGRAM |
Miligramo. |
GRAM |
Gramo. |
KILOGRAM |
Kilogramo. |
OUNCE |
Onza. |
POUND |
Libra. |
PurchaseReturnsInfo
Muestra información asociada con un pedido o una línea de pedido en particular.
Representación JSON | |
---|---|
{ "isReturnable": boolean, "daysToReturn": number, "policyUrl": string } |
Campos | |
---|---|
isReturnable |
Si es verdadero, se permite mostrar un resultado. |
daysToReturn |
Se permite la devolución en ese plazo. |
policyUrl |
Vínculo a la política de devoluciones. |
PurchaseFulfillmentInfo
Es la información de entrega asociada con una orden de compra o una línea de pedido en particular.
Representación JSON | |
---|---|
{ "id": string, "fulfillmentType": enum ( |
Campos | |
---|---|
id |
Es el identificador único de esta opción de servicio. |
fulfillmentType |
Obligatorio: El tipo de entrega. |
expectedFulfillmentTime |
Una ventana si se especifica un intervalo de tiempo o ETA si se especifica una sola hora. Hora de retiro o entrega estimada |
expectedPreparationTime |
Una ventana si se especifica un intervalo de tiempo o ETA si se especifica una sola hora. Tiempo previsto para preparar la comida. Se prefiere una sola vez. |
location |
Ubicación de retiro o entrega |
expireTime |
Hora en la que vence esta opción de entrega. Es una marca de tiempo en el formato RFC3339 UTC "Zulu", con precisión de nanosegundos. Ejemplo: |
price |
El costo de esta opción. |
fulfillmentContact |
Es el contacto del usuario para esta entrega. |
shippingMethodName |
Es el nombre del método de envío que seleccionó el usuario. |
storeCode |
StoreCode de la ubicación. Ejemplo: Walmart es el comercio, y storeCode es la tienda Walmart en la que se realizó la entrega. https://support.google.com/business/answer/3370250?ref_topic=4596653. |
pickupInfo |
Información adicional sobre cómo se elegiría el pedido. Este campo solo sería aplicable cuando el tipo de entrega es PICKUP. |
Tipo
Tipo de entrega.
Enumeraciones | |
---|---|
TYPE_UNSPECIFIED |
Indica un tipo no especificado. |
DELIVERY |
Este pedido se entregará. |
PICKUP |
Debes retirar este pedido. |
Hora
Construcción de tiempo para representar el tiempo de un evento que se usará al mostrar un pedido al usuario.
Representación JSON | |
---|---|
{ "timeIso8601": string } |
Campos | |
---|---|
timeIso8601 |
Representa la hora del evento del pedido, como la hora de la reserva, la hora de entrega, etcétera. Puede ser una duración (hora de inicio y finalización), solo la fecha, la fecha y la hora, etc. Consulta https://en.wikipedia.org/wiki/ISO_8601 para conocer todos los formatos compatibles. |
PickupInfo
Son los detalles sobre el retiro de un pedido. Incluye detalles como el tipo de retiro y metadatos adicionales adjuntos a cada tipo, si corresponde.
Representación JSON | |
---|---|
{ "pickupType": enum ( |
Campos | |
---|---|
pickupType |
Método de retiro, como INSTORE, CURBSIDE, etcétera |
curbsideInfo |
Detalles específicos de la información de retiro en la puerta. Si retiroType no es "CURBSIDE", se ignorará este campo. |
checkInInfo[] |
Lista de diversos métodos que admite el socio para el registro. |
PickupType
Lista de tipos de retiro admitidos.
Enumeraciones | |
---|---|
UNSPECIFIED |
Tipo de retiro sin especificar. |
INSTORE |
Retira la comida dentro del restaurante. |
CURBSIDE |
Estaciona el vehículo en un lugar designado fuera del restaurante y alguien entregaría la comida allí. |
CurbsideInfo
Detalles sobre cómo se facilitarían los pedidos en la puerta.
Representación JSON | |
---|---|
{ "curbsideFulfillmentType": enum ( |
Campos | |
---|---|
curbsideFulfillmentType |
Los socios necesitan información adicional para facilitar los pedidos de retiro en la puerta. Según el tipo de entrega que se elija, se recopilarán los detalles correspondientes del usuario. |
userVehicle |
Son los detalles del vehículo del usuario que realiza el pedido. |
CurbsideFulfillmentType
Valores posibles de los tipos de entrega en la puerta.
Enumeraciones | |
---|---|
UNSPECIFIED |
Tipo de entrega en la puerta sin especificar. |
VEHICLE_DETAIL |
Se requieren los detalles del vehículo para facilitar los retiros en la puerta. |
Vehículo
Detalles sobre un vehículo
Representación JSON | |
---|---|
{
"make": string,
"model": string,
"licensePlate": string,
"colorName": string,
"image": {
object ( |
Campos | |
---|---|
make |
Marca del vehículo (p.ej., "Honda"). Se muestra al usuario y debe localizarse. Obligatorio. |
model |
Modelo del vehículo (p.ej., "Grom"). Se muestra al usuario y debe localizarse. Obligatorio. |
licensePlate |
Número de matrícula del vehículo (p. ej., "1ABC234") Obligatorio. |
colorName |
Nombre del color del vehículo, p. ej., negro (opcional). |
image |
URL de una foto del vehículo. La foto se mostrará en aproximadamente 256x256 px. Debe ser un archivo .jpg o png. Opcional. |
CheckInInfo
Son los metadatos que requiere el socio para admitir un método de registro.
Representación JSON | |
---|---|
{
"checkInType": enum ( |
Campos | |
---|---|
checkInType |
Método utilizado para enviar instrucciones de registro de entrada. |
CheckInType
Se usan varios métodos para enviar instrucciones de registro.
Enumeraciones | |
---|---|
CHECK_IN_TYPE_UNSPECIFIED |
Valor desconocido. |
EMAIL |
La información de registro se enviará por correo electrónico. |
SMS |
La información de registro se enviará por SMS. |
ItemOption
Representa complementos o subelementos.
Representación JSON | |
---|---|
{ "id": string, "name": string, "prices": [ { object ( |
Campos | |
---|---|
id |
En el caso de las opciones que son artículos, usa el ID de artículo único. |
name |
Nombre de la opción. |
prices[] |
Es el precio total de la opción. |
note |
Nota relacionada con la opción. |
quantity |
En el caso de las opciones que son artículos, selecciona la cantidad. |
productId |
Es el ID de oferta o producto asociado con esta opción. |
subOptions[] |
Para definir otras subopciones anidadas. |
ProductDetails
Detalles sobre el producto.
Representación JSON | |
---|---|
{ "productId": string, "gtin": string, "plu": string, "productType": string, "productAttributes": { string: string, ... } } |
Campos | |
---|---|
productId |
Es el ID de oferta o producto asociado con esta línea de pedido. |
gtin |
Es el código comercial global de artículo del producto. Es útil si offerId no está presente en Merchant Center. Opcional. |
plu |
Los códigos de búsqueda de precios, comúnmente llamados códigos PLU, números de PLU, PLU, códigos de productos o etiquetas de productos, son un sistema de números que identifican de manera única los productos a granel que se venden en supermercados y supermercados. |
productType |
Es la categoría de producto definida por el comercio. P.ej., "Página principal > Tienda de comestibles > Productos lácteos y Huevos > Leche > Leche entera" |
productAttributes |
Detalles sobre el producto proporcionados por el comercio, p.ej., { "allergen": "peanut" }. Es útil si offerId no está presente en Merchant Center. Opcional. Es un objeto que contiene una lista de pares |
ReservationItemExtension
Contenido de líneas de pedido para pedidos de reserva, como restaurantes, cortes de pelo, etc. Siguiente ID: 15.
Representación JSON | |
---|---|
{ "status": enum ( |
Campos | |
---|---|
status |
Obligatorio: Estado de la reserva. |
userVisibleStatusLabel |
Obligatorio: Etiqueta o cadena visible para el usuario para el estado. La longitud máxima permitida es de 50 caracteres. |
type |
Tipo de reserva. Se puede desactivar si ninguna de las opciones de tipo es aplicable. |
reservationTime |
Es la hora a la que está programado el servicio o evento. Puede ser un intervalo de tiempo, una fecha o una fecha y hora exacta. |
userAcceptableTimeRange |
Es el intervalo de tiempo aceptable para el usuario. |
confirmationCode |
Código de confirmación para esta reserva. |
partySize |
Es la cantidad de personas. |
staffFacilitators[] |
Facilitadores del personal que se encargarán de la reserva. P. ej., El peluquero. |
location |
Ubicación del servicio o evento. |
extension |
Cualquier campo adicional que se intercambie entre el comercio y Google Un objeto que contiene campos de un tipo arbitrario. Un campo adicional |
ReservationStatus
Estado de la reserva.
Enumeraciones | |
---|---|
RESERVATION_STATUS_UNSPECIFIED |
Estado sin especificar. |
PENDING |
La reserva está pendiente. |
CONFIRMED |
Se confirmó la reserva. |
CANCELLED |
El usuario cancela la reserva. |
FULFILLED |
Se completó la reserva. |
CHANGE_REQUESTED |
Se solicitó el cambio de la reserva |
REJECTED |
El integrador venció o rechazó la reserva. |
ReservationType
Tipo de reserva.
Enumeraciones | |
---|---|
RESERVATION_TYPE_UNSPECIFIED |
Tipo no especificado |
RESTAURANT |
Reserva para restaurante. |
HAIRDRESSER |
Reserva para peluquero. |
StaffFacilitator
Información sobre la persona de servicio.
Representación JSON | |
---|---|
{
"name": string,
"image": {
object ( |
Campos | |
---|---|
name |
El nombre del facilitador del personal. P. ej., "Juan Pérez" |
image |
Imágenes del artista. |
PaymentData
Son los datos de pago relacionados con un pedido.
Representación JSON | |
---|---|
{ "paymentResult": { object ( |
Campos | |
---|---|
paymentResult |
Es el resultado del pago que usa el integrador para completar una transacción. Actions on Google propagará este campo si Actions-on-Google administra la experiencia de confirmación de la compra. |
paymentInfo |
Información de pago relacionada con el pedido que es útil para la interacción del usuario. |
PaymentResult
El integrador usa el resultado del pago para completar una transacción.
Representación JSON | |
---|---|
{ // Union field |
Campos | ||
---|---|---|
Campo de unión result . Se proporcionan los datos de Google Payments o una forma de pago de comerciante. Las direcciones (result ) solo pueden ser una de las siguientes opciones: |
||
googlePaymentData |
Google proporcionó los datos de la forma de pago. Si tu procesador de pagos aparece como procesador de pagos compatible con Google aquí: https://developers.google.com/pay/api/ Navega a tu procesador de pagos a través del vínculo para obtener más información. De lo contrario, consulta la siguiente documentación para conocer los detalles de la carga útil. https://developers.google.com/pay/api/payment-data-cryptography |
|
merchantPaymentMethodId |
Forma de pago proporcionada por el comercio o por la acción elegida por el usuario. |
PaymentInfo
Información de pago relacionada con el pedido realizado. Este proto captura información útil para la interacción del usuario.
Representación JSON | |
---|---|
{ "paymentMethodDisplayInfo": { object ( |
Campos | |
---|---|
paymentMethodDisplayInfo |
Es la información visible de la forma de pago que se usó para realizar la transacción. |
paymentMethodProvenance |
Procedencia de la forma de pago utilizada para la transacción. Es posible que el usuario haya registrado la misma forma de pago en Google y en el comercio. |
PaymentMethodDisplayInfo
El integrador usa el resultado del pago para completar una transacción.
Representación JSON | |
---|---|
{
"paymentType": enum ( |
Campos | |
---|---|
paymentType |
Es el tipo de pago. |
paymentMethodDisplayName |
Es el nombre visible del usuario de la forma de pago. Por ejemplo, cuenta corriente VISA **** 1234 **** 5678 |
paymentMethodVoiceName |
Es el nombre de la forma de pago que se le informará al usuario en el caso de los dispositivos con el Asistente integrado que solo funcionen por voz. Por ejemplo, “visa que termina en uno, dos, tres, cuatro” o “cuenta corriente que termina en cinco, seis, siete, ocho”. Nota: Esta es la cadena optimizada para voz que se usará en lugar de paymentMethodDisplayName en dispositivos con el Asistente de voz integrado. Si no se establece esta cadena, se leerá el nombre de paymentMethodDisplayName al usuario. |
PaymentType
PaymentType indica la forma de pago que se usó para la forma de pago proporcionada por el comercio. La acción también debe proporcionar un nombre visible para la forma de pago.
Enumeraciones | |
---|---|
PAYMENT_TYPE_UNSPECIFIED |
No se especificó el tipo de pago. |
PAYMENT_CARD |
Una tarjeta prepagada o de crédito o débito |
BANK |
La forma de pago es una cuenta bancaria. |
LOYALTY_PROGRAM |
La forma de pago es un programa de lealtad. |
CASH |
La forma de pago es en efectivo. |
GIFT_CARD |
La forma de pago es una tarjeta de regalo. |
WALLET |
Billetera de terceros, p.ej., PayPal |
PaymentMethodProvenance
Representa la procedencia de la forma de pago utilizada para la transacción.
Enumeraciones | |
---|---|
PAYMENT_METHOD_PROVENANCE_UNSPECIFIED |
No se especifica la procedencia. |
PAYMENT_METHOD_PROVENANCE_GOOGLE |
La procedencia es Google. |
PAYMENT_METHOD_PROVENANCE_MERCHANT |
La procedencia es Comerciante. |
Promoción
Promociones/ofertas que se agregaron al carrito.
Representación JSON | |
---|---|
{ "coupon": string } |
Campos | |
---|---|
coupon |
Obligatorio: Se aplicó el código de cupón a esta oferta. |
PurchaseOrderExtension
Extensión de pedido para la vertical de compras. Estas propiedades se aplican a todas las líneas de pedido dentro del pedido, a menos que se anulen en una línea de pedido.
Representación JSON | |
---|---|
{ "status": enum ( |
Campos | |
---|---|
status |
Obligatorio: Estado general del pedido. |
userVisibleStatusLabel |
Etiqueta o cadena visible para el usuario para el estado. La longitud máxima permitida es de 50 caracteres. |
type |
Obligatorio: Tipo de compra. |
returnsInfo |
Devolución de la información del pedido |
fulfillmentInfo |
Es la información de entrega del pedido. |
extension |
Cualquier campo adicional que se intercambie entre el comercio y Google Un objeto que contiene campos de un tipo arbitrario. Un campo adicional |
purchaseLocationType |
Ubicación de la compra (en la tienda o en línea) |
errors[] |
Opcional: Errores por los que se rechazó este pedido |
PurchaseLocationType
Es el tipo de ubicación de la compra.
Enumeraciones | |
---|---|
UNSPECIFIED_LOCATION |
Valor desconocido. |
ONLINE_PURCHASE |
Todas las compras realizadas en línea. |
INSTORE_PURCHASE |
Todas las compras en la tienda. |
PurchaseError
Errores por los que se puede rechazar una orden de compra.
Representación JSON | |
---|---|
{ "type": enum ( |
Campos | |
---|---|
type |
Obligatorio: Representa el motivo detallado por el que el comercio rechaza un pedido. |
description |
Descripción adicional del error. |
entityId |
El ID de entidad que corresponde al error. Ejemplo que puede corresponder a LineItemId o ItemOptionId. |
updatedPrice |
Es relevante en caso de un tipo de error de PRICE_CHANGED o INCORRECT_PRICE. |
availableQuantity |
La cantidad está disponible ahora. Se aplica en el caso de AVAILABILITY_CHANGED. |
ErrorType
Tipos de errores posibles.
Enumeraciones | |
---|---|
ERROR_TYPE_UNSPECIFIED |
Error desconocido |
NOT_FOUND |
No se encontró la entidad. Puede ser Item, FulfillmentOption o Promoción. El ID de entidad es obligatorio. |
INVALID |
Los datos de la entidad no son válidos. puede ser Item, FulfillmentOption o Promoción. El ID de entidad es obligatorio. |
AVAILABILITY_CHANGED |
Artículo no disponible o insuficiente para cumplir con la solicitud. El ID de entidad es obligatorio. |
PRICE_CHANGED |
El precio del artículo es diferente del precio en la entidad Item. Se requieren un ID de entidad y un precio actualizado. |
INCORRECT_PRICE |
Errores de precio en Tarifas y Total Se requieren un ID de entidad y un precio actualizado. |
REQUIREMENTS_NOT_MET |
Restricciones para aceptar un pedido que no se cumple: tamaño mínimo del carrito, etcétera. |
TOO_LATE |
Venció la opción FulfillmentOption. |
NO_CAPACITY |
No hay capacidad de servicio disponible. |
INELIGIBLE |
El usuario no es apto para realizar pedidos (se encuentra en la lista negra). |
OUT_OF_SERVICE_AREA |
No se puede realizar la entrega a la dirección solicitada debido a las normas fronterizas, etc. |
CLOSED |
El restaurante está cerrado a la hora de hacer pedidos. |
PROMO_NOT_APPLICABLE |
Es un código de error genérico que permite detectar todos los casos en los que no se puede aplicar el código promocional, si ninguno de los que se incluyen a continuación es adecuado. Agrega el código promocional como ID de la entidad. |
PROMO_NOT_RECOGNIZED |
El socio no reconoció el código del cupón. Agrega el código promocional como ID de la entidad. |
PROMO_EXPIRED |
No se pudo aplicar porque la promoción venció. Agrega el código promocional como ID de la entidad. |
PROMO_USER_INELIGIBLE |
El usuario actual no cumple con los requisitos para obtener este cupón. Agrega el código promocional como ID de la entidad. |
PROMO_ORDER_INELIGIBLE |
El pedido actual no es apto para este cupón. Agrega el código promocional como ID de la entidad. |
UNAVAILABLE_SLOT |
El horario disponible para pedido por adelantado no está disponible. |
FAILED_PRECONDITION |
No se cumplen las restricciones para aceptar un pedido: tamaño mínimo del carrito, etcétera. |
PAYMENT_DECLINED |
El pago no es válido. |
MERCHANT_UNREACHABLE |
No se puede acceder al comercio. Esto es útil cuando un socio es un agregador y no puede comunicarse con el comercio. |
TicketOrderExtension
Pedir contenido para pedidos de entradas como películas, deportes, etc.
Representación JSON | |
---|---|
{
"ticketEvent": {
object ( |
Campos | |
---|---|
ticketEvent |
El evento se aplica a todas las entradas de líneas de pedido. |
TicketEvent
Representa un evento único.
Representación JSON | |
---|---|
{ "type": enum ( |
Campos | |
---|---|
type |
Obligatorio: Tipo del evento de entrada (p.ej., película, concierto. |
name |
Obligatorio: Nombre del evento. Por ejemplo, si el evento es una película, este debe ser el nombre de la película. |
description |
Descripción del evento. |
url |
Es la URL de la información del evento. |
location |
Es la ubicación donde se lleva a cabo el evento o se encuentra una organización. |
eventCharacters[] |
Son los personajes relacionados con este evento. Pueden ser directores o actores de un evento cinematográfico, o bien actores de un concierto, etcétera. |
startDate |
Hora de inicio |
endDate |
Hora de finalización |
doorTime |
Hora de entrada, que puede ser diferente de la hora de inicio del evento. p.ej., el evento comienza a las 9 a.m., pero el horario de entrada es a las 8:30 a.m. |
Tipo
El tipo de evento.
Enumeraciones | |
---|---|
EVENT_TYPE_UNKNOWN |
Tipo de evento desconocido. |
MOVIE |
Película. |
CONCERT |
Concierto |
SPORTS |
Deportes. |
EventCharacter
Un carácter de evento, p.ej., organizador, artista, etc.
Representación JSON | |
---|---|
{ "type": enum ( |
Campos | |
---|---|
type |
Tipo del carácter del evento, p.ej., es el actor o el director. |
name |
Es el nombre del personaje. |
image |
Imágenes del personaje. |
Tipo
Tipo de carácter.
Enumeraciones | |
---|---|
TYPE_UNKNOWN |
Tipo desconocido. |
ACTOR |
Perpetrador. |
PERFORMER |
Artistas |
DIRECTOR |
Director |
ORGANIZER |
Organizador. |