La API de Transactions se dará de baja el 3 de mayo de 2023, antes de la baja de Conversational Actions el 13 de junio de 2023. Para obtener más información, consulta Eliminación de acciones en conversaciones.

Se usó la API de Cloud Translation para traducir esta página.

Cómo crear transacciones digitales consumibles (Dialogflow)

En esta guía, se explica cómo agregar transacciones digitales a tu acción conversacional para que los usuarios puedan comprar tus artículos digitales consumibles.

Términos clave: Un artículo digital consumible es una unidad de almacenamiento (SKU) que un usuario puede usar y comprar más de una vez, como una cantidad de moneda de un juego para Android. Este artículo digital es diferente de un artículo digital no consumible que un usuario solo puede comprar una vez.

Para obtener más información sobre los productos consumibles únicos, consulta la documentación de Android sobre las funciones específicas de productos únicos.

Restricciones y lineamientos para la revisión

Se aplican políticas adicionales a las Acciones con transacciones. Es posible que tardemos algunas semanas en revisar las Acciones que incluyen transacciones, así que ten 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 la acción a revisión.

Las acciones que venden artículos digitales solo se pueden implementar en los siguientes países:

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

Flujo de transacciones

En esta guía, se describe cada paso de desarrollo a medida que ocurren en un flujo de transacción de artículos digitales. Cuando tu Acción controla transacciones de artículos digitales, usa el siguiente flujo:

Configura un cliente de la API de compras digitales: Tu Acción usa la API de compras digitales para comunicarse con tu inventario de Google Play y realizar transacciones. Antes de que tu Acción haga cualquier otra cosa, crea un cliente de JWT con una clave de servicio para comunicarse con la API de compras digitales.
Recopilar información: Tu Acción recopila información básica sobre el usuario y tu inventario de Google Play a fin de preparar una transacción.
1. Valida los requisitos de las transacciones: Tu Acción usa el asistente de requisitos de transacciones digitales al comienzo del flujo de compra para garantizar que el usuario pueda realizar la transacción.
2. Reúne el inventario disponible: Tu Acción verifica tu inventario de Google Play e identifica los elementos que están disponibles para la compra en ese momento.
Crea el pedido: Tu Acción presenta los artículos digitales disponibles al usuario para que pueda seleccionar uno y comprarlo.
Completa la compra: Tu Acción usa la API de compras digitales para iniciar una compra con la selección del usuario en Google Play Store.
Controla el resultado: Tu acción recibe un código de estado para la transacción y notifica al usuario que la compra se realizó correctamente (o realiza pasos adicionales).
Hacer que la compra se pueda repetir: Tu Acción usa la API de compras digitales a fin de "consumir" el artículo comprado, lo que permite que ese usuario vuelva a comprarlo.

Requisitos previos

Antes de incorporar transacciones digitales en tu Acción, necesitas los siguientes requisitos previos:

Una cuenta de desarrollador y una cuenta de comerciante en Google Play para administrar tus artículos digitales en Google Play Console
Un dominio web que esté verificado en Google Search Console No es necesario que este dominio esté asociado a un sitio web que se haya lanzado públicamente; solo necesitamos hacer referencia a tu dominio web.
Una app para Android con el permiso com.android.vending.BILLING en Google Play Console Tus artículos digitales estarán asociados a las "compras directas desde la aplicación" en Google Play Console.

También debes crear una versión en Play Console con esta app, pero si no quieres que sea pública, puedes crear una versión alfa cerrada.

Si aún no tienes una app para Android, sigue las instrucciones para asociar una app para Android.
Uno o más productos administrados en Google Play Console, que son artículos digitales que vendes con tu Acción Ten en cuenta que no puedes crear productos administrados en Play Console hasta que configures el requisito previo de la app para Android.

Si aún no tienes productos administrados, sigue las instrucciones para crear artículos digitales.

Asocia una app para Android

Si actualmente no tienes una app para Android con el permiso de facturación en Google Play Console, sigue estos pasos:

En Android Studio o en el IDE de Android que prefieras, crea un proyecto nuevo. Elige opciones en las instrucciones de configuración del proyecto para crear una app muy básica.
Asígnale al proyecto un nombre de paquete, como com.mycompany.myapp. No dejes este nombre como predeterminado, ya que no puedes subir paquetes que incluyan com.example a Play Console.
Abre el archivo AndroidManifest.xml de tu app.

Agrega la siguiente línea de código dentro del elemento manifest:

<uses-permission android:name="com.android.vending.BILLING" />

Tu archivo AndroidManifest.xml debería verse como el siguiente bloque de código:

