Struct google_displayvideo1::api::UserListCall
source · pub struct UserListCall<'a, S>where
S: 'a,{ /* private fields */ }Expand description
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. This method has unique authentication requirements. Read the prerequisites in our Managing Users guide before using this method. The “Try this method” feature does not work for this method.
A builder for the list method supported by a user resource.
It is not used directly, but through a UserMethods instance.
§Example
Instantiate a resource method builder
// You can configure optional parameters by calling the respective setters at will, and
// execute the final call using `doit()`.
// Values shown here are possibly random and not representative !
let result = hub.users().list()
.page_token("magna")
.page_size(-83)
.order_by("invidunt")
.filter("et")
.doit().await;Implementations§
source§impl<'a, S> UserListCall<'a, S>
impl<'a, S> UserListCall<'a, S>
sourcepub async fn doit(self) -> Result<(Response<Body>, ListUsersResponse)>
pub async fn doit(self) -> Result<(Response<Body>, ListUsersResponse)>
Perform the operation you have build so far.
sourcepub fn page_token(self, new_value: &str) -> UserListCall<'a, S>
pub fn page_token(self, new_value: &str) -> UserListCall<'a, S>
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.
Sets the page token query property to the given value.
sourcepub fn page_size(self, new_value: i32) -> UserListCall<'a, S>
pub fn page_size(self, new_value: i32) -> UserListCall<'a, S>
Requested page size. Must be between 1 and 200. If unspecified will default to 100.
Sets the page size query property to the given value.
sourcepub fn order_by(self, new_value: &str) -> UserListCall<'a, S>
pub fn order_by(self, new_value: &str) -> UserListCall<'a, S>
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.
Sets the order by query property to the given value.
sourcepub fn filter(self, new_value: &str) -> UserListCall<'a, S>
pub fn filter(self, new_value: &str) -> UserListCall<'a, S>
Allows filtering by user fields. 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 budget.budget_segments.date_range.end_date field must use the LESS THAN (<) operator. * The displayName and emailfield must use theHAS (:)operator. * All other fields must use theEQUALS (=)operator. Supported fields: *assignedUserRole.advertiserId*assignedUserRole.entityType* This is synthetic field ofAssignedUserRoleused for filtering. Identifies the type of entity to which the user role is assigned. Valid values arePartnerandAdvertiser. * assignedUserRole.parentPartnerId* This is a synthetic field ofAssignedUserRoleused for filtering. Identifies the parent partner of the entity to which the user role is assigned. *assignedUserRole.partnerId*assignedUserRole.userRole*displayName*emailExamples: * The user withdisplayNamecontaining "foo":displayName:“foo”* The user withemailcontaining "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. Reference our [filterLIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
Sets the filter query property to the given value.
sourcepub fn delegate(self, new_value: &'a mut dyn Delegate) -> UserListCall<'a, S>
pub fn delegate(self, new_value: &'a mut dyn Delegate) -> UserListCall<'a, S>
The delegate implementation is consulted whenever there is an intermediate result, or if something goes wrong while executing the actual API request.
It should be used to handle progress information, and to implement a certain level of resilience.
Sets the delegate property to the given value.
sourcepub fn param<T>(self, name: T, value: T) -> UserListCall<'a, S>
pub fn param<T>(self, name: T, value: T) -> UserListCall<'a, S>
Set any additional parameter of the query string used in the request. It should be used to set parameters which are not yet available through their own setters.
Please note that this method must not be used to set any of the known parameters which have their own setter method. If done anyway, the request will fail.
§Additional Parameters
- $.xgafv (query-string) - V1 error format.
- access_token (query-string) - OAuth access token.
- alt (query-string) - Data format for response.
- callback (query-string) - JSONP
- fields (query-string) - Selector specifying which fields to include in a partial response.
- key (query-string) - 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 (query-string) - OAuth 2.0 token for the current user.
- prettyPrint (query-boolean) - Returns response with indentations and line breaks.
- quotaUser (query-string) - 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 (query-string) - Legacy upload protocol for media (e.g. “media”, “multipart”).
- upload_protocol (query-string) - Upload protocol for media (e.g. “raw”, “multipart”).
sourcepub fn add_scope<St>(self, scope: St) -> UserListCall<'a, S>
pub fn add_scope<St>(self, scope: St) -> UserListCall<'a, S>
Identifies the authorization scope for the method you are building.
Use this method to actively specify which scope should be used, instead of the default Scope variant
Scope::DisplayVideoUserManagement.
The scope will be added to a set of scopes. This is important as one can maintain access
tokens for more than one scope.
Usually there is more than one suitable scope to authorize an operation, some of which may encompass more rights than others. For example, for listing resources, a read-only scope will be sufficient, a read-write scope will do as well.
sourcepub fn add_scopes<I, St>(self, scopes: I) -> UserListCall<'a, S>
pub fn add_scopes<I, St>(self, scopes: I) -> UserListCall<'a, S>
Identifies the authorization scope(s) for the method you are building.
See Self::add_scope() for details.
sourcepub fn clear_scopes(self) -> UserListCall<'a, S>
pub fn clear_scopes(self) -> UserListCall<'a, S>
Removes all scopes, and no default scope will be used either.
In this case, you have to specify your API-key using the key parameter (see Self::param()
for details).