Method: operators.planGroups.create
Stay organized with collections
Save and categorize content based on your preferences.
Allows a mobile operator (identified by its unique Autonomous System Number (ASN)) to add a new PlanGroup entry.
HTTP request
POST https://mobiledataplansharing.googleapis.com/v1/{parent=operators/*}/planGroups
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
The resource name of the parent resource in the following format: operators/{asn_id}.
|
Request body
The request body contains data with the following structure:
| JSON representation |
{
"planGroupId": string,
"planGroup": {
object (PlanGroup)
}
} |
| Fields |
planGroupId |
string
The planGroupId, which uniquely identifies a subscriber to the mobile network operator. For example, planGroupId can be the mobile station international subscriber directory number (MSISDN) or an encrypted version of MSISDN.
|
planGroup |
object (PlanGroup)
The PlanGroup resource to create.
|
Response body
If successful, the response body contains data with the following structure:
PlanGroup contains details for all top-level mobile service packages a user has purchased.
| JSON representation |
{
"name": string,
"dataPlans": [
{
object (Plan)
}
],
"responseStaleTime": string,
"lastUpdatedTime": string
} |
| Fields |
name |
string
The resource name of the plan group in the following format: operators/{asn_id}/planGroups/{planGroupId}. The name is ignored when creating a PlanGroup entry.
|
dataPlans[] |
object (Plan)
List of data plans owned by this user.
|
responseStaleTime |
string (Timestamp format)
Time when the shared plan group information becomes outdated. PlanGroup will not be served to applications after this time. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
|
lastUpdatedTime |
string (Timestamp format)
Time when the data plan agent (DPA) fetched the data plan status information from backend systems. Will be used to determine how recent is the data plan status information. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
|
Authorization Scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/dataplansharing
For more information, see the OAuth 2.0 Overview.
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 document describes how a mobile operator can add a new PlanGroup entry using the \u003ccode\u003ePOST\u003c/code\u003e method to \u003ccode\u003ehttps://mobiledataplansharing.googleapis.com/v1/{parent=operators/*}/planGroups\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe request body should contain the \u003ccode\u003eplanGroupId\u003c/code\u003e (a unique identifier for the subscriber) and the \u003ccode\u003eplanGroup\u003c/code\u003e object with details of the new plan group.\u003c/p\u003e\n"],["\u003cp\u003eA successful response will include the \u003ccode\u003ename\u003c/code\u003e of the created plan group, details of associated \u003ccode\u003edataPlans\u003c/code\u003e, and timestamps indicating the staleness and last update time of the information.\u003c/p\u003e\n"],["\u003cp\u003eThis operation requires the \u003ccode\u003ehttps://www.googleapis.com/auth/dataplansharing\u003c/code\u003e OAuth scope for authorization.\u003c/p\u003e\n"]]],[],null,["# Method: operators.planGroups.create\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n - [JSON representation](#body.PlanGroup.SCHEMA_REPRESENTATION)\n- [Authorization Scopes](#body.aspect)\n\n| This item is deprecated!\nAllows a mobile operator (identified by its unique Autonomous System Number (ASN)) to add a new PlanGroup entry.\n\n### HTTP request\n\n`POST https://mobiledataplansharing.googleapis.com/v1/{parent=operators/*}/planGroups`\n\nThe URL uses [gRPC Transcoding](https://github.com/googleapis/googleapis/blob/master/google/api/http.proto) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|--------------------------------------------------------------------------------------------------|\n| `parent` | `string` The resource name of the parent resource in the following format: `operators/{asn_id}`. |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation ||\n|---------------------------------------------------------------------------------------------------------------------------------------------|---|\n| ``` { \"planGroupId\": string, \"planGroup\": { object (/mobile-data-plan/reference/rest/v1/operators.planGroups/create#body.PlanGroup) } } ``` |\n\n| Fields ||\n|---------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `planGroupId` | `string` The planGroupId, which uniquely identifies a subscriber to the mobile network operator. For example, planGroupId can be the mobile station international subscriber directory number (MSISDN) or an encrypted version of MSISDN. |\n| `planGroup` | `object (`[PlanGroup](/mobile-data-plan/reference/rest/v1/operators.planGroups/create#body.PlanGroup)`)` The PlanGroup resource to create. |\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\n| This item is deprecated!\nPlanGroup contains details for all top-level mobile service packages a user has purchased.\n\n| JSON representation ||\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| ``` { \"name\": string, \"dataPlans\": [ { object (/mobile-data-plan/reference/rest/v1/operators.clients.users.planStatus#PlanStatus.Plan) } ], \"responseStaleTime\": string, \"lastUpdatedTime\": string } ``` |\n\n| Fields ||\n|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` The resource name of the plan group in the following format: `operators/{asn_id}/planGroups/{planGroupId}`. The name is ignored when creating a PlanGroup entry. |\n| `dataPlans[]` | `object (`[Plan](/mobile-data-plan/reference/rest/v1/operators.clients.users.planStatus#PlanStatus.Plan)`)` List of data plans owned by this user. |\n| `responseStaleTime` | `string (`[Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Timestamp)` format)` Time when the shared plan group information becomes outdated. PlanGroup will not be served to applications after this time. A timestamp in RFC3339 UTC \"Zulu\" format, with nanosecond resolution and up to nine fractional digits. Examples: `\"2014-10-02T15:01:23Z\"` and `\"2014-10-02T15:01:23.045123456Z\"`. |\n| `lastUpdatedTime` | `string (`[Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Timestamp)` format)` Time when the data plan agent (DPA) fetched the data plan status information from backend systems. Will be used to determine how recent is the data plan status information. A timestamp in RFC3339 UTC \"Zulu\" format, with nanosecond resolution and up to nine fractional digits. Examples: `\"2014-10-02T15:01:23Z\"` and `\"2014-10-02T15:01:23.045123456Z\"`. |\n\n### Authorization Scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/dataplansharing`\n\nFor more information, see the [OAuth 2.0 Overview](https://developers.google.com/identity/protocols/OAuth2)."]]