Crear reservas

En esta guía, se explica el proceso de desarrollo de un proyecto de Acciones que use la API de Orders para realizar reservas.

Flujo de transacciones

Cuando tu proyecto de Acciones controla las reservas, usa el siguiente flujo:

  1. Valida los requisitos de las transacciones (opcional): Usa el asistente de requisitos de las transacciones al comienzo de la conversación para asegurarte de que el usuario pueda realizar una transacción.
  2. Crea el pedido: Guía al usuario a través de un "ensamblaje del carrito" en el que compila los detalles de su reserva.
  3. Proponer el pedido: Una vez que el "carrito" esté completo, propón el "pedido" de la reserva al usuario para que pueda confirmar que es correcto. Si se confirma la reserva, recibirás una respuesta con los detalles de la reserva.
  4. Finaliza el pedido y envía un recibo: Una vez confirmado el pedido, actualiza tu sistema de reservas y envía un recibo al usuario.
  5. Enviar actualizaciones de pedidos: En el transcurso de la vida útil de la reserva, envía solicitudes PATCH a la API de pedidos para proporcionar al usuario actualizaciones del estado de la reserva.

Restricciones y lineamientos para la revisión

Ten en cuenta que se aplican políticas adicionales a las acciones que usan la API de transacciones y pedidos. La revisión de las Acciones con transacciones puede tardar hasta seis semanas, por lo que te recomendamos que tengas en cuenta ese tiempo cuando planifiques tu programa de lanzamientos. Para facilitar el proceso de revisión, asegúrate de cumplir con las políticas y los lineamientos para las transacciones antes de enviar tu acción a revisión.

Solo puedes implementar Acciones que usen la API de Orders en los siguientes países:

Australia
Brasil
Canadá
Indonesia
Japón
México
Catar
Rusia
Singapur
Suiza
Tailandia
Turquía
Reino Unido
Estados Unidos

Cómo compilar un proyecto

Para ver un amplio ejemplo de conversaciones transaccionales, consulta nuestra muestra de transacciones en Node.js.

Configuración

Cuando creas tu acción, debes especificar que deseas realizar transacciones en la Consola de Actions.

Para configurar tu proyecto y la entrega, haz lo siguiente:

  1. Crea un proyecto nuevo o importa uno existente.
  2. Ve a Implementar > Información del directorio.
  3. En Información adicional > Transacciones > marca la casilla que dice “¿Tus acciones usan la API de transacciones para realizar transacciones de bienes físicos?”.

Valida los requisitos de las transacciones (opcional)

En cuanto el usuario indique que desea configurar una reserva, debes verificar que pueda solicitarla. Por ejemplo, cuando se invoca, la Acción podría preguntar: "¿Te gustaría reservar un lugar?". Si el usuario dice “sí”, debes asegurarte de que pueda continuar y darle la oportunidad de corregir cualquier configuración que impida continuar con la transacción. Para hacerlo, debes hacer una transición a una escena que realice una verificación de los requisitos de la transacción.

Crea una escena de verificación de requisitos para las transacciones

  1. En la pestaña Scenes, agrega una escena nueva con el nombre TransactionRequirementsCheck.
  2. En Relleno de ranuras, haz clic en + para agregar un espacio nuevo.
  3. En Select type, selecciona actions.type.TransactionRequirementsCheckResult como el tipo de ranura.
  4. En el campo del nombre del espacio, asígnale el nombre TransactionRequirementsCheck.
  5. Habilita la casilla de verificación Customize slot value writeback (habilitada de forma predeterminada).
  6. Haz clic en Guardar.

Una verificación de requisitos de la transacción da como resultado uno de los siguientes resultados:

  • Si se cumplen los requisitos, el parámetro de sesión se establece con una condición de éxito y puedes continuar con la creación del pedido del usuario.
  • Si no se pueden cumplir uno o más de los requisitos, el parámetro de sesión se establece con una condición de falla. En este caso, debes alejar la conversación de la experiencia transaccional o finalizar la conversación.
    • Si el usuario puede corregir los errores que generan el estado de falla, se le solicitará que resuelvan esos problemas en el dispositivo. Si la conversación se realiza en una superficie solo de voz, se iniciará un traspaso en el teléfono del usuario.

