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.).
Additional Info
Requires Mule Enterprise License |
Yes |
Requires Entitlement |
Yes |
Mule Version |
3.9.0 or higher |
Configs
OAuth 2.0
<google-ad-manager:config-oauth>
Connection Management
Connection strategy to connect with Google Ad Manager through OAuth authentication.
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
name |
The name of this configuration. With this name can be later referenced. |
x |
||
clientId |
the client Id |
x |
||
clientSecret |
the client secret |
x |
||
refreshToken |
The refresh token for Google Ad Manager. |
x |
||
tokenServerUrl |
The token server URL for Google Ad Manager. |
|
||
applicationName |
The application name for Google Ad Manager. |
x |
||
endpoint |
The endpoint (URL) for Google Ad Manager. |
|
||
networkCode |
The network code for Google Ad Manager. |
x |
Service Account
<google-ad-manager:config-service-account>
Connection Management
Connection strategy to connect with Google Ad Manager through service account authentication.
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
name |
The name of this configuration. With this name can be later referenced. |
x |
||
jsonKeyFilePath |
the path to the JSON file provided by google for service authentication |
x |
||
tokenServerUrl |
The token server URL for Google Ad Manager. |
|
||
applicationName |
The application name for Google Ad Manager. |
x |
||
endpoint |
The endpoint (URL) for Google Ad Manager. |
|
||
networkCode |
The network code for Google Ad Manager. |
x |
Processors
Download Report
<google-ad-manager:download-report>
DataSense enabled
Download a Report from the Google Ad Manager service.
XML Sample
<google-ad-manager:download-report config-ref="Google-ad-manager"/>
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
reportJob |
ReportJob |
the Report Job for which the download needs to be generated |
#[payload] |
|
exportFormat |
the format in which the document should be produced |
XML |
|
Get Report Download URL
<google-ad-manager:get-report-download-url>
Gets the URL containing the Report generated.
XML Sample
<google-ad-manager:get-report-download-url config-ref="Google-ad-manager" reportJobId="#[flowVars.reportJobId]" >
<google-ad-manager:report-download-options ref="#[flowVars.ReportDownloadOptionsRef]"/>
</google-ad-manager:get-report-download-url>
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
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 |
Select PQL
<google-ad-manager:select-pql>
Method for executing a PQL (Publisher-Query-Language) select statement to retrieve data from Google Ad Manager.
XML Sample
<google-ad-manager:select-pql config-ref="Google-ad-manager" fromTable="#[flowVars.fromTable]" queryString="#[flowVars.queryString]" >
<google-ad-manager:query-params ref="#[flowVars.QueryParamsRef]"/>
</google-ad-manager:select-pql>
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
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 |
x |
||
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) |
x |
||
queryParams |
the query parameters to filter the objects, these parameters should match the promised parameters specified in the queryString parameter |
x |
||
queryOrder |
the order in which the results will be retrieved |
ASC |
|
|
queryOffset |
the query limit for the statement |
0 |
|
Get by Statement
<google-ad-manager:get-by-statement>
DataSense enabled
Retrieve object(s) that match the query.
XML Sample
<google-ad-manager:get-by-statement config-ref="Google-ad-manager" selector="#[flowVars.selector]" queryString="#[flowVars.queryString]" >
<google-ad-manager:query-params ref="#[flowVars.QueryParamsRef]"/>
</google-ad-manager:get-by-statement>
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
selector |
the object that will be retrieved |
x |
||
queryString |
the query string to filter the objects The query string is written as id=:id, in turns the |
x |
||
queryParams |
the query parameters to filter the objects, these parameters should match the promised parameters specified in the |
x |
||
queryOrder |
the order in which the results will be retrieved |
ASC |
|
|
queryOffset |
the query offset for the statement |
0 |
|
Get
<google-ad-manager:get>
DataSense enabled
Gets a object(s) depending on the service chosen.
XML Sample
<google-ad-manager:get config-ref="Google-ad-manager" selector="#[flowVars.selector]" />
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
selector |
the object that will be retrieved |
x |
Perform
<google-ad-manager:perform>
DataSense enabled
Perform action onto objects.
XML Sample
<google-ad-manager:perform config-ref="Google-ad-manager" selector="#[flowVars.selector]" queryString="#[flowVars.queryString]" >
<google-ad-manager:query-params ref="#[flowVars.QueryParamsRef]"/>
</google-ad-manager:perform>
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
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 |
x |
||
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) |
x |
||
queryParams |
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 |
---|---|
The number of objects effected by the perform operation |
Create
<google-ad-manager:create>
DataSense enabled
Create Objects on a service.
XML Sample
<google-ad-manager:create config-ref="Google-ad-manager" selector="#[flowVars.selector]" />
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
selector |
the type of object being created (see CreateSelector) |
x |
||
objects |
List |
#[payload] |
|
Returns
Return Java Type | Description |
---|---|
List (either Long or String containing the IDs of the objects created |
Update
<google-ad-manager:update>
DataSense enabled
Update a list of Objects.
XML Sample
<google-ad-manager:update config-ref="Google-ad-manager" selector="#[flowVars.selector]" />
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
selector |
the update operation to be performed |
x |
||
items |
the items to be updated |
#[payload] |
|
Returns
Return Java Type | Description |
---|---|
List containing the IDs for the items updated through the operation |
Create Report
<google-ad-manager:create-report>
Creates a Report with the given parameters.
XML Sample
<google-ad-manager:create-report config-ref="Google-ad-manager" 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 |
Specify which config to use |
x |
||
createReportMethod |
whether sync (wait for report to be created) or async (refer to Get Report Job Status) |
x |
||
dimensions |
comma-delimited dimensions list |
x |
||
columns |
comma-delimited columns list |
x |
||
dimensionAttributes |
comma-delimited dimension attributes list |
|
||
startDate |
the start of the Report date |
x |
||
endDate |
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-ad-manager:get-custom-field-option>
Gets a Custom Field with the given Custom field Option ID.
XML Sample
<google-ad-manager:get-custom-field-option config-ref="Google-ad-manager" customFieldOptionId="#[flowVars.customFieldOptionId]" />
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
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-ad-manager: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-ad-manager:get-report-job-status config-ref="Google-ad-manager" reportJobId="#[flowVars.reportJobId]" />
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
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 |
Get Availability Forecast
<google-ad-manager:get-availability-forecast>
Retrieve the Availability Forecast for the given prospective Line Item.
XML Sample
<google-ad-manager:get-availability-forecast config-ref="Google-ad-manager"/>
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
prospectiveLineItem |
ProspectiveLineItem |
the prospective Line Item to retrieve the Availability Forecast for |
#[payload] |
|
includeTargetingCriteriaBreakdown |
boolean to include or not targeting criteria breakdown |
|
||
includeContendingLineItems |
boolean to include or not contending Line Items |
|
||
forecastBreakdownOptions |
ForecastBreakdownOptions |
Configuration of the forecast breakdown |
x |
Returns
Return Java Type | Description |
---|---|
AvailabilityForecast |
AvailabilityForecast the Availability Forecast for the |
Get Availability Forecast by ID
<google-ad-manager:get-availability-forecast-by-id>
Retrieve the Availability Forecast for the given prospective Line Item ID.
XML Sample
<google-ad-manager:get-availability-forecast-by-id config-ref="Google-ad-manager" lineItemId="#[flowVars.lineItemId]" />
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
lineItemId |
long |
the prospective Line Item ID for retrieve the Availability Forecast |
x |
|
includeTargetingCriteriaBreakdown |
boolean for include or not targeting criteria breakdown |
|
||
includeContendingLineItems |
boolean for include or not contending Line Items |
|
||
forecastBreakdownOptions |
ForecastBreakdownOptions |
configuration of the forecast breakdown |
x |
Returns
Return Java Type | Description |
---|---|
AvailabilityForecast |
AvailabilityForecast the Availability Forecast for the |
Get Delivery Forecast by IDs
<google-ad-manager:get-delivery-forecast-by-ids>
Retrieve the Delivery Forecast for the given prospective Line Item IDs.
XML Sample
<google-ad-manager:get-delivery-forecast-by-ids config-ref="Google-ad-manager"/>
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
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
Return Java Type | Description |
---|---|
DeliveryForecast |
DeliveryForecast the Delivery Forecast for the prospective |
Get Delivery Forecast
<google-ad-manager:get-delivery-forecast>
Retrieve the Delivery Forecast for the given prospective Line Items.
XML Sample
<google-ad-manager:get-delivery-forecast config-ref="Google-ad-manager"/>
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
prospectiveLineItems |
list of prospective Line Items for the Delivery Forecast |
#[payload] |
|
|
ignoredLineItems |
comma-delimited list of IDs for the Line Items to ignore |
|
Returns
Return Java Type | Description |
---|---|
DeliveryForecast |
DeliveryForecast the Delivery Forecast for the prospective |