fcm

Firebase Cloud Messaging (FCM) สำหรับ Android และ iOS

อัญมณี FCM ช่วยให้แบ็กเอนด์ทับทิมของคุณส่งการแจ้งเตือนไปยังอุปกรณ์ Android และ iOS ผ่านการส่งข้อความคลาวด์ Firebase

การติดตั้ง

 $ gem install fcm

หรือใน Gemfile ของคุณรวมไว้ด้วย:

 gem 'fcm' 

ความต้องการ

สำหรับ Android คุณจะต้องใช้อุปกรณ์ที่ใช้งาน 2.3 (หรือใหม่กว่า) ที่ติดตั้งแอป Google Play Store หรือตัวจำลองที่ใช้ Android 2.3 กับ Google APIs อุปกรณ์ iOS ยังรองรับ

Ruby ที่รองรับรุ่นปัจจุบัน: ruby >= 2.4

เริ่มต้น

ในการใช้อัญมณีนี้คุณจะต้องสร้างอินสแตนซ์ลูกค้าด้วยข้อมูลรับรอง Firebase ของคุณ:

 fcm = FCM . new (
  GOOGLE_APPLICATION_CREDENTIALS_PATH ,
  FIREBASE_PROJECT_ID
) 

เกี่ยวกับ GOOGLE_APPLICATION_CREDENTIALS_PATH

GOOGLE_APPLICATION_CREDENTIALS_PATH นั้นมีไว้เพื่อให้มีข้อมูลประจำตัวของคุณ

วิธีที่ง่ายที่สุดในการให้พวกเขาคือการผ่านเส้นทางที่แน่นอนไปยังไฟล์ที่มีข้อมูลประจำตัวของคุณ:

 fcm = FCM . new (
  '/path/to/credentials.json' ,
  FIREBASE_PROJECT_ID
)

ตามธรรมชาติที่เป็นความลับของพวกเขาคุณอาจไม่ต้องการให้พวกเขาอยู่ในที่เก็บของคุณ ในกรณีนี้โซลูชันที่รองรับอื่นคือการผ่าน StringIO ที่มีข้อมูลประจำตัวของคุณ:

 fcm = FCM . new (
  StringIO . new ( ENV . fetch ( 'FIREBASE_CREDENTIALS' ) ) ,
  FIREBASE_PROJECT_ID
) 

การใช้งาน

http v1 api

เพื่อย้ายไปยัง http v1 ดู: https://firebase.google.com/docs/cloud-messaging/migrate-v1

 fcm = FCM . new (
  GOOGLE_APPLICATION_CREDENTIALS_PATH ,
  FIREBASE_PROJECT_ID
)
message = {
  'token' : "000iddqd" , # send to a specific device
  # 'topic': "yourTopic",
  # 'condition': "'TopicA' in topics && ('TopicB' in topics || 'TopicC' in topics)",
  'data' : {
    payload : {
      data : {
        id : 1
      }
    } . to_json
  } ,
  'notification' : {
    title : notification . title_th ,
    body : notification . body_th ,
  } ,
  'android' : { } ,
  'apns' : {
    payload : {
      aps : {
        sound : "default" ,
        category : " #{ Time . zone . now . to_i } "
      }
    }
  } ,
  'fcm_options' : {
    analytics_label : 'Label'
  }
}

fcm . send_v1 ( message ) # or fcm.send_notification_v1(message) 

การส่งข้อความกลุ่มอุปกรณ์

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

จำนวนสมาชิกสูงสุดที่อนุญาตสำหรับคีย์การแจ้งเตือนคือ 20 https://firebase.google.com/docs/cloud-messaging/android/device-group#managing_device_groups

สร้างคีย์การแจ้งเตือนสำหรับกลุ่มอุปกรณ์

จากนั้นคุณจะต้องมีคีย์การแจ้งเตือนซึ่งคุณสามารถสร้างสำหรับ key_name เฉพาะซึ่งจะต้องมีชื่อเฉพาะต่อแอปในกรณีที่คุณมีแอพหลายตัวสำหรับ project_id เดียวกัน สิ่งนี้ทำให้มั่นใจได้ว่าการแจ้งเตือนไปที่แอพ Target ที่ตั้งใจไว้เท่านั้น วิธี create จะทำสิ่งนี้และส่งคืนโทเค็น notification_key _key ซึ่งแสดงถึงกลุ่มอุปกรณ์ในการตอบสนอง:

project_id คือ Sender_ID ในการตั้งค่าคลาวด์ของคุณ https://firebase.google.com/docs/cloud-messaging/concept-options#senderid

 params = { key_name : "appUser-Chris" ,
                project_id : "my_project_id" ,
                registration_ids : [ "4" , "8" , "15" , "16" , "23" , "42" ] }
response = fcm . create ( * params . values )

ส่งไปยังกลุ่มอุปกรณ์แจ้งเตือน

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

 message = {
  'token' : "NOTIFICATION_KEY" , # send to a device group
  # ...data
}

