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

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

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

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

 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"}
    }
  }
}

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

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

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

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

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

พารามิเตอร์

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

ผลลัพธ์

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

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

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

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