服务器参考

服务器实现是可选的。如果您想执行以下操作，请使用实例 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 - 获授权向令牌发送的 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，您可以为应用实例创建关系映射。例如，您可以将注册令牌映射到 FCM 主题，将应用实例订阅该主题。该 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
{}

管理多个应用实例的关系映射

您可以使用实例 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。
  • 内部 - 后端服务器因未知原因而失败。请重试请求。
  • 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 令牌创建注册令牌

您可以使用 Instance ID 服务的 batchImport 方法将现有的 iOS APNs 令牌批量导入 Firebase Cloud Messaging，将它们映射到有效的注册令牌。调用此端点上的实例 ID 服务，在 JSON 正文中提供 APN 令牌列表：

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

响应正文包含一个实例 ID 注册令牌数组，可用于向相应的 APNs 设备令牌发送 FCM 消息。

参数

  • Authorization: Bearer <access_token>。在标头中设置此参数。 将短期有效的 OAuth2 令牌添加为 Authorization 标头的值。如需详细了解如何获取此令牌，请参阅手动提供凭据。
  • access_token_auth: true。在标头中设置此参数。
  • application：应用的软件包 ID。
  • sandbox：布尔值，用于指示沙盒环境 (TRUE) 或生产环境 (FALSE)
  • apns_tokens：您要添加或移除的应用实例的 APNs 令牌数组。每个请求的令牌数量上限为 100 个。

结果

成功时，该调用会返回 HTTP 状态 200 和 JSON 结果正文。对于请求中提供的每个 APNs 令牌，结果列表包含：

  • APN 令牌。
  • 状态。“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"
        },
     ]
  }

错误响应

对实例 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) - 服务不可用。使用指数退避算法重试请求。