Order

Entidad de pedido. Nota: 1. Todas las strings 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 ser inferiores a 50, a menos que se especifique lo contrario. 3. Todas las marcas de tiempo en todos los niveles, si se especifican, deben ser marcas de tiempo válidas.

Representación JSON
{
  "googleOrderId": string,
  "merchantOrderId": string,
  "userVisibleOrderId": string,
  "userVisibleStateLabel": string,
  "buyerInfo": {
    object (UserInfo)
  },
  "image": {
    object (Image)
  },
  "createTime": string,
  "lastUpdateTime": string,
  "transactionMerchant": {
    object (Merchant)
  },
  "contents": {
    object (Contents)
  },
  "priceAttributes": [
    {
      object (PriceAttribute)
    }
  ],
  "followUpActions": [
    {
      object (Action)
    }
  ],
  "paymentData": {
    object (PaymentData)
  },
  "termsOfServiceUrl": string,
  "note": string,
  "promotions": [
    {
      object (Promotion)
    }
  ],
  "disclosures": [
    {
      object (Disclosure)
    }
  ],
  "vertical": {
    "@type": string,
    field1: ...,
    ...
  },

  // Union field verticals can be only one of the following:
  "purchase": {
    object (PurchaseOrderExtension)
  },
  "ticket": {
    object (TicketOrderExtension)
  }
  // End of list of possible types for union field verticals.
}
Campos
googleOrderId

string

ID de pedido asignado por Google.

merchantOrderId

string

Obligatorio: ID de pedido interno asignado por el comercio. Este ID debe ser único y es obligatorio para las operaciones posteriores de actualización de pedidos. Este ID se puede establecer en el valor googleOrderId proporcionado o cualquier otro valor único. Ten en cuenta que el ID que se presenta 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

string

El ID que se muestra al usuario y que hace referencia al pedido actual. Este ID debe ser coherente con el ID que se muestra para este pedido en otros contextos, incluidos sitios web, aplicaciones y correo electrónico.

userVisibleStateLabel
(deprecated)

string

Obsoleto: Usa el estado de OrderExtensions en su lugar. Etiqueta visible para el estado del pedido.

buyerInfo

object (UserInfo)

Incluye información sobre el comprador.

image

object (Image)

Imagen asociada con el pedido.

createTime

string (Timestamp format)

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: "2014-10-02T15:01:23.045123456Z".

lastUpdateTime

string (Timestamp format)

Fecha y hora de la última actualización del pedido Obligatorio para OrderUpdate.

Es una marca de tiempo en el formato RFC3339 UTC "Zulu", con precisión de nanosegundos. Ejemplo: "2014-10-02T15:01:23.045123456Z".

transactionMerchant

object (Merchant)

Comercio que facilitó la confirmación de la compra. Este podría ser diferente de un proveedor a nivel de la línea de pedido. Ejemplo: pedido de Expedia con una línea de pedido de ANA.

contents

object (Contents)

Obligatorio: Ordene el contenido, que es un grupo de líneas de pedido.

priceAttributes[]

object (PriceAttribute)

Precio, descuentos, impuestos, etc.

followUpActions[]

object (Action)

Haz un seguimiento de las acciones a nivel del pedido.

paymentData

object (PaymentData)

Datos relacionados con el pago del pedido.

termsOfServiceUrl

string

Vínculo a las Condiciones del Servicio que se aplican al pedido o al pedido propuesto.

note

string

Notas adjuntas a un pedido.

promotions[]

object (Promotion)

Todas las promociones asociadas con este pedido.

disclosures[]

object (Disclosure)

Divulgaciones asociadas a este pedido.

vertical
(deprecated)

object

Obsoleto: Usa verticales. Estas propiedades se aplicarán a todas las líneas de pedido, a menos que se anulen en algunas. Esta vertical debe coincidir con el tipo vertical a nivel de la línea de pedido. Valores posibles: google.actions.orders.v3.verticals.purchase.PurchaseOrderExtension google.actions.orders.v3.verticals.ticket.TicketOrderExtension

Un objeto que contiene campos de un tipo arbitrario. Un campo adicional "@type" contiene una URI que identifica el tipo. Ejemplo: { "id": 1234, "@type": "types.example.com/standard/id" }.

Campo de unión verticals. Estas propiedades se aplicarán a todas las líneas de pedido, a menos que se anulen en algunas. Esta vertical debe coincidir con el tipo vertical a nivel de la línea de pedido. Las direcciones (verticals) solo pueden ser una de las siguientes opciones:
purchase

object (PurchaseOrderExtension)

Orden de compra

ticket

object (TicketOrderExtension)

Pedido de boleto

UserInfo

Información sobre el usuario. Se usa para representar información del usuario asociado con un pedido.

Representación JSON
{
  "email": string,
  "firstName": string,
  "lastName": string,
  "displayName": string,
  "phoneNumbers": [
    {
      object (PhoneNumber)
    }
  ]
}
Campos
email

string

Correo electrónico del usuario, p. ej.: juanperez@gmail.com.

firstName

string

Nombre del usuario.

lastName

string

Apellido del usuario.

displayName

string

El nombre visible del usuario puede ser diferente del nombre o el apellido.

phoneNumbers[]

object (PhoneNumber)

Números de teléfono del usuario.

PhoneNumber

Representación estándar de número de teléfono.

Representación JSON
{
  "e164PhoneNumber": string,
  "extension": string,
  "preferredDomesticCarrierCode": string
}
Campos
e164PhoneNumber

string

Número de teléfono en formato E.164, tal como se define en la Recomendación E.164 de la Unión Internacional de Telecomunicaciones Internacionales (UIT): https://en.wikipedia.org/wiki/E.164

extension

string

