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

Additional Info

Requires Mule Enterprise License

Yes  

Requires Entitlement

Yes  

Mule Version

3.6.0 or higher

Configs

OAuth 2.0

<google-dfp-premium:config-oauth>

Connection Management

Connection strategy to connect with Google DFP through OAuth authentication

Attributes

Name Java Type Description Default Value Required

name

String

The name of this configuration. With this name can be later referenced.

x 

clientId

String

The client Id

x 

clientSecret

String

The client secret

x 

refreshToken

String

The refresh token for Google DFP

x 

tokenServerUrl

String

The token server URL for Google DFP

https://accounts.google.com/o/oauth2/token

 

applicationName

String

The application name for Google DFP

x 

endpoint

String

The endpoint (url) for Google DFP

https://ads.google.com/

 

networkCode

String

The network code for Google DFP

x 

Service Account

<google-dfp-premium:config-service-account>

Connection Management

Connection strategy to connect with Google DFP through service account authentication

Attributes

Name Java Type Description Default Value Required

name

String

The name of this configuration. With this name can be later referenced.

x 

jsonKeyFilePath

String

The path to the json file provided by google for service authentication

x 

tokenServerUrl

String

The token server URL for Google DFP

https://accounts.google.com/o/oauth2/token

 

applicationName

String

The application name for Google DFP

x 

endpoint

String

The endpoint (url) for Google DFP

https://ads.google.com/

 

networkCode

String

The network code for Google DFP

x 

Processors

Download report

<google-dfp-premium:download-report>

  DataSense enabled

Download a report from the Google DFP service

XML Sample

<google-dfp-premium:download-report config-ref="Google-dfp-premium"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

reportJob

ReportJob

The report job for which the download needs to be generated

#[payload]

 

exportFormat

ExportFormat

The format in which the document should be produced

XML

 

Returns

Return Java Type Description

InputStream

Input Stream containing a dump of the report

Get report download url

<google-dfp-premium:get-report-download-url>

Gets the URL containing the report generated

XML Sample

<google-dfp-premium:get-report-download-url config-ref="Google-dfp-premium" reportJobId="#[flowVars.reportJobId]" >
                <google-dfp-premium:report-download-options ref="#[flowVars.ReportDownloadOptionsRef]"/>
        </google-dfp-premium:get-report-download-url>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

reportJobId

long

The Report Job Id (refer to Create Report)

x 

reportDownloadOptions

ReportDownloadOptions

Report Download Options a POJO containing the report download options

x 

Returns

Return Java Type Description

String

The URL location of the report

Select pql

<google-dfp-premium:select-pql>

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

XML Sample

<google-dfp-premium:select-pql config-ref="Google-dfp-premium" fromTable="#[flowVars.fromTable]"  queryString="#[flowVars.queryString]" >
                <google-dfp-premium:query-params ref="#[flowVars.QueryParamsRef]"/>
        </google-dfp-premium:select-pql>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

selectCols

String

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

String

The name of the table from which the data will be obtained

x 

queryString

String

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)

x 

queryParams

Map<String,Object>

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

x 

queryOrder

String

The order in which the results will be retrieved

ASC

 

queryOffset

Integer

The query limit for the statement

0

 

Returns

Return Java Type Description

List<String[]>

Result of the 'select' operation.

Get by statement

<google-dfp-premium:get-by-statement>

  DataSense enabled

Retrieve object(s) that match the query

XML Sample

<google-dfp-premium:get-by-statement config-ref="Google-dfp-premium" selector="#[flowVars.selector]"  queryString="#[flowVars.queryString]" >
                <google-dfp-premium:query-params ref="#[flowVars.QueryParamsRef]"/>
        </google-dfp-premium:get-by-statement>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

selector

GetByStatementSelector

The object that will be retrieved

x 

queryString

String

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)

x 

queryParams

Map<String,Object>

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

x 

queryOrder

String

The order in which the results will be retrieved

ASC

 

queryOffset

Integer

The query offset for the statement

0

 

Returns

Return Java Type Description

Object

Object object(s) that match with the parameters

Get

<google-dfp-premium:get>

  DataSense enabled

Gets a object(s) depending on the service chosen

XML Sample

<google-dfp-premium:get config-ref="Google-dfp-premium" selector="#[flowVars.selector]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

selector

GetSelector

The object that will be retrieved

x 

Returns

Return Java Type Description

Object

User or List of Role

Perform

<google-dfp-premium:perform>

  DataSense enabled

Perform action onto objects

XML Sample

<google-dfp-premium:perform config-ref="Google-dfp-premium" selector="#[flowVars.selector]"  queryString="#[flowVars.queryString]" >
                <google-dfp-premium:query-params ref="#[flowVars.QueryParamsRef]"/>
        </google-dfp-premium:perform>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

selector

String

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

x 

queryString

String

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)

