此页面由 Cloud Translation API 翻译。

GetGoogleIdOption.Builder

Kotlin |Java

class GetGoogleIdOption.Builder

GetGoogleIdOption 的构建器。

摘要

公共构造函数
`Builder()`

公共函数
`GetGoogleIdOption.Builder`	`associateLinkedAccounts( linkedServiceId: String, idTokenDepositionScopes: List<String>? )` 设置是否支持使用与您的用户相关联的 Google 账号登录账号。
`GetGoogleIdOption`	`build()`
`GetGoogleIdOption.Builder`	`setAutoSelectEnabled(autoSelectEnabled: Boolean)` 在请求中设置自动选择行为。
`GetGoogleIdOption.Builder`	`setFilterByAuthorizedAccounts(filterByAuthorizedAccounts: Boolean)` 设置是否仅允许用户从已获准登录您应用的 Google 账号中进行选择。
`GetGoogleIdOption.Builder`	`setNonce(nonce: String?)` 设置生成 Google ID 令牌时要使用的 Nonce。
`GetGoogleIdOption.Builder`	`setRequestVerifiedPhoneNumber(requestVerifiedPhoneNumber: Boolean)` 设置是否在注册时要求提供经过验证的电话号码。
`GetGoogleIdOption.Builder`	`setServerClientId(serverClientId: String)` 设置服务器的客户端 ID，以用作登录期间生成的 Google ID 令牌的受众群体。

Builder()

fun associateLinkedAccounts(
    linkedServiceId: String,
    idTokenDepositionScopes: List<String>?
): GetGoogleIdOption.Builder

设置是否支持使用与您的用户相关联的 Google 账号登录账号。

选择此类凭据后，系统会先将所选账号关联的 Google 账号的 Google ID 令牌存储到您的服务器，然后再将其返回给您。与常规登录类似，您的后端可以使用 ID 令牌来登录用户。请注意，只有在首次登录时，使用此凭据。由于 ID 令牌已与用户的账号相关联，因此后续登录无需再提交声明。

参数
`linkedServiceId: String`	将账号与 Google 账号关联时使用的服务 ID。
`idTokenDepositionScopes: List<String>?`	Google 将 Google ID 令牌存入您应用的后端服务器所需的 OAuth 范围。这是可选操作，可以设置为 null。只有在 Google 要求您具备特定范围才能存入 ID 令牌时，才需要此参数。

fun build(): GetGoogleIdOption

fun setAutoSelectEnabled(autoSelectEnabled: Boolean): GetGoogleIdOption.Builder

在请求中设置自动选择行为。

对于选择启用此功能的用户，系统会自动选择凭据，而无需等待用户执行操作（例如点按“继续”按钮）。凭据可以如果 1) 只有一个凭据可用于登录，则会自动选择；并且 2) 没有进一步的操作（例如，已拥有数据共享权限针对某个 Google 账号收集的信息）。

fun setFilterByAuthorizedAccounts(filterByAuthorizedAccounts: Boolean): GetGoogleIdOption.Builder

设置是否仅允许用户从已获准登录您应用的 Google 账号中进行选择。默认值为 true。

如果为 {@code true}，用户将无法选择任何符合以下条件的 Google 账号：否则，需要获得明确授权才能与您的应用。这可能会减少登录用户体验历程中的阻力，并保证返回的凭据是针对“回访用户”的，但会限制用户的选择自由在设备上的所有 Google 账号中进行共享。

参数
`filterByAuthorizedAccounts: Boolean`	是否仅允许用户从已获授权登录您的应用的 Google 账号中进行选择

fun setNonce(nonce: String?): GetGoogleIdOption.Builder

设置生成 Google ID 令牌时使用的 Nonce。

参数
`nonce: String?`	要在 ID 令牌生成期间使用的 Nonce

fun setRequestVerifiedPhoneNumber(requestVerifiedPhoneNumber: Boolean): GetGoogleIdOption.Builder

设置是否在注册期间要求提供经过验证的电话号码。

如需使用此功能，必须将 [filterByAuthorizedAccounts] 字段明确设置为 false，因为此功能仅在注册期间可用。

fun setServerClientId(serverClientId: String): GetGoogleIdOption.Builder

设置服务器的客户端 ID，以用作登录期间生成的 Google ID 令牌的受众群体。

参数
`serverClientId: String`	将向其发出 ID 令牌的服务器的客户端 ID