Las extensiones no están estandarizadas en las recomendaciones de ITU, excepto que se definen como una serie de números con una longitud máxima de 40 dígitos. Aquí se define como una string para adaptarse al posible uso de un cero inicial en la extensión (las organizaciones tienen libertad total para hacerlo, ya que no hay un estándar definido). Además de los dígitos, es posible que se almacenen aquí otros caracteres de marcación, como "," (que indican que hay que esperar). Por ejemplo, en la extensión xxx-xxx-xxxx 123, "123" es la extensión.

preferredDomesticCarrierCode

string

El código de selección de proveedor que se prefiere cuando se llama a este número de teléfono de manera local. Esto también incluye los códigos que se deben marcar en algunos países cuando se llama desde un teléfono fijo a un dispositivo móvil, o viceversa. Por ejemplo, en Colombia, se debe marcar el “3” antes del número de teléfono cuando se llama desde un teléfono celular a un teléfono fijo nacional y viceversa. https://en.wikipedia.org/wiki/Telephone_numbers_in_Colombia https://en.wikipedia.org/wiki/Brasilian_Carrier_Selection_Code

Ten en cuenta que este es el código "preferido", por lo que otros códigos también podrían funcionar.

Imagen

Se muestra una imagen en la tarjeta.

Representación JSON
{
  "url": string,
  "accessibilityText": string,
  "height": number,
  "width": number
}
Campos
url

string

La URL de origen de la imagen. Las imágenes pueden ser JPG, PNG y GIF (animados y no animados). Por ejemplo,https://www.agentx.com/logo.png. Obligatorio.

accessibilityText

string

Es una descripción de texto de la imagen que se usará para fines de accesibilidad, p.ej., los lectores de pantalla. Obligatorio.

height

number

La altura de la imagen en píxeles. Opcional.

width

number

El ancho de la imagen en píxeles. Opcional.

Merchant

Comercio para el carrito, el pedido o la línea de pedido

Representación JSON
{
  "id": string,
  "name": string,
  "image": {
    object (Image)
  },
  "phoneNumbers": [
    {
      object (PhoneNumber)
    }
  ],
  "address": {
    object (Location)
  }
}
Campos
id

string

ID opcional asignado al comercio, si corresponde.

name

string

El nombre del comercio, como "Panera Pan".

image

object (Image)

Es la imagen asociada con el comercio.

phoneNumbers[]

object (PhoneNumber)

Números de teléfono del comercio.

address

object (Location)

Dirección del comercio

Ubicación

Contenedor que representa una ubicación.

Representación JSON
{
  "coordinates": {
    object (LatLng)
  },
  "formattedAddress": string,
  "zipCode": string,
  "city": string,
  "postalAddress": {
    object (PostalAddress)
  },
  "name": string,
  "phoneNumber": string,
  "notes": string,
  "placeId": string
}
Campos
coordinates

object (LatLng)

Coordenadas geográficas. Requiere el permiso [DEVICE_PRECISE_LOCATION][google.actions.v2.Permission.DEVICE_PRECISE_LOCATION].

formattedAddress

string

Dirección visible, p.ej., “1600 Amphitheatre Pkwy, Mountain View, CA 94043”. Requiere el permiso [DEVICE_PRECISE_LOCATION][google.actions.v2.Permission.DEVICE_PRECISE_LOCATION].

zipCode

string

Código postal Requiere el permiso [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] o [DEVICE_COARSE_LOCATION] [google.actions.v2.Permission.DEVICE_COARSE_LOCATION].

city

string

Ciudad. Requiere el permiso [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] o [DEVICE_COARSE_LOCATION] [google.actions.v2.Permission.DEVICE_COARSE_LOCATION].

postalAddress

object (PostalAddress)

Dirección postal. Requiere el permiso [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] o [DEVICE_COARSE_LOCATION] [google.actions.v2.Permission.DEVICE_COARSE_LOCATION].

name

string

Indica el nombre del lugar.

phoneNumber

string

El número de teléfono de la ubicación, p. ej., el número de contacto de la empresa o el número de teléfono de la ubicación de entrega

notes

string

Notas sobre la ubicación.

placeId

string

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

number

La latitud expresada en grados. Debe pertenecer al rango [-90.0, +90.0].

longitude

number

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 el 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

number

La revisión del esquema de PostalAddress. Se debe configurar como 0, que es la última versión.

Todas las revisiones nuevas deben ser compatibles con las revisiones anteriores.

regionCode

string

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

string

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

string

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

string

Opcional. Código de ordenamiento adicional específico para cada país. No se usa en la mayoría de las regiones. Cuando se usa, el valor es una string como "CEDEX", opcionalmente seguida de un número (p.ej., "CEDEX 7") o simplemente un número, que representa el "código de sector" (Jamaica), el "indicador del área de entrega" (Malaui) o el "indicador de oficina postal" (p.ej., Costa de Marfil).

administrativeArea

string

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. En el caso específico de España, se trata de la provincia y no de la comunidad autónoma (p.ej., "Barcelona" y no "Catalonia"). Muchos países no usan un área administrativa en las direcciones postales. P. ej., en Suiza se dejaría vacío.

locality

string

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

string

Opcional. Sublocalidad de la dirección. Por ejemplo, pueden ser barrios, vecindarios o distritos.

addressLines[]

string

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, a veces, 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[]

string

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

string

Opcional. El nombre de la organización de la dirección.

Contenido

Wrapper para líneas de pedido

Representación JSON
{
  "lineItems": [
    {
      object (LineItem)
    }
  ]
}
Campos
lineItems[]

object (LineItem)

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 un carrito de compras pueden tener varias líneas de pedido de la misma vertical. Los elementos de sublínea/complementos, etc., deben definirse en protocolos proto verticales según sus casos de uso. Nota: 1. Todas las strings 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 ser inferiores a 50, a menos que se especifique lo contrario. 3. Todas las marcas de tiempo en todos los niveles, si se especifican, deben ser marcas de tiempo válidas.

