伺服器參考資料

伺服器實作是選用項目。如要執行下列作業，請使用 Instance ID 服務：

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

如要取得應用程式執行個體的相關資訊，請在這個端點呼叫 Instance 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：授權傳送至權杖的 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"}
    }
  }
}

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

您可以使用 Instance ID API 為應用程式執行個體建立關係對應圖。舉例來說，您可以將註冊權杖對應至 Firebase 雲端通訊主題，讓應用程式執行個體訂閱該主題。這個 API 提供方法，可個別或大量建立這類關係。

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

您可以使用註冊權杖和支援的關聯建立對應項目。舉例來說，您可以呼叫這個端點的 Instance 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
{}

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

您可以使用 Instance ID 服務的批次方法，對應用程式執行個體執行批次管理作業。舉例來說，您可以將應用程式執行個體大量新增或移除至 FCM 主題。如要透過每個 API 呼叫更新最多 1,000 個應用程式執行個體，請在這個端點呼叫 Instance 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_ARGUMENT：提供的註冊權杖對寄件者 ID 無效。
  • INTERNAL：後端伺服器因不明原因而失敗。重試要求。
  • 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"},
    {},
  ]
}

建立 APNs 權杖的註冊權杖

您可以使用 Instance ID 服務的 batchImport 方法，將現有的 iOS APN 符記大量匯入 Firebase 雲端通訊，並將其對應至有效的註冊符記。請在這個端點呼叫 Instance 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 權杖。
  • 狀態，顯示「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 伺服器 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) - 服務無法使用。以指數輪詢方式重試要求。