REST Resource: userProfiles
Stay organized with collections
Save and categorize content based on your preferences.
Resource: UserProfile
A UserProfile resource lets you list all DFA user profiles that are associated with a Google user account. The profileId needs to be specified in other API requests.
JSON representation |
{
"kind": string,
"profileId": string,
"userName": string,
"accountId": string,
"accountName": string,
"subAccountId": string,
"subAccountName": string,
"etag": string
} |
Fields |
kind |
string
Identifies what kind of resource this is. Value: the fixed string
"dfareporting#userProfile"
.
|
profileId |
string (int64 format)
The unique ID of the user profile.
|
userName |
string
The user name.
|
accountId |
string (int64 format)
The account ID to which this profile belongs.
|
accountName |
string
The account name this profile belongs to.
|
subAccountId |
string (int64 format)
The sub account ID this profile belongs to if applicable.
|
subAccountName |
string
The sub account name this profile belongs to if applicable.
|
etag |
string
Etag of this resource.
|
Methods |
|
Gets one user profile by ID. |
|
Retrieves list of user profiles for a user. |
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 2024-10-16 UTC.
[null,null,["Last updated 2024-10-16 UTC."],[[["\u003cp\u003eThe UserProfile resource allows you to manage and access information about DFA user profiles linked to a Google user account.\u003c/p\u003e\n"],["\u003cp\u003eEach profile is identified by a unique \u003ccode\u003eprofileId\u003c/code\u003e and includes details like user name, account and sub-account associations.\u003c/p\u003e\n"],["\u003cp\u003eYou can retrieve individual user profiles using their ID or get a list of all profiles associated with a specific user.\u003c/p\u003e\n"],["\u003cp\u003eThe API provides methods to retrieve (\u003ccode\u003eget\u003c/code\u003e, \u003ccode\u003elist\u003c/code\u003e) user profile data.\u003c/p\u003e\n"]]],[],null,["# REST Resource: userProfiles\n\n- [Resource: UserProfile](#UserProfile)\n - [JSON representation](#UserProfile.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: UserProfile\n---------------------\n\nA UserProfile resource lets you list all DFA user profiles that are associated with a Google user account. The profileId needs to be specified in other API requests.\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"kind\": string, \"profileId\": string, \"userName\": string, \"accountId\": string, \"accountName\": string, \"subAccountId\": string, \"subAccountName\": string, \"etag\": string } ``` |\n\n| Fields ||\n|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Identifies what kind of resource this is. Value: the fixed string `\"dfareporting#userProfile\"` . |\n| `profile``Id` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` The unique ID of the user profile. |\n| `user``Name` | `string` The user name. |\n| `account``Id` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` The account ID to which this profile belongs. |\n| `account``Name` | `string` The account name this profile belongs to. |\n| `sub``Account``Id` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` The sub account ID this profile belongs to if applicable. |\n| `sub``Account``Name` | `string` The sub account name this profile belongs to if applicable. |\n| `etag` | `string` Etag of this resource. |\n\n| Methods ------- ||\n|----------------------------------------------------------------|---------------------------------------------|\n| ### [get](/doubleclick-advertisers/rest/v4/userProfiles/get) | Gets one user profile by ID. |\n| ### [list](/doubleclick-advertisers/rest/v4/userProfiles/list) | Retrieves list of user profiles for a user. |"]]