Mobile Data Plan Sharing API
Stay organized with collections
Save and categorize content based on your preferences.
Partner API for mobile network operators to share users' plan status updates with Google.
Service: mobiledataplansharing.googleapis.com
We recommend that you call this service using Google-provided client libraries. If your application needs to call this service using your own libraries, you should use the following information when making the API requests.
Discovery document
A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery document:
Service endpoint
A service endpoint is a base URL that specifies the network address of an API service. One service may have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:
https://mobiledataplansharing.googleapis.com
| Methods |
create |
POST /v1/{parent=operators/*}/clients/{clientId}/users/{userKey}/planStatus
Allows a mobile operator (identified by its unique Autonomous System Number (ASN)) to add new PlanStatus entry for a user to be used by a particular client. |
| Methods |
create
(deprecated) |
POST /v1/{parent=operators/*}/planGroups
Allows a mobile operator (identified by its unique Autonomous System Number (ASN)) to add a new PlanGroup entry. |
| Methods |
create |
POST /v1/{parent=operators/*}/planStatuses
Allows a mobile operator (identified by its unique Autonomous System Number (ASN)) to add new PlanStatus entry. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2023-10-03 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2023-10-03 UTC."],[[["\u003cp\u003eThis API enables mobile network operators to share user plan status updates with Google.\u003c/p\u003e\n"],["\u003cp\u003eIt utilizes REST resources like \u003ccode\u003ev1.operators.clients.users.planStatus\u003c/code\u003e for managing user plan data.\u003c/p\u003e\n"],["\u003cp\u003eOperators can add new plan status entries and manage plan groups using specified methods.\u003c/p\u003e\n"],["\u003cp\u003eThe service is accessible via \u003ccode\u003ehttps://mobiledataplansharing.googleapis.com\u003c/code\u003e and Google-provided client libraries are recommended for interaction.\u003c/p\u003e\n"],["\u003cp\u003eA discovery document is available at \u003ccode\u003e<https://mobiledataplansharing.googleapis.com/$discovery/rest?version=v1>\u003c/code\u003e for API details.\u003c/p\u003e\n"]]],[],null,["# Mobile Data Plan Sharing API\n\nPartner API for mobile network operators to share users' plan status updates with Google.\n\n- [REST Resource: v1.operators.clients.users.planStatus](#v1.operators.clients.users.planStatus)\n- [REST Resource: v1.operators.planGroups](#v1.operators.planGroups)\n- [REST Resource: v1.operators.planStatuses](#v1.operators.planStatuses)\n\nService: mobiledataplansharing.googleapis.com\n---------------------------------------------\n\nWe recommend that you call this service using Google-provided [client libraries](https://cloud.google.com/apis/docs/client-libraries-explained). If your application needs to call this service using your own libraries, you should use the following information when making the API requests.\n\n### Discovery document\n\nA [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery document:\n\n- \u003chttps://mobiledataplansharing.googleapis.com/$discovery/rest?version=v1\u003e\n\n### Service endpoint\n\nA [service endpoint](https://cloud.google.com/apis/design/glossary) is a base URL that specifies the network address of an API service. One service may have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:\n\n- `https://mobiledataplansharing.googleapis.com`\n\nREST Resource: [v1.operators.clients.users.planStatus](/mobile-data-plan/v6_1/reference/rest/v1/operators.clients.users.planStatus)\n-----------------------------------------------------------------------------------------------------------------------------------\n\n| Methods ||\n|----------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [create](/mobile-data-plan/v6_1/reference/rest/v1/operators.clients.users.planStatus/create) | `POST /v1/{parent=operators/*}/clients/{clientId}/users/{userKey}/planStatus` Allows a mobile operator (identified by its unique Autonomous System Number (ASN)) to add new PlanStatus entry for a user to be used by a particular client. |\n\nREST Resource: [v1.operators.planGroups](/mobile-data-plan/v6_1/reference/rest/v1/operators.planGroups)\n-------------------------------------------------------------------------------------------------------\n\n| Methods ||\n|----------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [create](/mobile-data-plan/v6_1/reference/rest/v1/operators.planGroups/create)` ` **(deprecated)** | `POST /v1/{parent=operators/*}/planGroups` Allows a mobile operator (identified by its unique Autonomous System Number (ASN)) to add a new PlanGroup entry. |\n\nREST Resource: [v1.operators.planStatuses](/mobile-data-plan/v6_1/reference/rest/v1/operators.planStatuses)\n-----------------------------------------------------------------------------------------------------------\n\n| Methods ||\n|----------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [create](/mobile-data-plan/v6_1/reference/rest/v1/operators.planStatuses/create) | `POST /v1/{parent=operators/*}/planStatuses` Allows a mobile operator (identified by its unique Autonomous System Number (ASN)) to add new PlanStatus entry. |"]]