<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools"
    package="com.mycompany.myapp">
    <uses-permission android:name="com.android.vending.BILLING" />

    <application
        android:allowBackup="true"
        android:icon="@mipmap/ic_launcher"
        android:label="@string/app_name"
        android:roundIcon="@mipmap/ic_launcher_round"
        android:supportsRtl="true"
        android:theme="@style/AppTheme" />
</manifest>

Compila tu app como un APK firmado. En Android Studio, sigue estos pasos:
1. Ve a Build, Generate Signed Bundle / APK.
2. Presiona Siguiente.
3. En Ruta de acceso al almacén de claves, haz clic en Crear nueva.
4. Completa todos los campos y haz clic en Aceptar. Toma nota de la contraseña del almacén de claves y la contraseña de la clave, y almacénalas en un lugar seguro, ya que las usarás más adelante.
5. Presiona Siguiente.
6. Selecciona versión.
7. Selecciona V1 (JAR Signature).
8. Haz clic en Finish.
9. Después de unos segundos, Android Studio genera un archivo app-release.apk. Ubica este archivo para usarlo más adelante.
En Google Play Console, crea una aplicación nueva.
Ve a Versiones de la app.
En Segmentos cerrados, ve a Administrar y, luego, a Alfa.
Haz clic en el botón Crear versión.
En Permite que Google administre y proteja tu clave de firma, ingresa la información de tu clave de firma.
Sube el archivo APK.
Haz clic en Guardar.

Crea tus artículos digitales

Si actualmente no tienes artículos digitales en Play Console, sigue estos pasos:

En Google Play Console, ve a Productos integrados en la aplicación y, luego, a Productos administrados. Si ves una advertencia, sigue las instrucciones anteriores para crear una app para Android o haz clic en el vínculo para crear un perfil de comercio.
Haz clic en Crear producto administrado.
Completa los campos de tu producto digital. Toma nota del ID del producto, que es la forma en que harás referencia a este producto desde tu Acción.
Haz clic en Guardar.
Repite los pasos 2 a 4 para cada producto que desees vender.

Ejemplos de bienes consumibles en Google Play Console

Prepara tu proyecto de acciones

Con tus artículos digitales configurados en Google Play Console, debes habilitar las transacciones digitales y asociar tu proyecto de Acciones con tu app de Play.

Para activar las transacciones de artículos digitales en tu proyecto de Acciones, sigue estos pasos:

En la Consola de Actions, abre tu proyecto o crea uno nuevo.
Ve a Implementar y, luego, a Información del directorio.
En Información adicional y Transacciones, marca la casilla Sí en ¿Tus acciones usan la API de compra digital para realizar transacciones de artículos digitales?
Haz clic en Guardar.

Crea una clave de API para artículos digitales

Para enviar solicitudes a la API de artículos digitales, debes descargar una clave de cuenta de servicio JSON asociada con tu proyecto de la Consola de Actions.

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

En la Consola de Actions, haz clic en el ícono de tres puntos en la esquina superior derecha y, luego, en Configuración del proyecto.
Busca el ID del proyecto de tu Acción.
Sigue este vínculo y reemplaza “<project_id>” por el ID de tu proyecto: https://console.developers.google.com/apis/credentials?project=project_id
En la navegación principal, ve a Credenciales.
En la página que aparece, haz clic en Crear credenciales y, luego, en Clave de cuenta de servicio.
Ve a Cuenta de servicio y haz clic en Nueva cuenta de servicio.
Asigna un nombre como digitaltransactions a la cuenta de servicio.
Haz clic en Crear.
Establece el Rol en Proyecto > Propietario.
Haz clic en Continuar.
Haga clic en Crear clave.
Selecciona el tipo de clave JSON.
Haz clic en Crear clave y descarga la clave de cuenta de servicio JSON.

Guarda esta clave de cuenta de servicio en un lugar seguro. Usarás esta clave en tu entrega a fin de crear un cliente para la API de compras digitales.

Conéctate a tu inventario de Play

Para acceder a tus artículos digitales desde un proyecto de Acciones, asocia tu dominio web y la app con tu proyecto como propiedades conectadas.

Nota: Los pasos de conexión pueden tardar hasta una semana en completarse mientras verificamos tus propiedades. Si tu sitio web o app no están vinculados después de ese tiempo, comunícate con el equipo de asistencia.

Para conectar el dominio web y la app de Play Console a tu proyecto de Acciones, sigue estos pasos:

