Este guia explica como adicionar transações digitais à sua ação de conversa para que os usuários possam comprar seus produtos e softwares digitais consumíveis.
Termos-chave: um produto digital consumível é uma unidade de manutenção de estoque (SKU) que um usuário pode usar e comprar mais de uma vez, como uma quantidade de moeda no jogo para um jogo para Android. Esse produto digital é diferente de um produto digital que não é de consumo, que o usuário só pode comprar uma vez.
Para ver mais informações sobre produtos de aquisição única de consumo, consulte a documentação do Android sobre recursos específicos de produtos de aquisição única.
Fluxo de transações
Neste guia, descrevemos cada etapa de desenvolvimento à medida que elas ocorrem em um fluxo de transações de produtos digitais. Quando a Ação processa transações de produtos e softwares digitais, ela usa o seguinte fluxo:
- Configurar um cliente da API Digital Purchases: a ação usa a API Digital Purchases para se comunicar com o inventário do Google Play e fazer transações. Antes de a ação fazer qualquer outra coisa, ela cria um cliente JWT com uma chave de serviço para se comunicar com a API de compras digitais.
- Coletar informações: a ação reúne informações básicas sobre o
usuário e seu inventário do Google Play para se preparar para uma transação.
- Validar os requisitos de transação: a ação usa o assistente de requisitos de transações digitais no início do fluxo de compra para garantir que o usuário possa fazer transações.
- Coletar inventário disponível: a ação verifica seu inventário do Google Play e identifica quais itens estão disponíveis para compra no momento.
- Criar o pedido: sua ação apresenta os produtos e softwares digitais disponíveis ao usuário para que ele possa selecionar um para comprar.
- Concluir a compra: a ação usa a API de compras digitais para iniciar uma compra com a seleção do usuário na Google Play Store.
- Processar o resultado: a ação recebe um código de status para a transação e notifica o usuário de que a compra foi concluída ou segue outras etapas.
- Tornar a compra repetível: a ação usa a API de compras digitais para "consumir" o item comprado, disponibilizando-o novamente.
Restrições e diretrizes de revisão
Outras políticas se aplicam a ações com transações. Pode levar algumas semanas para analisar as ações que incluem transações. Portanto, considere esse tempo ao planejar a programação de lançamento. Para facilitar o processo de revisão, verifique se você está em conformidade com as políticas e diretrizes para transações antes de enviar sua ação para análise.
Ações que vendem produtos e softwares digitais só podem ser implantadas nos seguintes países:
- Austrália
- Brasil
- Canadá
- Indonésia
- Japão
- México
- Rússia
- Singapura
- Tailândia
- Turquia
- Reino Unido
- Estados Unidos
Pré-requisitos
Antes de incorporar transações digitais à ação, você precisa dos seguintes pré-requisitos:
Uma conta de desenvolvedor e uma conta de comerciante no Google Play para gerenciar seus produtos e softwares digitais no Google Play Console.
Um domínio da Web que seja verificado no Google Search Console. Esse domínio não precisa estar associado a um site lançado publicamente. Basta fazer referência ao seu domínio da Web.
Um app Android com a permissão
com.android.vending.BILLING
no Google Play Console. Seus produtos e softwares digitais serão "compras no app" associadas a este app no Google Play Console.Também é necessário criar uma versão no Play Console com esse app. Se você não quiser que ela seja pública, crie uma versão Alfa fechada.
Se você ainda não tiver um app Android, siga as instruções para associar um app Android.
Um ou mais produtos gerenciados no Google Play Console, que são os produtos e softwares digitais que você vende com sua Ação. Só é possível criar produtos gerenciados no Play Console depois que você configurar o pré-requisito do app Android.
Se você ainda não tiver produtos gerenciados, siga as instruções para Criar produtos digitais.
Associar um app Android
Se você não tiver um app Android com permissão de faturamento no Google Play Console, siga estas etapas:
- No Android Studio ou no ambiente de desenvolvimento integrado do Android de sua escolha, crie um novo projeto. Escolha as opções nas solicitações de configuração do projeto para criar um app muito básico.
- Dê um nome de pacote ao projeto, como
com.mycompany.myapp
. Não deixe esse nome como padrão, já que não é possível fazer upload de pacotes que incluemcom.example
no Play Console. - Abra o arquivo
AndroidManifest.xml
do app. Adicione a seguinte linha de código ao elemento
manifest
:<uses-permission android:name="com.android.vending.BILLING" />
O arquivo
AndroidManifest.xml
vai ficar parecido com este bloco 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>
Crie seu app como um APK assinado. No Android Studio, siga estas etapas:
- Acesse Build e Generate Signed Bundle / APK.
- Clique em Next.
- Em Caminho do repositório de chaves, clique em Criar novo.
- Preencha todos os campos e clique em OK. Anote a senha do keystore e a senha da chave e armazene-as em um local seguro para usar mais tarde.
- Clique em Next.
- Selecione release.
- Selecione V1 (Assinatura JAR).
- Clique em Finish.
- Após alguns segundos, o Android Studio gera um arquivo
app-release.apk
. Localize esse arquivo para uso posterior.
No Google Play Console, crie um novo aplicativo.
Acesse Versões de apps.
Em Faixas fechadas, acesse Gerenciar e clique em Alfa.
Clique no botão Criar versão.
Em Permitir que o Google gerencie e proteja sua chave de assinatura, insira as informações da chave.
Faça upload do arquivo APK.
Clique em Salvar.
Crie seus produtos digitais
Se você não tem produtos e softwares digitais no Play Console no momento, siga estas etapas:
- No Google Play Console, acesse Produtos no app e depois Produtos gerenciados. Se um aviso aparecer, siga as instruções anteriores para criar um app Android ou clique no link para criar um perfil de comerciante.
- Clique em Criar um produto gerenciado.
- Preencha os campos do produto digital. Anote o ID do produto, que é como você vai referenciar esse produto na sua ação.
- Clique em Salvar.
- Repita as etapas de 2 a 4 para cada produto que você quer vender.
Preparar seu projeto do Actions
Com seus produtos e softwares digitais configurados no Google Play Console, você precisa ativar transações digitais e associar seu projeto do Actions ao app do Google Play.
Configuração
Para ativar as transações de produtos e softwares digitais no seu projeto do Actions, siga estas etapas:
- No Console do Actions, abra seu projeto ou crie um novo.
- Acesse Implantar e Informações do diretório.
- Em Informações adicionais e Transações, marque a caixa Sim em Suas ações usam a API Digital Purchase para realizar transações de produtos e softwares digitais?.
- Clique em Salvar.
Criar uma chave de API de produtos e softwares digitais
Para enviar solicitações à API de produtos e softwares digitais, faça o download de uma chave de conta de serviço JSON associada ao seu projeto do Console do Actions.
Para recuperar a chave da conta de serviço, siga estas etapas:
- No Console do Actions, clique no ícone de três pontos no canto superior direito e em Configurações do projeto.
- Encontre o ID do projeto da sua Ação.
- Acesse este link, substituindo "
<project_id>
" pelo ID do seu projeto:https://console.developers.google.com/apis/credentials?project=project_id
- Na navegação principal, acesse Credenciais.
- Na página exibida, clique em Criar credenciais e em Chave da conta de serviço.
- Acesse Conta de serviço e clique em Nova conta de serviço.
- Dê um nome à conta de serviço, como digitaltransactions.
- Clique em Criar.
- Defina o Papel como Projeto > Proprietário.
- Clique em Continuar.
- Clique em Criar chave.
- Selecione o tipo de chave JSON.
- Clique em Criar chave e faça o download da chave da conta de serviço JSON.
Salve essa chave da conta de serviço em um local seguro. Você usará essa chave no fulfillment para criar um cliente para a API Digital Purchases.
Conectar ao inventário do Google Play
Para acessar seus produtos e softwares digitais em um projeto do Actions, associe o domínio da Web e o app ao projeto como propriedades conectadas.
Para conectar o domínio da Web e o app do Play Console ao projeto do Actions, siga estas etapas:
- No Console do Actions, acesse Implantar e depois Verificação de marca.
Se você não conectou nenhuma propriedade, primeiro conecte um site:
- Clique no botão da propriedade da Web (</>).
- Digite o URL do seu domínio da Web e clique em Conectar.
O Google envia um e-mail com mais instruções para o indivíduo verificado para esse domínio da Web no Google Search Console. Depois que o destinatário deste e-mail seguir essas etapas, o site vai aparecer em Verificação de marca.
Depois de ter pelo menos um site conectado, siga estas etapas para conectar seu app Android:
- No Console do Actions, acesse Implantar e depois Verificação de marca.
- Clique em Conectar aplicativo.
Na página exibida, siga as instruções para verificar seu domínio da Web no Play Console. Selecione o app do Google Play que contém seus produtos e softwares digitais e insira o URL do domínio da Web exatamente como aparece na página Verificação de marca.
Mais uma vez, o Google envia um e-mail de verificação para o proprietário verificado do domínio. Depois que ele aprovar a verificação, seu app do Google Play aparecerá em Verificação de marca.
Ative a opção Acessar compras no Google Play.
Crie seu fluxo de compra
Com o projeto do Actions e o inventário de produtos e softwares digitais preparados, crie um fluxo de compra de produtos e softwares digitais no webhook de fulfillment da conversa.
1. Configurar um cliente da API Digital Purchases
No webhook de fulfillment da conversa, crie um cliente JWT com a chave
JSON da conta de serviço e o
escopo https://www.googleapis.com/auth/actions.purchases.digital
.
O código Node.js a seguir cria um cliente JWT para a API de compras digitais:
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. Coletar informações
Antes que o usuário possa fazer uma compra, sua ação coleta informações sobre a capacidade do usuário de fazer compras e quais produtos estão disponíveis no seu inventário.
2. a. Validar requisitos de compra digital
É recomendável verificar se a conta do usuário está configurada para realizar
transações antes de oferecer a opção de fazer uma compra. Faça a
transição para um cenário DigitalPurchaseCheck
, que confere se o usuário foi verificado,
se ele está realizando a transação em uma superfície permitida (smart display,
alto-falante inteligente ou Android) e se está em uma localidade
com suporte a transações digitais.
Para criar uma cena de verificação de compra digital, siga estas etapas:
- Na guia Scenes, adicione uma nova cena com o nome
DigitalPurchaseCheck
. - Em Preenchimento de slot, clique em + para adicionar um novo slot.
- Em Selecionar tipo, selecione
actions.type.DigitalPurchaseCheckResult
como o tipo de slot. - No campo do nome do slot, digite o nome
DigitalPurchaseCheck
. - Ative a caixa de seleção Personalizar gravação do valor do slot (ativada por padrão).
- Clique em Salvar.
Uma verificação de compra digital resultará em um dos seguintes resultados:
- Se os requisitos forem atendidos, o parâmetro de sessão será definido com uma condição de sucesso, e você poderá continuar permitindo que o usuário compre produtos e softwares digitais.
- Se não for possível atender a um ou mais dos requisitos, o parâmetro da sessão será definido com uma condição de falha. Nesse caso, afaste a conversa da experiência transacional ou encerre a conversa.
Para processar um resultado de verificação de compra digital, siga estas etapas:
- Na guia Scenes, selecione a cena
DigitalPurchaseCheck
recém-criada. - Em Condição, clique em + para adicionar uma nova condição.
No campo de texto, insira a seguinte sintaxe de condição para verificar a condição bem-sucedida:
scene.slots.status == "FINAL" && session.params.DigitalPurchaseCheck.resultType == "CAN_PURCHASE"
Passe o cursor sobre a condição que você acabou de adicionar e clique na seta para cima para colocá-la antes de
if scene.slots.status == "FINAL"
.Ative Enviar solicitações e forneça uma solicitação simples informando ao usuário que ele está pronto para fazer uma transação:
candidates: - first_simple: variants: - speech: >- You are ready to purchase digital goods.
Em Transition, selecione outra cena, permitindo que o usuário continue a conversa e prossiga para a transação.
Selecione a condição
else if scene.slots.status == "FINAL"
.Ative Enviar solicitações e forneça uma solicitação simples informando ao usuário que não é possível realizar uma transação:
candidates: - first_simple: variants: - speech: Sorry you cannot perform a digital purchase.
Em Transição, selecione Encerrar conversa para encerrar a conversa.
2. b) Reunir inventário disponível
Use a API Digital Purchases para solicitar seu inventário da Play Store disponível no momento e crie-o em uma matriz de objetos JSON para cada produto. Você vai consultar essa matriz mais tarde para mostrar ao usuário quais opções estão disponíveis para compra.
Cada um dos seus produtos e softwares digitais é representado como uma SKU no formato JSON. O código Node.js a seguir descreve a formatação esperada de cada SKU:
body = {
skus: [
skuId: {
skuType: one of "SKU_TYPE_IN_APP" or "SKU_TYPE_SUBSCRIPTION"
id: string,
packageName: string
}
formattedPrice: string,
title: string,
description: string
]
}
Envie uma solicitação POST para o endpoint https://actions.googleapis.com/v3/packages/{packageName}/skus:batchGet
, em que {packageName}
é o nome do pacote do app no Google Play Console (por exemplo, com.myapp.digitalgoods
) e formate o resultado em uma matriz de objetos SKU.
Para recuperar apenas produtos e softwares digitais específicos na matriz resultante, liste os IDs de produtos para produtos e softwares digitais (conforme mostrado abaixo de cada produto no app no Google Play Console) que você quer disponibilizar para compra em body.ids
.
O código Node.js a seguir solicita uma lista de produtos disponíveis da API de compras digitais e formata o resultado como uma matriz de SKUs:
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': conv.session.id,
'skuType': 'SKU_TYPE_IN_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. Criar o pedido
Para iniciar a compra digital do usuário, apresente uma lista dos seus produtos e softwares digitais disponíveis para compra. É possível usar uma variedade de tipos de resposta avançada para representar sua estoque e solicitar que o usuário faça uma seleção.
O código Node.js a seguir lê uma matriz de inventário de objetos SKU e cria uma resposta de lista com um item de lista para cada:
const items = [];
const entries = [];
skus.forEach((sku) => {
const key = `${sku.skuId.skuType},${sku.skuId.id}`
items.push({
key: key
});
entries.push({
name: key,
synonyms: [],
display: {
title: sku.title,
description: `${sku.description} | ${sku.formattedPrice}`,
}
});
});
conv.session.typeOverrides = [{
name: 'type_name',
mode: 'TYPE_REPLACE',
synonym: {
entries: entries
}
}];
conv.add(new List({
title: 'List title',
subtitle: 'List subtitle',
items: items,
}));
Criar compra a partir da seleção do usuário
Depois que o usuário selecionar um item, você poderá criar o pedido. Para fazer isso, no slot associado ao item selecionado, chame o webhook para criar o pedido. No fulfillment, salve os dados do pedido em um parâmetro de sessão. O objeto de ordenação é usado em cenas da mesma sessão.
conv.session.params.purchase = {
"@type": "type.googleapis.com/google.actions.transactions.v3.CompletePurchaseValueSpec",
"skuId": {
"skuType": "<SKU_TYPE_IN_APP>",
"id": "<SKU_ID>",
"packageName": "<PACKAGE_NAME>"
},
"developerPayload": ""
};
No Actions Builder, você pode usar o editor de JSON para configurar o slot
com o objeto de ordenação acima. Ambas as implementações usam o mesmo formato para CompletePurchaseValueSpec
, que pode ser encontrado na referência de payload do webhook JSON.
4. Concluir a compra
Depois que o usuário selecionar um item, você poderá concluir a compra. Depois de preencher o slot associado ao item selecionado, faça a transição para uma cena que realize uma compra completa.
Criar cena de compra completa
- Na guia Cenas, adicione uma nova cena com o nome
CompletePurchase
. - Em Preenchimento de slot, clique em + para adicionar um novo slot.
- Em Selecionar tipo, selecione
actions.type.CompletePurchaseValue
como o tipo de slot. - No campo do nome do slot, digite o nome
CompletePurchase
. - Ative a caixa de seleção Personalizar gravação do valor do slot (ativada por padrão).
- Em Configurar slot, selecione
Use session parameter
no menu suspenso. - Em Configurar slot, insira no campo de texto o nome do parâmetro de sessão usado para armazenar a ordem (ou seja,
$session.params.purchase
). - Clique em Salvar.
5. Processar o resultado
Um slot com o tipo actions.type.CompletePurchaseValue
pode ter os seguintes
resultados:
PURCHASE_STATUS_OK
: a compra foi concluída. A transação está concluída neste momento, então saia do fluxo transacional e volte para sua conversa.PURCHASE_STATUS_ALREADY_OWNED
: a transação falhou porque o usuário já é o proprietário desse item. Para evitar esse erro, verifique as compras anteriores do usuário e adapte os itens mostrados para que ele não tenha a opção de comprar novamente.PURCHASE_STATUS_ITEM_UNAVAILABLE
: a transação falhou porque o item solicitado não está disponível. Para evitar esse erro, verifique as SKUs disponíveis mais próximas do momento da compra.PURCHASE_STATUS_ITEM_CHANGE_REQUESTED
: a transação falhou porque o usuário decidiu comprar outra coisa. Faça um novo prompt de criação do pedido para que o usuário possa tomar outra decisão imediatamente.PURCHASE_STATUS_USER_CANCELLED
: a transação falhou porque o usuário cancelou o fluxo de compra. Como o usuário saiu do fluxo prematuramente, pergunte se ele quer repetir a transação ou sair completamente.PURCHASE_STATUS_ERROR
: a transação falhou por um motivo desconhecido. Informe ao usuário que a transação falhou e pergunte se ele quer tentar novamente.PURCHASE_STATUS_UNSPECIFIED
: a transação falhou por um motivo desconhecido, resultando em um status desconhecido. Para lidar com esse status de erro, informe ao usuário que a transação falhou e pergunte se ele quer tentar novamente.
Gerencie cada um desses resultados da cena CompletePurchase
.
- Na guia Scenes, selecione a cena
CompletePurchase
recém-criada. - Em Condição, clique em + para adicionar uma nova condição.
No campo de texto, insira a seguinte sintaxe de condição para verificar a condição bem-sucedida:
scene.slots.status == "FINAL" && session.params.CompletePurchase.purchaseStatus == "PURCHASE_STATUS_OK"
Passe o cursor sobre a condição que você acabou de adicionar e clique na seta para cima para colocá-la antes de
if scene.slots.status == "FINAL"
.Ative Enviar solicitações e forneça uma solicitação simples informando ao usuário que ele está pronto para fazer uma transação:
candidates: - first_simple: variants: - speech: >- Your purchase was successful.
Em Transição, selecione Encerrar conversa para encerrar a conversa.
Repita as etapas acima para cada tipo de resultado de compra que você quer oferecer.
6. Tornar a compra repetível
Após uma transação bem-sucedida, envie uma solicitação POST à API de compras
digitais para consumir o item, permitindo que o usuário o compre novamente. Envie sua solicitação para o endpoint https://actions.googleapis.com/v3/conversations/{sessionId}/entitlement:consume
com o ID da sessão encontrado em session.id
.
A solicitação POST também precisa incluir o objeto de token associado à
compra do usuário, encontrado no JSON de solicitação do usuário em
packageEntitlements.entitlements.inAppDetails.inAppPurchaseData.purchaseToken
.
O código a seguir envia uma solicitação consume
para a API de compras digitais e
informa se essa solicitação foi bem-sucedida:
request.post(`https://actions.googleapis.com/v3/conversations/${conv.session.id}/entitlement:consume`, {
'auth': {
'bearer': tokens.access_token,
},
'json': true,
'body': {
// This purchase token is in both the purchase event and the user's entitlements
// in their request JSON
"purchaseToken": entitlement.purchaseToken
},
}, (err, httpResponse, body) => {
if (err) {
throw new Error(`API request error: ${err}`);
}
console.log(`${httpResponse.statusCode}: ${httpResponse.statusMessage}`);
console.log(JSON.stringify(httpResponse));
console.log(JSON.stringify(body));
resolve(body);
});
// Make sure the consume request was successful. In production, don't notify the user; handle failures on the back end
return consumePromise.then(body => {
const consumed = Object.keys(body).length === 0;
if (consumed) {
conv.add(`You successfully consumed ${id}`);
} else {
conv.add(`Failed to consume: ${id}`);
}
});
Refletem as compras do usuário.
Quando um usuário consulta sua ação, o objeto user
do JSON de solicitação inclui uma
lista das compras dele. Verifique essas informações e mude a resposta da Ação
com base no conteúdo pelo qual o usuário pagou.
O exemplo de código a seguir mostra o objeto user
de uma solicitação que inclui
packageEntitlements
de compras no app anteriores feitas para o
pacote com.digitalgoods.application
:
{
"handler": {
"name": "handler_name"
},
"intent": {
"name": "actions.intent.MAIN",
"params": {},
"query": ""
},
"scene": {
"name": "SceneName",
"slotFillingStatus": "UNSPECIFIED",
"slots": {}
},
"session": {
"id": "example_session_id",
"params": {},
"typeOverrides": []
},
"user": {
"locale": "en-US",
"params": {
"verificationStatus": "VERIFIED"
"packageEntitlements": [
{
"packageName": "com.digitalgoods.application",
"entitlements": [
{
"sku": "non-consumable.1",
"skuType": "SKU_TYPE_IN_APP"
}
{
"sku": "consumable.2",
"skuType": "SKU_TYPE_IN_APP"
}
]
},
{
"packageName": "com.digitalgoods.application",
"entitlements": [
{
"sku": "annual.subscription",
"skuType": "SKU_TYPE_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=="
}
}
]
}
]
}
},
"homeStructure": {
"params": {}
},
"device": {
"capabilities": [
"SPEECH",
"RICH_RESPONSE",
"LONG_FORM_AUDIO"
]
}
}
Testar o projeto
Ao testar o projeto, você pode ativar o modo sandbox no Console do Actions para testar a ação sem cobrar uma forma de pagamento. Para ativar o modo sandbox, siga estas etapas:
- No Console do Actions, clique em Testar na navegação.
- Clique em Configurações.
- Ative a opção Sandbox de desenvolvimento.