Google’s DoubleClick for Publishers is a comprehensive hosted ad serving platform that streamlines your ad management functions and allows you to generate even-greater advertising margins. It offers publishers a complete ad revenue engine, helping publishers streamline operations and capture the most value for every impression.

Google DFP (Premium) Connector 3.1.0

The Anypoint Connector for Google DFP enables publishers and third-parties to consume the Google DFP API to help them grow, sell, schedule, deliver, and measure their digital ad inventory on Google DFP through Mule.

The connector has a Community and Premium version, the Community connector is free and open source, whilst the Premium connector is a paid-for and closed source version which contains extra functionality.

The Anypoint Connector for Google DFP allows one to easily build Mule applications to consume the following services of the Google DFP API: Company, Contact, Inventory, Line Item, Order, User, Report (Premium Only), Custom Field (Premium Only), Custom Targeting (Premium Only), Forecast (Premium Only), Placement (Premium Only), PQL (Premium Only).

MuleSoft maintains the Premium connector under the Certified support policy.

Prerequisites

This document assumes that you are familiar with Mule, Anypoint Connectors, and Anypoint Studio. To increase your familiarity with Studio, consider completing a Anypoint Studio Tutorial. This page requires some basic knowledge of Mule Concepts, Elements in a Mule Flow, and Global Elements.

To use the this connector, you will need an account on the Google DFP website. Click on this link to obtain a Google DFP account and the necessary authentication credentials (OAuth/Service Account).

You will also require Anypoint Studio downloaded and installed on your development machine.

Hardware and Software Requirements

For hardware and software requirements, please visit the Hardware and Software Requirements page.

Compatibility

Software Version

Mule Runtime

EE 3.6.x+

Java

7+

Google DFP

v201711

How to Install

You can install the connector in Anypoint Studio using the instructions in Installing a Connector from Anypoint Exchange.

How to Configure

To use the Google DFP Premium connector in your Mule application, you must configure a global Google DFP Premium element that can be used by the Google DFP Community connector (read more about Global Elements). The Google DFP Premium connector offers the following two global configurations described below.

1. OAuth Authentication

  1. Click the Global Elements tab at the base of the canvas, then click Create.

  2. In the Choose Global Type menu, use the filter to locate and select Google DFP (Premium): OAuth 2.0, then click OK.

  3. Configure the parameters according to the table below.

    Parameter Description

    Name

    Name for the configuration so it can be referenced later.

    Client Id

    Client ID for your Google DFP application created in the API console.

    Client Secret

    Corresponding client secret.

    Application Name

    Name of your application chosen in the API console.

    Endpoint

    DFP API end point server (Optional).

    Network Code

    Header networkCode associated with your application created in the API console.

    Refresh Token

    Refresh token.

    Token Server URL

    DFP API token server URL (Optional).
    oauth config

2. Service Account Authentication

  1. Click the Global Elements tab at the base of the canvas, then click Create.

  2. In the Choose Global Type menu, use the filter to locate and select Google DFP (Premium): Service Account, then click OK.

  3. Configure the parameters according to the table below.

    Parameter Description

    Name

    Name for the configuration so it can be referenced later.

    Json Key File Path

    File path for your Google DFP application Json Key.

    Application Name

    Name of your application chosen in the Google DFP API console.

    Endpoint

    Google DFP API end point server (Optional).

    Network Code

    Header networkCode associated with your application created in the API console.

    Token Server URL

    Google DFP API token server URL (Optional).
    service account config

Required Connector Namespace and Schema

When designing your application in Studio, the act of dragging the connector from the palette onto the Anypoint Studio canvas should automatically populate the XML code with the connector namespace and schema location.

Namespace: http://www.mulesoft.org/schema/mule/google-dfp-premium

Schema Location: http://www.mulesoft.org/schema/mule/google-dfp-premium/current/mule-google-dfp-premium.xsd

Tip
 If you are manually coding the Mule application in Studio’s XML editor or other text editor, define the namespace and schema location in the header of your Configuration XML, inside the <mule> tag. 
<mule xmlns="http://www.mulesoft.org/schema/mule/core"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xmlns:google-dfp-premium="http://www.mulesoft.org/schema/mule/google-dfp-premium"
      xsi:schemaLocation="
               http://www.mulesoft.org/schema/mule/core
               http://www.mulesoft.org/schema/mule/core/current/mule.xsd
               http://www.mulesoft.org/schema/mule/google-dfp-premium
               http://www.mulesoft.org/schema/mule/google-dfp-premium/current/mule-google-dfp-premium.xsd">
      <!-- put your global configuration elements and flows here -->