En la Consola de Actions, ve a Implementar y, luego, a Verificación de marca.
Si no conectaste ninguna propiedad, primero conecta un sitio web:
1. Haz clic en el botón de propiedad web (</>).
2. Ingresa la URL de tu dominio web y haz clic en Conectar.
Google envía un correo electrónico con más instrucciones a la persona que tiene la verificación de ese dominio web en Google Search Console. Una vez que el destinatario de este correo electrónico siga esos pasos, el sitio web debería aparecer en Verificación de marca.
Una vez que tengas al menos un sitio web conectado, sigue estos pasos para conectar tu app para Android:
1. En la Consola de Actions, ve a Implementar y, luego, a Verificación de marca.
2. Haz clic en Conectar app.
3. En la página que aparece, sigue las instrucciones para verificar tu dominio web en Play Console. Selecciona la app de Play que contiene tus artículos digitales y, luego, ingresa la URL del dominio web exactamente como se muestra en la página Verificación de marca.
  
  Una vez más, Google envía un correo electrónico de verificación al propietario verificado del dominio. Una vez que se apruebe la verificación, tu app de Play debería aparecer en Verificación de marca.
  
  Nota: Tu dominio web aparecerá en Play Console antes que en la Consola de Actions. La Consola de Actions puede tardar varios días en actualizarse.
4. Habilita Acceder a compras en Play.

Imagen en la que se muestran el sitio web y las apps conectadas al proyecto de Actions.

Crea tu flujo de compra

Con tu proyecto de Acciones y tu inventario de artículos digitales preparados, crea un flujo de compra de artículos digitales en tu webhook de entrega de conversaciones.

1. Cómo configurar un cliente de API de compras digitales

En el webhook de entrega de conversaciones, crea un cliente de JWT con la clave JSON de tu cuenta de servicio y el alcance https://www.googleapis.com/auth/actions.purchases.digital.

El siguiente código de Node.js crea un cliente JWT para la API de compras digitales:

  const serviceAccount = {'my-file.json'};
  const request = require('request');
  const {google} = require('googleapis');

  const jwtClient = new google.auth.JWT(
    serviceAccount.client_email, null, serviceAccount.private_key,
    ['https://www.googleapis.com/auth/actions.purchases.digital'],
    null
  );

2. Recopila información

Antes de que el usuario pueda realizar una compra, tu Acción recopila información sobre su capacidad para realizar compras y qué productos están disponibles en tu inventario.

2. a. Valida los requisitos de las transacciones

Se recomienda asegurarse de que la cuenta del usuario esté configurada para realizar transacciones antes de darle la opción de realizar una compra. Este paso incluye verificar que el usuario tenga configurada una forma de pago y que esté en una configuración regional donde se admitan transacciones digitales. Al comienzo del flujo de transacciones, usa el ayudante DIGITAL_PURCHASE_CHECK para validar la configuración de transacciones del usuario con Asistente.

El siguiente código de Node.js usa el DIGITAL_PURCHASE_CHECK al comienzo de la conversación:

app.intent('Default Welcome Intent', async (conv, { SKU }) => {
  // Immediately invoke digital purchase check intent to confirm
  // purchase eligibility.
  conv.ask(new DigitalPurchaseCheck());
});

Busca el resultado de esta verificación en los argumentos de la conversación como DIGITAL_PURCHASE_CHECK_RESULT. En función de este resultado, continúa con el flujo de la transacción o retíralo y pídele que verifique su configuración de Google Pay.

El siguiente código de Node.js controla el resultado de la verificación de requisitos :

app.intent('Digital Purchase Check', async (conv) => {
  const arg = conv.arguments.get('DIGITAL_PURCHASE_CHECK_RESULT');
  if (!arg || !arg.resultType) {
    conv.close('Digital Purchase check failed. Please check logs.');
    return;
  }
  // User does not meet necessary conditions for completing a digital purchase
  if (arg.resultType === 'CANNOT_PURCHASE' || arg.resultType === 'RESULT_TYPE_UNSPECIFIED') {
    conv.close(`It looks like you aren't able to make digital purchases. Please check your Google Pay configuration and try again.`);
    return;
  }
  conv.ask('Welcome to the Digital Goods Sample. Would you like to see what I have for sale?');
});

2. b. Reunir el inventario disponible

Usa la API de compras digitales para solicitar tu inventario de Play Store disponible actualmente y, luego, compílalo en un array de objetos JSON para cada producto. Más adelante, harás referencia a este array para mostrarle al usuario qué opciones están disponibles para la compra.

Cada uno de tus artículos digitales está representado como un SKU en formato JSON. En el siguiente código de Node.js, se describe el formato esperado de cada SKU:

