A API Transactions vai ser descontinuada em 3 de maio de 2023, antes da desativação das ações de conversa em 13 de junho de 2023. Para mais informações, consulte Desativação do recurso Ações de conversa.

Esta página foi traduzida pela API Cloud Translation.

Criar transações de assinatura digital (Dialogflow)

Este guia explica como adicionar transações de assinatura digital à sua conversa Ação para que os usuários possam comprar suas assinaturas.

Termos-chave: um produto digital com assinatura é uma unidade de manutenção de estoque (SKU) que exige uma cobrança recorrente do usuário, como uma revista on-line. Isso é diferente de um produto digital consumível que um usuário precisa manualmente comprada de novo ou um produto digital não consumível que seja automaticamente comprada apenas uma vez.

Para mais informações sobre assinaturas digitais, consulte a documentação sobre recursos específicos para assinaturas.

Restrições e diretrizes de avaliações

Outras políticas são aplicáveis a ações com transações. Podemos levar alguns para analisar as ações que incluem transações. Por isso, considere o tempo planejar sua programação de lançamentos. Para facilitar o processo de revisão, verifique se você está em conformidade com o políticas e diretrizes para transações antes de enviar sua Ação para revisão.

As 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

Fluxo de transações

Este guia descreve cada etapa de desenvolvimento conforme elas ocorrem em um produto digital fluxo de transações. Quando sua Ação lida com transações de produtos e softwares digitais, usa este fluxo:

Configurar um cliente de API de compras digitais: sua ação usa o a API de compras para se comunicar com seu inventário do Google Play e realizar transações. Antes de qualquer outra ação, a ação cria um cliente JWT com uma chave de serviço para se comunicar com a API Digital Purchases.
Coletar informações: a ação coleta informações básicas sobre o usuário e seu inventário do Google Play a fim de se preparar para uma transação.
1. Validar os requisitos de transação: sua ação usa o do assistente de requisitos de transações no início do fluxo de compra para para garantir que o usuário possa fazer transações.
2. Coletar inventário disponível: a ação verifica o inventário do Google Play. inventário 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 para o usuário para que ele possa selecionar um para comprar.
Concluir a compra: sua ação usa a API de compras digitais para iniciar uma compra com a seleção do usuário na Google Play Store.
Gerencie o resultado: sua ação recebe um código de status para o transação e notifica o usuário de que a compra foi bem-sucedida (ou leva etapas adicionais).

Pré-requisitos

Antes de incorporar transações digitais à sua ação, você precisa do seguintes pré-requisitos:

Um conta de desenvolvedor e um conta do comerciante no Google Play, para gerenciar seus produtos e softwares digitais na Google Play Console:
Um domínio da Web que é verificadas no Google Search Console. Esse domínio não precisa estar associado a um site lançado publicamente. só precisamos fazer referência ao seu domínio da Web.
Um app Android com o com.android.vending.BILLING permissão no Google Play Console. Seus produtos e softwares digitais serão "compras no app" associadas a ele no Google Play Console.

Você também precisa criar uma versão no Play Console com esse app. No entanto, se você não quiser que a versão seja pública, crie uma versão Alfa fechada lançamento.

Se você ainda não tem um app Android, siga as Instruções para associar um app Android.
Uma ou mais assinaturas no Google Play Console, que são os produtos e softwares digitais que você vende com a ação. Observe que você não é possível criar assinaturas no Play Console antes da configuração do Pré-requisito do app Android.

Se você ainda não tem assinaturas, siga as Crie as instruções para seus produtos digitais.

Associar um app Android

Se você não tem um app Android com a permissão de faturamento na Google Play Console, siga estas etapas:

No Android Studio ou o ambiente de desenvolvimento integrado do Android de sua escolha, crie um novo projeto. Escolher opções em os comandos 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 carregar pacotes que incluem com.example ao Play Console.
Abra o arquivo AndroidManifest.xml do app.

