คุณเลือกที่จะติดตั้งใช้งานเซิร์ฟเวอร์หรือไม่ก็ได้ ใช้บริการรหัสอินสแตนซ์หากต้องการดำเนินการต่อไปนี้
- รับข้อมูลเกี่ยวกับอินสแตนซ์ของแอป ยืนยันโทเค็นแอปหรือดูข้อมูลเพิ่มเติมเกี่ยวกับอินสแตนซ์ของแอปที่สร้างโทเค็น
- สร้างแผนที่ความสัมพันธ์สำหรับอินสแตนซ์ของแอป สร้างความสัมพันธ์ระหว่างอินสแตนซ์ของแอปและเอนทิตี
- สร้างโทเค็นการลงทะเบียนสำหรับโทเค็น APNs API นี้ช่วยให้คุณนำเข้าโทเค็น APN ที่มีอยู่ได้หลายรายการพร้อมกัน โดยแมปกับโทเค็นการลงทะเบียนที่ถูกต้องสำหรับ FCM
รับข้อมูลเกี่ยวกับอินสแตนซ์ของแอป
หากต้องการรับข้อมูลเกี่ยวกับอินสแตนซ์ของแอป ให้เรียกใช้บริการรหัสอินสแตนซ์ที่ปลายทางนี้ โดยระบุโทเค็นของอินสแตนซ์แอปดังต่อไปนี้
https://iid.googleapis.com/iid/info/IID_TOKEN
พารามิเตอร์
Authorization: Bearer <access_token>
ตั้งค่าพารามิเตอร์นี้ในส่วนหัว เพิ่มโทเค็น OAuth2 ที่มีอายุสั้นเป็นค่าของส่วนหัวAuthorization
ดูข้อมูลเพิ่มเติมเกี่ยวกับการรับโทเค็นนี้ได้ที่ระบุข้อมูลเข้าสู่ระบบด้วยตนเองaccess_token_auth: true
ตั้งค่าพารามิเตอร์นี้ในส่วนหัว- [ไม่บังคับ] บูลีน
details
: ตั้งค่าพารามิเตอร์การค้นหานี้เป็นtrue
เพื่อรับข้อมูลการสมัครใช้บริการหัวข้อ FCM (หากมี) ที่เชื่อมโยงกับโทเค็นนี้ เมื่อไม่ระบุ ค่าเริ่มต้นจะเป็นfalse
ผลลัพธ์
เมื่อเรียกใช้ได้สำเร็จ จะแสดงสถานะ HTTP 200 และออบเจ็กต์ JSON ที่ประกอบด้วย
application
- ชื่อแพ็กเกจที่เชื่อมโยงกับโทเค็นauthorizedEntity
- รหัสโปรเจ็กต์ที่ได้รับสิทธิ์ให้ส่งไปยังโทเค็นapplicationVersion
- เวอร์ชันของแอปพลิเคชันplatform
- แสดงผลANDROID
,IOS
หรือCHROME
เพื่อระบุแพลตฟอร์มอุปกรณ์ที่โทเค็นอยู่
หากตั้งค่าแฟล็ก details
ไว้ ให้ทำดังนี้
rel
- ความสัมพันธ์ที่เชื่อมโยงกับโทเค็น เช่น รายการการติดตามหัวข้อ
ตัวอย่างคำขอ GET
https://iid.googleapis.com/iid/info/nKctODamlM4:CKrh_PC8kIb7O...clJONHoA
Content-Type:application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA
access_token_auth: true
ตัวอย่างผลลัพธ์
HTTP 200 OK
{
"application":"com.iid.example",
"authorizedEntity":"123456782354",
"platform":"Android",
"rel":{
"topics":{
"topicname1":{"addDate":"2015-07-30"},
"topicname2":{"addDate":"2015-07-30"},
"topicname3":{"addDate":"2015-07-30"},
"topicname4":{"addDate":"2015-07-30"}
}
}
}
สร้างแผนที่ความสัมพันธ์สำหรับอินสแตนซ์แอป
API รหัสอินสแตนซ์ให้คุณสร้างแผนที่ความสัมพันธ์สำหรับอินสแตนซ์ของแอป ตัวอย่างเช่น คุณแมปโทเค็นการลงทะเบียนกับหัวข้อ FCM เพื่อสมัครรับข้อมูลอินสแตนซ์ของแอปจากหัวข้อได้ API มีวิธีสำหรับการสร้างความสัมพันธ์ดังกล่าวทั้งแบบทีละรายการและแบบกลุ่ม
สร้างการแมปความสัมพันธ์สำหรับอินสแตนซ์ของแอป
เมื่อมีโทเค็นการลงทะเบียนและความสัมพันธ์ที่รองรับ คุณจะสร้างการแมปได้ ตัวอย่างเช่น คุณสมัครรับข้อมูลอินสแตนซ์ของแอปกับหัวข้อ FCM ได้โดยเรียกใช้บริการรหัสอินสแตนซ์ที่ปลายทางนี้ โดยระบุโทเค็นของอินสแตนซ์แอปดังที่แสดงด้านล่าง
https://iid.googleapis.com/iid/v1/IID_TOKEN/rel/topics/TOPIC_NAME
พารามิเตอร์
Authorization: Bearer <access_token>
ตั้งค่าพารามิเตอร์นี้ในส่วนหัว เพิ่มโทเค็น OAuth2 ที่มีอายุสั้นเป็นค่าของส่วนหัวAuthorization
ดูข้อมูลเพิ่มเติมเกี่ยวกับการรับโทเค็นนี้ได้ที่ระบุข้อมูลเข้าสู่ระบบด้วยตนเองaccess_token_auth: true
ตั้งค่าพารามิเตอร์นี้ในส่วนหัว
ผลลัพธ์
เมื่อสำเร็จ การเรียกใช้จะแสดงสถานะ HTTP 200
ตัวอย่างคำขอ POST
https://iid.googleapis.com/iid/v1/nKctODamlM4:CKrh_PC8kIb7O...clJONHoA/rel/topics/movies
Content-Type:application/json
Content-Length: 0
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA
access_token_auth: true
ตัวอย่างผลลัพธ์
HTTP 200 OK
{}
จัดการการจับคู่ความสัมพันธ์สำหรับอินสแตนซ์แอปหลายรายการ
การใช้เมธอดแบบกลุ่มของบริการรหัสอินสแตนซ์จะทำให้คุณจัดการอินสแตนซ์ของแอปเป็นกลุ่มได้ ตัวอย่างเช่น คุณเพิ่มหรือนําอินสแตนซ์แอปออกจากหัวข้อ FCM หลายรายการได้ หากต้องการอัปเดตอินสแตนซ์แอปสูงสุด 1,000 รายการต่อการเรียก API ให้เรียกใช้บริการรหัสอินสแตนซ์ที่ปลายทางนี้ โดยระบุโทเค็นอินสแตนซ์ของแอปในเนื้อหา JSON ดังนี้
https://iid.googleapis.com/iid/v1:batchAdd
https://iid.googleapis.com/iid/v1:batchRemove
พารามิเตอร์
Authorization: Bearer <access_token>
ตั้งค่าพารามิเตอร์นี้ในส่วนหัว เพิ่มโทเค็น OAuth2 ที่มีอายุสั้นเป็นค่าของส่วนหัวAuthorization
ดูข้อมูลเพิ่มเติมเกี่ยวกับการรับโทเค็นนี้ได้ที่ระบุข้อมูลเข้าสู่ระบบด้วยตนเองaccess_token_auth: true
ตั้งค่าพารามิเตอร์นี้ในส่วนหัวto
: ชื่อหัวข้อregistration_tokens
: อาร์เรย์ของโทเค็น IID สำหรับอินสแตนซ์ของแอปที่คุณต้องการเพิ่มหรือนำออก
ผลลัพธ์
เมื่อสำเร็จ การเรียกใช้จะแสดงสถานะ HTTP 200 หากผลลัพธ์ว่างเปล่า แสดงว่าสมัครใช้บริการโทเค็นสำเร็จ สำหรับการสมัครใช้บริการที่ไม่สำเร็จ ผลลัพธ์จะมีรหัสข้อผิดพลาดอย่างใดอย่างหนึ่งต่อไปนี้
- NOT_FOUND — โทเค็นการลงทะเบียนถูกลบหรือถอนการติดตั้งแอปแล้ว
- INVALID_ARGUMENT — โทเค็นการลงทะเบียนที่ระบุไม่ถูกต้องสำหรับรหัสผู้ส่ง
- ภายใน — เซิร์ฟเวอร์แบ็กเอนด์ล้มเหลวโดยไม่ทราบสาเหตุ ลองส่งคำขออีกครั้ง
- TOO_MANY_TOPICS — มีจำนวนหัวข้อมากเกินไปต่ออินสแตนซ์ของแอป
- RESOURCE_EXHAUSTED — มีการสมัครรับข้อมูลหรือยกเลิกการสมัครรับข้อมูลมากเกินไปในระยะเวลาสั้นๆ ลองอีกครั้งโดยใช้ Exponential Backoff
ตัวอย่างคำขอ POST
https://iid.googleapis.com/iid/v1:batchAdd
Content-Type:application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA
access_token_auth: true
{
"to": "/topics/movies",
"registration_tokens": ["nKctODamlM4:CKrh_PC8kIb7O...", "1uoasi24:9jsjwuw...", "798aywu:cba420..."],
}
ตัวอย่างผลลัพธ์
HTTP 200 OK
{
"results":[
{},
{"error":"NOT_FOUND"},
{},
]
}
สร้างโทเค็นการลงทะเบียนสำหรับโทเค็น APNs
เมื่อใช้เมธอด batchImport
ของบริการรหัสอินสแตนซ์ คุณจะสามารถนำเข้าโทเค็น iOS APN ที่มีอยู่เป็นจำนวนมากไปยัง Firebase Cloud Messaging จากนั้นแมปโทเค็นดังกล่าวกับโทเค็นการลงทะเบียนที่ถูกต้อง เรียกใช้บริการรหัสอินสแตนซ์ที่ปลายทางนี้ โดยระบุรายการโทเค็น APN ในเนื้อหา JSON ดังนี้
https://iid.googleapis.com/iid/v1:batchImport
เนื้อหาการตอบกลับประกอบด้วยอาร์เรย์ของโทเค็นการลงทะเบียนรหัสอินสแตนซ์ที่พร้อมใช้เพื่อส่งข้อความ FCM ไปยังโทเค็นอุปกรณ์ APN ที่เกี่ยวข้อง
พารามิเตอร์
Authorization: Bearer <access_token>
ตั้งค่าพารามิเตอร์นี้ในส่วนหัว เพิ่มโทเค็น OAuth2 ที่มีอายุสั้นเป็นค่าของส่วนหัวAuthorization
ดูข้อมูลเพิ่มเติมเกี่ยวกับการรับโทเค็นนี้ได้ที่ระบุข้อมูลเข้าสู่ระบบด้วยตนเองaccess_token_auth: true
ตั้งค่าพารามิเตอร์นี้ในส่วนหัวapplication
: รหัสชุดของแอปsandbox
: บูลีนสำหรับระบุสภาพแวดล้อมแซนด์บ็อกซ์ (TRUE) หรือเวอร์ชันที่ใช้งานจริง (FALSE)apns_tokens
: อาร์เรย์ของโทเค็น APN สำหรับอินสแตนซ์ของแอปที่คุณต้องการเพิ่มหรือนำออก โทเค็นสูงสุด 100 รายการต่อคำขอ
ผลลัพธ์
เมื่อเรียกใช้สำเร็จ จะแสดงสถานะ HTTP 200 และเนื้อหาผลลัพธ์ JSON สำหรับโทเค็น AAP แต่ละรายการที่ระบุในคำขอ รายการผลลัพธ์จะมีข้อมูลต่อไปนี้
- โทเค็น APNs
- สถานะ "ตกลง" หรือข้อความแสดงข้อผิดพลาดที่อธิบายความล้มเหลว
- โทเค็นการลงทะเบียนที่ FCM จะแมปกับโทเค็น APNs เพื่อให้ได้ผลลัพธ์ที่สำเร็จ
ตัวอย่างคำขอ POST
https://iid.googleapis.com/iid/v1:batchImport
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA
access_token_auth:true
{
"application": "com.google.FCMTestApp",
"sandbox":false,
"apns_tokens":[
"368dde283db539abc4a6419b1795b6131194703b816e4f624ffa12",
"76b39c2b2ceaadee8400b8868c2f45325ab9831c1998ed70859d86"
]
}
ตัวอย่างผลลัพธ์
HTTP 200 OK
{
"results":[
{
"apns_token": "368dde283db539abc4a6419b1795b6131194703b816e4f624ffa12",
"status": "OK",
"registration_token":"nKctODamlM4:CKrh_PC8kIb7O...clJONHoA"
},
{
"apns_token": "76b39c2b2ceaadee8400b8868c2f45325ab9831c1998ed70859d86",
"status":"Internal Server Error"
},
]
}
การตอบกลับข้อผิดพลาด
การเรียก API เซิร์ฟเวอร์รหัสอินสแตนซ์จะแสดงรหัสข้อผิดพลาด HTTP ต่อไปนี้
HTTP status 400 (Bad request)
- พารามิเตอร์คำขอขาดหายไปหรือไม่ถูกต้อง ตรวจสอบข้อความแสดงข้อผิดพลาดเพื่อดูข้อมูลโดยละเอียดHTTP status 401 (Unauthorized)
- ส่วนหัวการให้สิทธิ์ไม่ถูกต้องHTTP status 403 (Forbidden)
- ส่วนหัวการให้สิทธิ์ไม่ตรงกับauthorizedEntity
HTTP status 404 (Not found)
- ไม่พบเส้นทาง HTTP หรือโทเค็น IID ที่ไม่ถูกต้อง ตรวจสอบข้อความแสดงข้อผิดพลาดเพื่อดูข้อมูลโดยละเอียดHTTP status 503 (Service unavailable)
- บริการไม่พร้อมให้บริการ ลองส่งคำขออีกครั้ง โดยใช้ Exponential Backoff