Controla el resultado de la verificación de requisitos de la transacción

  1. En la pestaña Scenes, selecciona la escena TransactionRequirementsCheck que acabas de crear.
  2. En Condición, haz clic en + para agregar una condición nueva.
  3. En el campo de texto, ingresa la siguiente sintaxis de condición para verificar la condición de éxito:

    scene.slots.status == "FINAL" && session.params.TransactionRequirementsCheck.resultType == "CAN_TRANSACT"
    
  4. Coloca el cursor sobre la condición que acabas de agregar y haz clic en la flecha hacia arriba para colocarla antes de if scene.slots.status == "FINAL".

  5. Habilita Send prompts y proporciona un mensaje simple que informe al usuario que está listo para realizar una transacción:

    candidates:
      - first_simple:
          variants:
            - speech: >-
                Looks like you're good to go!.
    
  6. En Transition, selecciona otra escena para que el usuario continúe la conversación y realice una transacción.

  7. Selecciona la condición else if scene.slots.status == "FINAL".

  8. Habilita Send prompts y proporciona un mensaje simple que informe al usuario que no puede realizar una transacción:

    candidates:
      - first_simple:
          variants:
            - speech: Transaction requirements check failed.
    
  9. En Transición, selecciona Finalizar conversación para finalizar la conversación si un usuario no puede realizar transacciones.

Arma el pedido

Una vez que tengas la información del usuario que necesitas, crea una experiencia de "ensamblaje del carrito" que guíe al usuario a crear su reserva. Cada acción tendrá un flujo de ensamblado del carrito ligeramente diferente según corresponda para su servicio.

En una experiencia básica de armado de carrito, un usuario selecciona opciones de una lista para agregar a su reserva, aunque puedes diseñar la conversación para simplificar la experiencia del usuario. Por ejemplo, crea una experiencia de ensamblaje de carritos que le permita al usuario programar una reserva mensual con una pregunta simple de sí o no. También puedes presentar al usuario un carrusel o una tarjeta de lista de reservas "recomendadas".

Recomendamos usar respuestas enriquecidas para presentar las opciones del usuario de forma visual, pero también diseñar la conversación para que el usuario pueda crear su carrito solo con su voz. Para conocer algunas prácticas recomendadas y ejemplos de experiencias de armado de carritos, consulta los lineamientos de diseño.

Crea un pedido

Durante la conversación, recopila los detalles de la reserva del usuario y, luego, construye un objeto Order.

Como mínimo, tu Order debe contener lo siguiente:

  • buyerInfo: Es la información sobre el usuario que realiza la compra.
  • transactionMerchant: Es información sobre el comercio que facilitó el pedido.
  • contents: Es el contenido real del pedido que aparece como lineItems.

Consulta la documentación de respuesta de Order para crear tu carrito. Ten en cuenta que es posible que debas incluir campos diferentes según la reserva.

El siguiente código de muestra indica un pedido de reserva completo, que incluye campos opcionales:

const order = {
   createTime: '2019-09-24T18:00:00.877Z',
   lastUpdateTime: '2019-09-24T18:00:00.877Z',
   merchantOrderId: orderId, // A unique ID String for the order
   userVisibleOrderId: orderId,
   transactionMerchant: {
     id: 'http://www.example.com',
     name: 'Example Merchant',
   },
   contents: {
     lineItems: [
       {
         id: 'LINE_ITEM_ID',
         name: 'Dinner reservation',
         description: 'A world of flavors all in one destination.',
         reservation: {
           status: 'PENDING',
           userVisibleStatusLabel: 'Reservation is pending.',
           type: 'RESTAURANT',
           reservationTime: {
             timeIso8601: '2020-01-16T01:30:15.01Z',
           },
           userAcceptableTimeRange: {
             timeIso8601: '2020-01-15/2020-01-17',
           },
           partySize: 6,
           staffFacilitators: [
             {
               name: 'John Smith',
             },
           ],
           location: {
             zipCode: '94086',
             city: 'Sunnyvale',
             postalAddress: {
               regionCode: 'US',
               postalCode: '94086',
               administrativeArea: 'CA',
               locality: 'Sunnyvale',
               addressLines: [
                 '222, Some other Street',
               ],
             },
           },
         },
       },
     ],
   },
   buyerInfo: {
     email: 'janedoe@gmail.com',
     firstName: 'Jane',
     lastName: 'Doe',
     displayName: 'Jane Doe',
   },
   followUpActions: [
     {
       type: 'VIEW_DETAILS',
       title: 'View details',
       openUrlAction: {
         url: 'http://example.com',
       },
     },
     {
       type: 'CALL',
       title: 'Call us',
       openUrlAction: {
         url: 'tel:+16501112222',
       },
     },
     {
       type: 'EMAIL',
       title: 'Email us',
       openUrlAction: {
         url: 'mailto:person@example.com',
       },
     },
   ],
   termsOfServiceUrl: 'http://www.example.com'
 };

Crear opciones de orden y presentación

const orderOptions = {
      'requestDeliveryAddress': false,
    };

