Data Plan Agent API

October 2019

  1. Require a new CPID every time we contact the CPID endpoint. This can be accomplished by adding a timestamp to the CPID generation algorithm.
  2. Remove planLanguage from Offer which until now was marked as a required field.

September 2019

  1. Added support for data expiration notifications, distinguished from data expiration warning notifications.

July 2019

  1. Clarified the possible client identifier values.
  2. Added support for account top up notifications.
  3. Relaxed CPID generation requirements from requiring a new CPID every time the CPID endpoint is called.
  4. Add documentation for different error responses from GTAF when calling Mobile Data Plan Sharing API.

June 2019

  1. Updated DPA API specification requiring carriers to accept a _clientid as a query parameter.
  2. Updated Mobile Data Plan Sharing API allowing carriers to share plan information of a user for a particular client with Google.
  3. The order in which offers are shown to the user may not be the same as the order in which offers are given to GTAF.
  4. GTAF may share more than 10 plans with Mobile Data Plan UI.

May 2019

  1. ExpirationTime is required unless the plan does not expire.
  2. Per RFC 6749, mark token_type as required in OAuth server response.
  3. Return the type of notifications that have been sent to the user when the carrier pushes a plan status to GTAF.

April 2019

  1. AccountInfo is required for prepaid subscribers.
  2. Update recommended CPID generation method to include language in the plain text when generating CPID.
  3. Removed support for moreInfoUrl, operatorLogoUrl, purchaseUrl from offers. These fields were not supported by the mobile data plan UI. The change is backwards compatible.
  4. Added support for sending notifications when a user is spending account balance using data in a pay as you go state.
  5. Removed support for flex time windows from plan modules. The change is backwards compatible. So, if an operator is sending us flex time windows, the response will be accepted.

March 2019

  1. Remove offerInfo.promoMessage from the set of required fields. MDP does not use this field when showing offers to the users.
  2. Fix documentation bug saying that the CPID must be URL encoded. Instead, GTAF encodes the CPID per RFC2396.
  3. Added requirements for push notifications.

February 2019

  1. Removed support for sharing PlanOffer with Google using data plan sharing API.

January 2019

  1. Added guide for updating carrier configuration using the ISP portal.
  2. Added guide for OAuth implementation for the Data Plan Agent API.
  3. Renamed and reorganized the Mobile Data Plan Sharing API integration guide.

November 2018

  1. Added support for plan activation notifications.
  2. Added support for an APP_STORE plan module traffic category.

September 2018

  1. Added API to report user consent to operators.
  2. Added support for plans that periodically refresh their quota to PlanModule and Offer.
  3. Added support for expiry notifications.
  4. Renamed PlanModuleState to PlanState. This is a documentation change that should not affect operators.

August 2018

  1. Added the ability for carriers to specify account balance as part of a PlanStatus.

June 2018

  1. Removed update, get methods for plan status and plan offers.
  2. Allowed coarse balance level to be populated at the same time when byte balance or time balance are populated.
  3. Added connection type to an Offer.
  4. Added plan module state field to PlanModule to allow an operator to indicate plans which the user has bought but have not been activated yet. This is not a required field.
  5. DataPlan renamed to Plan. This is a documentation change that should not affect operators.
  6. Added formOfPayment field to PlanOffer allowing an operator to specify how the user will be charged for the purchase. This defaults to deducted from plan balance.

May 2018

  1. Updated CPID response to keep the response backwards compatible.
  2. Added title for a PlanStatus. The title will be used to populate the header in the settings UI.
  3. Added module name and used bytes for a PlanModule.
  4. Added a purchase response call back to GTAF.

March 2018

This update includes the following changes to the Data Plan Agent API. These changes are relative to Data Plan API v4.2 hosted here.

  1. Deprecates the following API calls:
    1. Querying user account (DPA_URL/{data_plan_key_string}/account).
    2. Querying purchased plans (DPA_URL/{data_plan_key_string}/purchasedPlans).
  2. Changes the URL we call for data plan status. The new URL is described here. The DPA is expected to return an instance of PlanStatus.
  3. Changes the URL we call for plan offers. The new URL is described here. The DPA is expected to return an instance of PlanOffer.
  4. Changes the body of the request sent to DPA when purchasing a plan. Note that API call is the same. The body of the request now contains an instance of TransactionRequest. Note the removal of a level of nesting compared to the previous version of the API.
  5. Response to a purchase request has changed. We take advantage of currency type defined by Google protobuf. In response to a successful purchase, we expect the response body to contain an instance of TransactionResponse.
  6. If a plan_id is not specified, then the eligibility API MUST return all the data plans that the user is eligible for. Previously this was optional.
  7. Adds an MSISDN registration endpoint for GTAF to register MSISDNs for notifications with the DPA.

Google Mobile Data Plan Sharing API

March 2018

This update includes the following changes to the Google Mobile Data Plan Sharing API:

  1. Introduces new API calls allowing an operator to push upsell offer information to GTAF to be pushed further down to user devices. These new calls allow an operator to push offers to Google.
  2. Introduces a last updated time field in a PlanGroup.
  3. Removes data credit percentage field from flex time window.