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

Class ContactService

java.lang.Object

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

public class ContactService
extends Object

Service containing Contact helper methods.

Constructor Summary

Constructors

Constructor and Description
ContactService()

Method Summary

Modifier and Type	Method and Description
List<Long>	createContacts(com.google.api.ads.admanager.lib.client.AdManagerSession session, List<com.google.api.ads.admanager.axis.v201902.Contact> contactsToCreate) Creates the specified contacts.
protected com.google.api.ads.admanager.axis.v201902.ContactServiceInterface	createContactService(com.google.api.ads.admanager.lib.client.AdManagerSession session)
List<com.google.api.ads.admanager.axis.v201902.Contact>	getContacts(com.google.api.ads.admanager.lib.client.AdManagerSession session, String queryString, Map<String,Object> queryParams, String queryOrder, Integer queryOffset) Retrieve a filtered list of contacts.
List<Long>	updateContacts(com.google.api.ads.admanager.lib.client.AdManagerSession session, List<com.google.api.ads.admanager.axis.v201902.Contact> contactsToUpdate) Updates the specified contacts.

Methods inherited from class java.lang.Object

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

Constructor Detail

ContactService

public ContactService()

Method Detail

createContactService

protected com.google.api.ads.admanager.axis.v201902.ContactServiceInterface createContactService(com.google.api.ads.admanager.lib.client.AdManagerSession session)

createContacts

public List<Long> createContacts(com.google.api.ads.admanager.lib.client.AdManagerSession session,
                                 List<com.google.api.ads.admanager.axis.v201902.Contact> contactsToCreate)
                          throws AdManagerApiException,
                                 AdManagerCommunicationException

Creates the specified contacts.

Parameters:

session - the API session

contactsToCreate - list of contacts to create

Returns:

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

updateContacts

public List<Long> updateContacts(com.google.api.ads.admanager.lib.client.AdManagerSession session,
                                 List<com.google.api.ads.admanager.axis.v201902.Contact> contactsToUpdate)
                          throws AdManagerApiException,
                                 AdManagerCommunicationException

Updates the specified contacts.

Parameters:

session - the API session

contactsToUpdate - list of contacts to update

Returns:

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

getContacts

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

Retrieve a filtered list of contacts.

Parameters:

session - the API session

queryString - the query

queryParams - the query parameters

queryOrder - the order

queryOffset - the offset

Returns:

List<Contact> list of created contacts

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