Representación JSON
{
  "id": string,
  "name": string,
  "userVisibleStateLabel": string,
  "provider": {
    object (Merchant)
  },
  "priceAttributes": [
    {
      object (PriceAttribute)
    }
  ],
  "followUpActions": [
    {
      object (Action)
    }
  ],
  "recipients": [
    {
      object (UserInfo)
    }
  ],
  "image": {
    object (Image)
  },
  "description": string,
  "notes": [
    string
  ],
  "disclosures": [
    {
      object (Disclosure)
    }
  ],
  "vertical": {
    "@type": string,
    field1: ...,
    ...
  },

  // Union field verticals can be only one of the following:
  "purchase": {
    object (PurchaseItemExtension)
  },
  "reservation": {
    object (ReservationItemExtension)
  }
  // End of list of possible types for union field verticals.
}
Campos
id

string

Obligatorio: Identificador asignado por el comerciante para la línea de pedido. Se usa para identificar la línea de pedido existente en la aplicación de actualizaciones parciales. La longitud máxima permitida es de 64 caracteres.

name

string

Nombre de la línea de pedido tal como se muestra en el recibo. La longitud máxima permitida es de 100 caracteres.

userVisibleStateLabel
(deprecated)

string

Ya no está disponible. En su lugar, use el estado a nivel vertical. Por ejemplo, para las compras, usa PurchaseOrderExtension.status. Etiqueta visible para el estado de esta línea de pedido.

provider

object (Merchant)

El proveedor de la línea de pedido específica, si es diferente del pedido general Ejemplo: Pedido de Expedia con el proveedor ANA.

priceAttributes[]

object (PriceAttribute)

Precio y ajustes de la línea de pedido

followUpActions[]

object (Action)

Acciones de seguimiento en la línea de pedido.

recipients[]

object (UserInfo)

Clientes a nivel de la línea de pedido, esto puede ser diferente del comprador a nivel del pedido Ejemplo: El usuario X hizo una reserva en un restaurante con el nombre del usuario Y.

image

object (Image)

Imagen pequeña asociada con este elemento, si corresponde.

description

string

Descripción de la línea de pedido.

notes[]

string

Notas adicionales aplicables a esta línea de pedido en particular, por ejemplo, la política de cancelación.

disclosures[]

object (Disclosure)

Divulgaciones asociadas a esta línea de pedido.

vertical
(deprecated)

object

Obsoleto: Usa verticales. 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: google.actions.orders.v3.verticals.purchase.PurchaseItemExtension google.actions.orders.v3.verticals.reservation.ReservationItemExtension google.actions.orders.v3.verticals.ticket.TicketItemExtension

Un objeto que contiene campos de un tipo arbitrario. Un campo adicional "@type" contiene una URI que identifica el tipo. Ejemplo: { "id": 1234, "@type": "types.example.com/standard/id" }.

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

object (PurchaseItemExtension)

Órdenes de compra como bienes, comida, etc.

reservation

object (ReservationItemExtension)

Pedidos de reserva, como restaurante, corte de cabello, etcétera

Atributo de precio

Es el atributo de precio de un pedido o una línea de pedido.

Representación JSON
{
  "type": enum (Type),
  "name": string,
  "state": enum (State),
  "taxIncluded": boolean,

  // Union field spec can be only one of the following:
  "amount": {
    object (Money)
  },
  "amountMillipercentage": number
  // End of list of possible types for union field spec.
}
Campos
type

enum (Type)

Obligatorio: Tipo de dinero.

name

string

Obligatorio: El usuario muestra una string del atributo price [precio]. El comerciante lo envía y localiza.

state

enum (State)

Obligatorio: Estado del precio: estimado o real

taxIncluded

boolean

Si el precio incluye impuestos.

Campo de unión spec. Representa el importe monetario o el porcentaje en milisegundos. Las direcciones (spec) solo pueden ser una de las siguientes opciones:
amount

object (Money)

Importe monetario

amountMillipercentage
(deprecated)

number

La especificación de porcentaje, a 1/1,000 de un porcentaje. P. ej.: 8.750% se representa como 8750, mientras que los porcentajes negativos representan porcentajes. Este campo dejará de estar disponible. Se puede considerar volver a agregar cuando se requiere un caso de uso sólido.

Tipo

Representa el tipo de dinero.

Enumeradores
TYPE_UNSPECIFIED El tipo no se especifica; los clientes no deberían tener que establecerlo de forma explícita.
REGULAR Precio visible normal, sin aplicar ningún descuento, etc.
DISCOUNT Se restará del subtotal.
TAX Se agregará al subtotal.
DELIVERY Se agregará al subtotal.
SUBTOTAL Es posible que se agregue un subtotal antes de que se agreguen algunas tarifas.
FEE Cualquier Tarifa Adicional.
GRATUITY Se agregará al subtotal.
TOTAL Precio mostrado del pedido o línea de pedido.

Estado

Representa el estado del precio.

Enumeradores
STATE_UNSPECIFIED No se especifica.
ESTIMATE El precio es solo una estimación.
ACTUAL Precio real que se le cobrará al usuario.

Dinero

Representa un importe de dinero con su tipo de moneda.

Representación JSON
{
  "currencyCode": string,
  "amountInMicros": string
}
Campos
currencyCode

string

El código de moneda de 3 letras definido en el estándar ISO 4217.

amountInMicros

string (int64 format)

Importe en micros. Por ejemplo, este campo se debe establecer como 1990000 por USD 1.99.

Acción

Una acción de seguimiento asociada con el pedido o la línea de pedido.

Representación JSON
{
  "type": enum (Type),
  "title": string,
  "openUrlAction": {
    object (OpenUrlAction)
  },
  "actionMetadata": {
    object (ActionMetadata)
  }
}
Campos
type

enum (Type)

Obligatorio: Tipo de acción.

title

string

Título o etiqueta de la acción, que se muestra al usuario. La longitud máxima permitida es de 100 caracteres.

openUrlAction

object (OpenUrlAction)

Medida que puede tomar.

actionMetadata

object (ActionMetadata)

Son los metadatos asociados con una acción.

Tipo

Posibles acciones de seguimiento.

