App Flip สําหรับ Android

เมื่อติดตั้งใช้งาน OAuth 2.0 แล้ว คุณจะเลือกกําหนดค่า App Flip, which allows your Android users to more quickly link their accounts in your authentication system to their Google accounts. The following sections describe how to design and implement App Flip for your smart home Action. แบบ OAuth ได้

Design guidelines

This section describes the design requirements and recommendations for the App Flip account linking consent screen. After Google calls your app, your app displays the consent screen to the user.

Requirements

1. You must communicate that the user's account is being linked to Google, not to a specific Google product, such as Google Home or Google Assistant.

Recommendations

We recommend that you do the following:

1. Display Google's Privacy Policy. Include a link to Google's Privacy Policy on the consent screen.

2. Data to be shared. Use clear and concise language to tell the user what data of theirs Google requires and why.

3. Clear call-to-action. State a clear call-to-action on your consent screen, such as "Agree and link." This is because users need to understand what data they're required to share with Google to link their accounts.

4. Ability to cancel. Provide a way for users to go back or cancel, if they choose not to link.

5. Ability to unlink. Offer a mechanism for users to unlink, such as a URL to their account settings on your platform. Alternatively, you can include a link to Google Account where users can manage their linked account.

6. Ability to change user account. Suggest a method for users to switch their account(s). This is especially beneficial if users tend to have multiple accounts.

   • If a user must close the consent screen to switch accounts, send a recoverable error to Google so the user can sign in to the desired account with OAuth linking and the implicit flow.

7. Include your logo. Display your company logo on the consent screen. Use your style guidelines to place your logo. If you wish to also display Google's logo, see Logos and trademarks.

ตั้งค่าสําหรับ Flip ของแอปที่ใช้ OAuth

ส่วนต่อไปนี้จะอธิบายข้อกําหนดเบื้องต้นสําหรับ App Flip ที่ใช้ OAuth และวิธีกําหนดค่าโปรเจ็กต์ Flip ของแอปในคอนโซล Actions

สร้างการดําเนินการสมาร์ทโฮมและตั้งค่าเซิร์ฟเวอร์ OAuth 2.0

ก่อนที่จะกําหนดค่า App Flip ได้ คุณต้องทําสิ่งต่อไปนี้

• ตั้งค่าเซิร์ฟเวอร์ OAuth 2.0 ดูข้อมูลเพิ่มเติมเกี่ยวกับการตั้งค่าเซิร์ฟเวอร์ OAuth ได้ที่การใช้งานเซิร์ฟเวอร์ OAuth 2.0
• สร้างการดําเนินการ หากต้องการสร้างการดําเนินการ ให้ทําตามวิธีการในสร้างโปรเจ็กต์การดําเนินการ

กําหนดค่า App Flip ในคอนโซลการดําเนินการ

ส่วนต่อไปนี้อธิบายวิธีกําหนดค่า App Flip ในคอนโซล Actions

1. กรอกข้อมูลในช่องทั้งหมดในส่วนข้อมูลไคลเอ็นต์ OAuth (หากระบบไม่รองรับ Flip ของแอป ระบบจะใช้ OAuth ปกติเป็นโฆษณาสํารอง)
2. ในส่วนใช้แอปสําหรับการลิงก์บัญชี (ไม่บังคับ) ให้เลือกเปิดใช้สําหรับ Android
3. กรอกข้อมูลในช่องต่อไปนี้
• รหัสแอปพลิเคชัน รหัสแอปพลิเคชันคือรหัสที่ไม่ซ้ํากันที่คุณตั้งไว้สําหรับแอป
• ลายเซ็นแอป แอป Android จะต้อง "ลงนาม" ด้วยใบรับรองคีย์สาธารณะก่อน จึงจะติดตั้งได้ ดูข้อมูลเกี่ยวกับการรับลายเซ็นแอปได้ที่การตรวจสอบสิทธิ์ไคลเอ็นต์ของคุณ
• ความตั้งใจของการให้สิทธิ์ ในช่องนี้ ให้ป้อนสตริงที่ระบุการกระทําตามความตั้งใจของคุณ
4. หากต้องการกําหนดค่าไคลเอ็นต์ (ไม่บังคับ) ให้เพิ่มขอบเขต แล้วคลิกเพิ่มขอบเขตในส่วนกําหนดค่าไคลเอ็นต์ (ไม่บังคับ)
5. คลิกบันทึก

นํา App Flip ไปใช้ในแอป Android

หากต้องการใช้ App Flip คุณต้องแก้ไขรหัสการให้สิทธิ์ของผู้ใช้ในแอปเพื่อรับ Deep Link จาก Google