x 

queryParams

Map<String,Object>

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

x 

Returns

Return Java Type Description

Integer

The number of objects effected by the perform operation

Create

<google-dfp-premium:create>

  DataSense enabled

Create Objects on a service

XML Sample

<google-dfp-premium:create config-ref="Google-dfp-premium" selector="#[flowVars.selector]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

selector

CreateSelector

The type of object being created (see CreateSelector)

x 

objects

Object

List Objects to be created (different depending on the service chosen)

#[payload]

 

Returns

Return Java Type Description

Object

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

Update

<google-dfp-premium:update>

  DataSense enabled

Update a list of Objects

XML Sample

<google-dfp-premium:update config-ref="Google-dfp-premium" selector="#[flowVars.selector]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

selector

UpdateSelector

The update operation to be performed

x 

items

Object

The items to be updated

#[payload]

 

Returns

Return Java Type Description

Object

List containing the ids for the items updated through the operation

Create report

<google-dfp-premium:create-report>

Creates a report with the given parameters

XML Sample

<google-dfp-premium:create-report config-ref="Google-dfp-premium" createReportMethod="#[flowVars.createReportMethod]"  dimensions="#[flowVars.dimensions]"  columns="#[flowVars.columns]"  startDate="#[flowVars.startDate]"  endDate="#[flowVars.endDate]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

createReportMethod

DownloadReportMethod

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

x 

dimensions

String

comma-delimited dimensions list

x 

columns

String

comma-delimited columns list

x 

dimensionAttributes

String

comma-delimited dimension attributes list

 

startDate

Date

the start of the report date

x 

endDate

Date

the end of the report date

x 

Returns

Return Java Type Description

ReportJob

ReportJob the report job of the report created/being created

Get custom field option

<google-dfp-premium:get-custom-field-option>

Gets a Custom Field with the given Custom field option ID

XML Sample

<google-dfp-premium:get-custom-field-option config-ref="Google-dfp-premium" customFieldOptionId="#[flowVars.customFieldOptionId]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

customFieldOptionId

long

the ID of the custom field option

x 

Returns

Return Java Type Description

CustomFieldOption

CustomFieldOption the custom field option that has the id specified

Get report job status

<google-dfp-premium:get-report-job-status>

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

XML Sample

<google-dfp-premium:get-report-job-status config-ref="Google-dfp-premium" reportJobId="#[flowVars.reportJobId]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

reportJobId

long

the ID of the Report Job

x 

Returns

Return Java Type Description

ReportJobStatus

ReportJobStatus the job status of the report that has the id submitted

Get availability forecast

<google-dfp-premium:get-availability-forecast>

Retrieve the availability forecast for the given prospective line item

XML Sample

<google-dfp-premium:get-availability-forecast config-ref="Google-dfp-premium"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

prospectiveLineItem

ProspectiveLineItem

the prospective line item to retrieve the availability forecast for

#[payload]

 

includeTargetingCriteriaBreakdown

Boolean

boolean to include or not targeting criteria breakdown

 

includeContendingLineItems

Boolean

boolean to include or not contending line items

 

Returns

Return Java Type Description

AvailabilityForecast

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

Get availability forecast by id

<google-dfp-premium:get-availability-forecast-by-id>

Retrieve the availability forecast for the given prospective line item id

XML Sample

<google-dfp-premium:get-availability-forecast-by-id config-ref="Google-dfp-premium" lineItemId="#[flowVars.lineItemId]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

lineItemId

long

the prospective line item id for retrieve the availability forecast

x 

includeTargetingCriteriaBreakdown

Boolean

boolean for include or not targeting criteria breakdown

 

includeContendingLineItems

Boolean

boolean for include or not contending line items

 

Returns

Return Java Type Description

AvailabilityForecast

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

Get delivery forecast by ids

<google-dfp-premium:get-delivery-forecast-by-ids>

Retrieve the delivery forecast for the given prospective line items ids

XML Sample

<google-dfp-premium:get-delivery-forecast-by-ids config-ref="Google-dfp-premium"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

lineItemIds

String

comma-delimited list of ids for the line items to include

 

ignoredLineItems

String

comma-delimited list of ids for the line items to ignore

 

Returns

Return Java Type Description

DeliveryForecast

DeliveryForecast the delivery forecast for the prospective line item ids given by parameter

Get delivery forecast

<google-dfp-premium:get-delivery-forecast>

Retrieve the delivery forecast for the given prospective line items

XML Sample

<google-dfp-premium:get-delivery-forecast config-ref="Google-dfp-premium"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

prospectiveLineItems

List

list of prospective line items for the delivery forecast

#[payload]

 

ignoredLineItems

String

comma-delimited list of ids for the line items to ignore

 

Returns

Return Java Type Description

DeliveryForecast

DeliveryForecast the delivery forecast for the prospective line items given by parameter