אחרי שיוצרים כרטיס ומקודדים אותו ב-JWT, אפשר להנפיק אותו באפליקציה ל-Android. כדי לעשות זאת, צריך לבדוק אם Google Wallet API זמין במכשיר של המשתמש, להציג לו את הלחצן 'הוספה ל-Google Wallet' ולאחר מכן לשמור את הכרטיס ב-Google Wallet אחרי שהוא מקייש על הלחצן.
דרישות מוקדמות
לפני שמנסים להנפיק כרטיס, חשוב לוודא שהתנאים הבאים מתקיימים:
- השלמתם את כל השלבים שמפורטים במדריך לתחילת השימוש.
- יוצרים לפחות סיווג של ציונים אחד.
- יוצרים לפחות אובייקט העברה אחד.
- קידוד של הכיתה Passes והאובייקט Passes ב-JWT.
1. התקנת Google Wallet Android SDK
כדי להשתמש ב-Google Wallet Android SDK, מוסיפים את com.google.android.gms:play-services-pay
לקטע dependencies
בקובץ build.gradle
ברמת האפליקציה:
implementation "com.google.android.gms:play-services-pay:16.5.0"
2. בדיקת הזמינות של Google Wallet API
לפני שמשמרים את האובייקט החדש, צריך לוודא ש-Google Wallet API זמין במכשיר היעד. לשם כך, קוראים ל-method getPayApiAvailabilityStatus
בכיתה PayClient
.
מתחילים בהוספת משתנה חבר לפעילות שבה רוצים להציג את הלחצן, ויוצרים מופע שלו כשיוצרים את הפעילות:
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
}
אם אתם משתמשים בתבניות עיצוב אחרות, כדאי להציב את הלוגיקה העסקית הספציפית לדומיין באופן מתאים. לדוגמה, אם אתם משתמשים בתבנית MVVM, תוכלו למקם את הלוגיקה העסקית שקשורה לממשק המשתמש ב-Activity או ב-Fragment (למשל: אלמנטים של ממשק המשתמש, תוצאת הפעילות) ולוגיקה תפעולית במודל התצוגה (למשל: יצירת מכונה של לקוח, טריגרים של קריאות לרשת).
לאחר מכן, משתמשים ב-PayClient
כדי לבדוק אם ה-API זמין:
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
});
}
לבסוף, כשצריך לקבוע את הזמינות של ה-API, קוראים לשיטה שהגדרתם באפליקציה.
טיפול במקרים שבהם ה-API לא זמין
בין הסיבות האפשריות לכך שה-API לא זמין: הגרסאות של Android או של Google Play Services לא עדכניות, או ש-Google Wallet לא זמין במדינה של המשתמש.
אם ה-API לא זמין, מומלץ להסתיר את הלחצן ולעבור לשילוב אחר (למשל, שימוש בקישור JWT). חשוב לדעת שהמשתמש עשוי לעמוד בדרישות לשימוש ב-API בעתיד.
3. הוספת הלחצן 'הוספה ל-Google Wallet'
ב-Google Wallet יש לחצן מוכר שאפשר להשתמש בו כדי להפעיל את התהליך של ההוספה ל-Google Wallet באפליקציה. נכסי וקטורים של הלחצן זמינים בהנחיות ללחצנים.
אפשר לייבא נכסי וקטורים ב-Android Studio בקטע File > New > Vector Asset
. בוחרים באפשרות 'קובץ מקומי' באשף, מוסיפים שם (למשל:
add_to_google_wallet_button.xml
) ומאתרים את הקובץ בכונן המקומי כדי לייבא אותו.
עכשיו אפשר להשתמש ב-drawable שיובאת כדי להוסיף את הלחצן לממשק המשתמש:
<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" />
הלחצן צריך להיות ברוחב של 200dp לפחות, עם layout_height
של 48dp.
4. הוספת כרטיס ל-Google Wallet של משתמש
כדי להוסיף את TransitObject
, מעבירים JWT לא חתום לשיטה savePasses
.
אפשר להתחיל את פעולת ההוספה בלחיצה על הלחצן של 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
}
טיפול בתוצאות
השיטה savePasses
מפעילה את תהליך השמירה ומפעילה את השיטה onActivityResult
אחרי שהתהליך מסתיים. ההטמעה של onActivityResult
אמורה להיראות כך:
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
}
}
}
}
כשהכרטיס נוסף בהצלחה, השדה resultCode
מכיל את הערך של Activity.RESULT_OK
.