</mule>

Maven Dependency Information

If Maven is backing the application, this XML snippet must be included in your pom.xml file.

<dependency>
  <groupId>org.mule.modules</groupId>
  <artifactId>google-dfp-connector-premium</artifactId>
  <version>3.1.0</version>
</dependency>

Common Use Cases

Create Company

The following walkthrough describes a simple procedure to use the connector and create a company on Google DFP.

usecase createcompany 01

  1. Drag an HTTP Endpoint into a new flow. Configure a new HTTP Listener Configuration on Port 8081. In the properties view of the HTTP Endpoint configure the HTTP endpoint as follows:

    Field

    Value

    Display Name

    HTTP (or any other name you prefer)

    Exchange Pattern

    request-response

    Path

    /createCompany

    Port

    8081

    Method

    POST

  2. Drag a Google DFP (Premium) connector endpoint into the same flow. Select it to open the properties editor console. Next to Connector Configuration click the + sign to add a new connection configuration and add your credentials. Set the rest of the properties as follows:

    usecase createcompany 03

  3. Add a Dataweave transformer after HTTP endpoint to create a new Google Company to pass on to the connector. Do the mapping from a JSON object to a Google Company object to assign the values.

    usecase createcompany 02

    Since internally the Google DFP library uses classes to represent Enum a global MEL function should be defined in the Mule Configuration XML as shown below:

        <configuration doc:name="Configuration">
        <expression-language>
            <global-functions>
              def stringToCompanyType(enumString){
    		return com.google.api.ads.dfp.axis.v201711.CompanyType.fromString(enumString.toUpperCase())
          	}
    	     </global-functions>
         </expression-language>
    </configuration>

  4. Add another Dataweave transformer after the Google DFP endpoint to map an object of List<Long> returned by the Google DFP to JSON and extract the new company ID.

  5. Save the project and then run it as a Mule Application (right-click project name, then select Run As > Mule Application).

  6. Make a POST request to: http://localhost:8081/createCompany with a suitable body:

        {
      "Companies":
      [
        {
          "companyName": "demoCompany",
          "companyAddress": "12, John Doe Street, Birkirkara BKR1234",
          "companyEmail": "hello@democompany.com",
          "companyType": "Agency"
        }
      ]
    }

  7. The Mule application will perform the operation and add the Company record to GoogleDfp. An ID should be returned in JSON format.

Get a Company

The following walkthrough describes a simple procedure to use the connector and retrieve a company record from Google DFP.

usecase getcompany 01

  1. Drag an HTTP Endpoint into a new flow. Configure a new HTTP Listener Configuration on Port 8081. In the properties view of the HTTP Endpoint configure the HTTP endpoint as follows:

    Field

    Value

    Display Name

    HTTP (or any other name you prefer)

    Exchange Pattern

    request-response

    Path

    /getCompany/{companyId}

    Port

    8081

    Method

    GET

  2. Drag a Google DFP (Premium) connector endpoint into the same flow. Select it to open the properties editor console. Next to Connector Configuration click the + sign to add a new connection configuration and add your credentials. Set the rest of the properties as follows:

    usecase getcompany 02

  3. In the Query Params field, select Create Object manually. Click the button …​ and in the popup window that opens select the + sign to create a new object. Configure the new object as follows:

    usecase getcompany 03

  4. Add an Object to JSON transformer after the Google DFP connector endpoint.

  5. Save the project and then run it as a Mule Application (right-click project name, then select Run As > Mule Application).

  6. Make a GET request to: http://localhost:8081/getCompany/1234. Here 1234 refers to the ID of the company you are trying to retrieve.

  7. The Mule application will perform the operation and return JSON data containing information about the company requested.

Update a Company

The following walkthrough describes a simple procedure to use the connector to update a Company record on Google DFP.

