Ads API .NET library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Google.Api.Ads.AdManager.v202208.UserService Class Reference

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

Inheritance diagram for Google.Api.Ads.AdManager.v202208.UserService:
Google.Api.Ads.AdManager.v202208.IUserService Google.Api.Ads.AdManager.v202208.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.v202208.User[] 
createUsers (Google.Api.Ads.AdManager.v202208.User[] users)
 Creates new User objects. More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202208.User[]> 
createUsersAsync (Google.Api.Ads.AdManager.v202208.User[] users)
 
virtual
Google.Api.Ads.AdManager.v202208.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.v202208.Role[]> 
getAllRolesAsync ()
 
virtual
Google.Api.Ads.AdManager.v202208.User 
getCurrentUser ()
 Returns the current User. More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202208.User
getCurrentUserAsync ()
 
virtual
Google.Api.Ads.AdManager.v202208.UserPage 
getUsersByStatement (Google.Api.Ads.AdManager.v202208.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.v202208.UserPage
getUsersByStatementAsync (Google.Api.Ads.AdManager.v202208.Statement filterStatement)
 
virtual
Google.Api.Ads.AdManager.v202208.UpdateResult 
performUserAction (Google.Api.Ads.AdManager.v202208.UserAction userAction, Google.Api.Ads.AdManager.v202208.Statement filterStatement)
 Performs actions on User objects that match the given Statement::query. More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202208.UpdateResult
performUserActionAsync (Google.Api.Ads.AdManager.v202208.UserAction userAction, Google.Api.Ads.AdManager.v202208.Statement filterStatement)
 
virtual
Google.Api.Ads.AdManager.v202208.User[] 
updateUsers (Google.Api.Ads.AdManager.v202208.User[] users)
 Updates the specified User objects. More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202208.User[]> 
updateUsersAsync (Google.Api.Ads.AdManager.v202208.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.v202208.UserService.UserService ( )
inline

Creates a new instance of the UserService class.

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

Creates a new instance of the UserService class.

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

Creates a new instance of the UserService class.

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

Creates a new instance of the UserService class.

Google.Api.Ads.AdManager.v202208.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.v202208.User [] Google.Api.Ads.AdManager.v202208.UserService.createUsers ( Google.Api.Ads.AdManager.v202208.User[]  users)
inlinevirtual

Creates new User objects.

Parameters
usersthe users to create
Returns
the created users with their IDs filled in

Implements Google.Api.Ads.AdManager.v202208.IUserService.

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

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

Returns
the roles defined for the user's network

Implements Google.Api.Ads.AdManager.v202208.IUserService.

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

Returns the current User.

Returns
the current user

Implements Google.Api.Ads.AdManager.v202208.UserServiceInterface.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202208.User> Google.Api.Ads.AdManager.v202208.UserService.getCurrentUserAsync ( )
inlinevirtual
virtual Google.Api.Ads.AdManager.v202208.UserPage Google.Api.Ads.AdManager.v202208.UserService.getUsersByStatement ( Google.Api.Ads.AdManager.v202208.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
Parameters
filterStatementa Publisher Query Language statement used to filter a set of users
Returns
the users that match the given filter

Implements Google.Api.Ads.AdManager.v202208.UserServiceInterface.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202208.UserPage> Google.Api.Ads.AdManager.v202208.UserService.getUsersByStatementAsync ( Google.Api.Ads.AdManager.v202208.Statement  filterStatement)
inlinevirtual
virtual Google.Api.Ads.AdManager.v202208.UpdateResult Google.Api.Ads.AdManager.v202208.UserService.performUserAction ( Google.Api.Ads.AdManager.v202208.UserAction  userAction,
Google.Api.Ads.AdManager.v202208.Statement  filterStatement 
)
inlinevirtual

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

Parameters
userActionthe action to perform
filterStatementa Publisher Query Language statement used to filter a set of users
Returns
the result of the action performed

Implements Google.Api.Ads.AdManager.v202208.UserServiceInterface.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202208.UpdateResult> Google.Api.Ads.AdManager.v202208.UserService.performUserActionAsync ( Google.Api.Ads.AdManager.v202208.UserAction  userAction,
Google.Api.Ads.AdManager.v202208.Statement  filterStatement 
)
inlinevirtual
virtual Google.Api.Ads.AdManager.v202208.User [] Google.Api.Ads.AdManager.v202208.UserService.updateUsers ( Google.Api.Ads.AdManager.v202208.User[]  users)
inlinevirtual

Updates the specified User objects.

Parameters
usersthe users to update
Returns
the updated users

Implements Google.Api.Ads.AdManager.v202208.IUserService.

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

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