Dokumentacja klienta

Ten dokument referencyjny opisuje metody klienta JavaScript, których należy użyć do wdrożenia interfejsu Google Pay API w aplikacjach internetowych.

Zespół

Inicjuje obiekt PaymentsClient. Musisz wywołać ten konstruktor przed wywołaniem metod składowych.

new PaymentsClient(paymentOptions)

Argumenty

Właściwość Opis
paymentOptions

Obiekt zawierający pary klucz-wartość danych konfiguracji interfejsu Google Pay API. Różne właściwości, które można skonfigurować, znajdziesz w PaymentOptions.

Przykład: {environment:'PRODUCTION'}

Zwroty

Typ Opis
google.payments.api.PaymentsClient Obiekt PaymentsClient.

Rzuty

Typ Opis
Error

Przekazana wartość właściwości środowiska nie jest obsługiwana.

Metody obiektów

createButton(options)

Metoda ułatwiająca służy do generowania przycisku płatności Google Pay z najnowszym logo Google Pay, który można wstawić na stronie internetowej.

Wygenerowany element HTMLElement zawiera dynamicznie wstawiony kod CSS i obraz SVG hostowany w sieci CDN Google.

Więcej informacji o tym, jak wybrać odpowiedni kolor i typ przycisku do projektu witryny, znajdziesz w wytycznych dotyczących marki. Może być konieczna zmiana wymiarów przycisku, aby pasował do innych podobnych przycisków lub elementów płatności na stronie. Użyj narzędzia do dostosowywania przycisku, aby skonfigurować przycisk pod kątem swojego przypadku użycia.

Argumenty

Nazwa Opis
options

Obiekt zawierający pary klucz-wartość konfiguracji przycisku. Właściwości, które można skonfigurować, znajdziesz w ButtonOptions.

Przykład: {onClick:onGooglePaymentButtonClicked}

Zwroty

Typ Opis
HTMLElement Element HTML <button> w kontenerze ogólnej treści, takim jak <div>.

Rzuty

Typ Opis
Error

Nie ustawiono wymaganej właściwości.

isReadyToPay(isReadyToPayRequest)

Użyj metody isReadyToPay(isReadyToPayRequest), aby określić, czy użytkownik może zwrócić formę płatności z interfejsu Google Pay API.

Jeśli przeglądarka obsługuje Google Pay, isReadyToPay zwraca true. Aby określić, czy użytkownik jest zalogowany na konto Google lub czy ma już zapisaną formę płatności w Google Pay, ustaw IsReadyToPayRequest.existingPaymentMethodRequired na true i sprawdź, czy paymentMethodPresent zwraca true w rozwiązanej obietnicy. Więcej informacji znajdziesz w artykule IsReadyToPayResponse.

Jeśli obiekt PaymentsClient został zainicjowany z właściwością środowiska TEST, metoda paymentMethodPresent zawsze zwraca wartość true.

Argumenty

Nazwa Opis
isReadyToPayRequest Obiekt zawierający formy płatności obsługiwane przez sprzedawcę. Szczegółowe informacje o różnych właściwościach, które można konfigurować, znajdziesz w artykule IsReadyToPayRequest.

Zwroty

Typ Opis
Promise

Resolved: obiekt zawierający informacje o możliwości zapłaty przez użytkownika. Więcej informacji: IsReadyToPayResponse.

Rejected: obiekt błędu zawierający więcej informacji o przyczynie odrzucenia. Więcej informacji: PaymentsError.

Błędy

statusCode Opis
DEVELOPER_ERROR
  • Przekazany obiekt IsReadyToPayRequest był nieprawidłowo sformatowany, nie zawierał minimalnych wymaganych parametrów do określenia gotowości użytkownika do zapłaty lub zawierał nieprawidłowy parametr lub wartość.
  • Żądanie zostało zainicjowane z kontekstu zabezpieczeń, którego agent płatności lub przeglądarka nie zdecydowały się spełnić. Najczęściej jest to błąd niebezpiecznego kontekstu przeglądarki.

loadPaymentData(paymentDataRequest)

Ta metoda wyświetla arkusz płatności Google Pay, który umożliwia wybór formy płatności i opcjonalnie skonfigurowanych parametrów.

