org.mule.modules.google.dfp.premium

Class GoogleDfpConnector

java.lang.Object

org.mule.modules.google.dfp.premium.GoogleDfpConnector

@RequiresEnterpriseLicense(allowEval=true)
 @Connector(name="google-dfp-premium",
           friendlyName="Google DFP (Premium)",
           minMuleVersion="3.6")
 @RequiresEntitlement(name="google-dfp-premium",
                     provider="Ricston-Ltd")
public class GoogleDfpConnector
extends Object

Google DFP Premium Connector

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

Author:

Ricston, Ltd.

Constructor Summary

Constructors

Constructor and Description
GoogleDfpConnector()

Method Summary

Modifier and Type	Method and Description
Object	create(CreateSelector selector, Object objects) Create Objects on a service
com.google.api.ads.dfp.axis.v201711.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.dfp.axis.v201711.ReportJob reportJob, ExportFormat exportFormat) Download a report from the Google DFP service
Object	get(GetSelector selector) Gets a object(s) depending on the service chosen
com.google.api.ads.dfp.axis.v201711.AvailabilityForecast	getAvailabilityForecast(com.google.api.ads.dfp.axis.v201711.ProspectiveLineItem prospectiveLineItem, Boolean includeTargetingCriteriaBreakdown, Boolean includeContendingLineItems) Retrieve the availability forecast for the given prospective line item
com.google.api.ads.dfp.axis.v201711.AvailabilityForecast	getAvailabilityForecastById(long lineItemId, Boolean includeTargetingCriteriaBreakdown, Boolean includeContendingLineItems) 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()
com.google.api.ads.dfp.axis.v201711.CustomFieldOption	getCustomFieldOption(long customFieldOptionId) Gets a Custom Field with the given Custom field option ID
com.google.api.ads.dfp.axis.v201711.DeliveryForecast	getDeliveryForecast(List<com.google.api.ads.dfp.axis.v201711.ProspectiveLineItem> prospectiveLineItems, String ignoredLineItems) Retrieve the delivery forecast for the given prospective line items
com.google.api.ads.dfp.axis.v201711.DeliveryForecast	getDeliveryForecastByIds(String lineItemIds, String ignoredLineItems) Retrieve the delivery forecast for the given prospective line items ids
String	getReportDownloadUrl(long reportJobId, com.google.api.ads.dfp.axis.v201711.ReportDownloadOptions reportDownloadOptions) Gets the URL containing the report generated
com.google.api.ads.dfp.axis.v201711.ReportJobStatus	getReportJobStatus(long reportJobId) Gets the status of a created Report Job (usually used in conjunction with Create Report with DownloadReportMethod set as Async)
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 DFP.
void	setConnectionStrategy(AbstractConfig connectionStrategy)
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

GoogleDfpConnector

public GoogleDfpConnector()

Method Detail

getConnectionStrategy

public AbstractConfig getConnectionStrategy()

Returns:

connection strategy

setConnectionStrategy

public void setConnectionStrategy(AbstractConfig connectionStrategy)

Parameters:

connectionStrategy - Google DFP connection strategy

downloadReport

@Processor
 @MetaDataScope(value=DownloadReportDataSense.class)
public InputStream downloadReport(@Default(value="#[payload]") @RefOnly
                                                                                                  com.google.api.ads.dfp.axis.v201711.ReportJob reportJob,
                                                                                                  @MetaDataKeyParam(affects=OUTPUT) @Default(value="XML")
                                                                                                  ExportFormat exportFormat)
                                                                                           throws DfpException

Download a report from the Google DFP 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:

Input Stream containing a dump of the report

Throws:

DfpException - DfpApiExceptionif there is a problem with the request made to the API. DfpCommunicationException if there is a communication problem with the API (such as timeouts etc)

getReportDownloadUrl

@Processor
public String getReportDownloadUrl(long reportJobId,
                                              com.google.api.ads.dfp.axis.v201711.ReportDownloadOptions reportDownloadOptions)
                                       throws DfpCommunicationException

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:

The URL location of the report

Throws:

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

selectPql

@Processor
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 DfpCommunicationException

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

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:

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