Enumeradores
TYPE_UNSPECIFIED Acción no especificada.
VIEW_DETAILS Ver acción de detalles del pedido.
MODIFY Modifica la acción del pedido.
CANCEL Cancelar acción de pedido
RETURN Acción de devolver pedido.
EXCHANGE Acción de pedido de Exchange.
EMAIL

Acción de correo electrónico. Los tipos CALL y EMAIL dejaron de estar disponibles. Se puede usar openUrlAction.url como número de teléfono o correo electrónico.

CALL

Acción de llamada.

REORDER Acción para reordenar.
REVIEW Revisa la acción del pedido.
CUSTOMER_SERVICE Comunícate con atención al cliente.
FIX_ISSUE Dirígete a la app o el sitio del comercio para solucionar el problema.
DIRECTION Vínculo de dirección.

Acción de OpenUrl

Abre la URL dada.

Representación JSON
{
  "url": string,
  "androidApp": {
    object (AndroidApp)
  },
  "urlTypeHint": enum (UrlTypeHint)
}
Campos
url

string

El campo de URL, que puede ser: - http/https para abrir una aplicación vinculada a una aplicación o una página web

androidApp

object (AndroidApp)

Información sobre la app para Android si se espera que una app para Android cumpla con la URL.

urlTypeHint

enum (UrlTypeHint)

Indica una sugerencia para el tipo de URL.

App para Android

Especificación de la app para Android sobre las restricciones de entrega

Representación JSON
{
  "packageName": string,
  "versions": [
    {
      object (VersionFilter)
    }
  ]
}
Campos
packageName

string

Nombre del paquete. El nombre del paquete debe especificarse cuando se especifica la entrega de Android.

versions[]

object (VersionFilter)

Si se especifican varios, cualquier coincidencia de filtro activará la app.

Filtro de versión

Se debe incluir VersionFilter si se requieren versiones específicas de la app.

Representación JSON
{
  "minVersion": number,
  "maxVersion": number
}
Campos
minVersion

number

Código de versión mín. o 0, inclusive.

maxVersion

number

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, deje los atributos 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.

Sugerencia de URLUrlType

Diferentes tipos de sugerencias de URL.

Enumeradores
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">.

Metadatos de acciones

Metadatos relacionados por acción.

Representación JSON
{
  "expireTime": string
}
Campos
expireTime

string (Timestamp format)

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: "2014-10-02T15:01:23.045123456Z".

Divulgación

Es una divulgación de las políticas, los servicios o los productos que se pueden presentar al usuario.

Representación JSON
{
  "title": string,
  "disclosureText": {
    object (DisclosureText)
  },
  "presentationOptions": {
    object (DisclosurePresentationOptions)
  }
}
Campos
title

string

Es el título de la divulgación. Ejemplo: "Información de seguridad".

disclosureText

object (DisclosureText)

Contenido de la divulgación Se permiten los vínculos web.

presentationOptions

object (DisclosurePresentationOptions)

Opciones de presentación para la divulgación.

Texto de divulgación

Representa un texto sin formato con vínculos web.

Representación JSON
{
  "template": string,
  "textLinks": [
    {
      object (TextLink)
    }
  ]
}
Campos
template

string

Texto que se mostrará, con marcadores de posición como "{0}" y "{1}" para cada vínculo de texto que se deba insertar Ejemplo: "ADVERTENCIA: Este producto puede exponerte a productos químicos que el estado de California sabe que causan cáncer. Para obtener más información, consulta {0}. Este texto de divulgación no debe incluir contenido promocional ni similar a anuncios.

Opciones de presentación de divulgación

Opciones para la presentación de una divulgación

Representación JSON
{
  "presentationRequirement": enum (PresentationRequirement),
  "initiallyExpanded": boolean
}
Campos
presentationRequirement

enum (PresentationRequirement)

Requisito de presentación de la divulgación.

initiallyExpanded

boolean

Indica si el contenido de la divulgación debe expandirse inicialmente. De forma predeterminada, se contrae inicialmente.

Requisitos de la presentación

Requisito de la presentación de la divulgación.

Enumeradores
REQUIREMENT_UNSPECIFIED Requisito no especificado. No debe establecerse de manera explícita.
REQUIREMENT_OPTIONAL La divulgación es opcional. Se puede omitir si el dispositivo no admite mostrar divulgaciones.
REQUIREMENT_REQUIRED La divulgación es obligatoria. La conversación se despegará en el teléfono si el dispositivo no admite mostrar divulgaciones.

Extensión ItemItem

Contenido de la línea de pedido de la vertical de compra

Representación JSON
{
  "status": enum (PurchaseStatus),
  "userVisibleStatusLabel": string,
  "type": enum (PurchaseType),
  "productId": string,
  "quantity": number,
  "unitMeasure": {
    object (MerchantUnitMeasure)
  },
  "returnsInfo": {
    object (PurchaseReturnsInfo)
  },
  "fulfillmentInfo": {
    object (PurchaseFulfillmentInfo)
  },
  "itemOptions": [
    {
      object (ItemOption)
    }
  ],
  "extension": {
    "@type": string,
    field1: ...,
    ...
  },
  "productDetails": {
    object (ProductDetails)
  }
}
Campos
status

enum (PurchaseStatus)

Obligatorio: Estado a nivel de la línea de pedido.

userVisibleStatusLabel

string

Obligatorio: Etiqueta o string visible para el estado del usuario. La longitud máxima permitida es de 50 caracteres.

type

enum (PurchaseType)

Obligatorio: Tipo de compra.

productId
(deprecated)

string

Es el ID de producto o de oferta asociado con esta línea de pedido.

quantity

number

Cantidad del artículo.

unitMeasure

object (MerchantUnitMeasure)

Medida de unidad. Especifica el tamaño del elemento en las unidades elegidas. El tamaño, junto con el precio activo, se usa para determinar el precio unitario.

returnsInfo

object (PurchaseReturnsInfo)

