Erste Schritte mit dem Android SDK

Prüfen Sie vor der Verwendung des Android SDK, ob alle Voraussetzungen erfüllt sind.

Mit dem Android SDK können Sie Karten/Tickets in Google Wallet hinzufügen. Wenn Sie Ihrer App die Schaltfläche Google Wallet hinzufügen, können die Nutzer Karten/Tickets einfach und bequem in Google Wallet einfügen.

Führen Sie die folgenden Schritte aus, um Ihrer Android-App die Schaltfläche Google Wallet hinzuzufügen:

1) Karten-/Ticketobjekt erstellen

Hinweis: Zum Erstellen eines Karten-/Ticketobjekts ist eine Karten-/Ticketklasse erforderlich. Wenn Sie diese Klasse noch nicht erstellt haben, folgen Sie der Anleitung unter Karten-/Ticketklasse erstellen. Definieren Sie ein entsprechendes EventObject mit den folgenden erforderlichen Attributen:

  • classId: Die ID der Karten-/Ticketklasse, die in den Voraussetzungen erstellt wurde
  • id: Eine eindeutige ID für das Objekt.

  • state: Mit diesem Feld wird festgelegt, wie ein Objekt angezeigt wird. Ein inaktives Objekt wird beispielsweise in den Bereich „Abgelaufene Karten/Tickets“ verschoben.

Weitere Informationen zur Darstellung dieser Attribute im Veranstaltungsticket finden Sie in der Layoutvorlage.

Hier ist die Definition für ein Beispiel-Veranstaltungsticket:

JSON

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

2. Unsigniertes JWT mit dem Objekt erstellen

Wenn das EventObject erstellt wird, müssen Sie es mit einem unsignierten JWT mit dem Attribut payload.EventObjects versehen, wie im folgenden Snippet gezeigt wird:

JSON

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

3. Schaltfläche „Google Wallet“ in die Benutzeroberfläche einfügen

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

Sie können Vektor-Assets in Android Studio unter File > New > Vector Asset importieren. Wählen Sie im Assistenten „Lokale Datei“ aus, fügen Sie einen Namen hinzu (z. B.: add_to_google_wallet_button.xml) und suchen Sie die Datei auf dem lokalen Laufwerk, um sie zu importieren.

Jetzt können Sie das importierte Drawable verwenden, um die Schaltfläche Ihrer 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 Sie das neue Objekt speichern, muss die Google Wallet API auf dem Zielgerät verfügbar sein. Rufen Sie dazu die Methode getPayApiAvailabilityStatus in der Klasse PayClient auf. Fügen Sie der Aktivität, in der die Schaltfläche angezeigt werden soll, eine Mitgliedervariable hinzu und instanziieren Sie 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üfen Sie 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
    });
}

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

5. Objekt zu Google Wallet hinzufügen

Sie können das EventObject hinzufügen, indem Sie das unsignierte JWT aus Schritt 2 an die Methode savePasses übergeben. Sie können den Vorgang starten, indem Sie auf die Schaltfläche für Google Wallet klicken:

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 Sie sich noch im Demomodus befinden, enthalten alle von Ihnen erstellten Karten/Tickets den zusätzlichen Text „[NUR TEST]“ im Titel Ihrer Karte bzw. Ihres Tickets. Dies unterscheidet zwischen Demokarten und Livetickets. Sobald unser Produktionsteam die Genehmigung erhalten hat, erhalten diese Demokarten keinen zusätzlichen Text mehr, wenn der Nutzer die Wallet App auf einem verbundenen Gerät wieder öffnet.

Nächste Schritte