com.google.api.ads.dfp.jaxws.v201711

Interface UserServiceInterface

public interface UserServiceInterface

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().

This class was generated by the JAX-WS RI. JAX-WS RI 2.2.9-b130926.1035 Generated source version: 2.1

Method Summary

Modifier and Type	Method and Description
List<User>	createUsers(List<User> users) Creates new User objects.
List<Role>	getAllRoles() Returns the Role objects that are defined for the users of the network.
User	getCurrentUser() Returns the current User.
UserPage	getUsersByStatement(Statement filterStatement) Gets a UserPage of User objects that satisfy the given Statement.query.
UpdateResult	performUserAction(UserAction userAction, Statement filterStatement) Performs actions on User objects that match the given Statement.query.
List<User>	updateUsers(List<User> users) Updates the specified User objects.

Method Detail

createUsers

@RequestWrapper(localName="createUsers",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201711",
                className="com.google.api.ads.dfp.jaxws.v201711.UserServiceInterfacecreateUsers")
 @ResponseWrapper(localName="createUsersResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201711",
                 className="com.google.api.ads.dfp.jaxws.v201711.UserServiceInterfacecreateUsersResponse")
List<User> createUsers(List<User> users)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    throws ApiException_Exception

Creates new User objects.

Parameters:

users - the users to create

users -

Returns:

the created users with their IDs filled in

Throws:

ApiException_Exception

getAllRoles

@RequestWrapper(localName="getAllRoles",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201711",
                className="com.google.api.ads.dfp.jaxws.v201711.UserServiceInterfacegetAllRoles")
 @ResponseWrapper(localName="getAllRolesResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201711",
                 className="com.google.api.ads.dfp.jaxws.v201711.UserServiceInterfacegetAllRolesResponse")
List<Role> getAllRoles()
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    throws ApiException_Exception

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

Returns:

the roles defined for the user's network

Throws:

ApiException_Exception

getCurrentUser

@RequestWrapper(localName="getCurrentUser",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201711",
                className="com.google.api.ads.dfp.jaxws.v201711.UserServiceInterfacegetCurrentUser")
 @ResponseWrapper(localName="getCurrentUserResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201711",
                 className="com.google.api.ads.dfp.jaxws.v201711.UserServiceInterfacegetCurrentUserResponse")
User getCurrentUser()
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             throws ApiException_Exception

Returns the current User.

Returns:

the current user

Throws:

ApiException_Exception

getUsersByStatement

@RequestWrapper(localName="getUsersByStatement",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201711",
                className="com.google.api.ads.dfp.jaxws.v201711.UserServiceInterfacegetUsersByStatement")
 @ResponseWrapper(localName="getUsersByStatementResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201711",
                 className="com.google.api.ads.dfp.jaxws.v201711.UserServiceInterfacegetUsersByStatementResponse")
UserPage getUsersByStatement(Statement filterStatement)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          throws ApiException_Exception

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

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

Parameters:

filterStatement - a Publisher Query Language statement used to filter a set of users

filterStatement -

Returns:

the users that match the given filter

Throws:

ApiException_Exception

performUserAction

@RequestWrapper(localName="performUserAction",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201711",
                className="com.google.api.ads.dfp.jaxws.v201711.UserServiceInterfaceperformUserAction")
 @ResponseWrapper(localName="performUserActionResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201711",
                 className="com.google.api.ads.dfp.jaxws.v201711.UserServiceInterfaceperformUserActionResponse")
UpdateResult performUserAction(UserAction userAction,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           Statement filterStatement)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    throws ApiException_Exception

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

Parameters:

userAction - the action to perform

filterStatement - a Publisher Query Language statement used to filter a set of users

userAction -

filterStatement -

Returns:

the result of the action performed

Throws:

ApiException_Exception

updateUsers

@RequestWrapper(localName="updateUsers",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201711",
                className="com.google.api.ads.dfp.jaxws.v201711.UserServiceInterfaceupdateUsers")
 @ResponseWrapper(localName="updateUsersResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201711",
                 className="com.google.api.ads.dfp.jaxws.v201711.UserServiceInterfaceupdateUsersResponse")
List<User> updateUsers(List<User> users)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    throws ApiException_Exception

Updates the specified User objects.

Parameters:

users - the users to update

users -

Returns:

the updated users

Throws:

ApiException_Exception