服务器参考

服务器实现是可选的。如果要执行以下操作,请使用实例 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 - 应用的版本。
  • appSigner - 应用于软件包的签名的 sha1 指纹。 表明哪一方为应用签名;例如 Play Store
  • platform - 返回 ANDROIDIOSCHROME 以指示令牌所属的设备平台。

如果设置了 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",
  "appSigner":"1a2bc3d4e5"
  "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_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"},
    {},
  ]
}

为 APNs 令牌创建注册令牌

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

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

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

参数

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

成果

成功后,调用将返回 HTTP 状态 200 和 JSON 结果正文。对于请求中提供的每个 APNs 令牌,结果列表会包含以下内容:

  • APNs 令牌。
  • 状态。正常,或者说明失败情况的错误消息。
  • 如果结果成功,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) - 服务不可用。请使用指数退避算法重试请求。