Google DFP Connector

Additional Info

Requires Mule Enterprise License

No  

Requires Entitlement

No  

Mule Version

3.6.0 or higher

Configs

OAuth-Configuration

<google-dfp:config-oauth>

Connection Management

Configuration type Strategy

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 DFP19

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

 

applicationName

String

The application name for Google DFP

x 

endpoint

String

The endpoint for Google DFP

https://ads.google.com/

 

networkCode

String

The network code for Google DFP

x 

Service-Account-Configuration

<google-dfp:config-service-account>

Connection Management

Configuration type Strategy

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

x 

tokenServerUrl

String

The token server URL for Google DFP19

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

 

applicationName

String

The application name for Google DFP

x 

endpoint

String

The endpoint for Google DFP

https://ads.google.com/

 

networkCode

String

The network code for Google DFP

x 

Processors

Get by statement

<google-dfp:get-by-statement>

  DataSense enabled

Retrieve object(s) that match the query

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 turn 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

x 

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:get>

  DataSense enabled

Gets a object(s) depending on the service chosen

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:perform>

  DataSense enabled

Perform action onto objects

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:create>

  DataSense enabled

Create Objects on a service

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:update>

  DataSense enabled

Update a list of Objects

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