การใช้งานเซิร์ฟเวอร์จะมีหรือไม่ก็ได้ ใช้บริการรหัสอินสแตนซ์หากต้องการดําเนินการต่อไปนี้
- ดูข้อมูลเกี่ยวกับอินสแตนซ์ของแอป ยืนยันโทเค็นแอปหรือดูข้อมูลเพิ่มเติมเกี่ยวกับอินสแตนซ์แอปที่สร้างโทเค็น
- สร้างแผนที่ความสัมพันธ์สําหรับอินสแตนซ์ของแอป สร้างความสัมพันธ์ระหว่างอินสแตนซ์ของแอปและเอนทิตี
- สร้างโทเค็นการลงทะเบียนสําหรับโทเค็น 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
- projectId ได้รับอนุญาตให้ส่งไปยังโทเค็นapplicationVersion
- เวอร์ชันของแอปพลิเคชันappSigner
- ลายนิ้วมือsha1
ของลายเซ็นที่ใช้กับแพ็กเกจ ระบุว่าใครเป็นผู้ลงนามแอป ตัวอย่างเช่นPlay Store
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",
"appSigner":"1a2bc3d4e5"
"rel":{
"topics":{
"topicname1":{"addDate":"2015-07-30"},
"topicname2":{"addDate":"2015-07-30"},
"topicname3":{"addDate":"2015-07-30"},
"topicname4":{"addDate":"2015-07-30"}
}
}
}
สร้างแผนที่ความสัมพันธ์สําหรับอินสแตนซ์ของแอป
Instance ID 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 — โทเค็นการลงทะเบียนที่ระบุไม่ถูกต้องสําหรับ ID ผู้ส่ง
- ภายใน — เซิร์ฟเวอร์แบ็กเอนด์ทํางานล้มเหลวโดยไม่ทราบสาเหตุ ลองส่งคําขออีกครั้ง
- 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"},
{},
]
}
สร้างโทเค็นการลงทะเบียนสําหรับโทเค็น APN
เมธอด batchImport
ของบริการ Instance ID ช่วยให้คุณนําเข้าโทเค็น 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 สําหรับโทเค็น APN แต่ละรายการที่ระบุในคําขอ รายการผลลัพธ์จะมีข้อมูลต่อไปนี้
- โทเค็น APN
- สถานะ ตกลง หรือข้อความแสดงข้อผิดพลาดที่อธิบายความล้มเหลว
- เพื่อให้ได้ผลลัพธ์ที่สําเร็จ โทเค็นการลงทะเบียนที่ FCM แมปกับโทเค็น APN
ตัวอย่างคําขอ 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