क्लाइंट का रेफ़रंस

इस रेफ़रंस में, JavaScript क्लाइंट के उन तरीकों के बारे में बताया गया है जिनका इस्तेमाल करके, अपने वेब ऐप्लिकेशन में Google Pay API को लागू किया जा सकता है.

निर्माता

PaymentsClient ऑब्जेक्ट को शुरू करता है. सदस्य के तरीकों को कॉल करने से पहले, आपको इस कंस्ट्रक्टर को कॉल करना होगा.

new PaymentsClient(paymentOptions)

तर्क

प्रॉपर्टी ब्यौरा
paymentOptions

ऐसा ऑब्जेक्ट जिसमें Google Pay API के कॉन्फ़िगरेशन डेटा के की-वैल्यू पेयर शामिल हों. कॉन्फ़िगर की जा सकने वाली अलग-अलग प्रॉपर्टी के लिए, PaymentOptions देखें.

उदाहरण: {environment:'PRODUCTION'}

रिटर्न

टाइप ब्यौरा
google.payments.api.PaymentsClient PaymentsClient ऑब्जेक्ट.

थ्रॉ

टाइप ब्यौरा
Error

पास की गई एनवायरमेंट प्रॉपर्टी की वैल्यू का इस्तेमाल नहीं किया जा सकता.

ऑब्जेक्ट के तरीके

createButton(options)

सुविधाजनक तरीके का इस्तेमाल करके, Google Pay से पेमेंट करने का बटन जनरेट किया जाता है. इसे Google Pay की नई ब्रैंडिंग के साथ स्टाइल किया जाता है, ताकि इसे किसी वेबपेज में शामिल किया जा सके.

जनरेट किए गए HTMLElement में, डाइनैमिक तौर पर शामिल की गई सीएसएस और Google के सीडीएन पर होस्ट की गई एसवीजी इमेज शामिल होती है.

अपनी साइट के डिज़ाइन के लिए सही बटन का रंग और बटन का टाइप चुनने के बारे में ज़्यादा जानकारी पाने के लिए, हमारे ब्रैंड से जुड़े दिशा-निर्देश देखें. आपको बटन के डाइमेंशन में बदलाव करना पड़ सकता है, ताकि वह आपके पेज पर मौजूद मिलते-जुलते बटन या चेकआउट एलिमेंट से मैच करे. अपने इस्तेमाल के उदाहरण के लिए बटन को कॉन्फ़िगर करने के लिए, हमारे बटन को पसंद के मुताबिक बनाएं टूल का इस्तेमाल करें.

तर्क

नाम ब्यौरा
options

ऐसा ऑब्जेक्ट जिसमें बटन कॉन्फ़िगरेशन के लिए की-वैल्यू पेयर शामिल हों. कॉन्फ़िगर की जा सकने वाली प्रॉपर्टी के लिए, ButtonOptions देखें.

उदाहरण: {onClick:onGooglePaymentButtonClicked}

रिटर्न

टाइप ब्यौरा
HTMLElement <div> जैसे सामान्य फ़्लो कॉन्टेंट कंटेनर के अंदर मौजूद एचटीएमएल <button>.

थ्रॉ

टाइप ब्यौरा
Error

कोई ज़रूरी प्रॉपर्टी सेट नहीं की गई है.

isReadyToPay(isReadyToPayRequest)

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 की पेमेंट शीट दिखती है. इससे पेमेंट का तरीका और ज़रूरत के हिसाब से कॉन्फ़िगर किए गए पैरामीटर चुने जा सकते हैं.

इस तरीके को तब कॉल किया जाना चाहिए, जब ब्राउज़र किसी क्लिक इवेंट के नतीजे के तौर पर, ऐक्टिवेशन बिहेवियर को प्रोसेस करता है. उपयोगकर्ता को एक पॉप-अप विंडो दिख सकती है. इसमें, पेमेंट का तरीका या पास किए गए अनुरोध पैरामीटर में बताई गई अन्य ज़रूरी जानकारी चुनने का विकल्प होता है.

तर्क

नाम ब्यौरा
paymentDataRequest ऐसा ऑब्जेक्ट जिसमें Google Pay API के पूरे कॉन्फ़िगरेशन के की-वैल्यू पेयर शामिल हों. कॉन्फ़िगर की जा सकने वाली प्रॉपर्टी के लिए, PaymentDataRequest देखें.

रिटर्न

टाइप ब्यौरा
Promise

Resolved: ऐसा ऑब्जेक्ट जिसमें खरीदार का अनुरोध किया गया डेटा शामिल होता है. ज़्यादा जानकारी के लिए, PaymentData देखें.

अस्वीकार किया गया: ऐसा ऑब्जेक्ट जिसमें गड़बड़ी का कोड और अस्वीकार किए जाने की वजह के बारे में ज़्यादा जानकारी शामिल हो. ज़्यादा जानकारी के लिए, PaymentsError देखें.

गड़बड़ियां

