Method: users.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists users that are accessible to the current user. If two users have user roles on the same partner or advertiser, they can access each other.
HTTP request
GET https://displayvideo.googleapis.com/v1beta2/users
The URL uses gRPC Transcoding syntax.
Query parameters
Parameters |
pageSize |
integer
Requested page size. Must be between 1 and 100 . If unspecified will default to 100 .
|
pageToken |
string
A token identifying a page of results the server should return. Typically, this is the value of nextPageToken returned from the previous call to users.list method. If not specified, the first page of results will be returned.
|
orderBy |
string
Field by which to sort the list. Acceptable values are:
The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, displayName desc .
|
filter |
string
Allows filtering by user properties. Supported syntax:
- Filter expressions are made up of one or more restrictions.
- Restrictions can be combined by the logical operator
AND .
- A restriction has the form of
{field} {operator} {value} .
- The operator must be
CONTAINS (:) or EQUALS (=) .
- The operator must be
CONTAINS (:) for the following fields:
- The operator must be
EQUALS (=) for the following fields:
assignedUserRole.userRole
assignedUserRole.partnerId
assignedUserRole.advertiserId
assignedUserRole.entityType : A synthetic field of AssignedUserRole used for filtering. Identifies the type of entity to which the user role is assigned. Valid values are Partner and Advertiser .
assignedUserRole.parentPartnerId : A synthetic field of AssignedUserRole used for filtering. Identifies the parent partner of the entity to which the user role is assigned."
Examples:
- The user with displayName containing
foo : displayName:"foo"
- The user with email containing
bar : email:"bar"
- All users with standard user roles:
assignedUserRole.userRole="STANDARD"
- All users with user roles for partner 123:
assignedUserRole.partnerId="123"
- All users with user roles for advertiser 123:
assignedUserRole.advertiserId="123"
- All users with partner level user roles:
entityType="PARTNER"
- All users with user roles for partner 123 and advertisers under partner 123:
parentPartnerId="123"
The length of this field should be no more than 500 characters.
|
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
JSON representation |
{
"users": [
{
object (User )
}
],
"nextPageToken": string
} |
Fields |
users[] |
object (User )
The list of users. This list will be absent if empty.
|
nextPageToken |
string
A token to retrieve the next page of results. Pass this value in the pageToken field in the subsequent call to users.list method to retrieve the next page of results. This token will be absent if there are no more results to return.
|
Authorization Scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/display-video-user-management
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 2024-09-18 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 2024-09-18 UTC."],[[["Lists users accessible to the current user, including those with shared user roles on the same partner or advertiser."],["Uses the `GET` method with the URL `https://displayvideo.googleapis.com/v1beta2/users` for retrieval."],["Allows filtering and sorting of results with query parameters like `pageSize`, `pageToken`, `orderBy`, and `filter`."],["Response provides a list of users and a token for pagination if more results are available."],["Requires authorization with the `https://www.googleapis.com/auth/display-video-user-management` scope."]]],[]]