การลิงก์ App Flip ด้วย OAuth (App Flip) จะแทรกแอป Android ไว้ในขั้นตอนการลิงก์บัญชี Google ขั้นตอนการลิงก์บัญชีแบบดั้งเดิมทําให้ผู้ใช้ต้องป้อนข้อมูลเข้าสู่ระบบในเบราว์เซอร์ การใช้ App Flip จะอนุญาตให้ผู้ใช้ลงชื่อเข้าใช้แอป Android ซึ่งช่วยให้คุณใช้ประโยชน์จากการให้สิทธิ์ที่มีอยู่ได้ หากผู้ใช้ลงชื่อเข้าใช้แอปของคุณ ผู้ใช้ไม่จําเป็นต้องป้อนข้อมูลเข้าสู่ระบบเพื่อลิงก์บัญชีอีก คุณต้องเปลี่ยนแปลงโค้ดเล็กน้อย ในการใช้ App Flip ในแอป Android

ในเอกสารนี้ คุณจะได้ดูวิธีแก้ไขแอป Android เพื่อรองรับ App Flip

ลองใช้ตัวอย่าง

App Link เป็นตัวอย่างแอป ที่แสดงถึงการผสานรวมการลิงก์บัญชีที่เข้ากันได้กับ App Flip บน Android คุณใช้แอปนี้เพื่อยืนยันวิธีตอบสนองต่อ Intent ของ App Flip ขาเข้าจากแอป Google บนอุปกรณ์เคลื่อนที่ได้

ตัวอย่างแอปได้รับการกําหนดค่าไว้ล่วงหน้าให้ผสานรวมกับเครื่องมือทดสอบแอป Flip สําหรับ Android ซึ่งคุณสามารถใช้เพื่อยืนยันการผสานรวมแอป Android กับ App Flip ก่อนที่คุณจะกําหนดค่าการลิงก์บัญชีกับ Google แอปนี้จะจําลองความตั้งใจที่แอป Google บนอุปกรณ์เคลื่อนที่ทริกเกอร์เมื่อเปิดใช้ App Flip

ลักษณะการทำงาน

คุณต้องทําตามขั้นตอนต่อไปนี้เพื่อผสานรวม App Flip

1. แอป Google จะตรวจสอบว่าแอปติดตั้งอยู่ในอุปกรณ์หรือไม่โดยใช้ชื่อแพ็กเกจของแอป
2. แอป Google ใช้การตรวจสอบลายเซ็นของแพ็กเกจเพื่อตรวจสอบว่าแอปที่ติดตั้งเป็นแอปที่ถูกต้อง
3. แอป Google มีการสร้าง Intent เพื่อเริ่มกิจกรรมที่กําหนดไว้ในแอป Intent นี้มีข้อมูลเพิ่มเติมที่จําเป็นในการลิงก์ และยังตรวจสอบด้วยว่าแอปรองรับ App Flip หรือไม่ด้วยการแก้ไขความตั้งใจนี้ผ่านเฟรมเวิร์ก Android
4. แอปของคุณจะตรวจสอบว่าคําขอมาจากแอป Google หรือไม่ ซึ่งแอปจะตรวจสอบลายเซ็นของแพ็กเกจและรหัสไคลเอ็นต์ที่ให้มา
5. แอปขอรหัสการให้สิทธิ์จากเซิร์ฟเวอร์ OAuth 2.0 ในตอนท้ายของขั้นตอนนี้ จะส่งคืนรหัสการให้สิทธิ์หรือข้อผิดพลาดไปยังแอป Google
6. แอป Google จะเรียกข้อมูลผลลัพธ์และดําเนินการลิงก์บัญชีต่อ หากมีรหัสการให้สิทธิ์

แก้ไขแอป Android เพื่อรองรับ App Flip

รองรับโค้ดต่อไปนี้ที่เปลี่ยนแปลงในแอป Android ของคุณเพื่อรองรับ App Flip

1. เพิ่ม <intent-filter> ลงในไฟล์ AndroidManifest.xml ที่มีสตริงการดําเนินการที่ตรงกับค่าที่ป้อนในช่อง App Flip Intent

   <activity android:name="AuthActivity">
     <!-- Handle the app flip intent -->
     <intent-filter>
       <action android:name="INTENT_ACTION_FROM_CONSOLE"/>
       <category android:name="android.intent.category.DEFAULT"/>
     </intent-filter>
   </activity>
   

