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

Class CustomTargetingService

java.lang.Object

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

public class CustomTargetingService
extends Object

Service containing Custom Targeting helper methods.

Constructor Summary

Constructors

Constructor and Description
CustomTargetingService()

Method Summary

Modifier and Type	Method and Description
List<Long>	createCustomTargetingKeys(com.google.api.ads.admanager.lib.client.AdManagerSession session, List<com.google.api.ads.admanager.axis.v201902.CustomTargetingKey> customTargetingKeysToCreate) Creates the specified CustomTargetingKeys.
protected com.google.api.ads.admanager.axis.v201902.CustomTargetingServiceInterface	createCustomTargetingService(com.google.api.ads.admanager.lib.client.AdManagerSession session)
List<Long>	createCustomTargetingValues(com.google.api.ads.admanager.lib.client.AdManagerSession session, List<com.google.api.ads.admanager.axis.v201902.CustomTargetingValue> customTargetingValuesToCreate) Creates the specified CustomTargetingValues.
List<com.google.api.ads.admanager.axis.v201902.CustomTargetingKey>	getCustomTargetingKeys(com.google.api.ads.admanager.lib.client.AdManagerSession session, String queryString, Map<String,Object> queryParams, String queryOrder, Integer queryOffset) Retrieves a filtered list of CustomTargetingKeys.
List<com.google.api.ads.admanager.axis.v201902.CustomTargetingValue>	getCustomTargetingValues(com.google.api.ads.admanager.lib.client.AdManagerSession session, String queryString, Map<String,Object> queryParams, String queryOrder, Integer queryOffset) Retrieves a filtered list of CustomTargetingValues.
Integer	performCustomTargetingKeys(com.google.api.ads.admanager.lib.client.AdManagerSession session, String customTargetingKeyActionString, String queryString, Map<String,Object> queryParams) Performs the specified CustomTargetingKeys action.
Integer	performCustomTargetingValues(com.google.api.ads.admanager.lib.client.AdManagerSession session, String customTargetingValueActionString, String queryString, Map<String,Object> queryParams) Performs the specified CustomTargetingValues action.
List<Long>	updateCustomTargetingKeys(com.google.api.ads.admanager.lib.client.AdManagerSession session, List<com.google.api.ads.admanager.axis.v201902.CustomTargetingKey> customTargetingKeysToUpdate) Update the specified CustomTargetingKeys.
List<Long>	updateCustomTargetingValues(com.google.api.ads.admanager.lib.client.AdManagerSession session, List<com.google.api.ads.admanager.axis.v201902.CustomTargetingValue> customTargetingValuesToUpdate) Updates the specified CustomTargetingValues.

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomTargetingService

public CustomTargetingService()

Method Detail

createCustomTargetingService

protected com.google.api.ads.admanager.axis.v201902.CustomTargetingServiceInterface createCustomTargetingService(com.google.api.ads.admanager.lib.client.AdManagerSession session)

createCustomTargetingKeys

public List<Long> createCustomTargetingKeys(com.google.api.ads.admanager.lib.client.AdManagerSession session,
                                            List<com.google.api.ads.admanager.axis.v201902.CustomTargetingKey> customTargetingKeysToCreate)
                                     throws AdManagerApiException,
                                            AdManagerCommunicationException

Creates the specified CustomTargetingKeys.

Parameters:

session - the API session

customTargetingKeysToCreate - list of CustomTargetingKeys to create

Returns:

List<Long> list of created CustomTargetingKeys 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.)

createCustomTargetingValues

public List<Long> createCustomTargetingValues(com.google.api.ads.admanager.lib.client.AdManagerSession session,
                                              List<com.google.api.ads.admanager.axis.v201902.CustomTargetingValue> customTargetingValuesToCreate)
                                       throws AdManagerApiException,
                                              AdManagerCommunicationException

Creates the specified CustomTargetingValues.

Parameters:

session - the API session

customTargetingValuesToCreate - list of CustomTargetingValues to create

Returns:

List<Long> list of created CustomTargetingValues 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.)

getCustomTargetingKeys

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

Retrieves a filtered list of CustomTargetingKeys.

Parameters:

session - the API session

queryString - the query

queryParams - the query parameters

queryOrder - the order

queryOffset - the offset

Returns:

List<CustomTargetingKey> list of retrieved CustomTargetingKeys

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.)

getCustomTargetingValues

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

Retrieves a filtered list of CustomTargetingValues.

Parameters:

session - the API session

queryString - the query

queryParams - the query parameters

queryOrder - the order

queryOffset - the offset

Returns:

List<CustomTargetingValue> list of CustomTargetingValues

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.)

updateCustomTargetingKeys

public List<Long> updateCustomTargetingKeys(com.google.api.ads.admanager.lib.client.AdManagerSession session,
                                            List<com.google.api.ads.admanager.axis.v201902.CustomTargetingKey> customTargetingKeysToUpdate)
                                     throws AdManagerApiException,
                                            AdManagerCommunicationException

Update the specified CustomTargetingKeys.

Parameters:

session - the API session

customTargetingKeysToUpdate - the CustomTargetingKeys to update

Returns:

List<Long> the updated CustomTargetingKeys 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.)

updateCustomTargetingValues

public List<Long> updateCustomTargetingValues(com.google.api.ads.admanager.lib.client.AdManagerSession session,
                                              List<com.google.api.ads.admanager.axis.v201902.CustomTargetingValue> customTargetingValuesToUpdate)
                                       throws AdManagerApiException,
                                              AdManagerCommunicationException

Updates the specified CustomTargetingValues.

Parameters:

session - the API session

customTargetingValuesToUpdate - the list of CustomTargetingValues to update

Returns:

List<Long> the updated CustomTargetingValues 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.)

performCustomTargetingKeys

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

Performs the specified CustomTargetingKeys action.

Parameters:

session - the API session

customTargetingKeyActionString - the action

queryString - the query

queryParams - the query parameters

Returns:

Integer the number of affected records

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.)

performCustomTargetingValues

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

Performs the specified CustomTargetingValues action.

Parameters:

session - the session

customTargetingValueActionString - the action

queryString - the query

queryParams - the query parameters

Returns:

Integer the number of affected records

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.)