Ads API .NET library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | List of all members
Google.Api.Ads.AdManager.v202311.UserService Class Reference

Provides operations for creating, updating and retrieving User objects. More...

Inheritance diagram for Google.Api.Ads.AdManager.v202311.UserService:
Google.Api.Ads.AdManager.v202311.IUserService Google.Api.Ads.AdManager.v202311.UserServiceInterface

Public Member Functions

 UserService ()
 Creates a new instance of the UserService class. More...
 
 UserService (string endpointConfigurationName)
 Creates a new instance of the UserService class. More...
 
 UserService (string endpointConfigurationName, string remoteAddress)
 Creates a new instance of the UserService class. More...
 
 UserService (string endpointConfigurationName, System.ServiceModel.EndpointAddress remoteAddress)
 Creates a new instance of the UserService class. More...
 
 UserService (System.ServiceModel.Channels.Binding binding, System.ServiceModel.EndpointAddress remoteAddress)
 Creates a new instance of the UserService class. More...
 
virtual
Google.Api.Ads.AdManager.v202311.User[] 		createUsers (Google.Api.Ads.AdManager.v202311.User[] users)
 Creates new User objects. More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202311.User[]> 		createUsersAsync (Google.Api.Ads.AdManager.v202311.User[] users)
 
virtual
Google.Api.Ads.AdManager.v202311.Role[] 		getAllRoles ()
 Returns the Role objects that are defined for the users of the network. More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202311.Role[]> 		getAllRolesAsync ()
 
virtual
Google.Api.Ads.AdManager.v202311.User 		getCurrentUser ()
 Returns the current User. More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202311.User > 		getCurrentUserAsync ()
 
virtual
Google.Api.Ads.AdManager.v202311.UserPage 		getUsersByStatement (Google.Api.Ads.AdManager.v202311.Statement filterStatement)
 Gets a UserPage of User objects that satisfy the given Statement::query. The following fields are supported for filtering: More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202311.UserPage > 		getUsersByStatementAsync (Google.Api.Ads.AdManager.v202311.Statement filterStatement)
 
virtual
Google.Api.Ads.AdManager.v202311.UpdateResult 		performUserAction (Google.Api.Ads.AdManager.v202311.UserAction userAction, Google.Api.Ads.AdManager.v202311.Statement filterStatement)
 Performs actions on User objects that match the given Statement::query. More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202311.UpdateResult > 		performUserActionAsync (Google.Api.Ads.AdManager.v202311.UserAction userAction, Google.Api.Ads.AdManager.v202311.Statement filterStatement)
 
virtual
Google.Api.Ads.AdManager.v202311.User[] 		updateUsers (Google.Api.Ads.AdManager.v202311.User[] users)
 Updates the specified User objects. More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202311.User[]> 		updateUsersAsync (Google.Api.Ads.AdManager.v202311.User[] users)
 

Detailed Description

Provides operations for creating, updating and retrieving User objects.

A user is assigned one of several different roles. Each Role type has a unique ID that is used to identify that role in an organization. Role types and their IDs can be retrieved by invoking #getAllRoles.

Constructor & Destructor Documentation

Google.Api.Ads.AdManager.v202311.UserService.UserService ( )
inline

Creates a new instance of the UserService class.

Google.Api.Ads.AdManager.v202311.UserService.UserService ( string  endpointConfigurationName)
inline

Creates a new instance of the UserService class.

Google.Api.Ads.AdManager.v202311.UserService.UserService ( string  endpointConfigurationName,
string  remoteAddress 
)
inline

Creates a new instance of the UserService class.

Google.Api.Ads.AdManager.v202311.UserService.UserService ( string  endpointConfigurationName,
System.ServiceModel.EndpointAddress  remoteAddress 
)
inline

Creates a new instance of the UserService class.

Google.Api.Ads.AdManager.v202311.UserService.UserService ( System.ServiceModel.Channels.Binding  binding,
System.ServiceModel.EndpointAddress  remoteAddress 
)
inline

