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

Class CustomFieldService

java.lang.Object

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

public class CustomFieldService
extends Object

Service containing Custom Field helper methods.

Constructor Summary

Constructors

Constructor and Description
CustomFieldService()

Method Summary

Modifier and Type	Method and Description
List<Long>	createCustomFieldOptions(com.google.api.ads.admanager.lib.client.AdManagerSession session, List<com.google.api.ads.admanager.axis.v201902.CustomFieldOption> customFieldOptionsToCreate) Creates the specified CustomFieldOptions.
List<Long>	createCustomFields(com.google.api.ads.admanager.lib.client.AdManagerSession session, List<com.google.api.ads.admanager.axis.v201902.CustomField> customFieldsToCreate) Creates the specified CustomFields.
protected com.google.api.ads.admanager.axis.v201902.CustomFieldServiceInterface	createCustomFieldService(com.google.api.ads.admanager.lib.client.AdManagerSession session)
com.google.api.ads.admanager.axis.v201902.CustomFieldOption	getCustomFieldOption(com.google.api.ads.admanager.lib.client.AdManagerSession session, Long id) Retrieves the specified CustomFieldOption.
List<com.google.api.ads.admanager.axis.v201902.CustomField>	getCustomFields(com.google.api.ads.admanager.lib.client.AdManagerSession session, String queryString, Map<String,Object> queryParams, String queryOrder, Integer queryOffset) Retrieves a list of filtered CustomFields.
Integer	performCustomFieldsAction(com.google.api.ads.admanager.lib.client.AdManagerSession session, String customFieldActionString, String queryString, Map<String,Object> queryParams) Performs the specified CustomField action.
List<Long>	updateCustomFieldOptions(com.google.api.ads.admanager.lib.client.AdManagerSession session, List<com.google.api.ads.admanager.axis.v201902.CustomFieldOption> customFieldOptionsToUpdate) Updates the respective CustomFieldOptions.
List<Long>	updateCustomFields(com.google.api.ads.admanager.lib.client.AdManagerSession session, List<com.google.api.ads.admanager.axis.v201902.CustomField> customFieldsToUpdate) Updates the respective Custom Fields.

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomFieldService

public CustomFieldService()

Method Detail

createCustomFieldService

protected com.google.api.ads.admanager.axis.v201902.CustomFieldServiceInterface createCustomFieldService(com.google.api.ads.admanager.lib.client.AdManagerSession session)

getCustomFieldOption

public com.google.api.ads.admanager.axis.v201902.CustomFieldOption getCustomFieldOption(com.google.api.ads.admanager.lib.client.AdManagerSession session,
                                                                                        Long id)
                                                                                 throws AdManagerApiException,
                                                                                        AdManagerCommunicationException

Retrieves the specified CustomFieldOption.

Parameters:

session - the API session

id - the Custom Field Option ID

Returns:

CustomFieldOption for the respective ID

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

createCustomFieldOptions

public List<Long> createCustomFieldOptions(com.google.api.ads.admanager.lib.client.AdManagerSession session,
                                           List<com.google.api.ads.admanager.axis.v201902.CustomFieldOption> customFieldOptionsToCreate)
                                    throws AdManagerApiException,
                                           AdManagerCommunicationException

Creates the specified CustomFieldOptions.

Parameters:

session - the API session

customFieldOptionsToCreate - list of CustomFieldOptions

Returns:

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

createCustomFields

public List<Long> createCustomFields(com.google.api.ads.admanager.lib.client.AdManagerSession session,
                                     List<com.google.api.ads.admanager.axis.v201902.CustomField> customFieldsToCreate)
                              throws AdManagerApiException,
                                     AdManagerCommunicationException

Creates the specified CustomFields.

Parameters:

session - the API session

customFieldsToCreate - the CustomFields to create

Returns:

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

getCustomFields

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

Retrieves a list of filtered CustomFields.

Parameters:

session - the API session

queryString - the query

queryParams - the query parameters

queryOrder - the order

queryOffset - the offset

Returns:

List<CustomField> list of filtered CustomFields

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

performCustomFieldsAction

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

Performs the specified CustomField action.

Parameters:

session - the API session

customFieldActionString - containing the action name

queryString - the query

queryParams - the query parameters

Returns:

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

updateCustomFieldOptions

public List<Long> updateCustomFieldOptions(com.google.api.ads.admanager.lib.client.AdManagerSession session,
                                           List<com.google.api.ads.admanager.axis.v201902.CustomFieldOption> customFieldOptionsToUpdate)
                                    throws AdManagerApiException,
                                           AdManagerCommunicationException

Updates the respective CustomFieldOptions.

Parameters:

session - the API session

customFieldOptionsToUpdate - list of CustomFieldOptions to update

Returns:

List<Long> list of updated CustomFieldOptions 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.)

updateCustomFields

public List<Long> updateCustomFields(com.google.api.ads.admanager.lib.client.AdManagerSession session,
                                     List<com.google.api.ads.admanager.axis.v201902.CustomField> customFieldsToUpdate)
                              throws AdManagerApiException,
                                     AdManagerCommunicationException

Updates the respective Custom Fields.

Parameters:

session - the API session

customFieldsToUpdate - list of CustomFields to update

Returns:

List<Long> list of updated CustomFields 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.)