com.google.api.ads.dfp.axis.v201403

Interface UserServiceInterface

All Superinterfaces:

Remote

All Known Implementing Classes:

UserServiceSoapBindingStub

public interface UserServiceInterface
extends Remote

Method Summary

Methods

Modifier and Type	Method and Description
User[]	createUsers(User[] users) Creates new User objects.
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.
User[]	updateUsers(User[] users) Updates the specified User objects.

Method Detail

createUsers

User[] createUsers(User[] users)
                   throws RemoteException,
                          ApiException

Creates new User objects.

Parameters:

users - the users to create

Returns:

the created users with their IDs filled in

Throws:

RemoteException

ApiException

getAllRoles

Role[] getAllRoles()
                   throws RemoteException,
                          ApiException

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

Returns:

the roles defined for the user's network

Throws:

RemoteException

ApiException

getCurrentUser

User getCurrentUser()
                    throws RemoteException,
                           ApiException

Returns the current User.

Returns:

the current user

Throws:

RemoteException

ApiException

getUsersByStatement

UserPage getUsersByStatement(Statement filterStatement)
                             throws RemoteException,
                                    ApiException

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

Returns:

the users that match the given filter

Throws:

RemoteException

ApiException

performUserAction

UpdateResult performUserAction(UserAction userAction,
                             Statement filterStatement)
                               throws RemoteException,
                                      ApiException

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

Returns:

the result of the action performed

Throws:

RemoteException

ApiException

updateUsers

User[] updateUsers(User[] users)
                   throws RemoteException,
                          ApiException

Updates the specified User objects.

Parameters:

users - the users to update

Returns:

the updated users

Throws:

RemoteException

ApiException