org.mule.modules.google.dfp.premium

Class GoogleAdManagerConnector

java.lang.Object

org.mule.modules.google.dfp.premium.GoogleAdManagerConnector

@RequiresEnterpriseLicense(allowEval=true)
 @Connector(name="google-ad-manager",
           friendlyName="Google Ad Manager",
           minMuleVersion="3.9")
 @RequiresEntitlement(name="google-ad-manager",
                     provider="Ricston-Ltd")
public class GoogleAdManagerConnector
extends Object

Google Ad Manager Premium Connector

All processors can throw a AdManagerApiException when there is a problem with the request submitted to the API or a AdManagerCommunicationException if there is a communication problem with the API (such as timeouts etc.).

Author:

Ricston, Ltd.

Constructor Summary

Constructors

Constructor and Description
GoogleAdManagerConnector()

Method Summary

Modifier and Type	Method and Description
Object	create(CreateSelector selector, Object objects) Create Objects on a service.
com.google.api.ads.admanager.axis.v201902.ReportJob	createReport(DownloadReportMethod createReportMethod, String dimensions, String columns, String dimensionAttributes, Date startDate, Date endDate) Creates a Report with the given parameters.
InputStream	downloadReport(com.google.api.ads.admanager.axis.v201902.ReportJob reportJob, ExportFormat exportFormat) Download a Report from the Google Ad Manager service.
Object	get(GetSelector selector) Gets a object(s) depending on the service chosen.
com.google.api.ads.admanager.axis.v201902.AvailabilityForecast	getAvailabilityForecast(com.google.api.ads.admanager.axis.v201902.ProspectiveLineItem prospectiveLineItem, Boolean includeTargetingCriteriaBreakdown, Boolean includeContendingLineItems, com.google.api.ads.admanager.axis.v201902.ForecastBreakdownOptions forecastBreakdownOptions) Retrieve the Availability Forecast for the given prospective Line Item.
com.google.api.ads.admanager.axis.v201902.AvailabilityForecast	getAvailabilityForecastById(long lineItemId, Boolean includeTargetingCriteriaBreakdown, Boolean includeContendingLineItems, com.google.api.ads.admanager.axis.v201902.ForecastBreakdownOptions forecastBreakdownOptions) Retrieve the Availability Forecast for the given prospective Line Item ID.
Object	getByStatement(GetByStatementSelector selector, String queryString, Map<String,Object> queryParams, String queryOrder, Integer queryOffset) Retrieve object(s) that match the query.
AbstractConfig	getConnectionStrategy() Returns the connection strategy.
com.google.api.ads.admanager.axis.v201902.CustomFieldOption	getCustomFieldOption(long customFieldOptionId) Gets a Custom Field with the given Custom field Option ID.
com.google.api.ads.admanager.axis.v201902.DeliveryForecast	getDeliveryForecast(List<com.google.api.ads.admanager.axis.v201902.ProspectiveLineItem> prospectiveLineItems, String ignoredLineItems) Retrieve the Delivery Forecast for the given prospective Line Items.
com.google.api.ads.admanager.axis.v201902.DeliveryForecast	getDeliveryForecastByIds(String lineItemIds, String ignoredLineItems) Retrieve the Delivery Forecast for the given prospective Line Item IDs.
String	getReportDownloadUrl(long reportJobId, com.google.api.ads.admanager.axis.v201902.ReportDownloadOptions reportDownloadOptions) Gets the URL containing the Report generated.
com.google.api.ads.admanager.axis.v201902.ReportJobStatus	getReportJobStatus(long reportJobId) Gets the status of a created Report Job.
Integer	perform(String selector, String queryString, Map<String,Object> queryParams) Perform action onto objects.
List<String[]>	selectPql(String selectCols, String fromTable, String queryString, Map<String,Object> queryParams, String queryOrder, Integer queryOffset) Method for executing a PQL (Publisher-Query-Language) select statement to retrieve data from Google Ad Manager.
void	setConnectionStrategy(AbstractConfig connectionStrategy) Sets the connection strategy according to the provided one.
Object	update(UpdateSelector selector, Object items) Update a list of Objects.

Methods inherited from class java.lang.Object

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

Constructor Detail

GoogleAdManagerConnector

public GoogleAdManagerConnector()

Method Detail

getConnectionStrategy

public AbstractConfig getConnectionStrategy()

Returns the connection strategy.

Returns:

AbstractConfig Google Ad Manager connection strategy

setConnectionStrategy

public void setConnectionStrategy(AbstractConfig connectionStrategy)

Sets the connection strategy according to the provided one.

Parameters:

connectionStrategy - AbstractConfig Google Ad Manager connection strategy

downloadReport

@Processor(friendlyName="Download Report")
 @MetaDataScope(value=DownloadReportDataSense.class)
public InputStream downloadReport(@Default(value="#[payload]") @RefOnly
                                                                                                                                  com.google.api.ads.admanager.axis.v201902.ReportJob reportJob,
                                                                                                                                  @MetaDataKeyParam(affects=OUTPUT) @Default(value="XML")
                                                                                                                                  ExportFormat exportFormat)
                                                                                                                           throws AdManagerException

Download a Report from the Google Ad Manager service.

Parameters:

reportJob - the Report Job for which the download needs to be generated

exportFormat - the format in which the document should be produced

Returns:

InputStream containing a dump of the report

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

getReportDownloadUrl

@Processor(friendlyName="Get Report Download URL")
public String getReportDownloadUrl(long reportJobId,
                                                                                      com.google.api.ads.admanager.axis.v201902.ReportDownloadOptions reportDownloadOptions)
                                                                               throws AdManagerCommunicationException

Gets the URL containing the Report generated.

Parameters:

reportJobId - the Report Job ID (refer to Create Report)

reportDownloadOptions - Report Download Options a POJO containing the report download options

Returns:

String containing the URL location of the Report

Throws:

AdManagerCommunicationException - if there is a communication problem with the API (such as timeouts etc.)

selectPql

@Processor(friendlyName="Select PQL")
public List<String[]> selectPql(@Default(value="*")
                                                                      String selectCols,
                                                                      String fromTable,
                                                                      String queryString,
                                                                      Map<String,Object> queryParams,
                                                                      @Default(value="ASC")
                                                                      String queryOrder,
                                                                      @Default(value="0")
                                                                      Integer queryOffset)
                                                               throws AdManagerCommunicationException

Method for executing a PQL (Publisher-Query-Language) select statement to retrieve data from Google Ad Manager.

Parameters:

selectCols - a comma-delimited list of columns to be selected, if it's left blank or an asterisk ('*') is used every column will be returned

fromTable - the name of the table from which the data will be obtained

queryString - the query string to filter the objects The query string is written as id=:id, in turns the queryParams must contain the parameter specified (e.g. :id)

queryParams - the query parameters to filter the objects, these parameters should match the promised parameters specified in the queryString parameter

queryOrder - the order in which the results will be retrieved

queryOffset - the query limit for the statement

Returns:

Result of the 'select' operation.

Each element of the List is a row of the table which contains an array with the values of every columns, with the first element of the list containing the names of every column for which data have been obtained.

Throws:

AdManagerCommunicationException - if there is a communication problem with the API (such as timeouts etc.)

getByStatement

@MetaDataScope(value=GetByStatementSelectorDataSense.class)
 @Processor(friendlyName="Get by Statement")
public Object getByStatement(@MetaDataKeyParam(affects=OUTPUT) @Placement(order=0,group="Service") @FriendlyName(value="Service")
                                                                                                                                      GetByStatementSelector selector,
                                                                                                                                      String queryString,
                                                                                                                                      Map<String,Object> queryParams,
                                                                                                                                      @Default(value="ASC")
                                                                                                                                      String queryOrder,
                                                                                                                                      @Default(value="0")
                                                                                                                                      Integer queryOffset)
                                                                                                                               throws AdManagerException,
                                                                                                                                      SelectorException

Retrieve object(s) that match the query.

Parameters:

selector - the object that will be retrieved

queryString - the query string to filter the objects The query string is written as id=:id, in turns the queryParams must contain the parameter specified (e.g. :id)

queryParams - the query parameters to filter the objects, these parameters should match the promised parameters specified in the queryString parameter

queryOrder - the order in which the results will be retrieved

queryOffset - the query offset for the statement

Returns:

Object object(s) that match with the parameters

Throws:

AdManagerException - when : a) Exception is raised by the API, in this case a specific AdManagerApiException is thrown b) Exception is raised because of a communication problem with the API AdManagerCommunicationException c) Exception is raised because of an incorrect action AdManagerException

SelectorException - if service chosen is not supported

get

@Processor
 @MetaDataScope(value=GetSelectorDataSense.class)
public Object get(@MetaDataKeyParam(affects=OUTPUT) @Placement(order=0,group="Service") @FriendlyName(value="Service")
                                                                               GetSelector selector)
                                                                        throws SelectorException,
                                                                               AdManagerApiException,
                                                                               AdManagerCommunicationException

Gets a object(s) depending on the service chosen.

Parameters:

selector - the object that will be retrieved

Returns:

User or List of Role