const presentationOptions = {
      'actionDisplayName': 'RESERVE'
    };

Parámetro de guardar datos del pedido en la sesión

Desde tu entrega, guarda los datos del pedido en un parámetro de sesión. El objeto de orden se utilizará en todas las escenas de la misma sesión.

conv.session.params.order = {
    '@type': 'type.googleapis.com/google.actions.transactions.v3.TransactionDecisionValueSpec',
    order: order,
    orderOptions: orderOptions,
    presentationOptions: presentationOptions
};

Proponer el orden

Una vez que hayas creado un pedido de reserva, debes presentarlo al usuario para que lo confirme o lo rechace. Para hacerlo, debes realizar la transición a una escena que realice una decisión de transacción.

Crea una escena de decisión de transacciones

  1. En la pestaña Scenes, agrega una escena nueva con el nombre TransactionDecision.
  2. En Relleno de ranuras, haz clic en + para agregar un espacio nuevo.
  3. En Select type, selecciona actions.type.TransactionDecisionValue como el tipo de ranura.
  4. En el campo del nombre del espacio, asígnale el nombre TransactionDecision.
  5. Habilita la casilla de verificación Customize slot value writeback (habilitada de forma predeterminada).
  6. En Configurar espacio, selecciona Usar parámetro de sesión en el menú desplegable.
  7. En Configurar ranura, ingresa el nombre del parámetro de sesión que se usa para almacenar el pedido en el campo de texto (es decir, $session.params.order).
  8. Haz clic en Guardar.

Para intentar llenar un espacio de TransactionDecisionValue, Asistente inicia una experiencia integrada en la que el Order que pasaste se renderiza directamente en una "tarjeta de vista previa del carrito". El usuario puede decir “programar la reserva”, rechazar la transacción o solicitar que se cambien los detalles de la reserva.

En este momento, el usuario también puede solicitar cambios en el pedido. En este caso, debes asegurarte de que tu entrega pueda controlar las solicitudes de cambio de pedido después de finalizar la experiencia de ensamblaje del carrito.

Controla el resultado de la decisión de transacción

Cuando se llene un espacio TransactionDecisionValue, la respuesta del usuario a la decisión sobre la transacción se almacenará en un parámetro de sesión. Este valor contiene lo siguiente:

  • ORDER_ACCEPTED,
  • ORDER_REJECTED,
  • CART_CHANGE_REQUESTED
  • USER_CANNOT_TRANSACT.

Para administrar un resultado de decisión de transacción, haz lo siguiente:

  1. En la pestaña Scenes, selecciona la escena TransactionDecision que acabas de crear.
  2. En Condición, haz clic en + para agregar una condición nueva.
  3. En el campo de texto, ingresa la siguiente sintaxis de condición para verificar la condición de éxito:

    scene.slots.status == "FINAL" && session.params.TransactionDecision.transactionDecision == "ORDER_ACCEPTED"
    
  4. Coloca el cursor sobre la condición que acabas de agregar y haz clic en la flecha hacia arriba para colocarla antes de if scene.slots.status == "FINAL".

  5. Habilita Send prompts y proporciona un mensaje simple para que el usuario sepa que se completó la reserva:

    candidates:
      - first_simple:
          variants:
            - speech: >-
                Transaction completed! Your reservation
                $session.params.TransactionDecision.order.merchantOrderId is all
                set!
    
  6. En Transición, selecciona Finalizar conversación.

  7. En Condición, haz clic en + para agregar una condición nueva.

  8. En el campo de texto, ingresa la siguiente sintaxis de condición para verificar las condiciones de falla:

      scene.slots.status == "FINAL" && session.params.TransactionDecision.transactionDecision == "ORDER_REJECTED"
    
  9. Coloca el cursor sobre la condición que acabas de agregar y haz clic en la flecha hacia arriba para colocarla antes de if scene.slots.status == "FINAL".

  10. Habilita Send prompts y proporciona un mensaje simple para informar al usuario que se rechazó el pedido:

    candidates:
      - first_simple:
          variants:
            - speech: Looks like you don't want to set up a reservation. Goodbye.
    
  11. En Transición, selecciona Finalizar conversación.

  12. Selecciona la condición else if scene.slots.status == "FINAL".

  13. Habilita Send prompts y proporciona un mensaje simple para informar al usuario que no puede realizar una transacción:

    candidates:
      - first_simple:
          variants:
            - speech: >-
                Transaction failed with status
                $session.params.TransactionDecision.transactionDecision
    
  14. En Transición, selecciona Finalizar conversación para finalizar la conversación si un usuario no puede realizar transacciones.

