הפניה ללקוח

במאמר הזה מוסבר על השיטות של לקוח JavaScript שבהן אפשר להשתמש כדי להטמיע את Google Pay API באפליקציות האינטרנט שלכם.

יצרן

מאותחל אובייקט PaymentsClient. צריך להפעיל את ה-constructor הזה לפני שמפעילים member methods.

new PaymentsClient(paymentOptions)

ארגומנטים

נכס תיאור
paymentOptions

אובייקט שמכיל צמדי מפתח-ערך של נתוני ההגדרה של Google Pay API. אפשר לעיין בPaymentOptions כדי לראות את המאפיינים השונים שאפשר להגדיר.

לדוגמה: {environment:'PRODUCTION'}

החזרות

סוג תיאור
google.payments.api.PaymentsClient אובייקט PaymentsClient.

מקפיצה את הודעות השגיאה (Throws)

סוג תיאור
Error

הערך של מאפיין הסביבה שהועבר לא נתמך.

שיטות של אובייקטים

createButton(options)

שיטת הנוחות משמשת ליצירת לחצן תשלום של Google Pay עם המיתוג העדכני של Google Pay, להוספה לדף אינטרנט.

ה-HTMLElement שנוצר כולל CSS שמוכנס באופן דינמי ותמונת SVG שמתארחת ב-CDN של Google.

מידע נוסף על בחירת הצבע והסוג המתאימים של הכפתור לעיצוב האתר זמין בהנחיות המיתוג. יכול להיות שתצטרכו לשנות את המידות של הלחצן כדי שיתאימו ללחצנים דומים או לרכיבים של דף התשלום בדף שלכם. אפשר להשתמש בכלי התאמה אישית של הלחצן כדי להגדיר לחצן לתרחיש השימוש שלכם.

ארגומנטים

שם תיאור
options

אובייקט שמכיל צמדי מפתח/ערך להגדרת לחצן. ButtonOptions לעיון במאפיינים שאפשר להגדיר.

לדוגמה: {onClick:onGooglePaymentButtonClicked}

החזרות

סוג תיאור
HTMLElement תג HTML‏ <button> בתוך מאגר כללי של תוכן זורם כמו <div>.

מקפיצה את הודעות השגיאה (Throws)

סוג תיאור
Error

לא הוגדר מאפיין חובה.

isReadyToPay(isReadyToPayRequest)

משתמשים ב-method‏ isReadyToPay(isReadyToPayRequest) כדי לקבוע אם למשתמש יש אפשרות להחזיר אמצעי תשלום מ-Google Pay API.

אם הדפדפן תומך ב-Google Pay, הפונקציה isReadyToPay מחזירה true. כדי לקבוע אם המשתמש מחובר לחשבון Google או אם הוא כבר שמר אמצעי תשלום ב-Google Pay, צריך להגדיר את IsReadyToPayRequest.existingPaymentMethodRequired ל-true ולוודא ש-paymentMethodPresent מחזיר true בהבטחה שהתקבלה. פרטים נוספים זמינים במאמר IsReadyToPayResponse.

אם הפונקציה PaymentsClient אותחלה עם מאפיין סביבה של TEST, הפונקציה paymentMethodPresent תמיד מחזירה true.

ארגומנטים

שם תיאור
isReadyToPayRequest אובייקט שמכיל את אמצעי התשלום שהמוֹכר תומך בהם. פרטים על הנכסים השונים שאפשר להגדיר זמינים במאמר IsReadyToPayRequest.

החזרות

סוג תיאור
Promise

Resolved: אובייקט שמכיל מידע על יכולת התשלום של המשתמש. מידע נוסף זמין במאמר IsReadyToPayResponse.

נדחה: אובייקט שגיאה שמכיל מידע נוסף על הסיבה לדחייה. מידע נוסף זמין במאמר PaymentsError.

שגיאות

statusCode תיאור
DEVELOPER_ERROR
  • האובייקט IsReadyToPayRequest שהועבר לא היה בפורמט הנכון, לא כלל את הפרמטרים המינימליים שנדרשים כדי לקבוע את מוכנות המשתמש לשלם, או שהוא הכיל פרמטר או ערך לא תקינים.
  • הבקשה בוצעה מהקשר אבטחה שסוכן התשלומים או הדפדפן בחרו שלא למלא. ברוב המקרים, מדובר בשגיאה של הקשר לא מאובטח בדפדפן.

loadPaymentData(paymentDataRequest)

בשיטה הזו מוצג גיליון תשלום של Google Pay שמאפשר לבחור אמצעי תשלום ולהגדיר פרמטרים אופציונליים.