body = {
  skus: [
    skuId: {
      skuType: one of "APP" or "UNSPECIFIED"
      id: string,
      packageName: string
    }
    formattedPrice: string,
    title: string,
    description: string
  ]
}

Envía una solicitud POST al extremo https://actions.googleapis.com/v3/packages/{packageName}/skus:batchGet, en el que {packageName} es el nombre del paquete de tu app en Google Play Console (por ejemplo, com.myapp.digitalgoods), y dale formato al resultado en un array de objetos SKU.

Para recuperar solo artículos digitales específicos en el array resultante, enumera los IDs de los productos para artículos digitales (como se muestra en cada producto integrado en la aplicación en Google Play Console) que desees que estén disponibles para la compra en body.ids.

El siguiente código de Node.js solicita una lista de productos disponibles de la API de compras digitales y da formato al resultado como un array de SKU:

return jwtClient.authorize((err, tokens) => {
    if (err) {
      throw new Error(`Auth error: ${err}`);
    }

    const packageName = 'com.example.projectname';

    request.post(`https://actions.googleapis.com/v3/packages/${packageName}/skus:batchGet`, {
      'auth': {
        'bearer': tokens.access_token,
      },
      'json': true,
      'body': {
        'conversationId': conversationId,
        'skuType': 'APP',
        // This request is filtered to only retrieve SKUs for the following product IDs
        'ids': ['consumable.1']
      },
    }, (err, httpResponse, body) => {
      if (err) {
        throw new Error(`API request error: ${err}`);
      }
      console.log(`${httpResponse.statusCode}: ${httpResponse.statusMessage}`);
      console.log(JSON.stringify(body));
    });
  });
});

3. Arma el pedido

Para iniciar la compra digital del usuario, presenta una lista de tus artículos digitales disponibles para la compra. Puedes usar una variedad de tipos de respuestas enriquecidas para representar tu stock y pedirle al usuario que seleccione una opción.

El siguiente código de Node.js lee un array de inventario de objetos SKU y crea una respuesta de lista con un elemento de lista para cada uno:

skus.forEach((sku) => {
  const key = `${sku.skuId.skuType},${sku.skuId.id}`
  list.items[key] = {
    title: sku.title,
    description: `${sku.description} | ${sku.formattedPrice}`,
  };
});

4. Completa la compra

Para completar la compra, usa el intent de ayuda COMPLETE_PURCHASE con el elemento que seleccionó el usuario.

El siguiente código de Node.js controla la selección del SKU del usuario de una respuesta de lista y solicita el intent COMPLETE_PURCHASE con esa información:

app.intent('Send Purchase', (conv, params, option) => {
  let [skuType, id] = option.split(',');

  conv.ask(new CompletePurchase({
    skuId: {
      skuType: skuType,
      id: id,
      packageName: <PACKAGE_NAME>,
    },
  }));
});

5. Controla el resultado

Cuando se completa la compra, se activa el evento actions_intent_COMPLETE_PURCHASE de Dialogflow (o el intent del SDK de Actions actions.intent.COMPLETE_PURCHASE) con un argumento COMPLETE_PURCHASE_VALUE que describe el resultado. Compila un intent, activado por este evento, que comunique el resultado al usuario.

Controla los siguientes resultados de compras posibles:

PURCHASE_STATUS_OK: La compra se realizó correctamente. La transacción se completó en este punto, así que sal del flujo transaccional y vuelve a la conversación.
PURCHASE_STATUS_ALREADY_OWNED: No se pudo realizar la transacción porque el usuario ya es propietario de ese elemento. Para evitar este error, revisa las compras anteriores del usuario y adapta los artículos que se muestran para que no tenga la opción de volver a comprar los que ya posee.
PURCHASE_STATUS_ITEM_UNAVAILABLE: La transacción falló porque el elemento solicitado no está disponible. Para evitar este error, verifica los SKU disponibles más cerca del momento de la compra.
PURCHASE_STATUS_ITEM_CHANGE_REQUESTED: No se pudo realizar la transacción porque el usuario decidió comprar otro producto. Vuelve a preguntar en la creación de tu pedido para que el usuario pueda tomar otra decisión de inmediato.
PURCHASE_STATUS_USER_CANCELLED: La transacción falló porque el usuario canceló el flujo de compra. Dado que el usuario salió del flujo antes de tiempo, pregúntale si quiere volver a intentar la transacción o salir de ella por completo.
PURCHASE_STATUS_ERROR: No se pudo realizar la transacción por un motivo desconocido. Informa al usuario que no se pudo realizar la transacción y pregúntale si desea volver a intentarlo.
PURCHASE_STATUS_UNSPECIFIED: La transacción falló por un motivo desconocido, lo que genera un estado desconocido. Para manejar este estado de error, infórmale al usuario que la transacción falló y pregúntale si desea volver a intentarlo.

