Premiers pas avec le SDK Android

Avant de commencer à utiliser le SDK Android, assurez-vous d'avoir rempli les conditions préalables.

Le SDK Android vous permet d'ajouter des cartes dans Google Wallet. Lorsque vous ajoutez 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 de carte est nécessaire pour créer un objet Cartes. Si vous n'en avez pas encore créé une, suivez les instructions pour créer une classe de carte. Définissez un élément FlightObject correspondant, y compris les attributs obligatoires suivants:

  • classId: identifiant de la classe de carte créée dans les conditions préalables.
  • id: identifiant unique de l'objet.

  • passenterName: nom du passager tel qu'il apparaît sur la carte d'embarquement
  • reservationInfo: informations sur la réservation de vol.
  • state: ce champ permet 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".

Reportez-vous au modèle de mise en page pour découvrir comment ces attributs sont représentés sur la carte d'embarquement.

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

JSON

      
{
  "id": "ISSUER_ID.OBJECT_ID",
  "classId": "ISSUER_ID.CLASS_ID",
  "passengerName": "Alex McJacobs",
  "reservationInfo": {
    "confirmationCode": "123456",
    "eticketNumber": "0000000000000",
    "frequentFlyerInfo": {
      "frequentFlyerProgramName": {
        "defaultValue": {
          "language": "en",
          "value": "Flying rewards program"
        }
      },
      "frequentFlyerNumber": "123456789"
    }
  },
  "state": "ACTIVE"
}

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

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

JSON

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

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

Google Wallet propose un bouton familier qui permet de déclencher le flux "Ajouter à Google Wallet" dans 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) et localisez le fichier sur votre disque local pour l'importer.

Vous pouvez maintenant 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

Vous pouvez ajouter FlightObject 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é. La mise en œuvre 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 la carte ajoutée, resultCode contient la valeur Activity.RESULT_OK.

[TEST UNIQUEMENT] Passes

Lorsque vous êtes toujours en mode démo, le titre de toutes les cartes que vous créez contiennent le texte supplémentaire "[TEST ONLY]". Cela permet de différencier les cartes de démonstration des cartes en temps réel. Une fois que notre équipe vous a donné son autorisation pour la production, ces cartes en mode démo ne seront plus accompagnées du texte supplémentaire lorsque l'utilisateur rouvrira l'application Wallet sur un appareil connecté.

Étapes suivantes