แนวทางปฏิบัติแนะนำสำหรับการจัดการโทเค็นการลงทะเบียน FCM

หากใช้ FCM API เพื่อสร้างคําขอส่งแบบเป็นโปรแกรม คุณอาจพบว่าเมื่อเวลาผ่านไป คุณกำลังใช้ทรัพยากรไปอย่างเปล่าประโยชน์ด้วยการส่งข้อความไปยังอุปกรณ์ที่ไม่ได้ใช้งานซึ่งมีโทเค็นการลงทะเบียนที่ล้าสมัย สถานการณ์นี้อาจส่งผลต่อข้อมูลการนำส่งข้อความที่รายงานในคอนโซล Firebase หรือข้อมูลที่ส่งออกไปยัง BigQuery ซึ่งจะแสดงเป็นอัตราการนำส่งที่ลดลงอย่างมาก (แต่ไม่ใช่อัตราจริง) คู่มือนี้กล่าวถึงมาตรการบางอย่างที่คุณทำได้เพื่อช่วยให้การกำหนดเป้าหมายข้อความมีประสิทธิภาพและการรายงานการนำส่งที่ถูกต้อง

โทเค็นการลงทะเบียนที่ล้าสมัยและหมดอายุ

โทเค็นการลงทะเบียนที่ล้าสมัยคือโทเค็นที่เชื่อมโยงกับอุปกรณ์ที่ไม่ได้ใช้งานซึ่งไม่ได้เชื่อมต่อกับ FCM เป็นเวลานานกว่า 1 เดือน ยิ่งเวลาผ่านไป โอกาสที่อุปกรณ์จะเชื่อมต่อกับ FCM อีกครั้งก็จะยิ่งน้อยลง การส่งข้อความและการแยกส่งหัวข้อสำหรับโทเค็นที่หมดอายุเหล่านี้มีแนวโน้มที่จะไม่ได้รับการนําส่ง

โทเค็นอาจหมดอายุได้หลายสาเหตุ เช่น อุปกรณ์ที่เชื่อมโยงกับโทเค็นอาจสูญหาย ถูกทำลาย หรือเก็บไว้แล้วลืม

เมื่อโทเค็นที่หยุดทำงานมีระยะเวลาที่ไม่ได้ใช้งานถึง 270 วัน FCM จะถือว่าโทเค็นเหล่านั้นเป็นโทเค็นที่หมดอายุ เมื่อโทเค็นหมดอายุ FCM จะทําเครื่องหมายว่าใช้งานไม่ได้และปฏิเสธการส่งไปยังโทเค็น อย่างไรก็ตาม FCM จะออกโทเค็นใหม่สําหรับอินสแตนซ์แอปในกรณีที่อุปกรณ์เชื่อมต่ออีกครั้งและเปิดแอปขึ้น ซึ่งเกิดขึ้นได้น้อยมาก

แนวทางปฏิบัติแนะนำพื้นฐาน

มีแนวทางปฏิบัติพื้นฐานบางอย่างที่คุณควรทำตามในแอปที่ใช้ FCMAPI เพื่อสร้างคำขอส่งแบบเป็นโปรแกรม แนวทางปฏิบัติแนะนำหลักๆ มีดังนี้

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

เรียกดูและจัดเก็บโทเค็นการลงทะเบียน

เมื่อเริ่มต้นแอปครั้งแรก FCM SDK จะสร้างโทเค็นการลงทะเบียนสําหรับอินสแตนซ์แอปไคลเอ็นต์ โทเค็นนี้เป็นสิ่งที่คุณต้องใส่ในคำขอส่งที่มีการกําหนดเป้าหมายจาก API หรือเพิ่มในการติดตามหัวข้อเพื่อกําหนดเป้าหมายหัวข้อ

เราขอแนะนําอย่างยิ่งให้แอปของคุณดึงข้อมูลโทเค็นนี้เมื่อเริ่มต้นใช้งานครั้งแรกและบันทึกลงในเซิร์ฟเวอร์แอปพร้อมกับการประทับเวลา โค้ดและเซิร์ฟเวอร์ของคุณต้องใช้การประทับเวลานี้ เนื่องจากFCM SDK ไม่ได้ระบุให้คุณ

นอกจากนี้ คุณยังควรบันทึกโทเค็นลงในเซิร์ฟเวอร์และอัปเดตการประทับเวลาทุกครั้งที่มีการเปลี่ยนแปลง เช่น ในกรณีต่อไปนี้

• กู้คืนแอปในอุปกรณ์เครื่องใหม่
• ผู้ใช้ถอนการติดตั้งหรือติดตั้งแอปอีกครั้ง
• ผู้ใช้ล้างข้อมูลแอป
• แอปจะกลับมาทำงานอีกครั้งหลังจากที่ FCM หมดอายุโทเค็นที่มีอยู่

ตัวอย่าง: จัดเก็บโทเค็นและการประทับเวลาใน Cloud Firestore

