クライアント リファレンス

com.google.android.gms.wallet documentation com.google.android.gms.wallet のドキュメントには、Google Pay API の複数のバージョンにわたるライブラリの全ドキュメントが含まれています。 以下は、Google Pay API の最新バージョン（バージョン 2.0）に最も適用可能なオブジェクトとメソッドの概要です。

ウォレット

テスト環境または本番環境用の PaymentsClient を生成します。

例

mPaymentsClient = Wallet.getPaymentsClient(
  this,
  new Wallet.WalletOptions.Builder()
      .setEnvironment(WalletConstants.ENVIRONMENT_TEST)
      .build()
);

PaymentsClient

Google Pay API とやり取りするクライアント。

isReadyToPay(IsReadyToPayRequest)

isReadyToPay(IsReadyToPayRequest) メソッドを使用して、ユーザーが Google Pay API からお支払い方法を返せるかどうかを判断します。

デバイスが Google Pay をサポートしていて、ユーザーがすでにお支払い方法を保存しているか、追加できる場合、IsReadyToPay は true を返します。ユーザーがすでに Google Pay にお支払い方法を保存しているかどうかを確認するには、IsReadyToPayRequest.existingPaymentMethodRequired を true に設定します。

loadPaymentData(PaymentDataRequest)

お支払い方法とオプションで構成したパラメータの選択を可能にする Google Pay 支払いシートを提示します。

IsReadyToPayRequest

IsReadyToPayRequest Java オブジェクトを作成します。これは PaymentsClient.isReadyToPay() で使用できます。

fromJson(java.lang.String)

JSON 形式の文字列から、IsReadyToPayRequest Java オブジェクトを作成します。提供された JSON 形式の文字列の予想される構造については、IsReadyToPayRequest オブジェクト リファレンスをご覧ください。

PaymentDataRequest

PaymentDataRequest Java オブジェクトを作成します。これは PaymentsClient.loadPaymentData で使用できます。

fromJson(java.lang.String)

JSON 形式の文字列から PaymentDataRequest Java オブジェクトを作成します。提供された JSON 形式の文字列の予想される構造については、 PaymentDataRequest オブジェクト リファレンス をご覧ください。

PaymentData

アプリで使用する Google Pay API JSON 形式のレスポンスを処理します。

toJson()

Google Pay API レスポンスを JSON 形式の文字列として出力します。JSON オブジェクトの構造について詳しくは、 PaymentData オブジェクト リファレンス をご覧ください。

PayButton

public void initialize(ButtonOption buttonOptions)

この便利なメソッドを使用すると、最新の Google Pay ブランドのスタイルを備えた Google Pay 支払いボタンが初期化されます。

引数

名前 説明
buttonOptions Google Pay 支払いボタンを構成するオブジェクト。構成可能なプロパティについては、 ButtonOptions をご覧ください。

例: カスタム構成で支払いボタンを初期化する

PayButton googlePayPaymentButton = layoutBinding.googlePayPaymentButton;
JSONArray paymentMethods = new JSONArray().put(getBaseCardPaymentMethod());
googlePayPaymentButton.initialize(
       ButtonOptions.newBuilder()
               .setButtonTheme(ButtonConstants.ButtonTheme.DARK)
               .setButtonType(ButtonConstants.ButtonType.BUY)
               .setCornerRadius(100)
               .setAllowedPaymentMethods(paymentMethods.toString())
               .build()
);

public void setVisibility(View view)

この便利なメソッドを使用すると、支払いボタンの表示設定が設定されます。

引数

名前 説明
View

View.VISIBLE を設定すると、支払いボタンが表示されます（デフォルト）。

View.GONE を設定すると、ボタンがユーザーに表示されなくなります。

例:

payButton.setVisibility(View.VISIBLE);

public void setOnClickListener(View.OnClickListener listener)

ユーザーが Google Pay 支払いボタンをクリックすると、メソッドが呼び出されます。

引数

名前 説明
listener クリック イベントが Google Pay 支払い ボタンに配信されたときに呼び出すイベント リスナー コールバック。

BasePaymentDataCallbacksService

