Premiers pas avec le SDK Android

Avant de commencer à utiliser le SDK Android, assurez-vous de remplir les conditions préalables.

Le SDK Android vous permet d'ajouter des cartes dans Google Wallet. Lorsque vous intégrez le bouton Google Wallet dans votre application, les utilisateurs bénéficient d'une expérience simple et agréable pour ajouter leurs cartes dans Google Wallet.

Suivez les étapes ci-dessous pour ajouter le bouton Google Wallet à votre application Android :

1. Créer un objet Cartes

Remarque : Une classe Cartes est nécessaire pour créer un objet Cartes. Si vous n'en avez pas encore, suivez les instructions pour créer une classe Cartes. Définissez un objet GiftCardObject correspondant, avec les attributs obligatoires suivants : * classId : identifiant de la classe Cartes créé dans les opérations préalables. * id : identifiant unique de l'objet.

* cardNumber : identifiant associé à la carte. * state : champ permettant de déterminer la manière dont un objet s'affiche. Par exemple, un objet inactif est déplacé dans la section "Cartes expirées".

Pour en savoir plus sur la représentation de ces attributs dans la carte cadeau, consultez le modèle de mise en page.

Voici la définition d'un exemple de carte cadeau :

JSON

      
{
  "id": "ISSUER_ID.OBJECT_ID",
  "classId": "CLASS_ID",
  "cardNumber": "1234567890",
  "state": "ACTIVE"
}

2. Créer un jeton JWT non signé avec l'objet

Une fois l'objet GiftCardObject créé, encapsulez-le avec un jeton JWT non signé doté de l'attribut payload.GiftCardObjects, comme dans l'extrait de code suivant :

JSON

{
  "iss": "OWNER_EMAIL_ADDRESS",
  "aud": "google",
  "typ": "savetowallet",
  "iat": "UNIX_TIME",
  "origins": [],
  "payload": {
      "giftcardObjects": [ NEW_OBJECT ]
  }
}

3. Inclure le bouton Google Wallet dans l'interface utilisateur

Dans Google Wallet, un bouton familier vous permet de déclencher le processus "Ajouter à Google Wallet" depuis votre application. Les éléments vectoriels pour le bouton sont disponibles dans les consignes pour les boutons.

Vous pouvez importer des éléments vectoriels dans Android Studio sous File > New > Vector Asset. Sélectionnez "Fichier local" dans l'assistant et ajoutez un nom (par exemple, add_to_google_wallet_button.xml), puis recherchez le fichier sur votre disque local pour l'importer.

Vous pouvez désormais utiliser le drawable importé pour ajouter le bouton à votre interface utilisateur :

<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" />

La hauteur du bouton (layout_height) est de 48 dp et sa largeur minimale doit être de 200 dp.

4. Vérifier si l'API Google Wallet est disponible sur l'appareil cible

Avant d'enregistrer le nouvel objet, assurez-vous que l'API Google Wallet est disponible sur l'appareil cible en appelant la méthode getPayApiAvailabilityStatus dans la classe PayClient. Commencez par ajouter une variable de membre à l'activité où le bouton sera affiché, puis instanciez-la lors de la création de l'activité :

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
}

À présent, utilisez le client pour vérifier si l'API est disponible :

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
    });
}

Enfin, appelez la méthode définie ci-dessus dans votre application lorsque vous devez déterminer la disponibilité de l'API.

5. Ajouter l'objet à Google Wallet

L'objet GiftCardObject peut être ajouté en transmettant le jeton JWT non signé de l'étape 2 à la méthode savePasses. Pour lancer l'opération d'ajout, cliquez sur le bouton Google Wallet :

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
}

La méthode savePasses déclenche le flux d'enregistrement et appelle la méthode onActivityResult une fois le flux d'enregistrement terminé. L'implémentation de onActivityResult doit se présenter comme suit :

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
      }
    }
  }
}

Une fois que la carte a bien été ajoutée, resultCode contient la valeur Activity.RESULT_OK.

Cartes [TEST UNIQUEMENT]

Lorsque vous êtes toujours en mode démo, le titre des cartes que vous créez comporte le texte supplémentaire "[TEST UNIQUEMENT]". Cela permet de différencier les cartes de démonstration des cartes disponibles. Une fois leur production approuvée par notre équipe, les cartes de démonstration ne comportent plus le texte supplémentaire lorsque l'utilisateur rouvre l'application Wallet sur un appareil connecté.

Étapes suivantes