fcm . send_v1 ( message )

เพิ่ม/ลบโทเค็นการลงทะเบียน

นอกจากนี้คุณยังสามารถเพิ่ม/ลบโทเค็นการลงทะเบียนไปที่/จาก notification_key เฉพาะ _Key ของ project_id ตัวอย่างเช่น:

 params = { key_name : "appUser-Chris" ,
                project_id : "my_project_id" ,
                notification_key : "appUser-Chris-key" ,
                registration_ids : [ "7" , "3" ] }
response = fcm . add ( * params . values )

params = { key_name : "appUser-Chris" ,
                project_id : "my_project_id" ,
                notification_key : "appUser-Chris-key" ,
                registration_ids : [ "8" , "15" ] }
response = fcm . remove ( * params . values ) 

ส่งข้อความไปยังหัวข้อ

การส่งข้อความหัวข้อ FCM ช่วยให้แอพเซิร์ฟเวอร์ของคุณส่งข้อความไปยังอุปกรณ์หลายตัวที่เลือกใช้ในหัวข้อเฉพาะ ขึ้นอยู่กับรูปแบบการเผยแพร่/สมัครสมาชิกอินสแตนซ์หนึ่งแอพสามารถสมัครได้ไม่เกิน 2,000 หัวข้อ การส่งไปยังหัวข้อนั้นคล้ายกับการส่งไปยังอุปกรณ์แต่ละตัวหรือไปยังกลุ่มผู้ใช้ในแง่ที่ว่าคุณสามารถใช้วิธี fcm.send_v1 ที่ topic ตรงกับนิพจน์ทั่วไป "/topics/[a-zA-Z0-9-_.~%]+" :

 message = {
  'topic' : "yourTopic" , # send to a device group
  # ...data
}

fcm . send_v1 ( message )

หรือคุณสามารถใช้ fcm.send_to_topic HELPER:

 response = fcm . send_to_topic ( "yourTopic" ,
            notification : { body : "This is a FCM Topic Message!" } ) 

ส่งข้อความไปยังหัวข้อที่มีเงื่อนไข

การส่งข้อความเงื่อนไขหัวข้อ FCM เพื่อส่งข้อความไปยังการรวมกันของหัวข้อระบุเงื่อนไขซึ่งเป็นนิพจน์บูลีนที่ระบุหัวข้อเป้าหมาย

 message = {
  'condition' : "'TopicA' in topics && ('TopicB' in topics || 'TopicC' in topics)" , # send to topic condition
  # ...data
}

fcm . send_v1 ( message )

หรือคุณสามารถใช้ fcm.send_to_topic_condition HELPER:

 response = fcm . send_to_topic_condition (
  "'TopicA' in topics && ('TopicB' in topics || 'TopicC' in topics)" ,
  notification : {
    body : "This is an FCM Topic Message sent to a condition!"
  }
)

ส่งไปยังหลายหัวข้อ

ในการส่งไปยังการรวมกันของหลายหัวข้อต้องให้คุณตั้งค่าคีย์ เงื่อนไข ให้เป็นเงื่อนไขบูลีนที่ระบุหัวข้อเป้าหมาย ตัวอย่างเช่นในการส่งข้อความไปยังอุปกรณ์ที่สมัครเป็นสมาชิก Topica และ TopicB หรือ TOBICC :

 'TopicA' in topics && ('TopicB' in topics || 'TopicC' in topics)

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

• หัวข้อและหัวข้อ
• หัวข้อและหัวข้อ

คุณสามารถรวมหัวข้อได้สูงสุดห้าหัวข้อในการแสดงออกตามเงื่อนไขของคุณและรองรับวงเล็บ ผู้ให้บริการที่รองรับ: && , || , ! - สังเกตการใช้งาน!:

 !('TopicA' in topics)

ด้วยนิพจน์นี้อินสแตนซ์แอพใด ๆ ที่ไม่ได้สมัครเป็นสมาชิก TOBICA รวมถึงอินสแตนซ์แอพที่ไม่ได้สมัครเป็นสมาชิกหัวข้อใด ๆ รับข้อความ

วิธี send_to_topic_condition ภายในไลบรารีนี้ช่วยให้คุณสามารถแยกแยะเงื่อนไขของหลายหัวข้อที่จะส่งไปยังข้อมูลข้อมูล

 response = fcm . send_to_topic_condition (
  "'TopicA' in topics && ('TopicB' in topics || 'TopicC' in topics)" ,
  notification : {
    body : "This is an FCM Topic Message sent to a condition!"
  }
) 

สมัครสมาชิกแอปไคลเอนต์ไปยังหัวข้อ

ด้วยโทเค็นการลงทะเบียนและชื่อหัวข้อคุณสามารถเพิ่มโทเค็นลงในหัวข้อโดยใช้ Google Instance ID Server API

 topic = "YourTopic"
