Method: operators.clients.users.planStatus.create

AI-generated Key Takeaways

• This API endpoint allows mobile operators to add new plan status entries for users.

• The request must include the operator's ASN, client ID (mobiledataplan or youtube), and a user key.

• Both the request and response bodies utilize the PlanStatus object for data transfer.

• Authorization requires the https://www.googleapis.com/auth/dataplansharing scope.

• The endpoint uses a POST request to https://mobiledataplansharing.googleapis.com/v1/{parent=operators/*}/clients/{clientId}/users/{userKey}/planStatus.

• HTTP request
• Path parameters
• Request body
• Response body
• Authorization Scopes

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.