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

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

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

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

 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 - เวอร์ชันของแอปพลิเคชัน
  • 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 — ลบโทเค็นการลงทะเบียนแล้วหรือถอนการติดตั้งแอปแล้ว
  • ไม่ถูกต้อง — โทเค็นการลงทะเบียนที่ระบุไม่ถูกต้องสำหรับรหัสผู้ส่ง
  • ภายใน — เซิร์ฟเวอร์แบ็กเอนด์ทำงานไม่สำเร็จโดยไม่ทราบสาเหตุ ลองส่งคำขออีกครั้ง
  • 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 ของบริการรหัสอินสแตนซ์ คุณจะนำเข้าโทเค็น APN ของ iOS ที่มีอยู่ไปยัง 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 สำหรับโทเค็น APIN แต่ละรายการที่ระบุไว้ในคำขอ รายการผลลัพธ์จะมีข้อมูลต่อไปนี้

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