2. ตรวจสอบลายเซ็นของแอปที่โทรอยู่

   private fun verifyFingerprint(
           expectedPackage: String,
           expectedFingerprint: String,
           algorithm: String
   ): Boolean {
   
       callingActivity?.packageName?.let {
           if (expectedPackage == it) {
               val packageInfo =
                   packageManager.getPackageInfo(it, PackageManager.GET_SIGNATURES)
               val signatures = packageInfo.signatures
               val input = ByteArrayInputStream(signatures[0].toByteArray())
   
               val certificateFactory = CertificateFactory.getInstance("X509")
               val certificate =
                   certificateFactory.generateCertificate(input) as X509Certificate
               val md = MessageDigest.getInstance(algorithm)
               val publicKey = md.digest(certificate.encoded)
               val fingerprint = publicKey.joinToString(":") { "%02X".format(it) }
   
               return (expectedFingerprint == fingerprint)
           }
       }
       return false
   }
   

3. ดึงข้อมูลรหัสไคลเอ็นต์จากพารามิเตอร์ Intent และตรวจสอบว่ารหัสไคลเอ็นต์ตรงกับค่าที่คาดไว้

   private const val EXPECTED_CLIENT = "<client-id-from-actions-console>"
   private const val EXPECTED_PACKAGE = "<google-app-package-name>"
   private const val EXPECTED_FINGERPRINT = "<google-app-signature>"
   private const val ALGORITHM = "SHA-256"
   ...
   
   override fun onCreate(savedInstanceState: Bundle?) {
       super.onCreate(savedInstanceState)
   
       val clientId = intent.getStringExtra("CLIENT_ID")
   
       if (clientId == EXPECTED_CLIENT &&
           verifyFingerprint(EXPECTED_PACKAGE, EXPECTED_FINGERPRINT, ALGORITHM)) {
   
           // ...authorize the user...
       }
   }
   

4. เมื่อการให้สิทธิ์สําเร็จ ให้ส่งกลับรหัสการให้สิทธิ์ที่ได้กลับไปที่ Google

   // Successful result
   val data = Intent().apply {
       putExtra("AUTHORIZATION_CODE", authCode)
   }
   setResult(Activity.RESULT_OK, data)
   finish()
   

5. หากเกิดข้อผิดพลาด ให้แสดงผลการค้นหาข้อผิดพลาดแทน

   // Error result
   val error = Intent().apply {
       putExtra("ERROR_TYPE", 1)
       putExtra("ERROR_CODE", 1)
       putExtra("ERROR_DESCRIPTION", "Invalid Request")
   }
   setResult(-2, error)
   finish()
   

เนื้อหาของจุดประสงค์การเปิดตัว

Intent ของ Android ที่เปิดแอปของคุณมีช่องต่อไปนี้

• CLIENT_ID (String): Google client_id ที่จดทะเบียนภายใต้แอปของคุณ
• SCOPE (String[]): รายการขอบเขตที่ขอ
• REDIRECT_URI (String): URL เปลี่ยนเส้นทาง

เนื้อหาของข้อมูลการตอบกลับ

ข้อมูลที่ส่งคืนไปยังแอป Google ได้รับการตั้งค่าในแอปโดยการเรียกใช้ setResult() ข้อมูลนี้รวมถึงข้อมูลต่อไปนี้

• AUTHORIZATION_CODE (String): ค่ารหัสการให้สิทธิ์
• resultCode (int): สื่อสารความสําเร็จหรือความล้มเหลวของกระบวนการ และใช้ค่าใดค่าหนึ่งต่อไปนี้
  • Activity.RESULT_OK: บ่งบอกว่าสําเร็จ และแสดงรหัสการให้สิทธิ์
  • Activity.RESULT_CANCELLED: สัญญาณที่ผู้ใช้ยกเลิกกระบวนการ ในกรณีนี้ แอป Google จะพยายามลิงก์บัญชีโดยใช้ URL การให้สิทธิ์ของคุณ
  • -2: บ่งบอกว่าเกิดข้อผิดพลาดขึ้น เราได้อธิบายข้อผิดพลาดประเภทต่างๆ ไว้ด้านล่าง
• ERROR_TYPE (int): ประเภทของข้อผิดพลาดที่มีค่าใดค่าหนึ่งต่อไปนี้
  • 1: ข้อผิดพลาดที่กู้คืนได้: แอป Google จะพยายามลิงก์บัญชีโดยใช้ URL การให้สิทธิ์
  • 2: ข้อผิดพลาดที่กู้คืนไม่ได้: แอป Google ยกเลิกการลิงก์บัญชี
  • 3: พารามิเตอร์คําขอไม่ถูกต้องหรือไม่มี
