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, accurate to nanoseconds. Example: "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, accurate to nanoseconds. Example: "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 deprecated functionality allowed mobile operators to add new PlanGroup entries using a POST request.\u003c/p\u003e\n"],["\u003cp\u003eThe request body includes a \u003ccode\u003eplanGroupId\u003c/code\u003e (a unique identifier) and a \u003ccode\u003eplanGroup\u003c/code\u003e object containing details of the mobile service package.\u003c/p\u003e\n"],["\u003cp\u003eSuccessful responses return a \u003ccode\u003ePlanGroup\u003c/code\u003e object with a name, data plans, and timestamps for data staleness and last update.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization requires the \u003ccode\u003ehttps://www.googleapis.com/auth/dataplansharing\u003c/code\u003e scope.\u003c/p\u003e\n"]]],["This document details the process of adding a new PlanGroup entry for a mobile operator via a POST request to `https://mobiledataplansharing.googleapis.com/v1/{parent=operators/*}/planGroups`. The request requires a `parent` path parameter (operator's resource name) and a JSON request body containing the `planGroupId` and `planGroup` data. A successful request returns a JSON response body with the `name`, `dataPlans`, `responseStaleTime`, and `lastUpdatedTime` of the newly created PlanGroup. Authorization is required using OAuth scope `https://www.googleapis.com/auth/dataplansharing`.\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, accurate to nanoseconds. Example: `\"2014-10-02T15:01:23.045123456Z\"`. \u003cbr /\u003e |\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, accurate to nanoseconds. Example: `\"2014-10-02T15:01:23.045123456Z\"`. \u003cbr /\u003e |\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)."]]