Adicione a linha de código abaixo no 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 o app como um APK assinado. No Android Studio, siga estas etapas:
1. Acesse Build e Generate Signed Bundle / APK.
2. Clique em Próxima.
3. Em Caminho do repositório de chaves, clique em Criar novo.
4. Preencha todos os campos e clique em OK. Anote as informações do seu Keystore senha e Senha da chave e armazene-as em um local seguro, já que você vai usá-las mais tarde.
5. Clique em Próxima.
6. Selecione lançar.
7. Selecione V1 (assinatura JAR).
8. Clique em Finish.
9. Após alguns segundos, o Android Studio gera um arquivo app-release.apk. Localize o arquivo para uso posterior.
Na Google Play Console, criar um novo aplicativo.
Acesse Versões de apps.
Em Faixas fechadas, acesse Gerenciar e Alfa.
Clique no botão Criar versão.
Em Deixar o Google gerenciar e proteger sua chave de assinatura, digite sua assinatura informações importantes.
Faça o upload do seu arquivo APK.
Clique em Salvar.

Crie seus produtos digitais

Se você não tiver produtos e softwares digitais no Play Console no momento, siga estas instruções etapas:

Na Google Play Console, acesse Produtos no aplicativo e, em seguida, Assinaturas. Se você receber um aviso, siga as instruções anteriores para criar um app Android ou clique no link para criar um perfil de comerciante.
Clique em Criar assinatura.
Preencha os campos do seu 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.

Exemplos de assinaturas no Google Play Console.

Preparar seu projeto do Actions

Com seus produtos e softwares digitais configurados no Google Play Console, você precisa ativar transações digitais e associar o projeto do Actions ao app do Google Play.

Para ativar as transações de produtos e softwares digitais no seu projeto do Actions, siga estas instruções etapas:

No Console do Actions, abra ou crie um projeto.
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, você precisa fazer o download de um serviço JSON chave da conta 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 seguida, Configurações do projeto.
Encontre o ID do projeto da sua ação.
Siga 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 Serviço chave de 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 JSON da conta de serviço.

Salve essa chave da conta de serviço em um local seguro. Você vai usar essa chave fulfillment para criar um cliente para a API Digital Purchases.

Conectar ao seu inventário do Google Play

Para acessar seus produtos e softwares digitais em um projeto do Actions, associe o seu domínio da Web e app com seu projeto como propriedades conectadas.

Observação:enquanto verificamos a conexão, as etapas de conexão podem levar até uma semana para serem concluídas. suas propriedades. Se o site ou app não for vinculado após esse período, entre em contato com o suporte.

Para conectar o domínio e o app da Web do Play Console ao projeto do Actions, siga estas etapas:

No Console do Actions, acesse Implantar e depois Verificação de marca.
Se você ainda não conectou propriedades, primeiro conecte um site:
1. Clique no botão de propriedade da web (</>).
2. Digite o URL do seu domínio da Web e clique em Conectar.
O Google envia um e-mail com mais instruções para a pessoa verificado para esse domínio da Web no Google Search Console. Depois que o destinatário seguir essas etapas, o site deverá aparecem em Verificação de marca.
Assim que você tiver pelo menos um site conectado, execute as seguintes etapas para conectar seu app Android:
1. No Console do Actions, acesse Implantar e depois Verificação de marca.
2. Clique em Conectar aplicativo.
3. Na página exibida, siga as instruções para verificar sua conta domínio no Play Console. Selecione o app Google Play que contém seu produtos e softwares digitais e insira o URL do domínio da Web exatamente como ele aparece Verificação de marca.
  
  Mais uma vez, o Google envia um e-mail de verificação para o proprietário verificado de o domínio. Depois que eles aprovarem a verificação, seu app do Google Play deverá aparecem em Verificação de marca.
  
  Observação: seu domínio da Web vai aparecer no Play Console antes de aparecer. no Console do Actions. O Console do Actions pode levar vários dias precisa ser atualizado.
4. Ative a opção Acessar compras no Google Play.

Imagem mostrando o site e os apps conectados ao projeto do Actions.

Criar seu fluxo de compra

Com o projeto do Actions e o inventário de produtos digitais preparados, crie um fluxo de compra de produtos no webhook de fulfillment da conversa.

1. Configurar um cliente de API de compras digitais

No webhook de fulfillment da conversa, crie um cliente JWT com seu serviço chave JSON da conta de serviço e a 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 de o usuário fazer uma compra, a ação coleta informações sobre o capacidade do usuário de fazer compras e quais produtos estão disponíveis no seu inventário.

2. A. Validar os requisitos de transação

