مرجع مشتری

این مرجع، متدهای کلاینت جاوا اسکریپت را برای پیاده‌سازی API گوگل پی در برنامه‌های وب شما شرح می‌دهد.

سازنده

شیء PaymentsClient را مقداردهی اولیه می‌کند. شما باید قبل از فراخوانی متدهای عضو، این سازنده را فراخوانی کنید.

مشتری پرداخت جدید (گزینه‌های پرداخت)

استدلال‌ها

ملک	توضیحات
paymentOptions	یک شیء حاوی جفت‌های کلید-مقدار از داده‌های پیکربندی API گوگل پی. برای ویژگی‌های مختلف قابل پیکربندی، به PaymentOptions مراجعه کنید. مثال: {environment:'PRODUCTION'}

بازگشت‌ها

نوع	توضیحات
google.payments.api.PaymentsClient	شیء PaymentsClient .

پرتاب‌ها

نوع	توضیحات
Error	مقدار ویژگی محیطی ارسالی پشتیبانی نمی‌شود.

متدهای شیء

دکمه‌ی ایجاد (گزینه‌ها)

از روش راحتی برای ایجاد یک دکمه پرداخت Google Pay با جدیدترین برند Google Pay برای درج در یک صفحه وب استفاده می‌شود.

HTMLElement تولید شده شامل CSS پویا و یک تصویر SVG است که در CDN گوگل میزبانی می‌شود.

برای اطلاعات بیشتر در مورد نحوه انتخاب رنگ و نوع دکمه مناسب برای طراحی سایت خود، به دستورالعمل‌های برند ما مراجعه کنید. ممکن است لازم باشد ابعاد دکمه را تغییر دهید تا با دکمه‌ها یا عناصر پرداخت مشابه در صفحه شما مطابقت داشته باشد. از ابزار «سفارشی‌سازی دکمه» ما برای پیکربندی یک دکمه برای مورد استفاده خود استفاده کنید.

نکته: حذف شنونده‌های رویداد onLoad و onClick هنگام پیاده‌سازی createButton API ممکن است باعث شود دکمه پرداخت Google Pay آنطور که در نظر گرفته شده کار نکند.

استدلال‌ها

نام	توضیحات
options	شیء‌ای که شامل جفت‌های کلید-مقدار برای پیکربندی دکمه است. برای ویژگی‌های قابل پیکربندی ButtonOptions مراجعه کنید. مثال: {onClick:onGooglePaymentButtonClicked}

بازگشت‌ها

نوع	توضیحات
HTMLElement	یک <button> HTML درون یک کانتینر محتوای عمومی مانند <div> .

پرتاب‌ها

نوع	توضیحات
Error	یک ویژگی الزامی تنظیم نشده است.

آماده پرداخت (درخواست آماده پرداخت)

از متد isReadyToPay(isReadyToPayRequest) برای تعیین توانایی کاربر در بازگرداندن یک نوع پرداخت از API گوگل پی استفاده کنید.

اگر مرورگر از Google Pay پشتیبانی کند، isReadyToPay مقدار true را برمی‌گرداند. برای تعیین اینکه آیا کاربر به حساب Google وارد شده است یا قبلاً یک روش پرداخت در Google Pay ذخیره کرده است، IsReadyToPayRequest.existingPaymentMethodRequired را روی true تنظیم کنید و تأیید کنید که paymentMethodPresent در promise حل شده مقدار true را برمی‌گرداند. برای جزئیات بیشتر، به IsReadyToPayResponse مراجعه کنید.

اگر PaymentsClient با یک ویژگی محیطی TEST مقداردهی اولیه شده باشد، paymentMethodPresent همیشه true را برمی‌گرداند.

هشدار: هنگام تعیین نمایش یا عدم نمایش دکمه Google Pay، نباید به existingPaymentMethodRequired تکیه کرد. ویژگی existingPaymentMethodRequired به کوکی‌ها و ردیابی بین سایتی متکی است. اگر این موارد در دسترس نباشند، ویژگی paymentMethodPresent بازگردانده نمی‌شود، حتی اگر isReadyToPayRequest.existingPaymentMethodRequired روی true تنظیم شده باشد.

استدلال‌ها

نام	توضیحات
isReadyToPayRequest	شیء‌ای که شامل روش‌های پرداخت پشتیبانی‌شده توسط فروشنده است. برای جزئیات بیشتر در مورد ویژگی‌های مختلف قابل پیکربندی، به IsReadyToPayRequest مراجعه کنید.

