Method: accountUserProfiles.list
Stay organized with collections
Save and categorize content based on your preferences.
Retrieves a list of account user profiles, possibly filtered. This method supports paging.
HTTP request
GET https://dfareporting.googleapis.com/dfareporting/v4/userprofiles/{profileId}/accountUserProfiles
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters |
profileId |
string (int64 format)
User profile ID associated with this request.
|
Query parameters
Parameters |
ids[] |
string (int64 format)
Select only user profiles with these IDs.
|
userRoleId |
string (int64 format)
Select only user profiles with the specified user role ID.
|
subaccountId |
string (int64 format)
Select only user profiles with the specified subaccount ID.
|
active |
boolean
Select only active user profiles.
|
maxResults |
integer
Maximum number of results to return.
|
pageToken |
string
Value of the
nextPageToken
from the previous result page.
|
searchString |
string
Allows searching for objects by name, ID or email. Wildcards (
*
) are allowed. For example,
"user profile*2015"
will return objects with names like
"user profile June 2015"
,
"user profile April 2015"
, or simply
"user profile 2015"
. Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of
"user profile"
will match objects with name
"my user profile"
,
"user profile 2015"
, or simply
"user profile"
.
|
sortField |
enum (SortField )
Field by which to sort the list.
|
sortOrder |
enum (SortOrder )
Order of sorted results.
|
Request body
The request body must be empty.
Response body
Account User Profile accountUserProfiles.list Response
If successful, the response body contains data with the following structure:
JSON representation |
{
"kind": string,
"nextPageToken": string,
"accountUserProfiles": [
{
object (AccountUserProfile )
}
]
} |
Fields |
kind |
string
Identifies what kind of resource this is. Value: the fixed string
"dfareporting#accountUserProfilesListResponse"
.
|
nextPageToken |
string
Pagination token to be used for the next list operation.
|
accountUserProfiles[] |
object (AccountUserProfile )
Account user profile collection.
|
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/dfatrafficking
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\u003eRetrieves a list of account user profiles, filtered by ID, user role, sub-account, active status, and other criteria.\u003c/p\u003e\n"],["\u003cp\u003eAllows pagination to retrieve large result sets using \u003ccode\u003epageToken\u003c/code\u003e and \u003ccode\u003emaxResults\u003c/code\u003e parameters.\u003c/p\u003e\n"],["\u003cp\u003eSupports searching for user profiles by name, ID, or email using wildcards.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/dfatrafficking\u003c/code\u003e scope.\u003c/p\u003e\n"],["\u003cp\u003eThe response includes a list of \u003ccode\u003eAccountUserProfile\u003c/code\u003e objects and a \u003ccode\u003enextPageToken\u003c/code\u003e for further navigation.\u003c/p\u003e\n"]]],[],null,["# Method: accountUserProfiles.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.AccountUserProfilesListResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nRetrieves a list of account user profiles, possibly filtered. This method supports [paging](/doubleclick-advertisers/trafficking_tasks#list).\n\n### HTTP request\n\n`GET https://dfareporting.googleapis.com/dfareporting/v4/userprofiles/{profileId}/accountUserProfiles`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|---------------|-----------------------------------------------------------------------------------------------------------------------------------|\n| `profile``Id` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` User profile ID associated with this request. |\n\n### Query parameters\n\n| Parameters ||\n|------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `ids[]` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Select only user profiles with these IDs. |\n| `user``Role``Id` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Select only user profiles with the specified user role ID. |\n| `subaccount``Id` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Select only user profiles with the specified subaccount ID. |\n| `active` | `boolean` Select only active user profiles. |\n| `max``Results` | `integer` Maximum number of results to return. |\n| `page``Token` | `string` Value of the `nextPageToken` from the previous result page. |\n| `search``String` | `string` Allows searching for objects by name, ID or email. Wildcards ( `*` ) are allowed. For example, `\"user profile*2015\"` will return objects with names like `\"user profile June 2015\"` , `\"user profile April 2015\"` , or simply `\"user profile 2015\"` . Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of `\"user profile\"` will match objects with name `\"my user profile\"` , `\"user profile 2015\"` , or simply `\"user profile\"` . |\n| `sort``Field` | `enum (`[SortField](/doubleclick-advertisers/rest/v4/SortField)`)` Field by which to sort the list. |\n| `sort``Order` | `enum (`[SortOrder](/doubleclick-advertisers/rest/v4/SortOrder)`)` Order of sorted results. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nAccount User Profile accountUserProfiles.list Response\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"kind\": string, \"nextPageToken\": string, \"accountUserProfiles\": [ { object (/doubleclick-advertisers/rest/v4/accountUserProfiles#AccountUserProfile) } ] } ``` |\n\n| Fields ||\n|-----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Identifies what kind of resource this is. Value: the fixed string `\"dfareporting#accountUserProfilesListResponse\"` . |\n| `next``Page``Token` | `string` Pagination token to be used for the next list operation. |\n| `account``User``Profiles[]` | `object (`[AccountUserProfile](/doubleclick-advertisers/rest/v4/accountUserProfiles#AccountUserProfile)`)` Account user profile collection. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/dfatrafficking`"]]