Antes de começar a usar o SDK do Android, confira se você concluiu os pré-requisitos.
O SDK do Android permite adicionar cartões à Carteira do Google. Ao adicionar o botão da Carteira do Google no app, os usuários terão uma experiência simples e divertida ao adicionar cartões à Carteira do Google.
Siga as etapas para adicionar o botão da Carteira do Google ao aplicativo Android:
1. Criar um objeto de cartões
Observação: é preciso ter uma classe de cartões para criar um
objeto de cartões. Se você ainda não criou uma, siga as instruções sobre
como
Criar uma classe de cartões.
Defina um GiftCardObject
correspondente, incluindo os seguintes
atributos obrigatórios:
* classId
: o ID da classe de cartões criada nos pré-requisitos.
* id
: um ID exclusivo para o objeto.
cardNumber
: o identificador associado ao cartão.
* state
: este campo é usado para determinar como um objeto é exibido. Por exemplo, um objeto inativo é movido para a seção "Cartões expirados".
Consulte o modelo de layout para mais informações sobre como esses atributos são representados no vale-presente.
Esta é a definição de um exemplo de vale-presente:
JSON
{
"id": "ISSUER_ID.OBJECT_ID",
"classId": "CLASS_ID",
"cardNumber": "1234567890",
"state": "ACTIVE"
}
2. Criar um JWT não assinado com o objeto
Ao criar oGiftCardObject
, una ele a um JWT
não assinado com o atributo payload.GiftCardObjects
, conforme mostrado no
seguinte snippet:
JSON
{
"iss": "OWNER_EMAIL_ADDRESS",
"aud": "google",
"typ": "savetowallet",
"iat": "UNIX_TIME",
"origins": [],
"payload": {
"giftcardObjects": [ NEW_OBJECT ]
}
}
3. Incluir o botão "Carteira do Google" na IU
A Carteira do Google oferece um botão conhecido que pode ser usado para acionar o fluxo "Adicionar à Carteira do Google" no aplicativo. Os recursos vetoriais do botão estão disponíveis nas Diretrizes de botões.
É possível importar recursos vetoriais no Android Studio em File > New > Vector
Asset
. Selecione "Arquivo local" no assistente, adicione um nome (por exemplo,
add_to_google_wallet_button.xml
) e encontre o arquivo no drive local para
importar.
Agora, é possível usar o drawable importado para adicionar o botão à interface do usuário:
<ImageButton
android:id="@+id/addToGoogleWalletButton"
android:layout_width="match_parent"
android:layout_height="48dp"
android:minWidth="200dp"
android:clickable="true"
android:src="@drawable/add_to_google_wallet_button" />
O botão tem um layout_height
de 48 dp e precisa ter pelo menos 200 dp de largura.
4. Verificar se a API Google Wallet está disponível no dispositivo de destino
Antes de salvar o novo objeto, confira se a API Google Wallet está
disponível no dispositivo de destino chamando o método getPayApiAvailabilityStatus
na classe PayClient
. Comece adicionando uma variável de membro à
atividade em que você vai mostrar o botão e instanciá-la quando a atividade for
criada:
Kotlin
import com.google.android.gms.pay.PayClient
private lateinit var walletClient: PayClient
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
walletClient = Pay.getClient(this)
// Additional logic in your onCreate method
}
Java
import com.google.android.gms.pay.PayClient;
private final PayClient walletClient;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
walletClient = Pay.getClient(application);
// Additional logic in your onCreate method
}
Agora use o cliente para verificar se a API está disponível:
Kotlin
import com.google.android.gms.pay.PayApiAvailabilityStatus
private fun fetchCanUseGoogleWalletApi() {
walletClient
.getPayApiAvailabilityStatus(PayClient.RequestType.SAVE_PASSES)
.addOnSuccessListener { status ->
if (status == PayApiAvailabilityStatus.AVAILABLE) {
// The API is available, show the button in your UI
} else {
// The user or device is not eligible for using the Pay API
}
}
.addOnFailureListener {
// Hide the button and optionally show an error message
}
}
Java
import com.google.android.gms.pay.PayApiAvailabilityStatus;
private void fetchCanAddPassesToGoogleWallet() {
walletClient
.getPayApiAvailabilityStatus(PayClient.RequestType.SAVE_PASSES)
.addOnSuccessListener(status -> {
if (status == PayApiAvailabilityStatus.AVAILABLE) {
// The API is available, show the button in your UI
} else {
// The user or device is not eligible for using the Pay API
};
})
.addOnFailureListener(exception -> {
// Google Play Services is too old, or API availability not verified
// Hide the button and optionally show an error message
});
}
Por fim, chame o método definido acima no aplicativo quando precisar determinar a disponibilidade da API.
5. Adicionar o objeto à Carteira do Google
OGiftCardObject
pode ser adicionado transmitindo o JWT não assinado da etapa 2 para o
método savePasses
.
É possível iniciar a operação de adição clicando no botão
"Carteira do Google":
Kotlin
import android.os.Bundle
import android.view.View
import com.google.android.gms.samples.wallet.databinding.ActivityCheckoutBinding
private val addToGoogleWalletRequestCode = 1000
private lateinit var layout: ActivityCheckoutBinding
private lateinit var addToGoogleWalletButton: View
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
// Use view binding to access the UI elements
layout = ActivityCheckoutBinding.inflate(layoutInflater)
setContentView(layout.root)
addToGoogleWalletButton = layout.addToGoogleWalletButton
addToGoogleWalletButton.setOnClickListener {
walletClient.savePasses(newObjectJson, this, addToGoogleWalletRequestCode)
}
// Additional logic in your onCreate method
}
Java
import android.os.Bundle;
import android.view.View;
import com.google.android.gms.samples.wallet.databinding.ActivityCheckoutBinding;
private static final int ADD_TO_GOOGLE_WALLET_REQUEST_CODE = 999;
private ActivityCheckoutBinding layout:
private View addToGoogleWalletButton;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
// Use view binding to access the UI elements
layout = ActivityCheckoutBinding.inflate(getLayoutInflater());
setContentView(layout.getRoot());
addToGoogleWalletButton = layout.addToGoogleWalletButton;
addToGoogleWalletButton.setOnClickListener(v -> {
walletClient.savePasses(newObjectJson, this, ADD_TO_GOOGLE_WALLET_REQUEST_CODE);
});
// Additional logic in your onCreate method
}
O método savePasses
aciona o fluxo de salvamento e, depois que ele é concluído, invoca o método
onActivityResult
. A implementação
do onActivityResult
precisa ser semelhante a esta:
Kotlin
import android.content.Intent
override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) {
super.onActivityResult(requestCode, resultCode, data)
if (requestCode == addToGoogleWalletRequestCode) {
when (resultCode) {
RESULT_OK -> {
// Pass saved successfully
}
RESULT_CANCELED -> {
// Save operation canceled
}
PayClient.SavePassesResult.SAVE_ERROR -> data?.let { intentData ->
val errorMessage = intentData.getStringExtra(PayClient.EXTRA_API_ERROR_MESSAGE)
// Handle error
}
else -> {
// Handle unexpected (non-API) exception
}
}
}
}
Java
import android.content.Intent;
@Override
protected void onActivityResult(int requestCode, int resultCode, @Nullable Intent data) {
super.onActivityResult(requestCode, resultCode, data);
if (requestCode == ADD_TO_GOOGLE_WALLET_REQUEST_CODE) {
switch (resultCode) {
case RESULT_OK: {
// Pass saved successfully
break;
}
case RESULT_CANCELED: {
// Save operation canceled
break;
}
case PayClient.SavePassesResult.SAVE_ERROR: {
if (data != null) {
String apiErrorMessage = data.getStringExtra(PayClient.EXTRA_API_ERROR_MESSAGE);
// Handle error
}
break;
}
default: {
// Handle unexpected (non-API) exception
}
}
}
}
Quando o cartão é adicionado, o resultCode
tem o valor de
Activity.RESULT_OK
.
[SOMENTE TESTE] cartões
No modo de demonstração, todos os cartões criados terão um texto adicional "[SOMENTE TESTE]" no título do cartão. Isso serve para diferenciar os cartões de demonstração dos cartões ativos. Depois de receber da nossa equipe a aprovação para a produção, esses cartões do modo de demonstração não terão mais o texto adicional quando o usuário reabrir o app da carteira em um dispositivo conectado.
Próximas etapas
- Avalie casos de uso de vale-presente e implemente os que atendem às necessidades da empresa
- Personalize a aparência dos vales-presente seguindo as diretrizes da marca
- Enviar o fluxo de UX para análise final na seção "API Google Wallet" do Console do Google Pay e da Carteira
- Teste a integração e comece a usar!
- Ficou alguma dúvida? Confira nossas perguntas frequentes.