GoogleApi.DisplayVideo.V1.Api.Users.displayvideo_users_list
You're seeing just the function
displayvideo_users_list
, go back to GoogleApi.DisplayVideo.V1.Api.Users module for more information.
Link to this function
displayvideo_users_list(connection, optional_params \\ [], opts \\ [])
View SourceSpecs
displayvideo_users_list(Tesla.Env.client(), keyword(), keyword()) :: {:ok, GoogleApi.DisplayVideo.V1.Model.ListUsersResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.DisplayVideo.V1.Connection.t
) - Connection to server -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter
(type:String.t
) - Allows filtering by user properties. Supported syntax: Filter expressions are made up of one or more restrictions. Restrictions can be combined by the logical operatorAND
. A restriction has the form of{field} {operator} {value}
. The operator must beCONTAINS (:)
orEQUALS (=)
. The operator must beCONTAINS (:)
for the following fields: -displayName
-email
The operator must beEQUALS (=)
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 arePartner
andAdvertiser
. -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 containingfoo
:displayName:"foo"
The user with email containingbar
: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. -
:orderBy
(type:String.t
) - 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
. -
:pageSize
(type:integer()
) - Requested page size. Must be between1
and100
. If unspecified will default to100
. -
:pageToken
(type:String.t
) - 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 toListUsers
method. If not specified, the first page of results will be returned.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.DisplayVideo.V1.Model.ListUsersResponse{}}
on success -
{:error, info}
on failure