Google Play 開発者サービスによって PaymentsClient.loadPaymentData(PaymentDataRequest)フロー内で開始されたお支払いデータのコールバックをホストする基本サービス クラス。

アプリケーションでこのサービスを拡張し、com.google.android.gms.permission.BIND_PAYMENTS_CALLBACK_SERVICE 権限と com.google.android.gms.wallet.callback.PAYMENT_DATA_CALLBACKS のインテント フィルタを使用して AndroidManifest.xml で宣言します。

createPaymentDataCallbacks()

受信したコールバック イベントを処理する BasePaymentDataCallbacks の実装を返します。コールバック イベントごとに 1 回呼び出されます。

BasePaymentDataCallbacks

動的料金設定の更新と支払い承認をサポートするために販売者が実装するお支払いデータのコールバック ハンドラを含む抽象基本クラス。

onPaymentDataChanged(intermediatePaymentData, onCompleteListener)

このメソッドは、配送先住所や 配送オプションなど、支払いシートの支払いデータの変更を処理します。

引数

名前 型 説明
intermediatePaymentData IntermediatePaymentData 支払いシートで選択された住所と配送オプションを含むオブジェクト。詳しくは、 IntermediatePaymentData をご覧ください。
onCompleteListener OnCompleteListener<PaymentDataRequestUpdate> 更新された取引情報、配送オプション、支払いデータのエラーで解決するリスナー。 PaymentDataRequestUpdate インスタンスを complete() に渡します。

例

override fun onPaymentDataChanged(
    intermediatePaymentData: IntermediatePaymentData,
    onCompleteListener: OnCompleteListener<PaymentDataRequestUpdate>
) {
    val paymentDataRequestUpdateJson = handlePaymentDataChanged(intermediatePaymentData.toJson())
    val update = PaymentDataRequestUpdate.fromJson(paymentDataRequestUpdateJson.toString())
    onCompleteListener.complete(update)
}

onPaymentAuthorized(paymentData, onCompleteListener)

支払いシートで支払いが承認されると、このメソッドが呼び出されます。

引数

名前 型 説明
paymentData PaymentData リクエストされた買い物客のデータを含むオブジェクト。詳しくは、 PaymentDataをご覧ください。
onCompleteListener OnCompleteListener<PaymentAuthorizationResult> 承認結果で解決するリスナー。 PaymentAuthorizationResult インスタンスを complete() に渡します。

例

override fun onPaymentAuthorized(
    paymentData: PaymentData,
    onCompleteListener: OnCompleteListener<PaymentAuthorizationResult>
) {
    val paymentAuthorizationResultJson = handlePaymentAuthorized(paymentData.toJson())
    val result = PaymentAuthorizationResult.fromJson(paymentAuthorizationResultJson.toString())
    onCompleteListener.complete(result)
}

IntermediatePaymentData

BasePaymentDataCallbacks.onPaymentDataChanged に渡される中間コールバック データを処理します。

toJson()

コールバック リクエスト データを JSON 形式の文字列として出力します。JSON オブジェクトの構造について詳しくは、 IntermediatePaymentData オブジェクト リファレンス をご覧ください。

getLastSavedState()

前のコールバック イテレーションで保存された状態を含む Bundle を返します。

PaymentDataRequestUpdate

BasePaymentDataCallbacks.onPaymentDataChanged で返す PaymentDataRequestUpdate Java オブジェクトを作成します。

fromJson(java.lang.String)

JSON 形式の文字列から PaymentDataRequestUpdate Java オブジェクトを作成します。提供された JSON 形式の文字列の予想される構造については、 PaymentDataRequestUpdate オブジェクト リファレンス をご覧ください。

withUpdatedSavedState(Bundle)

更新された状態 Bundle をアタッチして、コールバックの呼び出し間で永続化します。

PaymentAuthorizationResult

BasePaymentDataCallbacks.onPaymentAuthorized で返す PaymentAuthorizationResult Java オブジェクトを作成します。

fromJson(java.lang.String)

JSON 形式の文字列から PaymentAuthorizationResult Java オブジェクトを作成します。提供された JSON 形式の文字列の予想される構造については、 PaymentAuthorizationResult レスポンス オブジェクト リファレンス をご覧ください。