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

การติดตั้งใช้งานเซิร์ฟเวอร์เป็นตัวเลือกที่ไม่บังคับ ใช้บริการ Instance ID หากต้องการดำเนินการต่อไปนี้

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

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

 https://iid.googleapis.com/iid/info/IID_TOKEN

พารามิเตอร์

  • Authorization: Bearer <access_token>. ตั้งค่าพารามิเตอร์นี้ในส่วนหัว เพิ่มโทเค็น OAuth2 ที่มีอายุสั้นเป็นค่าของส่วนหัว Authorization ดูข้อมูลเพิ่มเติมเกี่ยวกับการรับโทเค็นนี้ได้ที่หัวข้อระบุข้อมูลเข้าสู่ระบบด้วยตนเอง
  • access_token_auth: true. ตั้งค่าพารามิเตอร์นี้ในส่วนหัว
  • [ไม่บังคับ] boolean details: ตั้งค่าพารามิเตอร์การค้นหานี้เป็น true เพื่อรับข้อมูลการสมัครรับหัวข้อ FCM (หากมี) ที่เชื่อมโยงกับโทเค็นนี้ หากไม่ได้ระบุไว้ ค่าเริ่มต้นจะเป็น false

ผลลัพธ์

หากดำเนินการสำเร็จ การเรียกใช้จะแสดงสถานะ HTTP 200 และออบเจ็กต์ JSON ที่มีข้อมูลต่อไปนี้

  • application - ชื่อแพ็กเกจที่เชื่อมโยงกับโทเค็น
  • authorizedEntity - projectId ได้รับอนุญาตให้ส่งไปยังโทเค็น
  • applicationVersion - เวอร์ชันของแอปพลิเคชัน
  • platform - แสดงผล ANDROID, IOS หรือ CHROME เพื่อระบุแพลตฟอร์มอุปกรณ์ที่เป็นเจ้าของโทเค็น

หากตั้งค่า Flag 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"}
    }
  }
}

สร้างแผนที่ความสัมพันธ์สําหรับอินสแตนซ์แอป

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

สร้างการแมปความสัมพันธ์สําหรับอินสแตนซ์แอป

เมื่อได้รับโทเค็นการลงทะเบียนและความสัมพันธ์ที่รองรับ คุณจะสร้างการแมปได้ ตัวอย่างเช่น คุณสามารถสมัครใช้บริการอินสแตนซ์แอปกับหัวข้อ FCM โดยเรียกใช้บริการ Instance ID ที่ปลายทางนี้ โดยระบุโทเค็นของอินสแตนซ์แอปดังที่แสดง

 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 ให้เรียกใช้บริการ InstanceID ที่ปลายทางนี้ โดยระบุโทเค็นอินสแตนซ์แอปในส่วนเนื้อหา 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"},
    {},
  ]
}

สร้างโทเค็นการลงทะเบียนสําหรับโทเค็น APN

เมื่อใช้เมธอด batchImport ของบริการ Instance ID คุณจะนำเข้าโทเค็น APNs ของ iOS ที่มีอยู่หลายรายการไปยัง Firebase Cloud Messaging ได้ โดยจับคู่โทเค็นเหล่านั้นกับโทเค็นการลงทะเบียนที่ถูกต้อง เรียกใช้บริการ Instance ID ที่ปลายทางนี้ โดยระบุรายการโทเค็น APNs ในเนื้อหา JSON

 https://iid.googleapis.com/iid/v1:batchImport

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

พารามิเตอร์

  • Authorization: Bearer <access_token>. ตั้งค่าพารามิเตอร์นี้ในส่วนหัว เพิ่มโทเค็น OAuth2 ที่มีอายุสั้นเป็นค่าของส่วนหัว Authorization ดูข้อมูลเพิ่มเติมเกี่ยวกับการรับโทเค็นนี้ได้ที่หัวข้อระบุข้อมูลเข้าสู่ระบบด้วยตนเอง
  • access_token_auth: true. ตั้งค่าพารามิเตอร์นี้ในส่วนหัว
  • application : รหัส App Bundle ของแอป
  • sandbox : บูลีนเพื่อระบุสภาพแวดล้อมแซนด์บ็อกซ์ (TRUE) หรือเวอร์ชันที่ใช้งานจริง (FALSE)
  • apns_tokens : อาร์เรย์ของโทเค็น APN สําหรับอินสแตนซ์แอปที่คุณต้องการเพิ่มหรือนําออก โทเค็นสูงสุด 100 รายการต่อคำขอ

ผลลัพธ์

หากดำเนินการสำเร็จ การเรียกจะแสดงสถานะ HTTP 200 และเนื้อหาผลลัพธ์ JSON รายการผลลัพธ์สำหรับโทเค็น APNs แต่ละรายการที่ระบุในคำขอจะมีข้อมูลต่อไปนี้

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

การตอบกลับข้อผิดพลาด

การเรียกใช้ Instance ID Server 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