usecase updatecompany 01

  1. Drag an HTTP Endpoint into a new flow. Configure a new HTTP Listener Configuration on Port 8081. In the properties view of the HTTP Endpoint configure the HTTP endpoint as follows:

    Field

    Value

    Display Name

    HTTP (or any other name you prefer)

    Exchange Pattern

    request-response

    Path

    /updateCompany

    Port

    8081

    Method

    PUT

  2. Add a Dataweave transformer after HTTP endpoint to create a new Google Company to pass on to the connector. Do the mapping from a JSON object to a Google Company object to assign the values.

    usecase updatecompany 02

  3. Drag a Google DFP (Premium) connector endpoint into the same flow. Select it to open the properties editor console. Next to Connector Configuration click the + sign to add a new connection configuration and add your credentials. Set the rest of the properties as follows:

    usecase updatecompany 03

  4. Add an Object to JSON transformer after the Google DFP connector endpoint to transform the Google Company object into JSON data.

  5. Save the project and then run it as a Mule Application (right-click project name, then select Run As > Mule Application).

  6. Make a PUT request to: http://localhost:8081/updateCompany with a suitable body:

        {
      "Companies":
      [
        {
        "companyId": "12345",
        "companyEmail" : "updatedcompanyemail@mycompany.com",
        "companyName": "updatedCompany",
        "companyAddress": "60, John Doe Street, Birkirkara BKR1234"
        }
      ]
    }

  7. The Mule application will perform the operation and return the ID of the update company record.

Create a Report

The following walkthrough describes a simple procedure to use the connector and create a report on Google DFP.

usecase createreport 01

  1. Drag an HTTP Endpoint into a new flow. Configure a new HTTP Listener Configuration on Port 8081. In the properties view of the HTTP Endpoint configure the HTTP endpoint as follows:

    Field

    Value

    Display Name

    HTTP (or any other name you prefer)

    Exchange Pattern

    request-response

    Path

    /createReport

    Port

    8081

    Method

    POST

  2. Add a Dataweave transformer after HTTP endpoint to create a new Report object to pass on to the connector.

    usecase createreport 02

  3. Drag a Google DFP (Premium) connector endpoint into the same flow. Select it to open the properties editor console. Next to Connector Configuration click the + sign to add a new connection configuration and add your credentials. Set the rest of the properties as follows:

    usecase createreport 03

  4. Add an Object to JSON transformer after the Google DFP connector endpoint to transform the Report object into JSON data.

  5. Save the project and then run it as a Mule Application (right-click project name, then select Run As > Mule Application).

  6. Make a POST request to: http://localhost:8081/createReport with a suitable body:

        {
      "Report": {
        "dimensions": "LINE_ITEM_ID,MONTH_AND_YEAR",
        "columns": "AD_SERVER_IMPRESSIONS",
        "dimensionAttributes": null,
        "startDate": "2017-01-01",
        "endDate": "2019-01-31"
      }
    }

  7. The Mule application will perform the operation and return the contents of the created report.

Create and Download a Report

The following walkthrough describes a simple procedure to use the connector to create a report and then retrieve it as an XML file.

usecase downloadrep 01

  1. Drag an HTTP Endpoint into a new flow. Configure a new HTTP Listener Configuration on Port 8081. In the properties view of the HTTP Endpoint configure the HTTP endpoint as follows:

    Field

    Value

    Display Name

    HTTP (or any other name you prefer)

    Exchange Pattern

    request-response

    Path

    /createDownload

    Port

    8081

    Method

    GET

  2. Add a Dataweave transformer to map the data into a Report object. For the purpose of this example, the data for the report we wish to create has been hardcoded.

    usecase downloadrep 02

  3. Drag a Google DFP (Premium) connector endpoint into the same flow. Select it to open the properties editor console. Next to Connector Configuration click the + sign to add a new connection configuration and add your credentials. Set the rest of the properties as follows:

    usecase downloadrep 03

  4. Add another Google DFP (Premium) connector endpoint and configure it with the operations to download a report:

    usecase downloadrep 04

  5. Save the project and then run it as a Mule Application (right-click project name, then select Run As > Mule Application).

  6. Make a GET request to: http://localhost:8081/createDownload.

  7. The Mule application will perform the operation and the created report should be displayed in XML format.

Get Report Download URL

The following walkthrough describes a simple procedure to use the connector and retrieve a report by obtaining a download URL.