É uma boa prática garantir que a conta do usuário esteja configurada para realizar transações, antes de dar a ele a opção de fazer uma compra. Esta etapa inclui verificar se o usuário tem uma forma de pagamento configurada e se está em um localidade onde as transações digitais são aceitas. No início da transação fluxo, use o auxiliar DIGITAL_PURCHASE_CHECK para validar a transação do usuário com o Assistente.

O código Node.js a seguir usa o DIGITAL_PURCHASE_CHECK no início da conversa:

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

Encontre o resultado dessa verificação nos argumentos da conversa como: DIGITAL_PURCHASE_CHECK_RESULT: Com base nesse resultado, continue o o fluxo de transações ou mudar e solicitar que ele verifique o Google Pay configuração do Terraform.

O código Node.js a seguir processa o resultado da verificação 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 inventário disponível

Use a API de compras digitais para solicitar a Play Store disponível no momento inventário e transformá-lo em uma matriz de objetos JSON para cada produto. Você vai consultar essa matriz mais tarde para mostrar ao usuário as opções disponíveis para compra.

Cada um dos seus produtos digitais é representado como uma SKU no formato JSON. A o código Node.js a seguir descreve a formatação esperada de cada SKU:

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

Envie uma solicitação POST ao 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 um matriz de objetos SKU.

Para recuperar apenas produtos digitais específicos na matriz resultante, liste o produto Códigos de produtos digitais (conforme exibido em cada produto no app no Google Play) Console) que você quer disponibilizar para compra no app body.ids.

O código Node.js a seguir solicita uma lista de produtos disponíveis na API de compras 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': conversationId,
        'skuType': 'APP',
        // This request is filtered to only retrieve SKUs for the following product IDs
        'ids': ['annual.subscription']
      },
    }, (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. Você pode usar uma variedade tipos de resposta avançada para representar seus 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 um resposta de lista com um item da lista para cada:

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

4. Concluir a compra

Para concluir a compra, use a intent auxiliar COMPLETE_PURCHASE com o item selecionado pelo usuário.

O código Node.js a seguir processa a seleção de SKU do usuário em uma resposta de lista. e solicita a intent COMPLETE_PURCHASE com essas informações:

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. Gerenciar o resultado

Quando a compra é concluída, ele aciona o actions_intent_COMPLETE_PURCHASE. Evento do Dialogflow (ou intent actions.intent.COMPLETE_PURCHASE do SDK do Actions) com um argumento COMPLETE_PURCHASE_VALUE descrevendo o resultado. Criar uma intent acionado por esse evento, que comunica o resultado ao usuário.

Processe os seguintes resultados de compra possíveis:

PURCHASE_STATUS_OK: a compra foi concluída. A transação estiver concluída neste ponto, então saia do fluxo transacional e volte para a conversa.
PURCHASE_STATUS_ALREADY_OWNED: a transação falhou porque o usuário já possui esse item. Para evitar esse erro, verifique a configuração compras e personalizar os itens mostrados para que não tenham a opção de comprar novamente itens que já possuem.
PURCHASE_STATUS_ITEM_UNAVAILABLE: a transação falhou porque o O item solicitado não está disponível. Evite esse erro verificando as opções SKUs mais próximos do momento da compra.
PURCHASE_STATUS_ITEM_CHANGE_REQUESTED: a transação falhou porque o o usuário decidiu comprar outra coisa. Reprompt com a criação do seu pedido para que o usuário possa tomar outra decisão imediatamente.
PURCHASE_STATUS_USER_CANCELLED: a transação falhou porque o usuário o fluxo de compra foi cancelado. Como o usuário saiu prematuramente do fluxo, pergunte o usuário se ele quiser repetir a transação ou sair dela completamente.
PURCHASE_STATUS_ERROR: a transação falhou por um motivo desconhecido. Vou o usuário sabe 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. Gerencie esse status de erro permitindo que o usuário saber que a transação falhou e perguntar se quer tentar novamente.

O código Node.js a seguir lê o argumento COMPLETE_PURCHASE_VALUE e lida com 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);
  }
});

Reflita as compras do usuário

Quando um usuário consulta sua ação, o objeto user da solicitação JSON inclui uma lista das compras. Confira estas informações e mude a resposta da Ação com base no conteúdo pago pelo usuário.

O exemplo de código a seguir mostra o objeto user de uma solicitação que inclui packageEntitlements das compras no app feitas anteriormente para o Pacote 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"
        }
      ]
    }
  ],
  ...
}