org.mule.modules.google.dfp.premium

Class PerformMethods

java.lang.Object

org.mule.modules.google.dfp.premium.PerformMethods

public class PerformMethods
extends Object

Set of methods used by the perform operations.

Constructor Summary

Constructors

Constructor and Description
PerformMethods(AbstractConfig connectionStrategy) Initialise the perform methods with the specified connection strategy.

Method Summary

Modifier and Type	Method and Description
Integer	performAdUnits(String queryString, Map<String,Object> queryParams, String adUnitAction) Perform the chosen action over the Ad Units that match with the query string given by parameter.
Integer	performCustomFields(String queryString, Map<String,Object> queryParams, String customFieldAction) Perform the chosen action over the CustomFields that match with the query string given by parameter.
Integer	performCustomTargetingKeys(String queryString, Map<String,Object> queryParams, String customTargetingKeyAction) Perform the chosen action over the Custom Targeting Keys that match with the query string given by parameter.
Integer	performCustomTargetingValues(String queryString, Map<String,Object> queryParams, String customTargetingValueAction) Perform the chosen action over the Custom Targeting Values that match with the query string given by parameter.
Integer	performLineItems(String queryString, Map<String,Object> queryParams, String lineItemAction) Perform the chosen action over the Line Items that match with the query string given by parameter.
Integer	performOrders(String queryString, Map<String,Object> queryParams, String orderAction) Perform the chosen action over the Orders that match with the query string given by parameter.
Integer	performPlacements(String queryString, Map<String,Object> queryParams, String placementAction) Perform the chosen action over the Placements that match with the query string given by parameter.
Integer	performUsers(String queryString, Map<String,Object> queryParams, String userAction) Perform the chosen action over the Users that match with the query string given by parameter.

Methods inherited from class java.lang.Object

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

Constructor Detail

PerformMethods

public PerformMethods(AbstractConfig connectionStrategy)

Initialise the perform methods with the specified connection strategy.

Parameters:

connectionStrategy - the connection strategy used to connect to the API

Method Detail

performAdUnits

public Integer performAdUnits(String queryString,
                              Map<String,Object> queryParams,
                              String adUnitAction)
                       throws AdManagerException

Perform the chosen action over the Ad Units that match with the query string given by parameter.

Parameters:

queryString - the query string for the statement

queryParams - a map with the query params included in the query string

adUnitAction - Action for perform over the Ad Units that match with the query string

Returns:

Number of Ad Units updated

Throws:

AdManagerException - when : a) Exception is raised by the API, in this case a specific AdManagerApiException is thrown b) Exception is raised because of a communication problem with the API AdManagerCommunicationException c) Exception is raised because of an incorrect action AdManagerException

performOrders

public Integer performOrders(String queryString,
                             Map<String,Object> queryParams,
                             String orderAction)
                      throws AdManagerException

Perform the chosen action over the Orders that match with the query string given by parameter.

Parameters:

queryString - the query string for the statement

queryParams - a map with the query params included in the query string

orderAction - Action for perform over the Orders that match with the query string

Returns:

Number of Orders updated

Throws:

AdManagerException - when : a) Exception is raised by the API, in this case a specific AdManagerApiException is thrown b) Exception is raised because of a communication problem with the API AdManagerCommunicationException c) Exception is raised because of an incorrect action AdManagerException

performLineItems

public Integer performLineItems(String queryString,
                                Map<String,Object> queryParams,
                                String lineItemAction)
                         throws AdManagerException

Perform the chosen action over the Line Items that match with the query string given by parameter.

Parameters:

queryString - the query string for the statement

queryParams - a map with the query params included in the query string

lineItemAction - Action for perform over the Line Items that match with the query string

Returns:

Number of Line Items updated

Throws:

AdManagerException - when : a) Exception is raised by the API, in this case a specific AdManagerApiException is thrown b) Exception is raised because of a communication problem with the API AdManagerCommunicationException c) Exception is raised because of an incorrect action AdManagerException

performUsers

public Integer performUsers(String queryString,
                            Map<String,Object> queryParams,
                            String userAction)
                     throws AdManagerException

Perform the chosen action over the Users that match with the query string given by parameter.

Parameters:

queryString - the query string for the statement

queryParams - a map with the query params included in the query string

userAction - Action for perform over the Users that match with the query string

Returns:

Number of Users updated

Throws:

AdManagerException - when : a) Exception is raised by the API, in this case a specific AdManagerApiException is thrown b) Exception is raised because of a communication problem with the API AdManagerCommunicationException c) Exception is raised because of an incorrect action AdManagerException

performPlacements

public Integer performPlacements(String queryString,
                                 Map<String,Object> queryParams,
                                 String placementAction)
                          throws AdManagerException

Perform the chosen action over the Placements that match with the query string given by parameter.

Parameters:

queryString - the query string for the statement

queryParams - a map with the query params included in the query string

placementAction - Action for perform over the Placements that match with the query string

Returns:

Number of Placements updated

Throws:

AdManagerException - when : a) Exception is raised by the API, in this case a specific AdManagerApiException is thrown b) Exception is raised because of a communication problem with the API AdManagerCommunicationException c) Exception is raised because of an incorrect action AdManagerException

performCustomFields

public Integer performCustomFields(String queryString,
                                   Map<String,Object> queryParams,
                                   String customFieldAction)
                            throws AdManagerException

Perform the chosen action over the CustomFields that match with the query string given by parameter.

Parameters:

queryString - the query string for the statement

queryParams - a map with the query parameters included in the query string

customFieldAction - Action for perform over the CustomFields that match with the query string

Returns:

Number of CustomFields updated

Throws:

AdManagerException - when : a) Exception is raised by the API, in this case a specific AdManagerApiException is thrown b) Exception is raised because of a communication problem with the API AdManagerCommunicationException c) Exception is raised because of an incorrect action AdManagerException

performCustomTargetingKeys

public Integer performCustomTargetingKeys(String queryString,
                                          Map<String,Object> queryParams,
                                          String customTargetingKeyAction)
                                   throws AdManagerException

Perform the chosen action over the Custom Targeting Keys that match with the query string given by parameter.

Parameters:

queryString - the query string for the statement

queryParams - a map with the query params included in the query string

customTargetingKeyAction - Action for perform over the Custom Targeting Keys that match with the query string

Returns:

Number of Custom Targeting Keys updated

Throws:

AdManagerException - when : a) Exception is raised by the API, in this case a specific AdManagerApiException is thrown b) Exception is raised because of a communication problem with the API AdManagerCommunicationException c) Exception is raised because of an incorrect action AdManagerException

performCustomTargetingValues

public Integer performCustomTargetingValues(String queryString,
                                            Map<String,Object> queryParams,
                                            String customTargetingValueAction)
                                     throws AdManagerException

Perform the chosen action over the Custom Targeting Values that match with the query string given by parameter.

Parameters:

queryString - the query string for the statement

queryParams - a map with the query params included in the query string

customTargetingValueAction - Action for perform over the Custom Targeting Values that match with the query string

Returns:

Number of Custom Targeting Values updated

Throws:

AdManagerException - when : a) Exception is raised by the API, in this case a specific AdManagerApiException is thrown b) Exception is raised because of a communication problem with the API AdManagerCommunicationException c) Exception is raised because of an incorrect action AdManagerException