Creates a new instance of the UserService class.

Member Function Documentation

virtual Google.Api.Ads.AdManager.v202311.User [] Google.Api.Ads.AdManager.v202311.UserService.createUsers ( Google.Api.Ads.AdManager.v202311.User[]  users)
inlinevirtual

Creates new User objects.

Implements Google.Api.Ads.AdManager.v202311.IUserService.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202311.User[]> Google.Api.Ads.AdManager.v202311.UserService.createUsersAsync ( Google.Api.Ads.AdManager.v202311.User[]  users)
inlinevirtual

Implements Google.Api.Ads.AdManager.v202311.IUserService.

virtual Google.Api.Ads.AdManager.v202311.Role [] Google.Api.Ads.AdManager.v202311.UserService.getAllRoles ( )
inlinevirtual

Returns the Role objects that are defined for the users of the network.

Implements Google.Api.Ads.AdManager.v202311.IUserService.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202311.Role[]> Google.Api.Ads.AdManager.v202311.UserService.getAllRolesAsync ( )
inlinevirtual

Implements Google.Api.Ads.AdManager.v202311.IUserService.

virtual Google.Api.Ads.AdManager.v202311.User Google.Api.Ads.AdManager.v202311.UserService.getCurrentUser ( )
inlinevirtual

Returns the current User.

Implements Google.Api.Ads.AdManager.v202311.UserServiceInterface.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202311.User> Google.Api.Ads.AdManager.v202311.UserService.getCurrentUserAsync ( )
inlinevirtual

Implements Google.Api.Ads.AdManager.v202311.UserServiceInterface.

virtual Google.Api.Ads.AdManager.v202311.UserPage Google.Api.Ads.AdManager.v202311.UserService.getUsersByStatement ( Google.Api.Ads.AdManager.v202311.Statement  filterStatement)
inlinevirtual

Gets a UserPage of User objects that satisfy the given Statement::query. The following fields are supported for filtering:

PQL Property Object Property
email User::email
id User::id
name User::name
roleId User::roleId
rolename User::roleName
status ACTIVE if User::isActive is true; INACTIVE otherwise

Implements Google.Api.Ads.AdManager.v202311.UserServiceInterface.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202311.UserPage> Google.Api.Ads.AdManager.v202311.UserService.getUsersByStatementAsync ( Google.Api.Ads.AdManager.v202311.Statement  filterStatement)
inlinevirtual

Implements Google.Api.Ads.AdManager.v202311.UserServiceInterface.

virtual Google.Api.Ads.AdManager.v202311.UpdateResult Google.Api.Ads.AdManager.v202311.UserService.performUserAction ( Google.Api.Ads.AdManager.v202311.UserAction  userAction,
Google.Api.Ads.AdManager.v202311.Statement  filterStatement 
)
inlinevirtual

Performs actions on User objects that match the given Statement::query.

Implements Google.Api.Ads.AdManager.v202311.UserServiceInterface.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202311.UpdateResult> Google.Api.Ads.AdManager.v202311.UserService.performUserActionAsync ( Google.Api.Ads.AdManager.v202311.UserAction  userAction,
Google.Api.Ads.AdManager.v202311.Statement  filterStatement 
)
inlinevirtual

Implements Google.Api.Ads.AdManager.v202311.UserServiceInterface.

virtual Google.Api.Ads.AdManager.v202311.User [] Google.Api.Ads.AdManager.v202311.UserService.updateUsers ( Google.Api.Ads.AdManager.v202311.User[]  users)
inlinevirtual

Updates the specified User objects.

Implements Google.Api.Ads.AdManager.v202311.IUserService.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202311.User[]> Google.Api.Ads.AdManager.v202311.UserService.updateUsersAsync ( Google.Api.Ads.AdManager.v202311.User[]  users)
inlinevirtual

Implements Google.Api.Ads.AdManager.v202311.IUserService.

The documentation for this class was generated from the following file: