org.mule.modules.google.dfp.premium

Class GetMethods

java.lang.Object

org.mule.modules.google.dfp.premium.GetMethods

public class GetMethods
extends Object

Set of methods used by the get operations.

Constructor Summary

Constructors

Constructor and Description
GetMethods(AbstractConfig connectionStrategy) Initialise the get methods with the specified connection strategy.

Method Summary

Modifier and Type	Method and Description
List<com.google.api.ads.admanager.axis.v201902.AdUnit>	getAdUnits(String queryString, Map<String,Object> queryParams, String queryOrder, Integer queryOffset) Retrieve the Ad Units that match with the queryString.
List<com.google.api.ads.admanager.axis.v201902.AdUnitSize>	getAdUnitSizes(String queryString, Map<String,Object> queryParams, String queryOrder, Integer queryOffset) Retrieve the Ad Unit sizes that match with the queryString.
List<com.google.api.ads.admanager.axis.v201902.Role>	getAllRoles() Returns the Role objects that are defined for the users of the network.
List<com.google.api.ads.admanager.axis.v201902.Company>	getCompanies(String queryString, Map<String,Object> queryParams, String queryOrder, Integer queryOffset) Retrieve the companies that match with the queryString.
List<com.google.api.ads.admanager.axis.v201902.Contact>	getContacts(String queryString, Map<String,Object> queryParams, String queryOrder, Integer queryOffset) Retrieve the contacts that match with the queryString.
com.google.api.ads.admanager.axis.v201902.User	getCurrentUser() Returns the current User.
List<com.google.api.ads.admanager.axis.v201902.CustomField>	getCustomFields(String queryString, Map<String,Object> queryParams, String queryOrder, Integer queryOffset) Retrieve the CustomFields that match with the queryString.
List<com.google.api.ads.admanager.axis.v201902.CustomTargetingKey>	getCustomTargetingKeys(String queryString, Map<String,Object> queryParams, String queryOrder, Integer queryOffset) Retrieve the Custom Targeting Keys that match with the queryString.
List<com.google.api.ads.admanager.axis.v201902.CustomTargetingValue>	getCustomTargetingValues(String queryString, Map<String,Object> queryParams, String queryOrder, Integer queryOffset) Retrieve the Custom Targeting Values that match with the queryString.
List<com.google.api.ads.admanager.axis.v201902.LineItem>	getLineItems(String queryString, Map<String,Object> queryParams, String queryOrder, Integer queryOffset) Retrieve the Line Items that match with the queryString.
List<com.google.api.ads.admanager.axis.v201902.Order>	getOrders(String queryString, Map<String,Object> queryParams, String queryOrder, Integer queryOffset) Retrieve the Orders that match with the queryString.
List<com.google.api.ads.admanager.axis.v201902.Placement>	getPlacements(String queryString, Map<String,Object> queryParams, String queryOrder, Integer queryOffset) Retrieve the Placements that match with the queryString.
List<com.google.api.ads.admanager.axis.v201902.SavedQuery>	getSavedQueryByStatement(String queryString, Map<String,Object> queryParams, String queryOrder, Integer queryOffset) Retrieve the Reconciliation Order Reports that match with the queryString.
List<com.google.api.ads.admanager.axis.v201902.User>	getUsers(String queryString, Map<String,Object> queryParams, String queryOrder, Integer queryOffset) Retrieve the Users that match with the queryString.

Methods inherited from class java.lang.Object

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

Constructor Detail

GetMethods

public GetMethods(AbstractConfig connectionStrategy)

Initialise the get methods with the specified connection strategy.

Parameters:

connectionStrategy - the connection strategy used to connect to the API

Method Detail

getAdUnits

public List<com.google.api.ads.admanager.axis.v201902.AdUnit> getAdUnits(String queryString,
                                                                         Map<String,Object> queryParams,
                                                                         String queryOrder,
                                                                         @Default(value="0")
                                                                         Integer queryOffset)
                                                                  throws AdManagerApiException,
                                                                         AdManagerCommunicationException

