CPIDResponse
Stay organized with collections
Save and categorize content based on your preferences.
Response from the CPID endpoint when CPID creation is successful.
| JSON representation |
{
"cpid": string,
"ttlSeconds": number
} |
| Fields |
cpid |
string
Required. Encrypted carrier plan identifier that uniquely identifies the user to the carrier.
|
ttlSeconds |
number
Required. Duration, in seconds, for which the CPID is valid and can be used by GTAF to query the DPA for details of a user's data plan.
|
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\u003eThe CPID endpoint returns a JSON object containing the \u003ccode\u003ecpid\u003c/code\u003e and \u003ccode\u003ettlSeconds\u003c/code\u003e when a carrier plan identifier is successfully created.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ecpid\u003c/code\u003e is an encrypted string that uniquely identifies the user to their carrier.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ettlSeconds\u003c/code\u003e value represents the duration, in seconds, that the CPID is valid and can be used to fetch user data plan details.\u003c/p\u003e\n"]]],["Upon successful CPID creation, the response includes a JSON object containing two key fields. The `cpid` is a required, encrypted string uniquely identifying the user to the carrier. The `ttlSeconds` field, also required, specifies the duration (in seconds) the `cpid` remains valid for use by GTAF to query user data plan details from the DPA. This object represents the core data and validity period of the created CPID.\n"],null,["# CPIDResponse\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n\nResponse from the CPID endpoint when CPID creation is successful.\n\n| JSON representation ||\n|--------------------------------------------------|---|\n| ``` { \"cpid\": string, \"ttlSeconds\": number } ``` |\n\n| Fields ||\n|--------------|--------------------------------------------------------------------------------------------------------------------------------------------------|\n| `cpid` | `string` Required. Encrypted carrier plan identifier that uniquely identifies the user to the carrier. |\n| `ttlSeconds` | `number` Required. Duration, in seconds, for which the CPID is valid and can be used by GTAF to query the DPA for details of a user's data plan. |"]]