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

Class CompanyService

java.lang.Object

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

public class CompanyService
extends Object

Service containing Company helper methods.

Constructor Summary

Constructors

Constructor and Description
CompanyService()

Method Summary

Modifier and Type	Method and Description
List<Long>	createCompanies(com.google.api.ads.admanager.lib.client.AdManagerSession session, List<com.google.api.ads.admanager.axis.v201902.Company> companiesToCreate) Creates the specified companies.
protected com.google.api.ads.admanager.axis.v201902.CompanyServiceInterface	createCompanyService(com.google.api.ads.admanager.lib.client.AdManagerSession session)
List<com.google.api.ads.admanager.axis.v201902.Company>	getCompanies(com.google.api.ads.admanager.lib.client.AdManagerSession session, String queryString, Map<String,Object> queryParams, String queryOrder, Integer queryOffset) Retrieves a list of companies.
List<Long>	updateCompanies(com.google.api.ads.admanager.lib.client.AdManagerSession session, List<com.google.api.ads.admanager.axis.v201902.Company> companiesToUpdate) Update the specified companies.

Methods inherited from class java.lang.Object

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

Constructor Detail

CompanyService

public CompanyService()

Method Detail

createCompanyService

protected com.google.api.ads.admanager.axis.v201902.CompanyServiceInterface createCompanyService(com.google.api.ads.admanager.lib.client.AdManagerSession session)

getCompanies

public List<com.google.api.ads.admanager.axis.v201902.Company> getCompanies(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 companies.

Parameters:

session - the Google API session

queryString - the query

queryParams - the query parameters

queryOrder - the order

queryOffset - the offset

Returns:

List<Company> the filtered list of companies

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

createCompanies

public List<Long> createCompanies(com.google.api.ads.admanager.lib.client.AdManagerSession session,
                                  List<com.google.api.ads.admanager.axis.v201902.Company> companiesToCreate)
                           throws AdManagerApiException,
                                  AdManagerCommunicationException

Creates the specified companies.

Parameters:

session - the Google API session

companiesToCreate - list of companies to create

Returns:

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

updateCompanies

public List<Long> updateCompanies(com.google.api.ads.admanager.lib.client.AdManagerSession session,
                                  List<com.google.api.ads.admanager.axis.v201902.Company> companiesToUpdate)
                           throws AdManagerApiException,
                                  AdManagerCommunicationException

Update the specified companies.

Parameters:

session - the Google API session

companiesToUpdate - the companies to update

Returns:

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