Karten/Tickets mit dem Android SDK ausstellen

Nachdem du eine Karte bzw. ein Ticket erstellt und in einem JWT codiert hast, kannst du sie in deiner Android-App ausstellen. Prüfe dazu, ob die Google Wallet API auf dem Gerät des Nutzers verfügbar ist, präsentiere die Karte mit der Schaltfläche „Zu Google Wallet hinzufügen“ und speichere die Karte bzw. das Ticket in Google Wallet, nachdem der Nutzer auf die Schaltfläche tippt.

Voraussetzungen

Bevor Sie versuchen, eine Karte bzw. ein Ticket auszustellen, müssen Sie Folgendes tun:

1. Google Wallet Android SDK installieren

Um das Google Wallet Android SDK zu verwenden, fügen Sie com.google.android.gms:play-services-pay zum Abschnitt dependencies der Datei build.gradle auf App-Ebene hinzu:

  implementation "com.google.android.gms:play-services-pay:16.4.0"

2. Verfügbarkeit der Google Wallet API prüfen

Bevor du das neue Objekt speicherst, muss die Google Wallet API auf dem Zielgerät verfügbar sein. Rufe dazu die Methode getPayApiAvailabilityStatus in der Klasse PayClient auf.

Fügen Sie der Aktivität, in der Sie die Schaltfläche anzeigen möchten, zuerst eine Member-Variable hinzu und instanziieren Sie sie beim Erstellen der Aktivität:

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
}

Wenn Sie andere Designmuster verwenden, sollten Sie die domainspezifische Geschäftslogik entsprechend platzieren. Wenn du beispielsweise das MVVM-Muster verwendest, platziere die UI-bezogene Geschäftslogik in deiner Aktivität oder deinem Fragment (z. B. UI-Elemente, Aktivitätsergebnisse) und die operative Logik im Ansichtsmodell (z. B. Client-Instanziierung, Trigger für Netzwerkaufrufe).

Prüfen Sie als Nächstes mithilfe von PayClient, ob die API verfügbar ist:

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

Rufen Sie schließlich die soeben in Ihrer Anwendung definierte Methode auf, wenn Sie die Verfügbarkeit der API ermitteln möchten.

Umgang, wenn die API nicht verfügbar ist

Gründe dafür, dass die API nicht verfügbar ist, sind möglicherweise veraltete Versionen von Android oder Google Play-Diensten oder die Tatsache, dass Google Wallet im Land des Nutzers nicht verfügbar ist.

Wenn die API nicht verfügbar ist, blende die Schaltfläche aus und kehre zu einer anderen Integration zurück (z.B. mithilfe eines JWT-Links). Hinweis: Der Nutzer kann die API möglicherweise in Zukunft verwenden.

3. Schaltfläche „Zu Google Wallet hinzufügen“ hinzufügen

Google Wallet bietet eine vertraute Schaltfläche, mit der du den Vorgang „Zu Google Wallet hinzufügen“ in deiner Anwendung auslösen kannst. Vektor-Assets für die Schaltfläche sind in den Richtlinien für Schaltflächen verfügbar.

Du kannst Vektor-Assets in Android Studio unter File > New > Vector Asset importieren. Wähle im Assistenten „Lokale Datei“ aus, gib einen Namen ein (z. B. add_to_google_wallet_button.xml) und suche die Datei auf dem lokalen Laufwerk, um sie zu importieren.

  • Schaltfläche „Zu Google Wallet hinzufügen“
  • Schaltfläche „Zu Google Wallet hinzufügen“ (komprimiert)

Jetzt kannst du das importierte Drawable verwenden, um die Schaltfläche deiner Benutzeroberfläche hinzuzufügen:

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

Die Schaltfläche hat eine layout_height von 48 dp und muss mindestens 200 dp breit sein.

4. Karte/Ticket zu Google Wallet eines Nutzers hinzufügen

Das EventObject kann durch Übergeben eines unsignierten JWT an die Methode savePasses hinzugefügt werden. Du kannst den Vorgang starten, nachdem du auf die Schaltfläche „Google Wallet“ geklickt hast.

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
}

Ergebnisverarbeitung

Die Methode savePasses löst den Speichervorgang aus und ruft die Methode onActivityResult auf, nachdem der Vorgang abgeschlossen ist. Die Implementierung von onActivityResult sollte in etwa so aussehen:

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

Wenn die Karte bzw. das Ticket erfolgreich hinzugefügt wurde, enthält resultCode den Wert Activity.RESULT_OK.