Data Plan Agent API
2019 年 12 月
- DPA が実装する register CPID API 定義を導入しました。
- クライアントが新しい CPID をリクエストしたときに CPID を生成して保存する方法に関する提案を追加しました。
- 通知の送信に使用する CPID を選択する方法に関するドキュメントを追加しました。
- GTAF が DPA を呼び出す場合と DPA が GTAF を呼び出す場合に、ユーザーの言語設定を決定する方法を明確にしました。
2019 年 10 月
- CPID エンドポイントにアクセスするたびに新しい CPID が必要になります。これは、CPID 生成アルゴリズムにタイムスタンプを追加することで実現できます。
- これまで必須フィールドとしてマークされていた Offer から planLanguage を削除します。
2019 年 9 月
- データ有効期限通知のサポートを追加しました。データ有効期限警告通知とは区別されます。
2019 年 7 月
- クライアント ID の値の可能性を明確にしました。
- アカウントのチャージ通知のサポートを追加しました。
- CPID エンドポイントが呼び出されるたびに新しい CPID が必要になるという CPID 生成要件を緩和。
- Mobile Data Plan Sharing API を呼び出す際の GTAF からのさまざまなエラー レスポンスに関するドキュメントを追加
2019 年 6 月
- 運送業者が _clientid をクエリ パラメータとして受け入れることを義務付ける DPA API 仕様を更新しました。
- 携帯通信会社が特定のクライアントのユーザーのプラン情報を Google と共有できるようにする、モバイル データプラン共有 API を更新しました。
- ユーザーに表示される特典の順序は、GTAF に提供される特典の順序と同じではない場合があります。
- GTAF は、モバイルデータ プラン UI と 10 個以上のプランを共有する場合があります。
2019 年 5 月
- プランに有効期限がない場合を除き、ExpirationTime は必須です。
- RFC 6749 に基づき、OAuth サーバー レスポンスで token_type を必須としてマークします。
- 携帯通信会社がプランのステータスを GTAF にプッシュしたときに、ユーザーに送信された通知のタイプを返します。
2019 年 4 月
- プリペイドの定期購入者には AccountInfo が必要です。
- CPID を生成する際に、プレーン テキストに言語を含めるように、推奨される CPID 生成方法を更新しました。
- オファーから moreInfoUrl、operatorLogoUrl、purchaseUrl のサポートを削除しました。これらのフィールドは、モバイル データプランの UI でサポートされていませんでした。この変更には下位互換性があります。
- 従量課金制の状態でデータを使用してユーザーがアカウント残高を消費している場合に通知を送信するサポートを追加しました。
- プラン モジュールから柔軟な時間枠のサポートを削除しました。この変更には下位互換性があります。したがって、オペレーターがフレックス時間枠を送信すると、レスポンスは受け入れられます。
2019 年 3 月
- 必須フィールドのセットから offerInfo.promoMessage を削除します。MDP は、ユーザーに特典を表示する際にこのフィールドを使用しません。
- CPID を URL エンコードする必要があるというドキュメントのバグを修正しました。代わりに、GTAF は RFC2396 に従って CPID をエンコードします。
- プッシュ通知の要件を追加しました。
2019 年 2 月
- データプラン共有 API を使用して Google と PlanOffer を共有するサポートを削除しました。
2019 年 1 月
- ISP ポータルを使用して携帯通信会社の構成を更新するためのガイドを追加しました。
- データプラン エージェント API の OAuth 実装のガイドを追加しました。
- Mobile Data Plan Sharing API 統合ガイドの名前を変更し、再編成しました。
2018 年 11 月
- プランのアクティベーション通知のサポートを追加しました。
- APP_STORE プラン モジュールのトラフィック カテゴリのサポートを追加しました。
2018 年 9 月
- ユーザーの同意を事業者に報告する API を追加しました。
- PlanModule と Offer に、割り当てを定期的に更新するプランのサポートを追加しました。
- 有効期限の通知のサポートを追加しました。
- PlanModuleState の名前を PlanState に変更しました。これはドキュメントの変更であり、オペレーターに影響することはありません。
2018 年 8 月
- 携帯通信会社が PlanStatus の一部としてアカウント残高を指定できる機能を追加しました。
2018 年 6 月
- プランのステータスとプランの特典の更新メソッドと取得メソッドを削除しました。
- バイト残高または時間残高が入力されると同時に、粗い残高レベルが入力されるようになりました。
- Offer に接続タイプを追加しました。
- PlanModule に plan module state フィールドを追加しました。これにより、ユーザーが購入したもののまだ有効化されていないプランをオペレーターが示すことができます。このフィールドは必須ではありません。
- DataPlan の名前が Plan に変更されました。これはオペレーターに影響しないドキュメントの変更です。
- PlanOffer に formOfPayment フィールドを追加しました。これにより、事業者はユーザーが購入料金を支払う方法を指定できます。デフォルトでは、プランの残高から差し引かれます。
2018 年 5 月
- レスポンスの下位互換性を維持するために、CPID レスポンスを更新しました。
- PlanStatus のタイトルを追加しました。このタイトルは、設定 UI のヘッダーに値を設定するために使用されます。
- PlanModule のモジュール名と使用済みバイト数を追加しました。
- GTAF に購入レスポンス コールバックを追加しました。
2018 年 3 月
このアップデートには、データプラン エージェント API の次の変更が含まれています。これらの変更は、こちらでホストされている Data Plan API v4.2 に関連しています。
- 次の API 呼び出しを非推奨にします。
- ユーザー アカウントのクエリ(DPA_URL/{data_plan_key_string}/account)。
- 購入したプランのクエリ(DPA_URL/{data_plan_key_string}/purchasedPlans)。
- データプランのステータスを呼び出す URL を変更します。新しい URL については、こちらをご覧ください。DPA は PlanStatus のインスタンスを返すことが想定されています。
- プラン オファーの呼び出しに使用する URL を変更します。新しい URL については、こちらをご覧ください。DPA は PlanOffer のインスタンスを返すことが想定されています。
- プランを購入する際に DPA に送信されるリクエストの本文を変更します。API 呼び出しは同じです。リクエストの本文には TransactionRequest のインスタンスが含まれるようになりました。以前のバージョンの API と比較して、ネストのレベルが削除されていることに注意してください。
- 購入リクエストへの回答が変更されました。Google protobuf で定義された通貨型を利用します。購入が成功した場合、レスポンスの本文には TransactionResponse のインスタンスが含まれていることが想定されます。
plan_id
が指定されていない場合、利用資格 API は、ユーザーが利用資格のあるすべてのデータプランを返さなければなりません。以前は省略可能でした。- GTAF が DPA に通知用の MSISDN を登録するための MSISDN 登録エンドポイントを追加します。
Google Mobile Data Plan Sharing API
2018 年 3 月
このアップデートには、Google Mobile Data Plan Sharing API の以下の変更が含まれています。
- 新しい API 呼び出しを導入し、事業者がアップセル オファー情報を GTAF にプッシュして、ユーザーのデバイスにプッシュできるようにします。これらの新しい呼び出しにより、オペレーターは特典を Google にプッシュできます。
- PlanGroup に最終更新日時フィールドを導入します。
- 柔軟な時間枠からデータ クレジットの割合フィールドを削除します。