Finaliza la reserva y envía un recibo

Cuando la ranura TransactionDecisionValue muestra un resultado de ORDER_ACCEPTED, debes realizar de inmediato el procesamiento necesario para programar la reserva (como conservarla en tu propia base de datos).

Envía una respuesta simple para que la conversación fluya. El usuario recibirá una "tarjeta de recibo contraída" junto con tu respuesta.

Para enviar una actualización inicial del pedido, sigue estos pasos:

  1. En la pestaña Scenes, selecciona tu escena TransactionDecision.
  2. En Condición, selecciona la condición que verifica el resultado exitoso, ORDER_ACCEPTED:

    scene.slots.status == "FINAL" && session.params.TransactionDecision.transactionDecision == "ORDER_ACCEPTED"
    
  3. Para esta condición, habilita Llamar a tu webhook (Call your webhook) y proporciona un nombre de controlador de intent, como update_order.

  4. En tu código de webhook, agrega un controlador de intents para enviar una actualización inicial del pedido:

    app.handle('update_order', conv => {
      const currentTime = new Date().toISOString();
      let order = conv.session.params.TransactionDecision.order;
      conv.add(new OrderUpdate({
        'updateMask': {
          'paths': [
            'reservation.status',
            'reservation.user_visible_status_label',
            'reservation.confirmation_code'
          ]
        },
        'order': {
          'merchantOrderId': order.merchantOrderId,
          'lastUpdateTime': currentTime,
          'reservation': {
            'status': 'CONFIRMED',
            'userVisibleStatusLabel': 'Reservation confirmed',
            'confirmationCode': '123ABCDEFGXYZ',
          },
        },
        'reason': 'Reason string'
      }));
    });
    

Enviar actualizaciones del pedido

El estado de la reserva cambia con el transcurso de su vida útil. Envía las actualizaciones del pedido de reserva del usuario con solicitudes HTTP PATCH a la API de Orders, que contienen el estado y los detalles del pedido.

Configura solicitudes asíncronas en la API de Orders

Las solicitudes de actualización de pedidos a la API de Orders están autorizadas por un token de acceso. Para empaquetar una actualización de pedido en la API de Orders, descarga una clave de cuenta de servicio JSON asociada con tu proyecto de Actions Console y, luego, intercambia la clave de la cuenta de servicio por un token del portador que se pueda pasar al encabezado Authorization de la solicitud HTTP.

Para recuperar la clave de tu cuenta de servicio, sigue estos pasos:

  1. En la consola de Google Cloud, ve a Menú \r > APIs y servicios > Credenciales > Crear credenciales > Clave de cuenta de servicio.
  2. En Cuenta de servicio, selecciona Nueva cuenta de servicio.
  3. Establece la cuenta de servicio en service-account.
  4. Configura el Rol como Proyecto > Propietario.
  5. Establece el tipo de clave en JSON.
  6. Selecciona Crear.
  7. Se descargará una clave de cuenta de servicio JSON privada en tu máquina local.

En tu código de actualizaciones de pedido, intercambia tu clave de servicio por un token del portador mediante la biblioteca cliente de las APIs de Google y el alcance "https://www.googleapis.com/auth/actions.order.developer". Puedes encontrar pasos de instalación y ejemplos en la página de GitHub de la biblioteca cliente de la API.

Haz referencia a order-update.js en nuestra muestra de Node.js para ver un intercambio de claves de ejemplo.

Enviar actualizaciones del pedido

Una vez que hayas intercambiado la clave de tu cuenta de servicio por un token del portador de OAuth, envía actualizaciones de pedidos como solicitudes PATCH autorizadas a la API de pedidos.

URL de la API de Orders: PATCH https://actions.googleapis.com/v3/orders/${orderId}

Proporciona los siguientes encabezados en tu solicitud:

  • "Authorization: Bearer token" por el token del portador de OAuth por el que intercambiaste la clave de tu cuenta de servicio.
  • "Content-Type: application/json".

La solicitud PATCH debe tener un cuerpo JSON con el siguiente formato:

{ "orderUpdate": OrderUpdate }