• ERROR_CODE (int): จํานวนเต็มที่แสดงลักษณะของข้อผิดพลาด หากต้องการดูความหมายของรหัสข้อผิดพลาดแต่ละรายการ โปรดดูตารางรหัสข้อผิดพลาด

• ERROR_DESCRIPTION (String, ไม่บังคับ): ข้อความสถานะที่มนุษย์อ่านได้ซึ่งอธิบายข้อผิดพลาด

ค่าของ AUTHORIZATION_CODE ควรเป็นค่าเมื่อ resultCode == Activity.RESULT_OK ในกรณีอื่นๆ ทั้งหมด ค่าของ AUTHORIZATION_CODE จะต้องว่างเปล่า หากเป็น resultCode == -2 ก็จะต้องมีการป้อนข้อมูลค่า ERROR_TYPE

ตารางรหัสข้อผิดพลาด

ตารางด้านล่างแสดงรหัสข้อผิดพลาดที่แตกต่างกัน และข้อผิดพลาดแต่ละรายการที่กู้คืนได้หรือกู้คืนไม่ได้มีดังนี้

รหัสข้อผิดพลาด	ความหมาย	กู้คืนได้	เรียกคืนไม่ได้
1	INVALID_REQUEST	✔
2	NO_INTERNET_CONNECTION		✔
3	OFFLINE_MODE_ACTIVE	✔
4	CONNECTION_TIMEOUT	✔
5	INTERNAL_ERROR	✔
6	AUTHENTICATION_SERVICE_UNAVAILABLE		✔
8	CLIENT_VERIFICATION_FAILED	✔
9	INVALID_CLIENT	✔
10	INVALID_APP_ID	✔
11	INVALID_REQUEST	✔
12	AUTHENTICATION_SERVICE_UNKNOWN_ERROR		✔
13	AUTHENTICATION_DENIED_BY_USER		✔
14	CANCELLED_BY_USER		✔
15	FAILURE_OTHER		✔
16	USER_AUTHENTICATION_FAILED	✔

สําหรับรหัสข้อผิดพลาดทั้งหมด คุณต้องแสดงผลข้อผิดพลาดผ่าน setResult เพื่อให้แน่ใจว่าระบบแสดงวิดีโอสํารองที่เหมาะสม

ทดสอบ App Flip ในอุปกรณ์

เมื่อสร้างการดําเนินการและกําหนดค่า App Flip ในคอนโซลและในแอปแล้ว คุณจะทดสอบ App Flip ในอุปกรณ์เคลื่อนที่ได้ คุณใช้แอป Google Assistant หรือแอป Google Home เพื่อทดสอบ App Flip ได้

หากต้องการทดสอบ App Flip จากแอป Assistant ให้ทําตามขั้นตอนต่อไปนี้

1. ไปที่คอนโซล Actions แล้วเลือกโปรเจ็กต์
2. คลิกทดสอบในการนําทางด้านบน
3. เรียกใช้ขั้นตอนการลิงก์บัญชีจากแอป Assistant โดยทําดังนี้
1. เปิดแอป Google Assistant
2. คลิกการตั้งค่า
3. ในแท็บ Assistant ให้คลิกระบบควบคุมอุปกรณ์ในบ้าน
4. คลิกเพิ่ม(+)
5. เลือกการกระทําจากรายการผู้ให้บริการ ซึ่งจะขึ้นต้นด้วย "[test]" ในรายการ การเลือกการดําเนินการ [ทดสอบ] จากรายการควรเปิดแอปของคุณ
6. ตรวจสอบว่าแอปเริ่มทํางานและเริ่มทดสอบขั้นตอนการให้สิทธิ์แล้ว

หากต้องการทดสอบ App Flip จากแอป Home ให้ทําตามขั้นตอนต่อไปนี้

1. ไปที่คอนโซล Actions แล้วเลือกโปรเจ็กต์
2. คลิกทดสอบในการนําทางด้านบน
3. เรียกใช้ขั้นตอนการลิงก์บัญชีจากแอป Home โดยทําดังนี้
1. เปิดแอป Google Home
2. คลิกปุ่ม +
3. คลิกตั้งค่าอุปกรณ์
4. คลิกหากมีรายการที่ตั้งค่าไว้แล้ว
5. เลือกการดําเนินการสมาร์ทโฮมจากรายชื่อผู้ให้บริการ ซึ่งจะขึ้นต้นด้วย "[test]" ในรายการ การเลือกการดําเนินการ [ทดสอบ] จากรายการควรเปิดแอปของคุณ
6. ตรวจสอบว่าแอปเริ่มทํางานและเริ่มทดสอบขั้นตอนการให้สิทธิ์แล้ว