更新日志

Data Plan Agent API

2019 年 12 月

  1. 引入了要实现的 DPA 的注册 CPID API 定义。
  2. 添加了有关如何在客户端请求新的 CPID 时生成并存储 CPID 的建议。
  3. 添加了有关如何选择用于发送通知的 CPID 的文档。
  4. 阐明了当 GTAF 调用 DPA 和 DPA 调用 GTAF 时如何确定用户语言偏好设置。

2019 年 10 月

  1. 每次联系 CPID 端点时都需要新的 CPID。这可以通过向 CPID 生成算法添加时间戳来实现。
  2. 从 Offer 中移除 planLanguage，直到这个时候为止，为止都被标记为必填字段。

2019 年 9 月

  1. 添加了对数据失效通知的支持，这与数据到期警告通知不同。

2019 年 7 月

  1. 阐明了可能的客户端标识符值。
  2. 添加了对帐号充值通知的支持。
  3. 宽松的 CPID 生成要求：在每次调用 CPID 端点时都要求提供新的 CPID。
  4. 添加了文档，介绍调用移动流量套餐共享 API 时来自 GTAF 的不同错误响应。

2019 年 6 月

  1. 更新了 DPA API 规范，要求运营商接受 _clientid 作为查询参数。
  2. 更新了 Mobile Data Plan Sharing API，让运营商能够与 Google 分享特定客户端的用户的套餐信息。
  3. 向用户显示优惠的顺序可能与向 GTAF 提供优惠的顺序不同。
  4. 使用移动流量套餐界面时，GTAF 可能会共享 10 个以上的套餐。

2019 年 5 月

  1. Expiration 是必填项，除非方案未过期。
  2. 根据 RFC 6749，在 OAuth 服务器响应中将令牌类型标记为必需。
  3. 返回运营商将套餐状态推送到 GTAF 时向用户发送的通知类型。

2019 年 4 月

  1. 预付费订阅者必须填写 AccountInfo。
  2. 更新了推荐的 CPID 生成方法，以便在生成 CPID 时以纯文本形式添加语言。
  3. 从优惠中移除了对 moreInfoUrl、OperatorLogoUrl 和 purchaseUrl 的支持。 移动流量套餐界面不支持这些字段。此变更可向后兼容。
  4. 添加了对在用户使用随用随付状态使用帐号余额时发送通知的通知。
  5. 从计划模块中移除了对灵活时间窗口的支持。此变更可向后兼容。因此，如果运营商向我们发送灵活时间段，则响应将被接受。

2019 年 3 月

  1. 从一组必填字段中移除 offerInfo.promoMessage。向用户显示优惠时，MDP 不使用此字段。
  2. 修复了文档指出 CPID 必须经过网址编码的错误。GTAF 会根据 RFC2396 对 CPID 进行编码。
  3. 添加了推送通知要求。

2019 年 2 月

  1. 不再支持使用流量套餐共享 API 与 Google 共享 PlanOffer。

2019 年 1 月

  1. 添加了使用 ISP 门户更新运营商配置的指南。
  2. 添加了 Data Plan Agent API 的 OAuth 实现指南。
  3. 已重命名和重新整理 Mobile Data Plan Sharing API 集成指南。

2018 年 11 月

  1. 添加了对方案激活通知的支持。
  2. 添加了对 APP_STORE 计划模块流量类别的支持。

2018 年 9 月

  1. 添加了用于向运营商报告用户同意情况的 API。
  2. 添加了对定期向 PlanModule 和 Offer 刷新配额的方案的支持。
  3. 添加了对到期通知的支持。
  4. PlanModuleState 已重命名为 PlanState。这属于文档变更，应该不会影响运算符。

2018 年 8 月

  1. 添加了让运营商在 PlanStatus 中指定帐号余额的功能。

2018 年 6 月

  1. 移除了更新，获取方案状态和方案优惠的方法。
  2. 允许在填充字节余额或时间余额的同时填充粗略余额。
  3. 为 Offer 添加了连接类型。
  4. 向 PlanModule 添加了“计划模块状态”字段，以允许运营商指明用户已购买但尚未激活的计划。此字段不是必填字段。
  5. DataPlan 已重命名为 Plan。这属于文档变更，应该不会影响运算符。
  6. 向 PlanOffer 添加了 formOfPayment 字段，让运营商能够指定用户如何支付购买交易费用。默认情况下，此金额会从方案余额中扣除。

2018 年 5 月

  1. 更新了 CPID 响应，以确保响应向后兼容。
  2. 为 PlanStatus 添加了标题。标题将用于填充设置界面中的标头。
  3. 为 PlanModule 添加了模块名称和已使用的字节数。
  4. 向 GTAF 添加了购买响应调用。

2018 年 3 月

此更新包含 Data Plan Agent API 的以下更改。这些变更是相对于此处托管的 Data Plan API v4.2 而言的。

  1. 弃用了以下 API 调用：
    1. 正在查询用户帐号 (DPA_网址/{data_plan_key_string}/account)。
    2. 查询购买的方案 (DPA_网址/{data_plan_key_string}/purchasedPlans)。
  2. 更改调用套餐状态的网址。新网址详见此处。DPA 应返回 PlanStatus 实例。
  3. 更改套餐信息的网址。新网址详见此处。DPA 应返回 PlanOffer 实例。
  4. 更改在购买套餐时发送给 DPA 的请求的正文。请注意，API 调用是相同的。请求正文现在包含 TransactionRequest 实例。请注意，与旧版 API 相比，移除了嵌套级别。
  5. 购买请求的响应已更改。我们会利用 Google protobuf 定义的货币类型。在响应购买交易时，我们预计响应正文会包含 TransactionResponse 实例。
  6. 如果未指定 plan_id，资格 API 必须返回用户有资格使用的所有数据计划。以前，这是可选操作。
  7. 为 GTAF 添加 MSISDN 注册端点，以便向 DPA 注册 MSISDN 以接收通知。

Google 移动流量套餐共享 API

2018 年 3 月

此更新包括对 Google 移动流量套餐共享 API 的以下更改：

  1. 引入了新的 API 调用，使运营商能够向 GTAF 推送追加销售优惠信息，从而进一步推送到用户设备。运营商可以通过这些新的调用将优惠推送到 Google。
  2. 在 PlanGroup 中引入了上次更新的时间字段。
  3. 从灵活时间窗口中移除数据功劳百分比字段。