Muestra información de esta línea de pedido. Si no se configura, esta línea de pedido hereda el nivel de pedido que muestra la información.

fulfillmentInfo

object (PurchaseFulfillmentInfo)

Información sobre la entrega de 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[]

object (ItemOption)

Complementos o elementos secundarios adicionales.

extension

object

Cualquier campo adicional intercambiado entre el comercio y Google.

Un objeto que contiene campos de un tipo arbitrario. Un campo adicional "@type" contiene una URI que identifica el tipo. Ejemplo: { "id": 1234, "@type": "types.example.com/standard/id" }.

productDetails

object (ProductDetails)

Detalles sobre el producto

Estado de la compra

Es el estado de compra asociado con una orden de compra o una línea de pedido en particular.

Enumeradores
PURCHASE_STATUS_UNSPECIFIED Estado sin especificar.
READY_FOR_PICKUP Listo para retirar.
SHIPPED Enviado.
DELIVERED Entregado.
OUT_OF_STOCK Agotado.
IN_PREPARATION "IN_PREPARATION" puede tener un significado diferente en un contexto diferente. Para el pedido de comida, podría ser comida que se está preparando. Para las ventas minoristas, podría ser un artículo que se está empaquetando.
CREATED Se creó 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 artículo.
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 pasar a otro estado después de que se maneje la solicitud.

Tipo de compra

Indica la categoría de compra.

Enumeradores
PURCHASE_TYPE_UNSPECIFIED Valor desconocido.
RETAIL Incluye compras como bienes físicos.
FOOD Incluye la compra de pedidos de comida.
GROCERY Compra de comestibles.
MOBILE_RECHARGE Compra prepaga de recarga móvil.

Medida de unidad de comercio

Medida de precio por unidad de comerciante.

Representación JSON
{
  "measure": number,
  "unit": enum (Unit)
}
Campos
measure

number

Valor: Ejemplo 1.2.

unit

enum (Unit)

Unidad: Ejemplo POUND, GRAM.

Unidad

Enumeradores
UNIT_UNSPECIFIED Unidad sin especificar.
MILLIGRAM Miligramo.
GRAM Gramo
KILOGRAM Kilograma.
OUNCE Onzas.
POUND Libra.

Información de devoluciones de compra

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

boolean

Si es verdadero, se permite un retorno.

daysToReturn

number

La devolución está permitida dentro de tantos días.

policyUrl

string

Vínculo a la política de devoluciones.

ComprarFulfillmentInfo

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 (Type),
  "expectedFulfillmentTime": {
    object (Time)
  },
  "expectedPreparationTime": {
    object (Time)
  },
  "location": {
    object (Location)
  },
  "expireTime": string,
  "price": {
    object (PriceAttribute)
  },
  "fulfillmentContact": {
    object (UserInfo)
  },
  "shippingMethodName": string,
  "storeCode": string,
  "pickupInfo": {
    object (PickupInfo)
  }
}
Campos
id

string

Es el identificador único de esta opción de servicio.

fulfillmentType

enum (Type)

Obligatorio: Es el tipo de entrega.

expectedFulfillmentTime

object (Time)

Una ventana si se especifica un intervalo de tiempo o de ETA si se especifica una única vez Hora estimada de entrega o retiro.

expectedPreparationTime

object (Time)

Una ventana si se especifica un intervalo de tiempo o de ETA si se especifica una única vez Tiempo esperado para preparar la comida. Se prefiere una sola vez.

location

object (Location)

Lugar de retiro o entrega.

expireTime

string (Timestamp format)

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: "2014-10-02T15:01:23.045123456Z".

price

object (PriceAttribute)

Costo de esta opción.

fulfillmentContact

object (UserInfo)

Es el contacto del usuario para esta entrega.

shippingMethodName

string

Es el nombre del método de envío que seleccionó el usuario.

storeCode

string

Código de tienda de la ubicación. Ejemplo: Walmart es el comercio y storeCode es la tienda de walmart en la que se realizó la entrega. https://support.google.com/business/answer/3370250?ref_topic=4596653.

pickupInfo

object (PickupInfo)

Información adicional sobre cómo se selecciona el pedido. Este campo solo se aplica cuando el tipo de entrega es PICKUP.

Tipo

Tipo de entrega.

Enumeradores
TYPE_UNSPECIFIED Indica un tipo no especificado.
DELIVERY Este pedido se entregará.
PICKUP Se debe retirar este pedido.

Tiempo

Construcción de tiempo para representar la hora a la que se usará un evento cuando se le muestra un pedido al usuario.

Representación JSON
{
  "timeIso8601": string
}
Campos
timeIso8601

string

Representa un tiempo de evento del pedido, como el tiempo de reserva, el tiempo de entrega, etcétera. Puede ser una duración (hora de inicio y finalización), solo la fecha, la hora, etc. Consulta https://en.wikipedia.org/wiki/ISO_8601 para conocer todos los formatos admitidos.

Información de retiro

Detalles sobre cómo se retira un pedido. Incluye detalles como el tipo de retiro y metadatos adicionales adjuntos a cada tipo, si corresponde.

Representación JSON
{
  "pickupType": enum (PickupType),
  "curbsideInfo": {
    object (CurbsideInfo)
  },
  "checkInInfo": [
    {
      object (CheckInInfo)
    }
  ]
}
Campos
pickupType

enum (PickupType)

Método de retiro, como INSTORE, CURBSIDE, etcétera

curbsideInfo

object (CurbsideInfo)

Detalles específicos de la información en la puerta. Si pickupType no es "CURBSIDE", se ignorará este campo.

checkInInfo[]

object (CheckInInfo)

Lista de varios métodos admitidos por el socio para admitir el registro.

Tipo de retiro

Lista de tipos de retiro admitidos.

Enumeradores
UNSPECIFIED Tipo de retiro sin especificar.
INSTORE Recoge la comida en el restaurante.
CURBSIDE Estaciona el vehículo en un lugar designado fuera del restaurante y alguien entregaría la comida allí.

