Class UsersResource.ListRequest
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.
Inheritance
Inherited Members
Namespace: Google.Apis.DisplayVideo.v1
Assembly: Google.Apis.DisplayVideo.v1.dll
Syntax
public class ListRequest : DisplayVideoBaseServiceRequest<ListUsersResponse>, IClientServiceRequest<ListUsersResponse>, IClientServiceRequestConstructors
ListRequest(IClientService)
Constructs a new List request.
Declaration
public ListRequest(IClientService service)Parameters
| Type | Name | Description |
|---|---|---|
| IClientService | service |
Properties
Filter
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: - displayName - email * 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.
Declaration
[RequestParameter("filter", RequestParameterType.Query)]
public virtual string Filter { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
HttpMethod
Gets the HTTP method.
Declaration
public override string HttpMethod { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Overrides
MethodName
Gets the method name.
Declaration
public override string MethodName { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Overrides
OrderBy
Field by which to sort the list. Acceptable values are: * displayName (default) 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.
Declaration
[RequestParameter("orderBy", RequestParameterType.Query)]
public virtual string OrderBy { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
PageSize
Requested page size. Must be between 1 and 200. If unspecified will default to 100.
Declaration
[RequestParameter("pageSize", RequestParameterType.Query)]
public virtual int? PageSize { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int32> |
PageToken
A token identifying a page of results the server should return. Typically, this is the value of
next_page_token returned from the previous call to ListUsers method. If not specified, the first page
of results will be returned.
Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
RestPath
Gets the REST path.
Declaration
public override string RestPath { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Overrides
Methods
InitParameters()
Initializes List parameter list.
Declaration
protected override void InitParameters()