بازگشت‌ها

نوع	توضیحات
Promise	حل‌شده: شیء‌ای که حاوی اطلاعاتی در مورد توانایی پرداخت کاربر است. برای اطلاعات بیشتر، به IsReadyToPayResponse مراجعه کنید. رد شده: یک شیء خطا که حاوی اطلاعات بیشتری در مورد دلیل رد شدن است. برای اطلاعات بیشتر، به PaymentsError مراجعه کنید.

خطاها

کد وضعیت	توضیحات
DEVELOPER_ERROR	شیء IsReadyToPayRequest ارسالی به طور نامناسبی قالب‌بندی شده است، حداقل پارامترهای لازم برای تعیین آمادگی کاربر برای پرداخت را ندارد، یا حاوی پارامتر و/یا مقدار نامعتبری است. درخواست از یک زمینه امنیتی آغاز شده است که عامل پرداخت یا مرورگر تصمیم به انجام آن نگرفته است. معمولاً این یک خطای زمینه مرورگر ناامن است.

بارگذاری داده‌های پرداخت (درخواست داده‌های پرداخت)

این روش یک برگه پرداخت Google Pay ارائه می‌دهد که امکان انتخاب روش پرداخت و پارامترهای پیکربندی‌شده اختیاری را فراهم می‌کند.

این متد باید زمانی فراخوانی شود که مرورگر در حال پردازش یک رفتار فعال‌سازی در نتیجه‌ی یک رویداد کلیک است. ممکن است یک پنجره‌ی پاپ‌آپ برای انتخاب روش پرداخت یا سایر داده‌های مورد نیاز مشخص شده در پارامتر درخواست ارسالی، به کاربر نمایش داده شود.

استدلال‌ها

نام	توضیحات
paymentDataRequest	یک شیء که شامل جفت‌های کلید-مقدار از پیکربندی کامل API گوگل پی است. برای ویژگی‌های قابل پیکربندی PaymentDataRequest مراجعه کنید.

بازگشت‌ها

نوع	توضیحات
Promise	حل شده: شیء‌ای که شامل داده‌های درخواستی خریدار است. برای اطلاعات بیشتر به PaymentData مراجعه کنید. رد شده: یک شیء حاوی کد خطا و اطلاعات بیشتر در مورد دلیل رد شدن. برای اطلاعات بیشتر به PaymentsError مراجعه کنید.

خطاها

کد وضعیت	توضیحات
CANCELED	مرورگر فعلی یا کاربر گوگل وارد شده پشتیبانی نمی‌شود. خریدار بدون اجازه پرداخت، برگه پرداخت گوگل پی را رد کرد. درخواست از یک زمینه امنیتی آغاز شده است که عامل پرداخت یا مرورگر تصمیم به انجام آن نگرفته است. معمولاً یک زمینه مرورگر ناامن . این متد زمانی فراخوانی شد که برگه پرداخت Google Pay از قبل نمایش داده شده بود. شیء PaymentDataRequest ارسالی توسط برگه پرداخت Google Pay رد شد. پارامترهای PaymentMethodTokenizationSpecification مربوط به درگاه شما یا مقادیر نامعتبر پارامترها، از دلایل رایج هستند.
DEVELOPER_ERROR	شیء PaymentDataRequest ارسالی به طور نامناسب قالب‌بندی شده است، حداقل پارامترهای مورد نیاز را ندارد، یا حاوی پارامتر و/یا مقدار نامعتبری است.

پیش‌واکشی داده‌های پرداخت (درخواست داده‌های پرداخت)

از این روش برای پیش‌واکشی پیکربندی PaymentDataRequest استفاده کنید تا زمان اجرای loadPaymentData در تعامل بعدی کاربر بهبود یابد. هیچ مقداری بازگردانده نمی‌شود.

بهینه‌سازی‌های Prefetch در کروم برای اندروید در دسترس هستند.

استدلال‌ها

نام	توضیحات
paymentDataRequest	شیء‌ای که شامل جفت‌های کلید-مقدار از پیکربندی کامل API گوگل پی است. برای ویژگی‌های قابل پیکربندی PaymentDataRequest مراجعه کنید. تغییر در ویژگی transactionInfo بر مقدار پیش‌واکشی ذخیره‌شده تأثیری نمی‌گذارد.