org.mule.modules.google.dfp.premium.services

Class UserService

java.lang.Object

org.mule.modules.google.dfp.premium.services.UserService

public class UserService
extends Object

Service containing User helper methods.

Constructor Summary

Constructors

Constructor and Description
UserService()

Method Summary

Modifier and Type	Method and Description
List<Long>	createUsers(com.google.api.ads.admanager.lib.client.AdManagerSession session, List<com.google.api.ads.admanager.axis.v201902.User> usersToCreate) Creates the specified Users.
protected com.google.api.ads.admanager.axis.v201902.UserServiceInterface	createUserService(com.google.api.ads.admanager.lib.client.AdManagerSession session)
List<com.google.api.ads.admanager.axis.v201902.Role>	getAllRoles(com.google.api.ads.admanager.lib.client.AdManagerSession session) Retrieves all Roles.
com.google.api.ads.admanager.axis.v201902.User	getCurrentUser(com.google.api.ads.admanager.lib.client.AdManagerSession session) Retrieves the current user.
List<com.google.api.ads.admanager.axis.v201902.User>	getUsers(com.google.api.ads.admanager.lib.client.AdManagerSession session, String queryString, Map<String,Object> queryParams, String queryUser, Integer queryOffset) Retrieves the specified Users.
Integer	performUsers(com.google.api.ads.admanager.lib.client.AdManagerSession session, String userActionString, String queryString, Map<String,Object> queryParams) Perform the selected Users action.
List<Long>	updateUsers(com.google.api.ads.admanager.lib.client.AdManagerSession session, List<com.google.api.ads.admanager.axis.v201902.User> usersToUpdate) Updates the specified Users.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UserService

public UserService()

Method Detail

createUserService

protected com.google.api.ads.admanager.axis.v201902.UserServiceInterface createUserService(com.google.api.ads.admanager.lib.client.AdManagerSession session)

getUsers

public List<com.google.api.ads.admanager.axis.v201902.User> getUsers(com.google.api.ads.admanager.lib.client.AdManagerSession session,
                                                                     String queryString,
                                                                     Map<String,Object> queryParams,
                                                                     String queryUser,
                                                                     Integer queryOffset)
                                                              throws AdManagerApiException,
                                                                     AdManagerCommunicationException

Retrieves the specified Users.

Parameters:

session - the API session

queryString - the query

queryParams - the query parameters

queryUser - the query user

queryOffset - the offset

Returns:

List<User> a list of Users

Throws:

AdManagerApiException - if there is a problem with the request made to the API.

AdManagerCommunicationException - if there is a communication problem with the API (such as timeouts etc.)

performUsers

public Integer performUsers(com.google.api.ads.admanager.lib.client.AdManagerSession session,
                            String userActionString,
                            String queryString,
                            Map<String,Object> queryParams)
                     throws AdManagerException

Perform the selected Users action.

Parameters:

session - the API session

userActionString - the action to perform

queryString - the query

queryParams - the query parameters

Returns:

Integer the number of affected users

Throws:

AdManagerException - AdManagerApiException if there is a problem with the request made to the API. AdManagerCommunicationException if there is a communication problem with the API (such as timeouts etc.)

createUsers

public List<Long> createUsers(com.google.api.ads.admanager.lib.client.AdManagerSession session,
                              List<com.google.api.ads.admanager.axis.v201902.User> usersToCreate)
                       throws AdManagerApiException,
                              AdManagerCommunicationException

Creates the specified Users.

Parameters:

session - the API session

usersToCreate - the list of Users to create

Returns:

List<Long> list of created User IDs

Throws:

AdManagerApiException - if there is a problem with the request made to the API.

AdManagerCommunicationException - if there is a communication problem with the API (such as timeouts etc.)

updateUsers

public List<Long> updateUsers(com.google.api.ads.admanager.lib.client.AdManagerSession session,
                              List<com.google.api.ads.admanager.axis.v201902.User> usersToUpdate)
                       throws AdManagerApiException,
                              AdManagerCommunicationException

Updates the specified Users.

Parameters:

session - the API session

usersToUpdate - list of users to update

Returns:

List<Long> list of updated user IDs

Throws:

AdManagerApiException - if there is a problem with the request made to the API.

AdManagerCommunicationException - if there is a communication problem with the API (such as timeouts etc.)

getAllRoles

public List<com.google.api.ads.admanager.axis.v201902.Role> getAllRoles(com.google.api.ads.admanager.lib.client.AdManagerSession session)
                                                                 throws AdManagerApiException,
                                                                        AdManagerCommunicationException

Retrieves all Roles.

Parameters:

session - the API session

Returns:

List<Role> the list of roles

Throws:

AdManagerApiException - if there is a problem with the request made to the API.

AdManagerCommunicationException - if there is a communication problem with the API (such as timeouts etc.)

getCurrentUser

public com.google.api.ads.admanager.axis.v201902.User getCurrentUser(com.google.api.ads.admanager.lib.client.AdManagerSession session)
                                                              throws AdManagerApiException,
                                                                     AdManagerCommunicationException

Retrieves the current user.

Parameters:

session - the API session

Returns:

User the current user account

Throws:

AdManagerApiException - if there is a problem with the request made to the API.

AdManagerCommunicationException - if there is a communication problem with the API (such as timeouts etc.)