GetGoogleIdOption.Builder

Kotlin |Java

public final class GetGoogleIdOption.Builder

GetGoogleIdOption 的建構工具。

摘要

公用建構函式
`Builder()`

公用方法
`final @NonNull GetGoogleIdOption.Builder`	`associateLinkedAccounts( @NonNull String linkedServiceId, List<@NonNull String> idTokenDepositionScopes )` 設定是否支援使用與使用者帳戶連結的 Google 帳戶登入。
`final @NonNull GetGoogleIdOption`	`build()`
`final @NonNull GetGoogleIdOption.Builder`	`setAutoSelectEnabled(boolean autoSelectEnabled)` 在要求中設定自動選取行為。
`final @NonNull GetGoogleIdOption.Builder`	`setClaims(@NonNull List<@NonNull Claim> claims)` 設定要納入 Google ID 權杖的憑證附加資訊。
`final @NonNull GetGoogleIdOption.Builder`	`setFilterByAuthorizedAccounts(boolean filterByAuthorizedAccounts)` 設定是否只允許使用者從已授權登入您應用程式的 Google 帳戶中選取。
`final @NonNull GetGoogleIdOption.Builder`	`setHostedDomainFilter(String hostedDomainFilter)` 設定代管網域篩選器，將 Google 登入限制為特定 Google Workspace 網域中的帳戶。
`final @NonNull GetGoogleIdOption.Builder`	`setNonce(String nonce)` 設定產生 Google ID 權杖時要使用的隨機數。
`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 ID 權杖存入伺服器，然後再傳回給您。與一般登入程序類似，後端可以使用 ID 權杖登入使用者。請注意，只有在首次使用這項憑證登入時，才會存放 ID 權杖。後續登入時，由於 ID 權杖已與使用者帳戶建立關聯，因此不需要再進行存證。

參數
`@NonNull String linkedServiceId`	將帳戶連結至 Google 帳戶時使用的服務 ID。
`List<@NonNull String> idTokenDepositionScopes`	Google 需要的 OAuth 範圍，才能將 Google ID 權杖存入應用程式的後端伺服器。這項設定為選用項目，可以設為空值。只有在 Google 要求特定範圍才能存入 ID 權杖時，才需要提供這項資訊。

build

public final @NonNull GetGoogleIdOption build()

setAutoSelectEnabled

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

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

如果使用者選擇加入，系統就會自動選取憑證，不必等待使用者操作 (例如輕觸「繼續」按鈕)。如果 1) 只有一個憑證可用於登入，且 2) 這個憑證不需要採取進一步行動 (例如已收集 Google 帳戶的資料共用權限)，系統就會自動選取憑證。

setClaims

public final @NonNull GetGoogleIdOption.Builder setClaims(@NonNull List<@NonNull Claim> claims)

設定要納入 Google ID 權杖的憑證附加資訊。

如需可用聲明清單，請參閱說明文件。系統會忽略任何不支援的聲明。

參數
`@NonNull List<@NonNull Claim> claims`	著作權聲明清單。

setFilterByAuthorizedAccounts

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

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

如果為 {@code true}，使用者將無法選取任何 Google 帳戶，否則必須明確授權，才能與您的應用程式共用基本個人資料/電子郵件資料。這項功能可減少使用者登入時遇到的阻礙，並確保傳回的憑證適用於「回訪使用者」，但會限制使用者在裝置上所有 Google 帳戶中進行選擇。

參數
`boolean filterByAuthorizedAccounts`	是否只允許使用者從已授權登入應用程式的 Google 帳戶中選取

setHostedDomainFilter

public final @NonNull GetGoogleIdOption.Builder setHostedDomainFilter(String hostedDomainFilter)

設定代管網域篩選器，將 Google 登入限制為特定 Google Workspace 網域中的帳戶。

如果傳遞空值或空字串，系統就不會進行篩選。

參數
`String hostedDomainFilter`	要篩選的網域 (例如 "example.com")

setNonce

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

設定產生 Google ID 權杖時要使用的隨機數。

參數
`String nonce`	在產生 ID 權杖時使用的隨機值

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