צריך להפעיל את ה-method הזו בזמן שהדפדפן מעבד התנהגות הפעלה כתוצאה מאירוע מסוג קליק. יכול להיות שיוצג למשתמש חלון קופץ שבו הוא יצטרך לבחור אמצעי תשלום או להזין נתונים נדרשים אחרים שצוינו בפרמטר של הבקשה שהועברה.

ארגומנטים

שם תיאור
paymentDataRequest אובייקט שמכיל צמדי מפתח-ערך של הגדרה מלאה של Google Pay API. PaymentDataRequest לעיון במאפיינים שאפשר להגדיר.

החזרות

סוג תיאור
Promise

הטיפול הסתיים: אובייקט שמכיל את נתוני הקונים המבוקשים. מידע נוסף זמין במאמר בנושא PaymentData.

נדחה: אובייקט שמכיל קוד שגיאה ומידע נוסף על הסיבה לדחייה. מידע נוסף זמין במאמר בנושא PaymentsError.

שגיאות

statusCode תיאור
CANCELED
  • אין תמיכה בדפדפן הנוכחי או במשתמש Google שמחובר לחשבון.
  • הקונה סגר את גיליון התשלום של Google Pay בלי לאשר את התשלום.
  • הבקשה בוצעה מהקשר אבטחה שסוכן התשלום או הדפדפן בחרו שלא למלא. בדרך כלל מדובר בהקשר לא מאובטח של הדפדפן.
  • השיטה הופעלה בזמן שגיליון התשלום של Google Pay כבר הוצג.
  • אובייקט PaymentDataRequest שעבר נדחה על ידי דף התשלום של Google Pay. סיבה נפוצה לכך היא שחסרים פרמטרים של PaymentMethodTokenizationSpecification השער או שהם לא הושלמו, או שערכי הפרמטרים לא תקינים.
DEVELOPER_ERROR האובייקט PaymentDataRequest שהועבר לא היה בפורמט תקין, חסרו בו הפרמטרים המינימליים הנדרשים או שהוא הכיל פרמטר או ערך לא תקינים.

prefetchPaymentData(paymentDataRequest)

אפשר להשתמש בשיטה הזו כדי לבצע אחזור מראש של הגדרה מסוימת של PaymentDataRequest כדי לשפר את loadPaymentData זמן הביצוע באינטראקציות מאוחרות יותר של המשתמשים. לא מוחזר ערך.

אופטימיזציות של אחזור מראש זמינות ב-Chrome ל-Android.

ארגומנטים

שם תיאור
paymentDataRequest אובייקט שמכיל צמדי מפתח-ערך של הגדרה מלאה של Google Pay API. PaymentDataRequest לעיון במאפיינים שאפשר להגדיר. שינוי במאפיין transactionInfo לא משפיע על ערך הטעינה מראש ששמור במטמון.

התקשרות חוזרת (callback) של נתוני תשלומים

אפשר להעביר את הפונקציות הבאות לטיפול בקריאות חוזרות אל PaymentOptions.paymentDataCallbacks כדי לתמוך באישור תשלומים ובעדכוני מחירים דינמיים.

onPaymentAuthorized(paymentData)

השיטה הזו מופעלת כשמאשרים תשלום בדף התשלום.

ארגומנטים

שם תיאור
paymentData אובייקט שמכיל את נתוני הקונים המבוקשים. פרטים נוספים זמינים במאמר PaymentData.

החזרות

סוג תיאור
Promise

Resolved: אובייקט שמכיל מידע על תוצאות של עסקאות תשלום. פרטים נוספים זמינים במאמר PaymentAuthorizationResult.

נדחה: אובייקט שגיאה עם כוונת שגיאה והודעה שיוצגו בדף התשלום. פרטים נוספים זמינים במאמר PaymentDataError.

onPaymentDataChanged(intermediatePaymentData)

השיטה הזו מטפלת בשינויים בנתוני התשלום בדף התשלום, כמו כתובת למשלוח ואפשרויות משלוח.

ארגומנטים

שם תיאור
intermediatePaymentData אובייקט שמכיל את הכתובת ואת אפשרות המשלוח שנבחרו בדף התשלום. פרטים נוספים זמינים במאמר IntermediatePaymentData.

החזרות

סוג תיאור
Promise

Resolved: אובייקט שמכיל מידע על פרטי עסקאות חדשים, על אפשרויות משלוח ועל שגיאות בפרטי התשלום. פרטים נוספים זמינים במאמר PaymentDataRequestUpdate.

נדחה: אובייקט שגיאה עם כוונת שגיאה והודעה שיוצגו בדף התשלום. פרטים נוספים זמינים במאמר PaymentDataError.