El objeto OrderUpdate consta de los siguientes campos de nivel superior:

  • updateMask: Son los campos del pedido que estás actualizando. Para actualizar el estado de la reserva, establece el valor en reservation.status, reservation.userVisibleStatusLabel.
  • order: Es el contenido de la actualización. Si actualizas el contenido de la reserva, establece el valor en el objeto Order actualizado. Si solo actualizas el estado de la reserva (por ejemplo, de "PENDING" a "FULFILLED"), el objeto contendrá los siguientes campos:

    • merchantOrderId: Es el mismo ID que configuraste en tu objeto Order.
    • lastUpdateTime: Es la marca de tiempo de esta actualización.
    • purchase: Es un objeto que contiene lo siguiente:
      • status: Es el estado del pedido como ReservationStatus, como "CONFIRMED" o "CANCELLED".
      • userVisibleStatusLabel: Es una etiqueta visible para el usuario que proporciona detalles sobre el estado del pedido, como “Se confirmó tu reserva”.
  • userNotification que se puede mostrar en el dispositivo del usuario cuando se envía esta actualización. Ten en cuenta que incluir este objeto no garantiza que aparezca una notificación en el dispositivo del usuario.

En el siguiente código de muestra, se presenta un OrderUpdate de ejemplo que actualiza el estado del pedido de reserva a FULFILLED:

// Import the 'googleapis' module for authorizing the request.
const {google} = require('googleapis');
// Import the 'request-promise' module for sending an HTTP POST request.
const request = require('request-promise');
// Import the OrderUpdate class from the client library.
const {OrderUpdate} = require('@assistant/conversation');

// Import the service account key used to authorize the request.
// Replacing the string path with a path to your service account key.
// i.e. const serviceAccountKey = require('./service-account.json')

// Create a new JWT client for the Actions API using credentials
// from the service account key.
let jwtClient = new google.auth.JWT(
   serviceAccountKey.client_email,
   null,
   serviceAccountKey.private_key,
   ['https://www.googleapis.com/auth/actions.order.developer'],
   null,
);

// Authorize the client
let tokens = await jwtClient.authorize();

// Declare the ID of the order to update.
const orderId = '<UNIQUE_MERCHANT_ORDER_ID>';

// Declare order update
const orderUpdate = new OrderUpdate({
   updateMask: {
     paths: [
       'contents.lineItems.reservation.status',
       'contents.lineItems.reservation.userVisibleStatusLabel'
     ]
   },
   order: {
     merchantOrderId: orderId, // Specify the ID of the order to update
     lastUpdateTime: new Date().toISOString(),
     contents: {
       lineItems: [
         {
           reservation: {
             status: 'FULFILLED',
             userVisibleStatusLabel: 'Reservation fulfilled',
           },
         }
       ]
     },
   },
   reason: 'Reservation status was updated to fulfilled.',
});

// Set up the PATCH request header and body,
// including the authorized token and order update.
let options = {
 method: 'PATCH',
 uri: `https://actions.googleapis.com/v3/orders/${orderId}`,
 auth: {
   bearer: tokens.access_token,
 },
 body: {
   header: {
     isInSandbox: true,
   },
   orderUpdate,
 },
 json: true,
};

// Send the PATCH request to the Orders API.
try {
 await request(options);
} catch (e) {
 console.log(`Error: ${e}`);
}

Establece el estado de la reserva

El elemento ReservationStatus de una actualización de pedido debe describir el estado actual del pedido. En el campo order.ReservationStatus de tu actualización, usa uno de los siguientes valores:

  • PENDING: Tu acción "creó" la reserva, pero requiere procesamiento adicional en el backend.
  • CONFIRMED: La reserva se confirma en el backend de programación.
  • CANCELLED: El usuario canceló su reserva.
  • FULFILLED: El servicio completó la reserva del usuario.
  • CHANGE_REQUESTED: El usuario solicitó un cambio en la reserva y se está procesando el cambio.
  • REJECTED: si no pudiste procesar o confirmar la reserva.

Envía actualizaciones de los pedidos por cada estado que sea relevante para tu reserva. Por ejemplo, si tu reserva requiere procesamiento manual para confirmarla después de que se solicita, envía una actualización de pedido de PENDING hasta que se complete el procesamiento adicional. No todas las reservas requieren todos los valores de estado.

Cómo probar tu proyecto

Cuando pruebas tu proyecto, puedes habilitar el modo de zona de pruebas en la Consola de Actions para probar tu acción sin cobrar a una forma de pago. Para habilitar el modo de zona de pruebas, sigue estos pasos:

  1. En la Consola de Actions, haz clic en Test, en el menú de navegación.
  2. Haz clic en Configuración.
  3. Habilita la opción Zona de pruebas de desarrollo.

Para las transacciones físicas, también puedes configurar el campo isInSandbox como true en la muestra. Esta acción equivale a habilitar el parámetro de configuración del modo de zona de pruebas en la Consola de Actions. Para ver un fragmento de código que usa isInSandbox, consulta la sección Envía actualizaciones de pedidos.

Solución de problemas

Si tienes algún problema durante la prueba, lee nuestros pasos para solucionar problemas de transacciones.