ยินดีต้อนรับสู่ศูนย์นักพัฒนาซอฟต์แวร์ Google Home ซึ่งเป็นจุดหมายใหม่เกี่ยวกับวิธีพัฒนาการดําเนินการสําหรับบ้านอัจฉริยะ หมายเหตุ: คุณจะสร้างการดําเนินการต่างๆ ต่อไปในคอนโซลการดําเนินการ

App Flip สําหรับ Android

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

หลักเกณฑ์การออกแบบ

ส่วนนี้จะอธิบายข้อกําหนดด้านการออกแบบและคําแนะนําสําหรับหน้าจอคํายินยอมการลิงก์บัญชี App Link หลังจากที่ Google เรียกใช้แอปแล้ว แอปจะแสดงหน้าจอขอความยินยอมต่อผู้ใช้

ข้อกำหนด

  1. คุณต้องแจ้งว่าบัญชีของผู้ใช้กําลังลิงก์กับ Google ไม่ใช่ผลิตภัณฑ์ Google ที่เจาะจง เช่น Google Home หรือ Google Assistant

คำแนะนำ

เราขอแนะนําให้คุณทําสิ่งต่อไปนี้

  1. แสดงนโยบายความเป็นส่วนตัวของ Google ใส่ลิงก์ไปยังนโยบายความเป็นส่วนตัวของ Google บนหน้าจอคํายินยอม

  2. ข้อมูลที่จะแชร์ ใช้ภาษาที่ชัดเจนและกระชับเพื่อบอกผู้ใช้ว่า Google ต้องการข้อมูลใดและเพราะเหตุใด

  3. คํากระตุ้นการตัดสินใจที่ชัดเจน ระบุคํากระตุ้นการตัดสินใจที่ชัดเจนในหน้าจอขอความยินยอม เช่น "ยอมรับและลิงก์" ทั้งนี้เนื่องจากผู้ใช้ต้องเข้าใจว่าตนเองต้องแชร์ข้อมูลใดกับ Google เพื่อลิงก์บัญชีของตน

  4. ความสามารถในการยกเลิก แสดงวิธีให้ผู้ใช้ยกเลิกหรือยกเลิกในกรณีที่ เลือกที่จะไม่ลิงก์

  5. ความสามารถในการยกเลิกการลิงก์ มีกลไกให้ผู้ใช้ยกเลิกการลิงก์ เช่น URL ไปยังการตั้งค่าบัญชีบนแพลตฟอร์ม อีกทางเลือกหนึ่งคือใส่ลิงก์ไปยังบัญชี Google ที่ผู้ใช้จะจัดการบัญชีที่ลิงก์ได้

  6. ความสามารถในการเปลี่ยนบัญชีผู้ใช้ แนะนําวิธีให้ผู้ใช้เปลี่ยนบัญชี วิธีนี้เป็นประโยชน์อย่างยิ่งหากผู้ใช้มักจะมีบัญชีหลายบัญชี

    • หากผู้ใช้ต้องปิดหน้าจอคํายินยอมเพื่อเปลี่ยนบัญชี ให้ส่งข้อผิดพลาดที่กู้คืนได้ไปให้ Google เพื่อให้ผู้ใช้ลงชื่อเข้าใช้บัญชีที่ต้องการด้วยการลิงก์ OAuth และขั้นตอนโดยนัย

  7. ใส่โลโก้ของคุณ แสดงโลโก้บริษัทในหน้าจอคํายินยอม ใช้หลักเกณฑ์สไตล์เพื่อวางโลโก้ หากต้องการแสดงโลโก้ของ Google ด้วย โปรดดูโลโก้และเครื่องหมายการค้า

รูปนี้แสดงตัวอย่างหน้าจอคํายินยอมพร้อมไฮไลต์ข้อกําหนดแต่ละรายการและคําแนะนําที่ควรปฏิบัติตามเมื่อออกแบบหน้าจอคํายินยอมของผู้ใช้
รูปที่ 1: หลักเกณฑ์การออกแบบหน้าจอคํายินยอมการลิงก์บัญชี

ตั้งค่าสําหรับ Flip-based App Flip

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

สร้างการดําเนินการสําหรับบ้านอัจฉริยะและตั้งค่าเซิร์ฟเวอร์ OAuth 2.0

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

กําหนดค่า App Flip ในคอนโซล Actions

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

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

ใช้การพลิกแอปในแอป Android

ในการใช้ App Flip คุณต้องแก้ไขรหัสการให้สิทธิ์ของผู้ใช้ในแอปเพื่อยอมรับลิงก์ในรายละเอียดจาก 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 เพื่อให้แน่ใจว่าระบบแสดงวิดีโอสํารองที่เหมาะสม

ทดสอบการพลิกแอปในอุปกรณ์

ตอนนี้คุณได้สร้าง Action และกําหนดค่า 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. ยืนยันว่าแอปเปิดตัวแล้วและเริ่มทดสอบขั้นตอนการให้สิทธิ์
ก่อนหน้า
สร้างโปรเจ็กต์การดําเนินการ
ถัดไป
ระบุและซิงค์