Prüfe vor der Verwendung des Android SDK, ob alle Voraussetzungen erfüllt sind.
Mit dem Android SDK kannst du Karten/Tickets in Google Wallet hinzufügen. Wenn du deiner App die Schaltfläche Google Wallet hinzufügst, können die Nutzer Karten/Tickets einfach und bequem in Google Wallet einfügen.
So fügst du deiner Android-App die Schaltfläche Google Wallet hinzu:
1. Karten-/Ticketobjekt erstellen
Hinweis: Zum Erstellen eines Karten-/Ticketobjekts ist eine Karten-/Ticketklasse erforderlich. Wenn du diese Klasse noch nicht erstellt hast, folge der Anleitung unter Karten-/Ticketklasse erstellen.
Definiere ein entsprechendes GenericObject
, einschließlich der folgenden erforderlichen Attribute:
* classId
: Die ID der Karten-/Ticketklasse, die unter Voraussetzungen erstellt wurde.
* id
: Eine eindeutige ID für das Objekt.
genericType
: Der Typ der Karte. Wenn deine Karte mit keiner der verfügbaren Optionen übereinstimmt, lege den Wert auf GENERIC_TYPE_UNSPECIFIED
fest.
* cardTitle
: Der Titel der Karte bzw. des Tickets.
* header
: Der Header der Karte bzw. des Tickets, z. B. der Name des Nutzers.
Es ist außerdem empfehlenswert, die folgenden Attribute hinzuzufügen:
logo
subheader
In der Layoutvorlage findest du weitere Informationen zur Darstellung dieser Attribute in der generischen Karte bzw. im generischen Ticket.
Hier ist die Definition für eine generische Beispielkarte bzw. ein generisches Beispielticket:
JSON
{
"id": "ISSUER_ID.OBJECT_ID",
"classId": "CLASS_ID",
"genericType": "GENERIC_TYPE_UNSPECIFIED",
"cardTitle": {
"defaultValue": {
"language": "en",
"value": "Card title"
}
},
"subheader": {
"defaultValue": {
"language": "en",
"value": "Attendee"
}
},
"header": {
"defaultValue": {
"language": "en",
"value": "Alex McJacobs"
}
},
"logo": {
"sourceUri": {
"uri": "https://storage.googleapis.com/wallet-lab-tools-codelab-artifacts-public/pass_google_logo.jpg"
}
}
}
2. Unsigniertes JWT mit dem Objekt erstellen
Wenn dasGenericObject
erstellt wird, musst du es mit einem unsignierten JWT mit dem Attribut payload.GenericObjects
versehen, wie im folgenden Snippet gezeigt wird:
JSON
{
"iss": "OWNER_EMAIL_ADDRESS",
"aud": "google",
"typ": "savetowallet",
"iat": "UNIX_TIME",
"origins": [],
"payload": {
"genericObjects": [ NEW_OBJECT ]
}
}
3. Schaltfläche „Google Wallet“ in die Benutzeroberfläche einfügen
Für Google Wallet gibt es 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.
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. Prüfen, ob die Google Wallet API auf dem Zielgerät verfügbar ist
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üge der Aktivität, in der die Schaltfläche angezeigt werden soll, eine Mitgliedervariable hinzu und instanziiere sie, wenn die Aktivität erstellt wird:
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üfe nun mithilfe des Clients, 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
});
}
Rufe schließlich die oben definierte Methode in deiner Anwendung auf, wenn du die Verfügbarkeit der API ermitteln möchtest.
5. Objekt zu Google Wallet hinzufügen
Du kannst dasGenericObject
hinzufügen, indem du das unsignierte JWT aus Schritt 2 an die Methode savePasses
übergibst.
Du kannst den Vorgang starten, nachdem du auf die Schaltfläche für 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
}
Die Methode savePasses
löst den Speichervorgang aus und ruft die Methode onActivityResult
auf, wenn 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
.
[TEST ONLY] Karten/Tickets
Wenn du dich noch im Demomodus befindest, haben alle erstellten Karten/Tickets den zusätzlichen Text „[TEST ONLY]“ im Titel der Karte bzw. des Tickets. Damit lassen sich Demokarten/-tickets von Livekarten/-tickets unterscheiden. Sobald du die Produktionsgenehmigung von unserem Team erhalten hast, werden diese Demokarten/-tickets nicht mehr den zusätzlichen Text enthalten, wenn der Nutzer die Wallet App auf einem verbundenen Gerät öffnet.
Nächste Schritte
- Anwendungsfälle für generische Karten/Tickets bewerten und die Fälle implementieren, die den geschäftlichen Anforderungen entsprechen
- Erscheinungsbild deiner generischen Karten/Tickets wie in den Richtlinien für Marken beschrieben anpassen
- UX-Vorgang zur abschließenden Überprüfung im Bereich „Google Wallet API“ in der Google Pay & Wallet Console einreichen
- Einbindung testen und online gehen
- Hast du noch Fragen? Weitere Informationen findest du in unseren FAQs.