Throws:

SelectorException - if selector provided does not match a service

AdManagerCommunicationException - If there are exceptions related to communication with the Google Ad Manager Service

AdManagerApiException - if there is a problem with the request made to the API.

perform

@Processor
 @MetaDataScope(value=PerformSelectorDataSense.class)
public Integer perform(@MetaDataKeyParam(labels={"Service","Action"})
                                                                                        String selector,
                                                                                        String queryString,
                                                                                        Map<String,Object> queryParams)
                                                                                 throws AdManagerException,
                                                                                        SelectorException

Perform action onto objects.

Parameters:

queryString - the query string to filter the objects the query string is written as id=:id, in turns the queryParams must contain the parameter specified (e.g. :id)

queryParams - the query parameters to filter the objects, these parameters should match the promised parameters specified in the queryString parameter

selector - the service that an action should be performed on, and the action to be perform.

The string should take form of object||action such as Ad Units||Activate Ad Units.

Supported objects can be found in the PerformSelector enum, the actions supported match the ones in the Google Ad Manager documentation

Returns:

The number of objects effected by the perform operation

Throws:

AdManagerException - when :

• a) Exception is raised by the API, in this case a specific AdManagerApiException is thrown
• b) Exception is raised because of a communication problem with the API AdManagerCommunicationException
• c) Exception is raised because of an incorrect action AdManagerException

SelectorException - if service chosen is not supported

create

@Processor
 @MetaDataScope(value=CreateSelectorDataSense.class)
public Object create(@MetaDataKeyParam(affects=BOTH) @Placement(order=0,group="Service") @FriendlyName(value="Service")
                                                                                     CreateSelector selector,
                                                                                     @Default(value="#[payload]") @RefOnly
                                                                                     Object objects)
                                                                              throws AdManagerApiException,
                                                                                     AdManagerCommunicationException,
                                                                                     SelectorException

Create Objects on a service.

Parameters:

objects - List<Object> Objects to be created (different depending on the service chosen)

selector - the type of object being created (see CreateSelector)

Returns:

List (either Long or String containing the IDs of the objects created

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

SelectorException - if service chosen is not supported

update

@MetaDataScope(value=UpdateSelectorDataSense.class)
 @Processor
public Object update(@MetaDataKeyParam(affects=BOTH) @Placement(order=0,group="Service") @FriendlyName(value="Service")
                                                                                     UpdateSelector selector,
                                                                                     @Default(value="#[payload]") @RefOnly
                                                                                     Object items)
                                                                              throws SelectorException,
                                                                                     AdManagerCommunicationException,
                                                                                     AdManagerApiException

Update a list of Objects.

Parameters:

selector - the update operation to be performed

items - the items to be updated

Returns:

List containing the IDs for the items updated through the operation

Throws:

SelectorException - if service chosen is not supported

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.

createReport

@Processor(friendlyName="Create Report")
public com.google.api.ads.admanager.axis.v201902.ReportJob createReport(DownloadReportMethod createReportMethod,
                                                                                                                 String dimensions,
                                                                                                                 String columns,
                                                                                                                 @Optional
                                                                                                                 String dimensionAttributes,
                                                                                                                 Date startDate,
                                                                                                                 Date endDate)
                                                                                                          throws AdManagerException

Creates a Report with the given parameters.

Parameters:

createReportMethod - whether sync (wait for report to be created) or async (refer to Get Report Job Status)

dimensions - comma-delimited dimensions list

columns - comma-delimited columns list

dimensionAttributes - comma-delimited dimension attributes list

startDate - the start of the Report date

endDate - the end of the report date

Returns:

ReportJob the Report Job of the Report created/being created

Throws:

AdManagerException - when : a) Exception is raised by the API, in this case a specific AdManagerApiException is thrown b) Exception is raised because of a communication problem with the API AdManagerCommunicationException c) Exception is raised because of an incorrect action AdManagerException

getCustomFieldOption

@Processor(friendlyName="Get Custom Field Option")
public com.google.api.ads.admanager.axis.v201902.CustomFieldOption getCustomFieldOption(long customFieldOptionId)
                                                                                                                                    throws AdManagerApiException,
                                                                                                                                           AdManagerCommunicationException

Gets a Custom Field with the given Custom field Option ID.

Parameters:

customFieldOptionId - the ID of the Custom field Option

Returns:

CustomFieldOption the Custom field Option that has the ID specified

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.

getReportJobStatus

@Processor(friendlyName="Get Report Job Status")
public com.google.api.ads.admanager.axis.v201902.ReportJobStatus getReportJobStatus(long reportJobId)
                                                                                                                              throws AdManagerApiException