Tę metodę należy wywołać, gdy przeglądarka przetwarza zachowanie aktywacji w wyniku zdarzenia kliknięcia. Użytkownikowi może wyświetlić się wyskakujące okienko, w którym może wybrać formę płatności lub inne wymagane dane określone w przekazanym parametrze żądania.

Argumenty

Nazwa Opis
paymentDataRequest Obiekt zawierający pary klucz-wartość pełnej konfiguracji interfejsu Google Pay API. Właściwości, które można skonfigurować, znajdziesz w PaymentDataRequest.

Zwroty

Typ Opis
Promise

Resolved: obiekt zawierający żądane dane kupującego. Więcej informacji znajdziesz w artykule PaymentData.

Rejected (Odrzucono): obiekt zawierający kod błędu i więcej informacji o przyczynie odrzucenia. Więcej informacji znajdziesz w sekcji PaymentsError.

Błędy

statusCode Opis
CANCELED
  • Bieżąca przeglądarka lub zalogowany użytkownik Google nie są obsługiwani.
  • Kupujący zamknął arkusz płatności Google Pay bez autoryzacji płatności.
  • Żądanie zostało zainicjowane z kontekstu zabezpieczeń, którego agent płatności lub przeglądarka nie zdecydowały się spełnić. Najczęściej jest to niebezpieczny kontekst przeglądarki.
  • Metoda została wywołana, gdy arkusz płatności Google Pay był już wyświetlany.
  • Przekazany obiekt PaymentDataRequest został odrzucony przez arkusz płatności Google Pay. Częstą przyczyną są brakujące lub niekompletne parametry PaymentMethodTokenizationSpecification bramy lub nieprawidłowe wartości parametrów.
DEVELOPER_ERROR Przekazany obiekt PaymentDataRequest był nieprawidłowo sformatowany, brakowało w nim minimalnych wymaganych parametrów lub zawierał nieprawidłowy parametr albo nieprawidłową wartość.

prefetchPaymentData(paymentDataRequest)

Użyj tej metody, aby wstępnie pobrać konfigurację PaymentDataRequest i skrócić czas wykonywania loadPaymentData podczas późniejszej interakcji użytkownika. Nie jest zwracana żadna wartość.

Optymalizacje pobierania wstępnego są dostępne w Chrome na Androida.

Argumenty

Nazwa Opis
paymentDataRequest Obiekt zawierający pary klucz-wartość pełnej konfiguracji interfejsu Google Pay API. Właściwości, które można skonfigurować, znajdziesz w PaymentDataRequest. Zmiana właściwości transactionInfo nie wpływa na zapisaną w pamięci podręcznej wartość pobierania wstępnego.

Wywołania zwrotne danych karty

Aby obsługiwać autoryzację płatności i dynamiczne aktualizacje cen, do PaymentOptions.paymentDataCallbacks można przekazać te moduły obsługi wywołania zwrotnego.

onPaymentAuthorized(paymentData)

Ta metoda jest wywoływana, gdy płatność jest autoryzowana w arkuszu płatności.

Argumenty

Nazwa Opis
paymentData Obiekt zawierający żądane dane kupującego. Więcej informacji: PaymentData.

Zwroty

Typ Opis
Promise

Resolved: obiekt zawierający informacje o wynikach transakcji płatniczej. Więcej informacji: PaymentAuthorizationResult.

Rejected: obiekt błędu z intencją błędu i komunikatem, który ma zostać wyświetlony w arkuszu płatności. Więcej informacji: PaymentDataError.

onPaymentDataChanged(intermediatePaymentData)

Ta metoda obsługuje zmiany danych karty w arkuszu płatności, takie jak adres dostawy i opcje dostawy.

Argumenty

cześć
Nazwa Opis
intermediatePaymentData Obiekt zawierający adres i opcję dostawy wybrane w arkuszu płatności. Więcej informacji: IntermediatePaymentData.

Zwroty

Typ Opis
Promise

Resolved: obiekt zawierający nowe informacje o transakcji, opcje dostawy i błędy danych o płatności. Więcej informacji: PaymentDataRequestUpdate.

Rejected: obiekt błędu z intencją błędu i komunikatem, który ma zostać wyświetlony w arkuszu płatności. Więcej informacji: PaymentDataError.