Retrieve the Ad Units that match with the queryString.

Parameters:

queryString - the query string for the statement

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

queryOrder - the query order for the statement

queryOffset - the query offset for the statement

Returns:

List<AdUnit> List of ad units that match with the parameters

Throws:

AdManagerApiException - if an exception is thrown by the API being called

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

getAdUnitSizes

public List<com.google.api.ads.admanager.axis.v201902.AdUnitSize> getAdUnitSizes(String queryString,
                                                                                 Map<String,Object> queryParams,
                                                                                 String queryOrder,
                                                                                 @Default(value="0")
                                                                                 Integer queryOffset)
                                                                          throws AdManagerApiException,
                                                                                 AdManagerCommunicationException

Retrieve the Ad Unit sizes that match with the queryString.

Parameters:

queryString - the query string for the statement

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

queryOrder - the query order for the statement

queryOffset - the query offset for the statement

Returns:

List<AdUnitSize> List of ad unit sizes that match with the parameters

Throws:

AdManagerApiException - if an exception is thrown by the API being called

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()
                                                                 throws AdManagerApiException,
                                                                        AdManagerCommunicationException

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

Returns:

List<Role> List of Roles.

Throws:

AdManagerApiException - if an exception is thrown by the API being called

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()
                                                              throws AdManagerApiException,
                                                                     AdManagerCommunicationException

Returns the current User.

Returns:

User User.

Throws:

AdManagerApiException - if an exception is thrown by the API being called

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

getCompanies

public List<com.google.api.ads.admanager.axis.v201902.Company> getCompanies(String queryString,
                                                                            Map<String,Object> queryParams,
                                                                            String queryOrder,
                                                                            @Default(value="0")
                                                                            Integer queryOffset)
                                                                     throws AdManagerApiException,
                                                                            AdManagerCommunicationException

Retrieve the companies that match with the queryString.

Parameters:

queryString - the query string for the statement

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

queryOrder - the query order for the statement

queryOffset - the query offset for the statement

Returns:

List<Company> List of companies that match with the parameters

Throws:

AdManagerApiException - if an exception is thrown by the API being called

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

getContacts

public List<com.google.api.ads.admanager.axis.v201902.Contact> getContacts(String queryString,
                                                                           Map<String,Object> queryParams,
                                                                           String queryOrder,
                                                                           @Default(value="0")
                                                                           Integer queryOffset)
                                                                    throws AdManagerApiException,
                                                                           AdManagerCommunicationException

Retrieve the contacts that match with the queryString.

Parameters:

queryString - the query string for the statement

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

queryOrder - the query order for the statement

queryOffset - the query offset for the statement

Returns:

List<Contact> List of contacts that match with the parameters

Throws:

AdManagerApiException - if an exception is thrown by the API being called

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

getLineItems

public List<com.google.api.ads.admanager.axis.v201902.LineItem> getLineItems(String queryString,
                                                                             Map<String,Object> queryParams,
                                                                             String queryOrder,
                                                                             @Default(value="0")
                                                                             Integer queryOffset)
                                                                      throws AdManagerApiException,
                                                                             AdManagerCommunicationException

Retrieve the Line Items that match with the queryString.

Parameters:

queryString - the query string for the statement

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

queryOrder - the query order for the statement

queryOffset - the query offset for the statement

Returns:

List<LineItem> List of line items that match with the parameters

Throws:

AdManagerApiException - if an exception is thrown by the API being called

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

getOrders

public List<com.google.api.ads.admanager.axis.v201902.Order> getOrders(String queryString,
                                                                       Map<String,Object> queryParams,
                                                                       String queryOrder,
                                                                       @Default(value="0")
                                                                       Integer queryOffset)
                                                                throws AdManagerApiException,
                                                                       AdManagerCommunicationException

Retrieve the Orders that match with the queryString.

Parameters:

queryString - the query string for the statement

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

queryOrder - the query order for the statement

queryOffset - the query offset for the statement

Returns:

List<Order> List of orders that match with the parameters

Throws:

