伺服器參考資料

您可以選擇是否導入伺服器。如要執行這些作業，請使用執行個體 ID 服務：

取得應用程式執行個體的相關資訊

如要取得應用程式執行個體的相關資訊，請在這個端點呼叫執行個體 ID 服務，並提供應用程式執行個體的權杖，如下所示：

 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 - 有權傳送至憑證的專案 ID。
  • 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 提供可個別或大量建立這類關係的方法。

為應用程式執行個體建立關係對應

只要取得註冊權杖和支援的關係，就能建立對應關係。舉例來說，您可以在這個端點呼叫執行個體 ID 服務，並提供應用程式執行個體的權杖，藉此將應用程式執行個體訂閱 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
{}

管理多個應用程式執行個體的關係對應圖

您可以使用執行個體 ID 服務的批次方法，執行應用程式執行個體的批次管理。舉例來說，您可以在 FCM 主題中大量新增或移除應用程式執行個體。如要在每個 API 呼叫中更新最多 1000 個應用程式執行個體，請在這個端點呼叫執行個體 ID 服務，並在 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_UNIT — 提供的註冊權杖對寄件者 ID 無效。
  • 內部：後端伺服器因不明原因而失敗。重試要求。
  • TOO_MANY_TOPICS — 每個應用程式執行個體的主題數量過多。
  • RESOURCE_EXHAUSTED — 短時間內過多的訂閱或取消訂閱要求。以指數輪詢方式重試。

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 權杖的註冊權杖

您可以使用執行個體 ID 服務的 batchImport 方法，將現有的 iOS APN 憑證大量匯入 Firebase 雲端通訊，並將這些憑證對應至有效的註冊權杖。在這個端點呼叫執行個體 ID 服務，並在 JSON 主體中提供 APN 權杖清單：

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

回應主體包含一系列執行個體 ID 註冊權杖，可用於將 FCM 訊息傳送至對應的 APN 裝置權杖。

參數

  • Authorization: Bearer <access_token>。請在標頭中設定這個參數。將短期 OAuth2 權杖新增為 Authorization 標頭的值。如要進一步瞭解如何取得這個權杖，請參閱「手動提供憑證」一文。
  • access_token_auth: true。請在標頭中設定這個參數。
  • application：應用程式的軟體包 ID。
  • 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"
        },
     ]
  }

錯誤回應

呼叫 Instance ID 伺服器 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) - 無法使用服務。以指數輪詢方式重試要求。