El siguiente código de Node.js lee el argumento COMPLETE_PURCHASE_VALUE y controla cada resultado:

app.intent('Purchase Result', (conv) => {
  const arg = conv.arguments.get('COMPLETE_PURCHASE_VALUE');
  console.log('User Decision: ' + JSON.stringify(arg));
  if (!arg || !arg.purchaseStatus) {
    conv.close('Purchase failed. Please check logs.');
    return;
  }
  if (arg.purchaseStatus === 'PURCHASE_STATUS_OK') {
    conv.close(`Purchase completed! You're all set!`);
  } else if (arg.purchaseStatus === 'PURCHASE_STATUS_ALREADY_OWNED') {
    conv.close('Purchase failed. You already own this item.');
  } else if (arg.purchaseStatus === 'PURCHASE_STATUS_ITEM_UNAVAILABLE') {
    conv.close('Purchase failed. Item is not available.');
  } else if (arg.purchaseStatus === 'PURCHASE_STATUS_ITEM_CHANGE_REQUESTED') {
    // Reprompt with your item selection dialog
  }  else {
    conv.close('Purchase Failed:' + arg.purchaseStatus);
  }
});

6. Hacer que la compra sea repetible

Cada uno de tus artículos digitales está representado como un SKU en formato JSON. En el siguiente código de Node.js, se describe el formato esperado de cada SKU:

body = {
  skus: [
    skuId: {
      skuType: one of "APP" or "UNSPECIFIED"
      id: string,
      packageName: string
    }
    formattedPrice: string,
    title: string,
    description: string
  ]
}

El siguiente código de Node.js solicita una lista de productos disponibles de la API de compras digitales y da formato al resultado como un array de SKU:

return jwtClient.authorize((err, tokens) => {
    if (err) {
      throw new Error(`Auth error: ${err}`);
    }

    const packageName = 'com.example.projectname';

    request.post(`https://actions.googleapis.com/v3/packages/${packageName}/skus:batchGet`, {
      'auth': {
        'bearer': tokens.access_token,
      },
      'json': true,
      'body': {
        'conversationId': conversationId,
        'skuType': 'APP',
        // This request is filtered to only retrieve SKUs for the following product IDs
        'ids': ['consumable.1']
      },
    }, (err, httpResponse, body) => {
      if (err) {
        throw new Error(`API request error: ${err}`);
      }
      console.log(`${httpResponse.statusCode}: ${httpResponse.statusMessage}`);
      console.log(JSON.stringify(body));
    });
  });
});

Reflejar las compras del usuario

Cuando un usuario consulta tu Acción, el objeto user de la solicitud JSON incluye una lista de sus compras. Verifica esta información y cambia la respuesta de tu Acción según el contenido que haya pagado el usuario.

En el siguiente código de ejemplo, se muestra el objeto user de una solicitud que incluye packageEntitlements de las compras directas desde la aplicación que realizaron anteriormente para el paquete com.digitalgoods.application:

  "user": {
    "userId": "xxxx",
    "locale": "en-US",
    "lastSeen": "2018-02-09T01:49:23Z",
    "packageEntitlements": [
      {
        "packageName": "com.digitalgoods.application",
        "entitlements": [
          {
            "sku": "non-consumable.1",
            "skuType": "APP"
          }
          {
            "sku": "consumable.2",
            "skuType": "APP"
          }
        ]
      },
      {
        "packageName": "com.digitalgoods.application",
        "entitlements": [
          {
            "sku": "annual.subscription",
            "skuType": "SUBSCRIPTION",
            "inAppDetails": {
              "inAppPurchaseData": {
                "autoRenewing": true,
                "purchaseState": 0,
                "productId": "annual.subscription",
                "purchaseToken": "12345",
                "developerPayload": "HSUSER_IW82",
                "packageName": "com.digitalgoods.application",
                "orderId": "GPA.233.2.32.3300783",
                "purchaseTime": 1517385876421
              },
              "inAppDataSignature": "V+Q=="
            }
          }
        ]
      }
    ]
  },
  "conversation": {
    "conversationId": "1518141160297",
    "type": "NEW"
  },
  "inputs": [
    {
      "intent": "actions.intent.MAIN",
      "rawInputs": [
        {
          "inputType": "VOICE",
          "query": "Talk to My Test App"
        }
      ]
    }
  ],
  ...
}