statusCode ब्यौरा
CANCELED
  • मौजूदा ब्राउज़र या लॉग इन किया हुआ Google उपयोगकर्ता, इस सुविधा के साथ काम नहीं करता.
  • खरीदार ने पेमेंट की अनुमति दिए बिना, Google Pay की पेमेंट शीट को खारिज कर दिया.
  • अनुरोध को सुरक्षा के लिहाज़ से शुरू किया गया था, लेकिन पेमेंट एजेंट या ब्राउज़र ने इसे पूरा नहीं किया. सबसे आम तौर पर, असुरक्षित ब्राउज़र कॉन्टेक्स्ट.
  • Google Pay की पेमेंट शीट पहले से दिखने के दौरान, इस तरीके को कॉल किया गया.
  • Google Pay की पेमेंट शीट ने, पास किए गए PaymentDataRequest ऑब्जेक्ट को अस्वीकार कर दिया. आपके गेटवे के लिए, PaymentMethodTokenizationSpecification पैरामीटर मौजूद न होना या अधूरा होना या पैरामीटर की वैल्यू अमान्य होना, आम तौर पर इसकी वजह होती है.
DEVELOPER_ERROR पास किए गए PaymentDataRequest ऑब्जेक्ट को गलत तरीके से फ़ॉर्मैट किया गया था. इसमें ज़रूरी पैरामीटर मौजूद नहीं थे या इसमें कोई अमान्य पैरामीटर और/या वैल्यू शामिल थी.

prefetchPaymentData(paymentDataRequest)

इस तरीके का इस्तेमाल करके, PaymentDataRequest कॉन्फ़िगरेशन को प्रीफ़ेच करें. इससे, उपयोगकर्ता के बाद के इंटरैक्शन पर loadPaymentData के लागू होने में लगने वाले समय को कम किया जा सकता है. कोई वैल्यू नहीं दिखती.

Android के लिए Chrome पर, प्रीफ़ेच ऑप्टिमाइज़ेशन की सुविधा उपलब्ध है.

तर्क

नाम ब्यौरा
paymentDataRequest ऐसा ऑब्जेक्ट जिसमें Google Pay API के पूरे कॉन्फ़िगरेशन के की-वैल्यू पेयर शामिल हों. कॉन्फ़िगर की जा सकने वाली प्रॉपर्टी के लिए, PaymentDataRequest देखें. transactionInfo प्रॉपर्टी में बदलाव करने से, कैश मेमोरी में सेव की गई प्रीफ़ेच वैल्यू पर कोई असर नहीं पड़ता.

पेमेंट डेटा कॉलबैक

पेमेंट की अनुमति देने और डाइनैमिक प्राइस अपडेट की सुविधा देने के लिए, इन कॉलबैक हैंडलर को PaymentOptions.paymentDataCallbacks को पास किया जा सकता है.

onPaymentAuthorized(paymentData)

इस तरीके को तब कॉल किया जाता है, जब पेमेंट शीट में पेमेंट की अनुमति दी जाती है.

तर्क

नाम ब्यौरा
paymentData ऐसा ऑब्जेक्ट जिसमें खरीदार का अनुरोध किया गया डेटा शामिल हो. ज़्यादा जानकारी के लिए, PaymentData देखें.

रिटर्न

टाइप ब्यौरा
Promise

Resolved: यह एक ऐसा ऑब्जेक्ट है जिसमें पेमेंट के लेन-देन के नतीजों की जानकारी होती है. ज़्यादा जानकारी के लिए, PaymentAuthorizationResult देखें.

Rejected: यह एक गड़बड़ी वाला ऑब्जेक्ट होता है. इसमें गड़बड़ी का इंटेंट और मैसेज होता है. इसे पेमेंट शीट में रेंडर किया जाता है. ज़्यादा जानकारी के लिए, PaymentDataError देखें.

onPaymentDataChanged(intermediatePaymentData)

यह तरीका, पेमेंट शीट में पेमेंट डेटा में होने वाले बदलावों को मैनेज करता है. जैसे, शिपिंग पता और शिपिंग के विकल्प.

तर्क

नमस्ते
नाम ब्यौरा
intermediatePaymentData ऐसा ऑब्जेक्ट जिसमें पेमेंट शीट में चुना गया पता और शिपिंग का विकल्प शामिल हो. ज़्यादा जानकारी के लिए, IntermediatePaymentData देखें.

रिटर्न

टाइप ब्यौरा
Promise

Resolved: यह एक ऐसा ऑब्जेक्ट है जिसमें लेन-देन की नई जानकारी, शिपिंग के विकल्प, और पेमेंट डेटा से जुड़ी गड़बड़ियों की जानकारी शामिल होती है. ज़्यादा जानकारी के लिए, PaymentDataRequestUpdate देखें.

Rejected: यह एक गड़बड़ी वाला ऑब्जेक्ट होता है. इसमें गड़बड़ी का इंटेंट और मैसेज होता है. इसे पेमेंट शीट में रेंडर किया जाता है. ज़्यादा जानकारी के लिए, PaymentDataError देखें.