registration_token = "12" # a client registration token
response = fcm . topic_subscription ( topic , registration_token )
# or unsubscription
response = fcm . topic_unsubscription ( topic , registration_token )

หรือคุณสามารถจัดการแผนที่ความสัมพันธ์สำหรับอินสแตนซ์แอปหลายอินสแตนซ์ Google อินสแตนซ์เซิร์ฟเวอร์ API จัดการความสัมพันธ์

 topic = "YourTopic"
registration_tokens = [ "4" , "8" , "15" , "16" , "23" , "42" ] # an array of one or more client registration tokens
response = fcm . batch_topic_subscription ( topic , registration_tokens )
# or unsubscription
response = fcm . batch_topic_unsubscription ( topic , registration_tokens ) 

รับข้อมูลเกี่ยวกับ ID อินสแตนซ์

เมื่อได้รับโทเค็นการลงทะเบียนคุณสามารถดึงข้อมูลเกี่ยวกับโทเค็นโดยใช้ Google Instance ID Server API

 registration_token = "12" # a client registration token
response = fcm . get_instance_id_info ( registration_token )

ในการรับข้อมูลรายละเอียดเกี่ยวกับ ID อินสแตนซ์คุณสามารถผ่าน options เลือกแฮชไปยังวิธี get_instance_id_info :

 registration_token = "12" # a client registration token
options = { "details" => true }
response = fcm . get_instance_id_info ( registration_token , options ) 

ลูกค้ามือถือ

คุณสามารถค้นหาคำแนะนำในการใช้แอพไคลเอนต์ Android เพื่อรับการแจ้งเตือนที่นี่: ตั้งค่าแอพไคลเอนต์ FCM บน Android

คำแนะนำในการตั้งค่าแอพ iOS เพื่อรับการแจ้งเตือนอยู่ที่นี่: การตั้งค่าแอปไคลเอนต์ FCM บน iOS

การเปลี่ยนแปลง

2.0.1

• เพิ่ม http_options เพื่อ initialize เมธอดและตัวเลือก timeout แบบขาว

2.0.0

ทำลายการเปลี่ยนแปลง

• ลบ API_KEY ที่เลิกใช้แล้ว
• ลบวิธี send ที่เลิกใช้แล้ว
• ลบเมธอด send_with_notification_key ที่เลิกใช้แล้ว
• ลบเมธอด subscribe_instance_id_to_topic
• ลบวิธี unsubscribe_instance_id_from_topic
• ลบ batch_subscribe_instance_ids_to_topic วิธีการ
• ลบ batch_unsubscribe_instance_ids_from_topic วิธีการ

คุณสมบัติที่รองรับ

• เพิ่มการสนับสนุน HTTP V1 API สำหรับวิธี send_to_topic_condition
• เพิ่มการสนับสนุน HTTP V1 API สำหรับวิธี send_to_topic

1.0.8

• แคชโทรไปที่ Google::Auth::ServiceAccountCredentials #103
• อนุญาตเวอร์ชัน faraday จาก 1 ถึง 2 #101

1.0.7

• แก้ไขการส่งผ่าน DEFAULT_TIMEOUT ไปยัง faraday #96
• แก้ไขปัญหาด้วย get_instance_id_info ตัวเลือกพารามิเตอร์ #98
• ยอมรับวัตถุ IO ใด ๆ สำหรับข้อมูลรับรอง #95

ขอบคุณมากสำหรับ @excid3 @jsparling @jensljungblad

1.0.3

• แก้ไขการพึ่งพาฟาราเดย์ที่เข้มงวดมากเกินไป

1.0.2

• การแก้ไขข้อผิดพลาด: ดึงรหัสการแจ้งเตือน "พารามิเตอร์: https://github.com/spacialdb/fcm/commit/b328a75c11d779a06d0ceda83527e26aa0495774

1.0.0

• ทับทับทิมที่รองรับถึง >= 2.4
• แก้ไขคำเตือนการเสื่อมราคาจาก faraday โดยการเปลี่ยนเวอร์ชันการพึ่งพาเป็น faraday 1.0.0

0.0.7

• แทนที่ httparty ด้วย faraday

0.0.2

• URL การส่งข้อความกลุ่มคงที่
• เพิ่ม API ลงใน recover_notification_key

0.0.1

• เวอร์ชันเริ่มต้น

ใบอนุญาต MIT

• ลิขสิทธิ์ (c) 2016 Kashif Rasul และ Shoaib Burq ดู License.txt สำหรับรายละเอียด

ขอบคุณมากสำหรับผู้มีส่วนร่วมทุกคน

• ผู้มีส่วนร่วม

ตัดการเปิดตัว

อัปเดตเวอร์ชันใน fcm.gemspec พร้อม VERSION และอัปเดตส่วน README.md ## ChangeLog

 # set the version
# VERSION="1.0.7"
gem build fcm.gemspec
git tag -a v ${VERSION} -m " Releasing version v ${VERSION} "
git push origin --tags
gem push fcm- ${VERSION} .gem