Información de retiro

Detalles sobre cómo se facilitaría el orden de retiros en la puerta.

Representación JSON
{
  "curbsideFulfillmentType": enum (CurbsideFulfillmentType),
  "userVehicle": {
    object (Vehicle)
  }
}
Campos
curbsideFulfillmentType

enum (CurbsideFulfillmentType)

Los socios necesitan información adicional para facilitar los pedidos de retiros en la puerta. Según el tipo de entrega, se recopilarán los detalles correspondientes del usuario.

userVehicle

object (Vehicle)

Detalles del vehículo del usuario que realiza el pedido.

Tipo de entrega en la puerta

Valores posibles de los tipos de entrega en la puerta.

Enumeradores
UNSPECIFIED Tipo de entrega en la puerta sin especificar.
VEHICLE_DETAIL Se requiere el detalle del vehículo para facilitar el retiro en la puerta.

Vehículo

Detalles sobre un vehículo

Representación JSON
{
  "make": string,
  "model": string,
  "licensePlate": string,
  "colorName": string,
  "image": {
    object (Image)
  }
}
Campos
make

string

Marca del vehículo (p. ej., "Honda") Se muestra al usuario y debe localizarse. Obligatorio.

model

string

Modelo del vehículo (p.ej., “Grom”). Se muestra al usuario y debe localizarse. Obligatorio.

licensePlate

string

Número de matrícula del vehículo (p.ej., "1ABC234"). Obligatorio.

colorName

string

Nombre del color del vehículo, p. ej., negro Opcional.

image

object (Image)

URL a una foto del vehículo. La foto se mostrará aproximadamente en 256 × 256 px. Debe ser un archivo JPG o PNG. Opcional.

InformaciónDeRegistro

Son los metadatos que requiere el socio para admitir un método de registro.

Representación JSON
{
  "checkInType": enum (CheckInType)
}
Campos
checkInType

enum (CheckInType)

Método utilizado para enviar las instrucciones de registro.

Tipo de registro

Varios métodos que se usan para enviar las instrucciones de registro.

Enumeradores
CHECK_IN_TYPE_UNSPECIFIED Valor desconocido.
EMAIL La información de CheckIn se enviará por correo electrónico.
SMS La información de check-in se enviará por SMS.

Opción de elemento

Representa complementos o subelementos.

Representación JSON
{
  "id": string,
  "name": string,
  "prices": [
    {
      object (PriceAttribute)
    }
  ],
  "note": string,
  "quantity": number,
  "productId": string,
  "subOptions": [
    {
      object (ItemOption)
    }
  ]
}
Campos
id

string

Para las opciones que son artículos, el ID único del artículo.

name

string

Nombre de la opción.

prices[]

object (PriceAttribute)

Precio total de la opción.

note

string

Nota relacionada con la opción.

quantity

number

Para las opciones que son artículos, la cantidad.

productId

string

Es el ID de oferta o producto asociado con esta opción.

subOptions[]

object (ItemOption)

Para definir otras opciones secundarias anidadas.

Detalles del producto

Detalles sobre el producto

Representación JSON
{
  "productId": string,
  "gtin": string,
  "plu": string,
  "productType": string,
  "productAttributes": {
    string: string,
    ...
  }
}
Campos
productId

string

Es el ID de producto o de oferta asociado con esta línea de pedido.

gtin

string

Código comercial global de artículo del producto. Es útil si OfferId no está presente en Merchant Center. Opcional.

plu

string

Los códigos de búsqueda de precios, comúnmente conocidos como códigos de PLU, números de PLU, PLU, códigos de producción o etiquetas de productos, son un sistema de números que identifican de forma única los productos agrícolas al por mayor que se venden en los supermercados y los supermercados.

productType

string

Es la categoría de producto definida por el comercio. P.ej., "Home > Supermercado > Lácteos y Huevos > Leche > Leche entera"

productAttributes

map (key: string, value: string)

Detalles proporcionados por el comercio sobre el producto, p.ej., { "allergen": "peanut" }. Resulta útil si el ID de oferta no está presente en Merchant Center. Opcional.

Es un objeto que contiene una lista de pares "key": value. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Extensión de elemento de reservación

Contenido de la línea de pedido para pedidos de reservación, como restaurante, corte de cabello, etc. ID siguiente: 15.

Representación JSON
{
  "status": enum (ReservationStatus),
  "userVisibleStatusLabel": string,
  "type": enum (ReservationType),
  "reservationTime": {
    object (Time)
  },
  "userAcceptableTimeRange": {
    object (Time)
  },
  "confirmationCode": string,
  "partySize": number,
  "staffFacilitators": [
    {
      object (StaffFacilitator)
    }
  ],
  "location": {
    object (Location)
  },
  "extension": {
    "@type": string,
    field1: ...,
    ...
  }
}
Campos
status

enum (ReservationStatus)

Obligatorio: estado de la reserva

userVisibleStatusLabel

string

Obligatorio: Etiqueta o string visible para el estado del usuario. La longitud máxima permitida es de 50 caracteres.

type

enum (ReservationType)

Tipo de reserva. Puede no configurarse si no se aplica ninguna de las opciones de tipo.

reservationTime

object (Time)

Hora a la que se programó el evento o servicio. Puede ser un período, una fecha o una fecha y hora exactas.

userAcceptableTimeRange

object (Time)

Es el intervalo de tiempo aceptable para el usuario.

confirmationCode

string

Código de confirmación de esta reserva.

partySize

number

Es la cantidad de personas.

staffFacilitators[]

object (StaffFacilitator)

facilitadores de personal que darán servicio a la reserva. P. ej.: La peluquería.

location

object (Location)

Ubicación del servicio o evento.

extension

object

Cualquier campo adicional intercambiado entre el comercio y Google.

Un objeto que contiene campos de un tipo arbitrario. Un campo adicional "@type" contiene una URI que identifica el tipo. Ejemplo: { "id": 1234, "@type": "types.example.com/standard/id" }.