AdManagerApiException - if an exception is thrown by the API being called

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

getUsers

public List<com.google.api.ads.admanager.axis.v201902.User> getUsers(String queryString,
                                                                     Map<String,Object> queryParams,
                                                                     String queryOrder,
                                                                     @Default(value="0")
                                                                     Integer queryOffset)
                                                              throws AdManagerApiException,
                                                                     AdManagerCommunicationException

Retrieve the Users that match with the queryString.

Parameters:

queryString - the query string for the statement

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

queryOrder - the query user for the statement

queryOffset - the query offset for the statement

Returns:

List<User> List of users that match with the parameters

Throws:

AdManagerApiException - if an exception is thrown by the API being called

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

getSavedQueryByStatement

public List<com.google.api.ads.admanager.axis.v201902.SavedQuery> getSavedQueryByStatement(String queryString,
                                                                                           Map<String,Object> queryParams,
                                                                                           String queryOrder,
                                                                                           @Default(value="0")
                                                                                           Integer queryOffset)
                                                                                    throws AdManagerApiException,
                                                                                           AdManagerCommunicationException

Retrieve the Reconciliation Order Reports that match with the queryString.

Parameters:

queryString - the query string for the statement

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

queryOrder - the query order for the statement

queryOffset - the query offset for the statement

Returns:

List<SavedQuery> List of saved query that match with the parameters

Throws:

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

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

getCustomFields

public List<com.google.api.ads.admanager.axis.v201902.CustomField> getCustomFields(String queryString,
                                                                                   Map<String,Object> queryParams,
                                                                                   String queryOrder,
                                                                                   @Default(value="0")
                                                                                   Integer queryOffset)
                                                                            throws AdManagerApiException,
                                                                                   AdManagerCommunicationException

Retrieve the CustomFields that match with the queryString.

Parameters:

queryString - the query string for the statement

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

queryOrder - the query order for the statement

queryOffset - the query offset for the statement

Returns:

List<CustomField> List of customFields that match with the parameters

Throws:

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

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

getCustomTargetingKeys

public List<com.google.api.ads.admanager.axis.v201902.CustomTargetingKey> getCustomTargetingKeys(String queryString,
                                                                                                 Map<String,Object> queryParams,
                                                                                                 String queryOrder,
                                                                                                 @Default(value="0")
                                                                                                 Integer queryOffset)
                                                                                          throws AdManagerApiException,
                                                                                                 AdManagerCommunicationException

Retrieve the Custom Targeting Keys that match with the queryString.

Parameters:

queryString - the query string for the statement

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

queryOrder - the query order for the statement

queryOffset - the query offset for the statement

Returns:

List<CustomTargetingKey> List of custom targeting keys that match with the parameters

Throws:

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

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

getCustomTargetingValues

public List<com.google.api.ads.admanager.axis.v201902.CustomTargetingValue> getCustomTargetingValues(String queryString,
                                                                                                     Map<String,Object> queryParams,
                                                                                                     String queryOrder,
                                                                                                     @Default(value="0")
                                                                                                     Integer queryOffset)
                                                                                              throws AdManagerApiException,
                                                                                                     AdManagerCommunicationException

Retrieve the Custom Targeting Values that match with the queryString.

Parameters:

queryString - the query string for the statement

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

queryOrder - the query order for the statement

queryOffset - the query offset for the statement

Returns:

List<CustomTargetingValue> List of custom targeting values that match with the parameters

Throws:

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

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

getPlacements

public List<com.google.api.ads.admanager.axis.v201902.Placement> getPlacements(String queryString,
                                                                               Map<String,Object> queryParams,
                                                                               String queryOrder,
                                                                               @Default(value="0")
                                                                               Integer queryOffset)
                                                                        throws AdManagerApiException,
                                                                               AdManagerCommunicationException

Retrieve the Placements that match with the queryString.

Parameters:

queryString - the query string for the statement

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

queryOrder - the query order for the statement

queryOffset - the query offset for the statement

Returns:

List<Placement> List of placements that match with the parameters

Throws:

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

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