org.mule.modules.google.dfp.premium

Class GetMethods

java.lang.Object

org.mule.modules.google.dfp.community.GetMethods

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

public class GetMethods
extends GetMethods

Constructor Summary

Constructors

Constructor and Description
GetMethods(AbstractConfig connectionStrategy)

Method Summary

Modifier and Type	Method and Description
List<com.google.api.ads.dfp.axis.v201805.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.dfp.axis.v201805.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.dfp.axis.v201805.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.dfp.axis.v201805.Placement>	getPlacements(String queryString, Map<String,Object> queryParams, String queryOrder, Integer queryOffset) Retrieve the Placements that match with the queryString.

Methods inherited from class org.mule.modules.google.dfp.community.GetMethods

getAdUnits, getAdUnitSizes, getAllRoles, getCompanies, getContacts, getCurrentUser, getLineItems, getOrders, getSavedQueryByStatement, getUsers

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)

Method Detail

getCustomFields

public List<com.google.api.ads.dfp.axis.v201805.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.dfp.axis.v201805.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.dfp.axis.v201805.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.dfp.axis.v201805.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.