usecase reporturl 01

  1. Drag an HTTP Endpoint into a new flow. Configure a new HTTP Listener Configuration on Port 8081. In the properties view of the HTTP Endpoint configure the HTTP endpoint as follows:

    Field

    Value

    Display Name

    HTTP (or any other name you prefer)

    Exchange Pattern

    request-response

    Path

    /reportUrl/{reportId}

    Port

    8081

    Method

    GET

  2. Drag a Google DFP (Premium) connector endpoint into the same flow. Select it to open the properties editor console. Next to Connector Configuration click the + sign to add a new connection configuration and add your credentials. Set the rest of the properties as follows:

    usecase reporturl 02

    Since internally the Google DFP library uses classes to represent Enum a global MEL function should be defined in the Mule Configuration XML as shown below:

        <configuration doc:name="Configuration">
        <expression-language>
            <global-functions>
              def stringToExportFormat(enumString){
    		return com.google.api.ads.dfp.axis.v201711.ExportFormat.fromString(enumString.toUpperCase())
          	}
    	     </global-functions>
         </expression-language>
    </configuration>

  3. Add a Dataweave transformer after the Google DFP connector endpoint and modify it as follows:

    usecase reporturl 03

  4. Save the project and then run it as a Mule Application (right-click project name, then select Run As > Mule Application).

  5. Make a GET request to: http://localhost:8081/reportUrl/1234. Here 1234 refers to the ID of the report you are trying to retrieve.

  6. The Mule application will perform the operation and return download URL for the requested report.

Select PQL

This walkthrough describes a procedure to retrieve reports using a PQL statement from Google DFP.

usecase pql 01

  1. Drag an HTTP Endpoint into a new flow. Configure a new HTTP Listener Configuration on Port 8081. In the properties view of the HTTP Endpoint configure the HTTP endpoint as follows:

    Field

    Value

    Display Name

    HTTP (or any other name you prefer)

    Exchange Pattern

    request-response

    Path

    /pql/{reportId}

    Port

    8081

    Method

    GET

  2. Drag a Google DFP (Premium) connector endpoint into the same flow. Select it to open the properties editor console. Next to Connector Configuration click the + sign to add a new connection configuration and add your credentials. Set the rest of the properties as follows: (For the purpose of demonstrating the operation, the query values have been hardcoded)

    usecase pql 02

  3. In the Query Params field, select Create Object Manually and click on …​. In the popup window that appears, click the + to configure a new Object. Create a new object as follows:

    usecase pql 03

  4. Add an Object to JSON transformer after the Google DFP connector endpoint.

  5. Save the project and then run it as a Mule Application (right-click project name, then select Run As > Mule Application).

  6. Make a GET request to: http://localhost:8081/pql/1234. Here 1234 refers to the ID of the report you are trying to retrieve.

  7. The Mule application will perform the operation and return the results of the query.

Supported Operations

Operations that are Currently Supported (ordered by Service):

  • Company Service:

    • Create Companies

    • Get Companies

    • Update Companies

  • Contact Service:

    • Create Contacts

    • Get Contacts

    • Update Contacts

  • Custom Field Service:

    • Create Custom Field Options

    • Create Custom Field

    • Get Custom Field Option

    • Perform Custom Field Action

    • Update Custom Field Option

    • Update Custom Fields

  • Custom Targeting Service:

    • Create Custom Targeting Keys

    • Create Custom Targeting Values

    • Get Custom Targeting Keys

    • Get Custom Targeting Values

    • Perform Custom Targeting Keys

    • Perform Custom Targeting Values

    • Update Custom Targeting Keys

    • Update Custom Targeting Values

  • Forecast Service:

    • Get Availability Forecast

    • Get Availability Forecast by ID

    • Get Delivery Forecast

    • Get Delivery Forecast by ID

  • Inventory Service (Ad Units):

    • Create Ad Units

    • Get Ad Units

    • Get Ad Unit Sizes

    • Perform Ad Units

    • Update Ad Units

  • Line Item Service:

    • Create Line Items

    • Get Line Items

    • Perform Line Items

    • Update Line Items

  • Order Service:

    • Create Orders

    • Get Orders

    • Perform Orders Action

    • Update Orders

  • Placement Service:

    • Create Placements

    • Get Placements

    • Perform Placements

    • Update Placements

  • Publisher Query Language Service:

    • Select PQL

  • Report Service:

    • Create Report Asynchronously

    • Create Report Synchronously

    • Download Report

    • Get Report Download Url With Options

    • Get Report Status

    • Get Saved Queries by Statement

  • User Service:

    • Create Users

    • Get All Roles

    • Get Current User

    • Get Users

    • Perform Users

    • Update Users

Resources