getByStatement

@MetaDataScope(value=GetByStatementSelectorDataSense.class)
 @Processor
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 DfpException,
                                                                                                     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:

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

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,
                                                                               DfpApiException,
                                                                               DfpCommunicationException

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

DfpCommunicationException - If there are exceptions related to communication with the Google DFP Service

DfpApiException - 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 DfpException,
                                                                                        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 DFP documentation

Returns:

The number of objects effected by the perform operation

Throws:

DfpException - when :

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

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 DfpApiException,
                                                                                     DfpCommunicationException,
                                                                                     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:

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

DfpCommunicationException - 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,
                                                                                     DfpCommunicationException,
                                                                                     DfpApiException

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

DfpCommunicationException - if there is a communication problem with the api (such as timeouts etc)

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

createReport

@Processor
public com.google.api.ads.dfp.axis.v201711.ReportJob createReport(DownloadReportMethod createReportMethod,
                                                                             String dimensions,
                                                                             String columns,
                                                                             @Optional
                                                                             String dimensionAttributes,
                                                                             Date startDate,
                                                                             Date endDate)
                                                                      throws DfpException

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:

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

getCustomFieldOption

@Processor
public com.google.api.ads.dfp.axis.v201711.CustomFieldOption getCustomFieldOption(long customFieldOptionId)
                                                                                      throws DfpApiException,
                                                                                             DfpCommunicationException

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:

DfpCommunicationException - if there is a communication problem with the api (such as timeouts etc)

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

getReportJobStatus

@Processor
public com.google.api.ads.dfp.axis.v201711.ReportJobStatus getReportJobStatus(long reportJobId)
                                                                                  throws DfpApiException

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:

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

getAvailabilityForecast

@Processor
public com.google.api.ads.dfp.axis.v201711.AvailabilityForecast getAvailabilityForecast(@RefOnly @Default(value="#[payload]")
                                                                                                   com.google.api.ads.dfp.axis.v201711.ProspectiveLineItem prospectiveLineItem,
                                                                                                   @Optional
                                                                                                   Boolean includeTargetingCriteriaBreakdown,
                                                                                                   @Optional
                                                                                                   Boolean includeContendingLineItems)
                                                                                            throws DfpApiException,
                                                                                                   DfpCommunicationException

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

Returns:

AvailabilityForecast the availability forecast for the prospective line item given by parameter

Throws:

DfpCommunicationException - if there is a communication problem with the api (such as timeouts etc)

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

getAvailabilityForecastById

@Processor
public com.google.api.ads.dfp.axis.v201711.AvailabilityForecast getAvailabilityForecastById(long lineItemId,
                                                                                                       @Optional
                                                                                                       Boolean includeTargetingCriteriaBreakdown,
                                                                                                       @Optional
                                                                                                       Boolean includeContendingLineItems)
                                                                                                throws DfpApiException,
                                                                                                       DfpCommunicationException

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

Returns:

AvailabilityForecast the availability forecast for the prospective line item id given by parameter

Throws:

DfpCommunicationException - if there is a communication problem with the api (such as timeouts etc)

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

getDeliveryForecastByIds

@Processor
public com.google.api.ads.dfp.axis.v201711.DeliveryForecast getDeliveryForecastByIds(@Optional
                                                                                                String lineItemIds,
                                                                                                @Optional
                                                                                                String ignoredLineItems)
                                                                                         throws DfpApiException,
                                                                                                DfpCommunicationException

Retrieve the delivery forecast for the given prospective line items 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:

DfpCommunicationException - if there is a communication problem with the api (such as timeouts etc)

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

getDeliveryForecast

@Processor
public com.google.api.ads.dfp.axis.v201711.DeliveryForecast getDeliveryForecast(@RefOnly @Default(value="#[payload]")
                                                                                           List<com.google.api.ads.dfp.axis.v201711.ProspectiveLineItem> prospectiveLineItems,
                                                                                           @Optional
                                                                                           String ignoredLineItems)
                                                                                    throws DfpApiException,
                                                                                           DfpCommunicationException

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:

DfpCommunicationException - if there is a communication problem with the api (such as timeouts etc)

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