Gets the status of a created Report Job. (Usually used in conjunction with Create Report with DownloadReportMethod set as Async)

Parameters:

reportJobId - the ID of the Report Job

Returns:

ReportJobStatus the job status of the Report that has the ID submitted

Throws:

AdManagerApiException - if there is a problem with the request made to the API.

getAvailabilityForecast

@Processor(friendlyName="Get Availability Forecast")
public com.google.api.ads.admanager.axis.v201902.AvailabilityForecast getAvailabilityForecast(@RefOnly @Default(value="#[payload]")
                                                                                                                                                   com.google.api.ads.admanager.axis.v201902.ProspectiveLineItem prospectiveLineItem,
                                                                                                                                                   @Optional
                                                                                                                                                   Boolean includeTargetingCriteriaBreakdown,
                                                                                                                                                   @Optional
                                                                                                                                                   Boolean includeContendingLineItems,
                                                                                                                                                   com.google.api.ads.admanager.axis.v201902.ForecastBreakdownOptions forecastBreakdownOptions)
                                                                                                                                            throws AdManagerApiException,
                                                                                                                                                   AdManagerCommunicationException

Retrieve the Availability Forecast for the given prospective Line Item.

Parameters:

prospectiveLineItem - the prospective Line Item to retrieve the Availability Forecast for

includeTargetingCriteriaBreakdown - boolean to include or not targeting criteria breakdown

includeContendingLineItems - boolean to include or not contending Line Items

forecastBreakdownOptions - Configuration of the forecast breakdown

Returns:

AvailabilityForecast the Availability Forecast for the prospective Line Item given by parameter

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.

getAvailabilityForecastById

@Processor(friendlyName="Get Availability Forecast by ID")
public com.google.api.ads.admanager.axis.v201902.AvailabilityForecast getAvailabilityForecastById(long lineItemId,
                                                                                                                                                             @Optional
                                                                                                                                                             Boolean includeTargetingCriteriaBreakdown,
                                                                                                                                                             @Optional
                                                                                                                                                             Boolean includeContendingLineItems,
                                                                                                                                                             com.google.api.ads.admanager.axis.v201902.ForecastBreakdownOptions forecastBreakdownOptions)
                                                                                                                                                      throws AdManagerApiException,
                                                                                                                                                             AdManagerCommunicationException

Retrieve the Availability Forecast for the given prospective Line Item ID.

Parameters:

lineItemId - the prospective Line Item ID for retrieve the Availability Forecast

includeTargetingCriteriaBreakdown - boolean for include or not targeting criteria breakdown

includeContendingLineItems - boolean for include or not contending Line Items

forecastBreakdownOptions - configuration of the forecast breakdown

Returns:

AvailabilityForecast the Availability Forecast for the prospective Line Item ID given by parameter

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.

getDeliveryForecastByIds

@Processor(friendlyName="Get Delivery Forecast by IDs")
public com.google.api.ads.admanager.axis.v201902.DeliveryForecast getDeliveryForecastByIds(@Optional
                                                                                                                                                   String lineItemIds,
                                                                                                                                                   @Optional
                                                                                                                                                   String ignoredLineItems)
                                                                                                                                            throws AdManagerApiException,
                                                                                                                                                   AdManagerCommunicationException,
                                                                                                                                                   AdManagerUserException

Retrieve the Delivery Forecast for the given prospective Line Item IDs.

Parameters:

lineItemIds - comma-delimited list of IDs for the Line Items to include

ignoredLineItems - comma-delimited list of IDs for the Line Items to ignore

Returns:

DeliveryForecast the Delivery Forecast for the prospective Line Item IDs given by parameter

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.

AdManagerUserException - if there is a user error when using the operation.

getDeliveryForecast

@Processor(friendlyName="Get Delivery Forecast")
public com.google.api.ads.admanager.axis.v201902.DeliveryForecast getDeliveryForecast(@RefOnly @Default(value="#[payload]")
                                                                                                                                       List<com.google.api.ads.admanager.axis.v201902.ProspectiveLineItem> prospectiveLineItems,
                                                                                                                                       @Optional
                                                                                                                                       String ignoredLineItems)
                                                                                                                                throws AdManagerApiException,
                                                                                                                                       AdManagerCommunicationException

Retrieve the Delivery Forecast for the given prospective Line Items.

Parameters:

prospectiveLineItems - list of prospective Line Items for the Delivery Forecast

ignoredLineItems - comma-delimited list of IDs for the Line Items to ignore

Returns:

DeliveryForecast the Delivery Forecast for the prospective Line Items given by parameter

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.