Method: operators.clients.users.planStatus.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 new PlanStatus entry for a user to be used by a particular client.
HTTP request
POST https://mobiledataplansharing.googleapis.com/v1/{parent=operators/*}/clients/{clientId}/users/{userKey}/planStatus
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}.
|
clientId |
string
Client for which the plan status is being shared with Google. The client ids supported are mobiledataplan and youtube.
|
userKey |
string
User key identifiying the user whose plan status is being created.
|
Request body
The request body contains an instance of PlanStatus.
Response body
If successful, the response body contains a newly created instance of PlanStatus.
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 API endpoint allows mobile operators to add new plan status entries for users.\u003c/p\u003e\n"],["\u003cp\u003eThe request must include the operator's ASN, client ID (mobiledataplan or youtube), and a user key.\u003c/p\u003e\n"],["\u003cp\u003eBoth the request and response bodies utilize the \u003ccode\u003ePlanStatus\u003c/code\u003e object for data transfer.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization requires the \u003ccode\u003ehttps://www.googleapis.com/auth/dataplansharing\u003c/code\u003e scope.\u003c/p\u003e\n"],["\u003cp\u003eThe endpoint uses a POST request to \u003ccode\u003ehttps://mobiledataplansharing.googleapis.com/v1/{parent=operators/*}/clients/{clientId}/users/{userKey}/planStatus\u003c/code\u003e.\u003c/p\u003e\n"]]],["A mobile operator uses a POST request to add a new `PlanStatus` entry for a specific user. The request targets a URL structured with `parent` (operator ASN), `clientId` (e.g., mobiledataplan, youtube), and `userKey`. The request body includes `PlanStatus` data, and a successful response returns a new `PlanStatus` instance. Authorization requires the `https://www.googleapis.com/auth/dataplansharing` OAuth scope. The core action is adding a new PlanStatus for a user.\n"],null,["# Method: operators.clients.users.planStatus.create\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization Scopes](#body.aspect)\n\nAllows 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\n### HTTP request\n\n`POST https://mobiledataplansharing.googleapis.com/v1/{parent=operators/*}/clients/{clientId}/users/{userKey}/planStatus`\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| `clientId` | `string` Client for which the plan status is being shared with Google. The client ids supported are mobiledataplan and youtube. |\n| `userKey` | `string` User key identifiying the user whose plan status is being created. |\n\n### Request body\n\nThe request body contains an instance of [PlanStatus](/mobile-data-plan/reference/rest/v1/operators.clients.users.planStatus#PlanStatus).\n\n### Response body\n\nIf successful, the response body contains a newly created instance of [PlanStatus](/mobile-data-plan/reference/rest/v1/operators.clients.users.planStatus#PlanStatus).\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)."]]