Dokumentacja klienta

W tym artykule znajdziesz opis metod klienta w JavaScripcie, które możesz wykorzystywać do implementacji Google Pay API w swoich aplikacjach internetowych.

Konstruktor

Inicjuje obiekt PaymentsClient. Musisz wywołać ten konstruktor, zanim zaczniesz wywoływać zawarte w nim metody.

Nowy PaymentsClient(paymentOptions)

Argumenty

Właściwość Opis
paymentOptions

Obiekt zawierający pary klucz-wartość dla danych konfiguracyjnych Google Pay API. W sekcji PaymentOptions znajdziesz różne właściwości, które można skonfigurować.

Przykład: {environment:'PRODUCTION'}

Zwraca

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

Wyrzuca

Typ Opis
Error

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

Metody obiektów

createButton(options)

Ta wygodna metoda służy do generowania przycisku płatności Google Pay zawierającego aktualne elementy marki, który można umieścić w witrynie.

Wygenerowany HTMLElement zawiera dynamicznie wstawiany kod CSS oraz obraz SVG hostowane w CDN Google.

Informacje o tym, jak wybrać odpowiedni kolor i typ przycisku pasującego do Twojej witryny, znajdziesz w naszych Wskazówkach dotyczących marki. Konieczna może być zmiana wymiarów otrzymanego przycisku płatności Google Pay, aby pasował on do innych podobnych przycisków i elementów procesu płatności na stronie.

Argumenty

Nazwa Opis
options

Obiekt zawierający pary klucz-wartość do konfiguracji przycisku. W sekcji ButtonOptions znajdziesz więcej informacji o właściwościach, które można skonfigurować.

Przykład: {onClick:onGooglePaymentButtonClicked}

Zwraca

Typ Opis
HTMLElement <button> HTML wewnątrz ogólnego kontenera na elementy ogólnej treści dokumentu, takiego jak <div>.

Wyrzuca

Typ Opis
Error

Wymagana właściwość nie jest ustawiona.

isReadyToPay(isReadyToPayRequest)

Ta metoda określa, czy kupujący może zwrócić formę płatności z Google Pay API.

Argumenty

Nazwa Opis
isReadyToPayRequest Obiekt zawierający formy płatności obsługiwane przez sprzedawcę. W sekcji IsReadyToPayRequest znajdziesz różne właściwości, które można skonfigurować.

Zwraca

Typ Opis
Promise

Wykonano: obiekt z informacjami o możliwości zapłacenia przez użytkownika. Więcej informacji znajdziesz w sekcji IsReadyToPayResponse.

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

Błędy

statusCode Opis
DEVELOPER_ERROR
  • Przekazany obiekt IsReadyToPayRequest został nieprawidłowo sformatowany, zawiera nieprawidłowy parametr lub niepoprawną wartość albo brakuje w nim podstawowych wymaganych parametrów potrzebnych do określenia, czy użytkownik jest gotowy do dokonania płatności.
  • Żądanie zostało zainicjowane z kontekstu zabezpieczeń, z którego agent płatności lub przeglądarka zdecydowały się nie wypełniać żądań. Najczęściej jest to kontekst niezabezpieczonej przeglądarki.

loadPaymentData(paymentDataRequest)

Ta metoda wyświetla arkusz płatności Google Pay pozwalający wybrać formę płatności i opcjonalnie skonfigurowane parametry.

Ta metoda musi być wywoływana zawsze wtedy, gdy przeglądarka przetwarza aktywację w rezultacie zdarzenia kliknięcia. Użytkownikowi może wyświetlić się wyskakujące okienko, w którym będzie mógł wybrać formę płatności lub podać inne wymagane dane określone w przekazanym parametrze żądania.

Argumenty

Nazwa Opis
paymentDataRequest Obiekt zawierający pary klucz-wartość dla pełnej konfiguracji Google Pay API. W sekcji PaymentDataRequest znajdziesz więcej informacji o właściwościach, które można skonfigurować.

Zwraca

Typ Opis
Promise

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

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ń, z którego agent płatności lub przeglądarka zdecydowały się nie wypełniać żądań. Najczęściej jest to kontekst niezabezpieczonej przeglądarki.
  • Metoda została wywołana, gdy arkusz płatności Google Pay się już wyświetlał.
  • Arkusz płatności odrzucił przekazany obiekt PaymentDataRequest. Częstą przyczyną są brakujące lub niepełne parametry PaymentMethodTokenizationSpecification Twojej bramy albo nieprawidłowe wartości parametrów.
DEVELOPER_ERROR Przekazany obiekt PaymentDataRequest został nieprawidłowo sformatowany, zawiera nieprawidłowy parametr lub niepoprawną wartość albo brakuje w nim podstawowych wymaganych parametrów.

prefetchPaymentData(paymentDataRequest)

Ta metoda umożliwia pobranie z wyprzedzeniem konfiguracji PaymentDataRequest, aby skrócić czas wykonywania loadPaymentData podczas dalszej interakcji z użytkownikiem. Nie jest zwracana żadna wartość.

Optymalizacje są obecnie dostępne do pobrania z wyprzedzeniem w Chrome na Androida. Wkrótce będą też obsługiwane inne przeglądarki i platformy.

Argumenty

Nazwa Opis
paymentDataRequest Obiekt zawierający pary klucz-wartość dla pełnej konfiguracji Google Pay API. W sekcji PaymentDataRequest znajdziesz więcej informacji o właściwościach, które można skonfigurować. Zmiana we właściwości transactionInfo nie ma wpływu na wartość pobraną z wyprzedzeniem i zapisaną w pamięci podręcznej.

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.

Zwraca

Typ Opis
Promise

Wykonano: obiekt z informacjami o wynikach transakcji płatności. Więcej informacji: PaymentAuthorizationResult.

Odrzucono: obiekt błędu z intencją błędu i komunikatem, który wyświetli się w arkuszu płatności. Więcej informacji: PaymentDataError.

onPaymentDataChanged(intermediatePaymentData)

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

Argumenty

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

Zwraca

Typ Opis
Promise

Wykonano: obiekt z informacjami o nowej transakcji, opcjach dostawy oraz błędach w danych dotyczących płatności. Więcej informacji: PaymentDataRequestUpdate.

Odrzucono: obiekt błędu z intencją błędu i komunikatem, który wyświetli się w arkuszu płatności. Więcej informacji: PaymentDataError.