Estado de reserva

Estado de la reserva.

Enumeradores
RESERVATION_STATUS_UNSPECIFIED Estado sin especificar.
PENDING La reserva está pendiente.
CONFIRMED Se confirmó la reserva.
CANCELLED El usuario canceló la reserva.
FULFILLED Se completó la reserva.
CHANGE_REQUESTED Se solicitó el cambio de reserva
REJECTED El integrador venció o rechazó la reserva.

Tipo de reserva

Tipo de reserva.

Enumeradores
RESERVATION_TYPE_UNSPECIFIED Tipo no especificado
RESTAURANT Reserva para un restaurante.
HAIRDRESSER Reservas para peluquería.

Facilitador de personal

Información sobre el personal de servicio.

Representación JSON
{
  "name": string,
  "image": {
    object (Image)
  }
}
Campos
name

string

El nombre del facilitador del personal. P. ej.: “Juan Pérez”

image

object (Image)

Imágenes del artista.

Datos de pago

Datos de pago relacionados con un pedido

Representación JSON
{
  "paymentResult": {
    object (PaymentResult)
  },
  "paymentInfo": {
    object (PaymentInfo)
  }
}
Campos
paymentResult

object (PaymentResult)

Es el resultado de 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

object (PaymentInfo)

Información de pago relacionada con el pedido que es útil para la interacción del usuario.

Resultado del pago

Es el resultado del pago que usa el integrador para completar una transacción.

Representación JSON
{

  // Union field result can be only one of the following:
  "googlePaymentData": string,
  "merchantPaymentMethodId": string
  // End of list of possible types for union field result.
}
Campos
Campo de unión result. Se proporcionan los datos de pago de Google o la forma de pago del comercio. Las direcciones (result) solo pueden ser una de las siguientes opciones:
googlePaymentData

string

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 detalles. De lo contrario, consulta la siguiente documentación para obtener más detalles sobre la carga útil: https://developers.google.com/pay/api/payment-data-cryptography

merchantPaymentMethodId

string

Es la forma de pago que eligió el comercio o la acción.

Información de pago

Información de pago del pedido realizado. Este .proto captura información que es útil para la interacción del usuario.

Representación JSON
{
  "paymentMethodDisplayInfo": {
    object (PaymentMethodDisplayInfo)
  },
  "paymentMethodProvenance": enum (PaymentMethodProvenance)
}
Campos
paymentMethodDisplayInfo

object (PaymentMethodDisplayInfo)

Es la información visible de la forma de pago que se usó para realizar la transacción.

paymentMethodProvenance

enum (PaymentMethodProvenance)

Indica la procedencia de la forma de pago que se usó para realizar la transacción. El usuario puede haber registrado el mismo método de pago en Google y el comercio.

Información de la forma de pago para mostrar

Es el resultado del pago que usa el integrador para completar una transacción.

Representación JSON
{
  "paymentType": enum (PaymentType),
  "paymentMethodDisplayName": string,
  "paymentMethodVoiceName": string
}
Campos
paymentType

enum (PaymentType)

Es el tipo de pago.

paymentMethodDisplayName

string

Es el nombre visible del usuario de la forma de pago. Por ejemplo, VISA **** 1234 Cuenta corriente **** 5678

paymentMethodVoiceName

string

Nombre de la forma de pago que se pronunciará al usuario para los dispositivos con Asistente de voz solamente. Por ejemplo, "visa que termina en uno dos dos cuatro" o "cuenta corriente que termina en cinco seis siete ocho". Nota: Esta es la string optimizada para voz que se usará en lugar de paymentMethodDisplayName para dispositivos con Asistente de voz únicamente. Si no estableces esta string, el usuario recibirá en voz alta el método de pagoMethodDisplayName.

PaymentType

PaymentType indica la forma de pago que se usa para la forma de pago proporcionada por el comercio. La acción también debe proporcionar un nombre visible para la forma de pago.

Enumeradores
PAYMENT_TYPE_UNSPECIFIED Tipo de pago sin especificar.
PAYMENT_CARD Una tarjeta de crédito o débito, o una tarjeta prepagada.
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, es decir, PayPal

Procedencia de la forma de pago

Representa la procedencia de la forma de pago que se usó para realizar la transacción.

Enumeradores
PAYMENT_METHOD_PROVENANCE_UNSPECIFIED La procedencia no está especificada.
PAYMENT_METHOD_PROVENANCE_GOOGLE La procedencia es Google.
PAYMENT_METHOD_PROVENANCE_MERCHANT La procedencia es el comercio.

Promoción

Promociones/ofertas que se agregaron al carrito.

Representación JSON
{
  "coupon": string
}
Campos
coupon

string

Obligatorio: Se aplicó el código del cupón a esta oferta.

Extensión de pedido de compra

Extensión de pedido para la vertical de compra. 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 (PurchaseStatus),
  "userVisibleStatusLabel": string,
  "type": enum (PurchaseType),
  "returnsInfo": {
    object (PurchaseReturnsInfo)
  },
  "fulfillmentInfo": {
    object (PurchaseFulfillmentInfo)
  },
  "extension": {
    "@type": string,
    field1: ...,
    ...
  },
  "purchaseLocationType": enum (PurchaseLocationType),
  "errors": [
    {
      object (PurchaseError)
    }
  ]
}
Campos
status

enum (PurchaseStatus)

Obligatorio: estado general del pedido

userVisibleStatusLabel

string

Etiqueta o string visible para el estado. La longitud máxima permitida es de 50 caracteres.

type

enum (PurchaseType)

Obligatorio: Tipo de compra.

returnsInfo

object (PurchaseReturnsInfo)

Información de devolución del pedido.

fulfillmentInfo

object (PurchaseFulfillmentInfo)

Información de entrega del pedido.

extension

object

Cualquier campo adicional intercambiado entre el comercio y Google.

Un objeto que contiene campos de un tipo arbitrario. Un campo adicional "@type" contiene una URI que identifica el tipo. Ejemplo: { "id": 1234, "@type": "types.example.com/standard/id" }.