เช่น คุณอาจใช้ Cloud Firestore เพื่อจัดเก็บโทเค็นในคอลเล็กชันที่ชื่อ fcmTokens รหัสเอกสารแต่ละรายการในคอลเล็กชันจะสอดคล้องกับรหัสผู้ใช้ และเอกสารจะจัดเก็บโทเค็นการลงทะเบียนปัจจุบันและการประทับเวลาการอัปเดตล่าสุด ใช้ฟังก์ชัน set ตามที่แสดงในตัวอย่าง Kotlin นี้

    /**
     * Persist token to third-party servers.
     *
     * Modify this method to associate the user's FCM registration token with any server-side account
     * maintained by your application.
     *
     * @param token The new token.
     */
    private fun sendTokenToServer(token: String?) {
        // If you're running your own server, call API to send token and today's date for the user

        // Example shown below with Firestore
        // Add token and timestamp to Firestore for this user
        val deviceToken = hashMapOf(
            "token" to token,
            "timestamp" to FieldValue.serverTimestamp(),
        )
        // Get user ID from Firebase Auth or your own server
        Firebase.firestore.collection("fcmTokens").document("myuserid")
            .set(deviceToken)
    }
MyFirebaseMessagingService.kt

เมื่อใดก็ตามที่มีการเรียกข้อมูลโทเค็น ระบบจะจัดเก็บโทเค็นไว้ใน Cloud Firestore โดยเรียกใช้ sendTokenToServer

    /**
     * Called if the FCM registration token is updated. This may occur if the security of
     * the previous token had been compromised. Note that this is called when the
     * FCM registration token is initially generated so this is where you would retrieve the token.
     */
    override fun onNewToken(token: String) {
        Log.d(TAG, "Refreshed token: $token")

        // If you want to send messages to this application instance or
        // manage this apps subscriptions on the server side, send the
        // FCM registration token to your app server.
        sendTokenToServer(token)
    }
MyFirebaseMessagingService.kt
        var token = Firebase.messaging.token.await()

        // Check whether the retrieved token matches the one on your server for this user's device
        val preferences = this.getPreferences(Context.MODE_PRIVATE)
        val tokenStored = preferences.getString("deviceToken", "")
        lifecycleScope.launch {
            if (tokenStored == "" || tokenStored != token)
            {
                // If you have your own server, call API to send the above token and Date() for this user's device

                // Example shown below with Firestore
                // Add token and timestamp to Firestore for this user
                val deviceToken = hashMapOf(
                    "token" to token,
                    "timestamp" to FieldValue.serverTimestamp(),
                )

                // Get user ID from Firebase Auth or your own server
                Firebase.firestore.collection("fcmTokens").document("myuserid")
                    .set(deviceToken).await()
            }
        }
MainActivity.kt

รักษาความใหม่ของโทเค็นและนำโทเค็นที่หมดอายุออก

การพิจารณาว่าโทเค็นใหม่หรือเก่านั้นไม่ใช่เรื่องง่ายเสมอไป คุณควรใช้เกณฑ์เมื่อพิจารณาว่าโทเค็นล้าสมัยแล้วเพื่อให้ครอบคลุมทุกกรณี โดยค่าเริ่มต้น FCM จะถือว่าโทเค็นไม่มีการใช้งานหากอินสแตนซ์แอปไม่ได้เชื่อมต่อเป็นเวลา 1 เดือน โทเค็นที่มีอายุมากกว่า 1 เดือนมีแนวโน้มที่จะเป็นอุปกรณ์ที่ไม่ได้ใช้งาน เนื่องจากอุปกรณ์ที่ใช้งานอยู่จะรีเฟรชโทเค็น

1 เดือนอาจสั้นหรือยาวเกินไป ทั้งนี้ขึ้นอยู่กับกรณีการใช้งานของคุณ คุณจึงต้องเป็นผู้กำหนดเกณฑ์ที่เหมาะกับตัวเอง

ตรวจหาการตอบกลับโทเค็นที่ไม่ถูกต้องจากแบ็กเอนด์ FCM

ตรวจสอบการตอบกลับโทเค็นที่ไม่ถูกต้องจาก FCM และตอบสนองด้วยการลบโทเค็นการลงทะเบียนที่ทราบว่าไม่ถูกต้องหรือหมดอายุแล้วออกจากระบบ เมื่อใช้ HTTP v1 API ข้อความแสดงข้อผิดพลาดเหล่านี้อาจบ่งบอกว่าคำขอส่งของคุณกำหนดเป้าหมายไปยังโทเค็นที่ไม่ถูกต้องหรือหมดอายุแล้ว

• UNREGISTERED (HTTP 404)
• INVALID_ARGUMENT (HTTP 400)

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

    // Registration token comes from the client FCM SDKs
    const registrationToken = 'YOUR_REGISTRATION_TOKEN';

    const message = {
    data: {
        // Information you want to send inside of notification
    },
    token: registrationToken
    };

    // Send message to device with provided registration token
    getMessaging().send(message)
    .then((response) => {
        // Response is a message ID string.
    })
    .catch((error) => {
        // Delete token for user if error code is UNREGISTERED or INVALID_ARGUMENT.
        if (errorCode == "messaging/registration-token-not-registered") {
            // If you're running your own server, call API to delete the
            token for the user

            // Example shown below with Firestore
            // Get user ID from Firebase Auth or your own server
            Firebase.firestore.collection("fcmTokens").document(user.uid).delete()
        }
    });

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

