Справочные материалы о клиенте

В этом справочнике описываются клиентские методы JavaScript, которые можно использовать для реализации API Google Pay в ваших веб-приложениях.

Конструктор

Инициализирует объект PaymentsClient . Этот конструктор необходимо вызвать перед вызовом методов-членов.

новый PaymentsClient(paymentOptions)

Аргументы

Свойство Описание
paymentOptions

Объект, содержащий пары «ключ-значение» данных конфигурации API Google Pay. Сведения о различных настраиваемых свойствах см. в разделе PaymentOptions .

Пример: {environment:'PRODUCTION'}

Возврат

Тип Описание
google.payments.api.PaymentsClient Объект PaymentsClient .

Броски

Тип Описание
Error

Переданное значение свойства среды не поддерживается.

Методы объекта

createButton(опции)

Удобный метод используется для создания кнопки оплаты Google Pay, оформленной в соответствии с последним фирменным стилем Google Pay, для вставки на веб-страницу.

Сгенерированный HTMLElement включает динамически вставленный CSS и изображение SVG, размещенное на CDN Google.

Ознакомьтесь с нашими рекомендациями по фирменному стилю , чтобы узнать больше о выборе цвета и типа кнопки, подходящих для дизайна вашего сайта. Возможно, вам потребуется изменить размеры кнопки, чтобы она соответствовала аналогичным кнопкам или элементам оформления заказа на вашей странице. Воспользуйтесь инструментом «Настроить кнопку» , чтобы настроить кнопку для вашего варианта использования.

Аргументы

Имя Описание
options

Объект, содержащий пары «ключ-значение» для настройки кнопки. Сведения о настраиваемых свойствах см. в разделе ButtonOptions .

Пример: {onClick:onGooglePaymentButtonClicked}

Возврат

Тип Описание
HTMLElement HTML- <button> внутри универсального контейнера потокового содержимого, например <div> .

Броски

Тип Описание
Error

Обязательное свойство не установлено.

isReadyToPay(isReadyToPayRequest)

Используйте метод isReadyToPay(isReadyToPayRequest) , чтобы определить возможность пользователя вернуть форму оплаты из API Google Pay.

Если браузер поддерживает 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 Объект, содержащий пары «ключ-значение» полной конфигурации API Google Pay. Настраиваемые свойства см. 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 Объект, содержащий пары «ключ-значение» полной конфигурации API Google Pay. Настраиваемые свойства см. PaymentDataRequest . Изменение свойства transactionInfo не влияет на кэшированное значение предварительной выборки.

onPaymentAuthorized(paymentData)

Этот метод вызывается при авторизации платежа на платежном листе.

Аргументы

Имя Описание
paymentData Объект, содержащий запрошенные данные покупателя. Подробнее см. PaymentData .

Возврат

Тип Описание
Promise

Resolved: объект, содержащий информацию о результатах платёжной транзакции. Подробнее см. PaymentAuthorizationResult .

Отклонено: объект ошибки с намерением и сообщением об ошибке, которое будет отображено на странице оплаты. Подробнее см. PaymentDataError .

onPaymentDataChanged(промежуточные данные о платежах)

Этот метод обрабатывает изменения платежных данных на платежном листе, такие как адрес доставки и варианты доставки.

Аргументы

Имя Описание
intermediatePaymentData Объект, содержащий выбранный адрес и вариант доставки на странице оплаты. Подробнее см. IntermediatePaymentData .

Возврат

Тип Описание
Promise

Решено: объект, содержащий информацию о новых транзакциях, вариантах доставки и ошибках в платёжных данных. Подробнее см. PaymentDataRequestUpdate .

Отклонено: объект ошибки с намерением и сообщением об ошибке, которое будет отображено на странице оплаты. Подробнее см. PaymentDataError .