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
`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)` ตั้งค่า Nonce ที่จะใช้เมื่อสร้างโทเค็นรหัส Google
`final @NonNull GetGoogleIdOption.Builder`	`setRequestVerifiedPhoneNumber(boolean requestVerifiedPhoneNumber)` กำหนดว่าจะขอหมายเลขโทรศัพท์ที่ยืนยันแล้วในระหว่างการลงชื่อสมัครใช้หรือไม่
`final @NonNull GetGoogleIdOption.Builder`	`setServerClientId(@NonNull String serverClientId)` ตั้งค่ารหัสไคลเอ็นต์ของเซิร์ฟเวอร์เพื่อใช้เป็นกลุ่มเป้าหมายสำหรับโทเค็นรหัส Google ที่สร้างขึ้นระหว่างการลงชื่อเข้าใช้

เครื่องมือสร้างสาธารณะ

ช่างก่อสร้าง

public Builder()

เมธอดสาธารณะ

associateLinkedAccounts

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

กำหนดว่าจะรองรับการลงชื่อเข้าใช้โดยใช้บัญชี Google ที่ลิงก์กับบัญชีของผู้ใช้หรือไม่

เมื่อเลือกข้อมูลเข้าสู่ระบบดังกล่าว ระบบจะฝากโทเค็นรหัส Google สำหรับบัญชี Google ที่ลิงก์กับบัญชีที่เลือกไว้ไปยังเซิร์ฟเวอร์ของคุณก่อน แล้วจึงส่งคืนให้คุณ เช่นเดียวกับการลงชื่อเข้าใช้ปกติ แบ็กเอนด์สามารถใช้โทเค็นรหัสเพื่อลงชื่อเข้าใช้ผู้ใช้ได้ โปรดทราบว่าการฝากโทเค็นรหัสจะเกิดขึ้นเมื่อลงชื่อเข้าใช้เป็นครั้งแรกโดยใช้ข้อมูลเข้าสู่ระบบนี้เท่านั้น การลงชื่อเข้าใช้ครั้งต่อๆ ไปจะไม่ต้องมีการฝากข้อมูล เนื่องจากโทเค็นรหัสจะเชื่อมโยงกับบัญชีของผู้ใช้แล้ว

พารามิเตอร์

พารามิเตอร์
`@NonNull String linkedServiceId`	รหัสบริการที่ใช้เมื่อลิงก์บัญชีกับบัญชี Google
`List<@NonNull String> idTokenDepositionScopes`	ขอบเขต OAuth ที่ Google จะต้องใช้เพื่อฝากโทเค็นรหัส Google ไปยังเซิร์ฟเวอร์แบ็กเอนด์ของแอปพลิเคชัน โดยคุณจะระบุหรือไม่ก็ได้ และตั้งค่าเป็น null ได้ จำเป็นเฉพาะในกรณีที่ Google กำหนดให้ต้องมีขอบเขตที่เฉพาะเจาะจงจึงจะฝากโทเค็นรหัสได้

@NonNull String linkedServiceId

รหัสบริการที่ใช้เมื่อลิงก์บัญชีกับบัญชี Google

List<@NonNull String> idTokenDepositionScopes

ขอบเขต OAuth ที่ Google จะต้องใช้เพื่อฝากโทเค็นรหัส Google ไปยังเซิร์ฟเวอร์แบ็กเอนด์ของแอปพลิเคชัน โดยคุณจะระบุหรือไม่ก็ได้ และตั้งค่าเป็น null ได้ จำเป็นเฉพาะในกรณีที่ Google กำหนดให้ต้องมีขอบเขตที่เฉพาะเจาะจงจึงจะฝากโทเค็นรหัสได้

สร้าง

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

ดูรายการการอ้างสิทธิ์ที่ใช้ได้ในเอกสารประกอบ ระบบจะไม่สนใจการอ้างสิทธิ์ที่ไม่รองรับ

พารามิเตอร์
`@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 ที่เฉพาะเจาะจง

การส่งสตริงที่ว่างเปล่าหรือค่า Null จะส่งผลให้ไม่มีการกรอง

พารามิเตอร์
`String hostedDomainFilter`	โดเมนที่จะกรอง (เช่น "example.com")

setNonce

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

ตั้งค่า Nonce ที่จะใช้เมื่อสร้างโทเค็นรหัส Google

พารามิเตอร์
`String nonce`	ค่า Nonce ที่จะใช้ในระหว่างการสร้างโทเค็นรหัส

setRequestVerifiedPhoneNumber

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

กำหนดว่าจะขอหมายเลขโทรศัพท์ที่ยืนยันแล้วในระหว่างการลงชื่อสมัครใช้หรือไม่

หากต้องการใช้ฟีเจอร์นี้ คุณต้องตั้งค่าฟิลด์ [filterByAuthorizedAccounts] เป็น false อย่างชัดเจน เนื่องจากฟีเจอร์นี้จะใช้ได้ระหว่างการลงชื่อสมัครใช้เท่านั้น

setServerClientId

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

ตั้งค่ารหัสไคลเอ็นต์ของเซิร์ฟเวอร์เพื่อใช้เป็นกลุ่มเป้าหมายสำหรับโทเค็นรหัส Google ที่สร้างขึ้นระหว่างการลงชื่อเข้าใช้

พารามิเตอร์
`@NonNull String serverClientId`	รหัสไคลเอ็นต์ของเซิร์ฟเวอร์ที่จะออกโทเค็นรหัส