GetGoogleIdOption.Builder

public final class GetGoogleIdOption.Builder

GetGoogleIdOption 的建構工具。

摘要

公用建構函式

公用方法
final @NonNull GetGoogleIdOption.Builder
associateLinkedAccounts(
    @NonNull String linkedServiceId,
    List<@NonNull String> idTokenDepositionScopes
)

設定是否支援使用已連結至使用者帳戶的 Google 帳戶登入。
final @NonNull GetGoogleIdOption
final @NonNull GetGoogleIdOption.Builder
setAutoSelectEnabled(boolean autoSelectEnabled)

設定要求中的自動選取行為。
final @NonNull GetGoogleIdOption.Builder
setFilterByAuthorizedAccounts(boolean filterByAuthorizedAccounts)

設定是否只允許使用者選取已授權登入應用程式的 Google 帳戶。
final @NonNull GetGoogleIdOption.Builder

設定產生 Google ID 權杖時要使用的 Nonce。
final @NonNull GetGoogleIdOption.Builder
setRequestVerifiedPhoneNumber(boolean requestVerifiedPhoneNumber)

設定是否要在註冊時要求使用者提供已驗證的電話號碼。
final @NonNull GetGoogleIdOption.Builder
setServerClientId(@NonNull String serverClientId)

將伺服器的用戶端 ID 設為登入期間產生的 Google ID 權杖的目標對象。

公用建構函式

Builder

public Builder()

公用方法

associateLinkedAccounts

public final @NonNull GetGoogleIdOption.Builder associateLinkedAccounts(
    @NonNull String linkedServiceId,
    List<@NonNull String> idTokenDepositionScopes
)

設定是否支援使用已連結至使用者帳戶的 Google 帳戶登入。

選取這類憑證後，系統會先將所選帳戶連結的 Google 帳戶 Google ID 權杖存入您的伺服器，然後再傳回給您。與一般登入程序類似，後端可以使用 ID 權杖登入使用者。請注意，ID 權杖存證只會在使用此憑證首次登入時發生。後續登入作業不需要再提供證明，因為 ID 權杖已與使用者帳戶建立關聯。

參數
@NonNull String linkedServiceId

連結帳戶與 Google 帳戶時使用的服務 ID。
List<@NonNull String> idTokenDepositionScopes

Google 需要將 Google ID 權杖存入應用程式後端伺服器的 Oauth 範圍。這是選用值，可設為空值。只有在 Google 要求特定權限才能存放 ID 權杖時，才需要使用這個屬性。

build

public final @NonNull GetGoogleIdOption build()

setAutoSelectEnabled

public final @NonNull GetGoogleIdOption.Builder setAutoSelectEnabled(boolean autoSelectEnabled)

設定要求中的自動選取行為。

對於選擇加入的使用者，自動選取功能可讓系統自動選取憑證，無須等待使用者採取動作 (例如輕觸「繼續」按鈕)。如果符合以下條件，系統就會自動選取憑證：1) 登入時只能使用一組憑證；2) 不需要針對這組憑證採取進一步行動 (例如，已為 Google 帳戶收集資料分享權限)。

setFilterByAuthorizedAccounts

public final @NonNull GetGoogleIdOption.Builder setFilterByAuthorizedAccounts(boolean filterByAuthorizedAccounts)

設定是否只允許使用者選取已授權登入應用程式的 Google 帳戶。預設值為 true。

如果為 {@code true}，使用者就無法選取任何 Google 帳戶，否則系統會要求明確授權，才能與您的應用程式共用基本個人資料/電子郵件資料。這麼做或許能減少登入使用者歷程中的摩擦，並確保傳回的憑證是「回訪使用者」的，但會限制使用者在裝置上選擇 Google 帳戶的自由。

參數
boolean filterByAuthorizedAccounts

是否只允許使用者選取已授權登入應用程式的 Google 帳戶

setNonce

public final @NonNull GetGoogleIdOption.Builder setNonce(String nonce)

設定產生 Google ID 權杖時要使用的 Nonce。

參數
String nonce

在產生 ID 權杖時使用的 Nonce

setRequestVerifiedPhoneNumber

public final @NonNull GetGoogleIdOption.Builder setRequestVerifiedPhoneNumber(boolean requestVerifiedPhoneNumber)

設定是否要在註冊時要求使用已驗證的電話號碼。

如要使用這項功能，[filterByAuthorizedAccounts] 欄位必須明確設為 false，因為這項功能僅適用於註冊期間。

setServerClientId

public final @NonNull GetGoogleIdOption.Builder setServerClientId(@NonNull String serverClientId)

將伺服器的用戶端 ID 設為登入期間產生的 Google ID 權杖的目標對象。

參數
@NonNull String serverClientId

要發出 ID 權杖的伺服器用戶端 ID