การอ้างอิงเซิร์ฟเวอร์

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

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

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

 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 ผลลัพธ์ว่างเปล่าหมายความว่าสำเร็จแล้ว สำหรับโทเค็นนี้ สำหรับการสมัครใช้บริการที่ไม่สำเร็จ ผลลัพธ์จะมี 1 รายการ ของรหัสข้อผิดพลาดเหล่านี้

  • 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 สำหรับแต่ละรายการ โทเค็น APN ที่ระบุไว้ในคําขอ รายการผลลัพธ์ประกอบด้วย

  • โทเค็น 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