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 范围。此字段为可选字段，可设置为 null。只有在 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