purchaseLocationType

enum (PurchaseLocationType)

Ubicación de la compra (en la tienda o en línea)

errors[]

object (PurchaseError)

Opcional: errores por los cuales se rechazó este pedido.

TipoDeUbicaciónDeCompra

Es el tipo de ubicación de la compra.

Enumeradores
UNSPECIFIED_LOCATION Valor desconocido.
ONLINE_PURCHASE Todas las compras que se hacen en línea
INSTORE_PURCHASE Todas las compras en la tienda.

Error de compra

Errores por los que se puede rechazar una orden de compra.

Representación JSON
{
  "type": enum (ErrorType),
  "description": string,
  "entityId": string,
  "updatedPrice": {
    object (PriceAttribute)
  },
  "availableQuantity": number
}
Campos
type

enum (ErrorType)

Obligatorio: Representa el motivo detallado por el que el comercio rechaza un pedido.

description

string

Descripción de error adicional.

entityId

string

ID de entidad que corresponde al error. Este ejemplo puede corresponder a LineItemId o ItemOptionId.

updatedPrice

object (PriceAttribute)

Relevante para el tipo de error PRICE_CHANGED / INORRECT_PRICE.

availableQuantity

number

Cantidad disponible ahora. Se aplica en caso de AVAILABILITY_CHANGED.

ErrorType

Posibles tipos de errores.

Enumeradores
ERROR_TYPE_UNSPECIFIED Error desconocido
NOT_FOUND No se encontró la entidad; podría ser Artículo, Entrega de artículos, Promoción. El ID de entidad es obligatorio.
INVALID Los datos de la entidad no son válidos. Pueden ser Artículo, Entrega de artículos, Promoción. El ID de entidad es obligatorio.
AVAILABILITY_CHANGED Elemento 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 del artículo. Se requiere el ID de la entidad y el precio actualizado.
INCORRECT_PRICE Errores de precio en Tarifas, Total. Se requiere el ID de la entidad y el precio actualizado.
REQUIREMENTS_NOT_MET Restricciones por aceptar pedido no alcanzado: tamaño mínimo de la cesta, etc.
TOO_LATE FulfillmentOption venció.
NO_CAPACITY No hay capacidad de servicio disponible.
INELIGIBLE El usuario no es apto para realizar el pedido (lista negra).
OUT_OF_SERVICE_AREA No se pudo realizar la entrega a la dirección solicitada debido a las reglas de borde, etcétera
CLOSED El restaurante está cerrado. No se realizan pedidos a la hora de hacer el pedido.
PROMO_NOT_APPLICABLE Código de error genérico para detectar todos los casos en los que no se aplica el código promocional, si ninguno de los siguientes es adecuado. Agrega el código promocional como ID de entidad.
PROMO_NOT_RECOGNIZED El socio no reconoció el código del cupón. Agrega el código promocional como ID de entidad.
PROMO_EXPIRED No se pudo aplicar porque venció la promoción. Agrega el código promocional como ID de entidad.
PROMO_USER_INELIGIBLE El usuario actual no es apto para recibir este cupón. Agrega el código promocional como ID de entidad.
PROMO_ORDER_INELIGIBLE El pedido actual no es apto para este cupón. Agrega el código promocional como ID de entidad.
UNAVAILABLE_SLOT El espacio para pedir por adelantado no está disponible.
FAILED_PRECONDITION No se cumplieron las restricciones para aceptar el pedido: tamaño de cesta mínimo, etc.
PAYMENT_DECLINED Pago no válido.
MERCHANT_UNREACHABLE No se puede contactar al comercio. Esto ayuda cuando un socio es un agregador y no pudo llegar al comercio.

Extensión de pedido de entrada

Contenido de los pedidos de entradas, como películas, deportes, etcétera.

Representación JSON
{
  "ticketEvent": {
    object (TicketEvent)
  }
}
Campos
ticketEvent

object (TicketEvent)

El evento se aplicó a todas las entradas de la línea de pedido.

Evento Entradas

Representa un solo evento.

Representación JSON
{
  "type": enum (Type),
  "name": string,
  "description": string,
  "url": string,
  "location": {
    object (Location)
  },
  "eventCharacters": [
    {
      object (EventCharacter)
    }
  ],
  "startDate": {
    object (Time)
  },
  "endDate": {
    object (Time)
  },
  "doorTime": {
    object (Time)
  }
}
Campos
type

enum (Type)

Obligatorio: Tipo de evento de la entrada, p. ej., película o concierto

name

string

Obligatorio: El nombre del evento. Por ejemplo, si el evento es una película, debería ser el nombre de la película.

description

string

Descripción del evento.

url

string

URL de la información del evento

location

object (Location)

La ubicación donde se realiza el evento o una organización.

eventCharacters[]

object (EventCharacter)

Son los caracteres relacionados con este evento. Pueden ser directores o actores de un evento cinematográfico, los artistas de un concierto, etcétera.

startDate

object (Time)

Hora de inicio

endDate

object (Time)

Hora de finalización

doorTime

object (Time)

La 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 la hora de entrada es 8:30 a.m.

Tipo

El tipo de evento.

Enumeradores
EVENT_TYPE_UNKNOWN Tipo de evento desconocido
MOVIE Película
CONCERT Concierto.
SPORTS Deportes.

Personaje del evento

Un personaje de evento, p. ej., organizador, artista, etcétera

Representación JSON
{
  "type": enum (Type),
  "name": string,
  "image": {
    object (Image)
  }
}
Campos
type

enum (Type)

Es el tipo de personaje del evento, p.ej., actor o director.

name

string

Es el nombre del personaje.

image

object (Image)

Imágenes del personaje

Tipo

Tipo de personaje.

Enumeradores
TYPE_UNKNOWN Tipo desconocido.
ACTOR Actor
PERFORMER Artista.
DIRECTOR Director
ORGANIZER Organizador.