อัปเดตโทเค็นเป็นประจำ

เราขอแนะนําให้เรียกข้อมูลและอัปเดตโทเค็นการลงทะเบียนทั้งหมดในเซิร์ฟเวอร์เป็นประจํา โดยคุณจะต้องดำเนินการต่อไปนี้

• เพิ่มตรรกะแอปในแอปไคลเอ็นต์เพื่อดึงข้อมูลโทเค็นปัจจุบันโดยใช้การเรียก API ที่เหมาะสม (เช่น token(completion): สำหรับแพลตฟอร์ม Apple หรือ getToken() สำหรับ Android) จากนั้นส่งโทเค็นปัจจุบันไปยังเซิร์ฟเวอร์แอปเพื่อจัดเก็บ (พร้อมการประทับเวลา) ซึ่งอาจเป็นงานรายเดือนที่กำหนดค่าให้ครอบคลุมไคลเอ็นต์หรือโทเค็นทั้งหมด
• เพิ่มตรรกะเซิร์ฟเวอร์เพื่ออัปเดตการประทับเวลาของโทเค็นเป็นระยะๆ ไม่ว่าโทเค็นจะมีการเปลี่ยนแปลงหรือไม่ก็ตาม

ดูตัวอย่างตรรกะ Android สำหรับการอัปเดตโทเค็นโดยใช้ WorkManager ได้ที่การจัดการโทเค็น Cloud Messaging ในบล็อก Firebase

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

นำโทเค็นการลงทะเบียนที่ล้าสมัยออก

ก่อนส่งข้อความไปยังอุปกรณ์ ให้ตรวจสอบว่าการประทับเวลาของโทเค็นการลงทะเบียนของอุปกรณ์อยู่ภายในกรอบเวลาหมดอายุ ตัวอย่างเช่น คุณอาจใช้ Cloud Functions for Firebase เพื่อเรียกใช้การตรวจสอบรายวันเพื่อให้แน่ใจว่าการประทับเวลาอยู่ภายในกรอบเวลาหมดอายุที่กําหนด เช่น const EXPIRATION_TIME = 1000 * 60 * 60 * 24 * 30; จากนั้นนําโทเค็นที่หมดอายุออก

exports.pruneTokens = functions.pubsub.schedule('every 24 hours').onRun(async (context) => {
  // Get all documents where the timestamp exceeds is not within the past month
  const staleTokensResult = await admin.firestore().collection('fcmTokens')
      .where("timestamp", "<", Date.now() - EXPIRATION_TIME)
      .get();
  // Delete devices with stale tokens
  staleTokensResult.forEach(function(doc) { doc.ref.delete(); });
});
index.js

ยกเลิกการสมัครรับโทเค็นที่หมดอายุแล้วจากหัวข้อ

หากใช้หัวข้อ คุณอาจต้องยกเลิกการลงทะเบียนโทเค็นที่ล้าสมัยจากหัวข้อที่สมัครรับข้อมูลไว้ด้วย ซึ่งประกอบด้วย 2 ขั้นตอนดังนี้

1. แอปควรสมัครรับข้อมูลหัวข้ออีกครั้งเดือนละครั้งและทุกครั้งที่โทเค็นการลงทะเบียนมีการเปลี่ยนแปลง วิธีนี้จะเป็นโซลูชันการแก้ไขอัตโนมัติ ซึ่งการสมัครใช้บริการจะปรากฏขึ้นอีกครั้งโดยอัตโนมัติเมื่อแอปกลับมาทำงานอีกครั้ง
2. หากอินสแตนซ์แอปไม่มีการใช้งานเป็นเวลา 1 เดือน (หรือกรอบเวลาหมดอายุของคุณเอง) คุณควรยกเลิกการสมัครรับข้อมูลจากหัวข้อโดยใช้ Firebase Admin SDK เพื่อลบการแมปโทเค็นกับหัวข้อจากแบ็กเอนด์ FCM

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

วัดความสําเร็จในการนำส่ง

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

ก่อนกําหนดเป้าหมายข้อความไปยังโทเค็น ให้พิจารณาสิ่งต่อไปนี้

• Google Analytics, ข้อมูลที่บันทึกไว้ใน BigQuery หรือสัญญาณการติดตามอื่นๆ บ่งชี้ว่าโทเค็นทำงานอยู่หรือไม่
• ก่อนหน้านี้มีความพยายามนำส่งไม่สำเร็จอย่างต่อเนื่องเป็นระยะเวลาหนึ่งหรือไม่
• มีอัปเดตโทเค็นการลงทะเบียนในเซิร์ฟเวอร์ในช่วงเดือนที่ผ่านมาหรือไม่
• สำหรับอุปกรณ์ Android นั้น FCM Data API รายงานเปอร์เซ็นต์การส่งข้อความที่ไม่สำเร็จสูงเนื่องจาก droppedDeviceInactive หรือไม่

ดูข้อมูลเพิ่มเติมเกี่ยวกับการนำส่งได้ที่การทำความเข้าใจการนำส่งข้อความ