Create Report with Google Ads API on New Open (Instant) from Mailgun API

Pipedream makes it easy to connect APIs for Google Ads, Mailgun and 2,500+ other apps remarkably fast.

Trigger workflow on

New Open (Instant) from the Mailgun API

Next, do this

Create Report with the Google Ads API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Mailgun trigger and Google Ads action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Open (Instant) trigger
1. Connect your Mailgun account
2. Select a Domain Name
3. Configure Mailgun webhook signing key
Configure the Create Report action
1. Connect your Google Ads account
2. Select a Use Google Ads As
3. Optional- Select a Managed Account
4. Select a Resource
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger#

New Open (Instant) on Mailgun

Description:Emit new event when the email recipient opened the email and enabled image viewing. Open tracking must be enabled in the Mailgun control panel, and the CNAME record must be pointing to mailgun.org. See more at the Mailgun User's Manual [Tracking Messages](https://documentation.mailgun.com/en/latest/user_manual.html#tracking-messages) section

Version:0.0.2

Key:mailgun-new-open

View on GitHub

Mailgun Overview#

The Mailgun API on Pipedream is a potent tool for automating email operations without the overhead of managing a full-fledged email server. It offers capabilities to send, receive, track, and store emails with ease. With Pipedream's serverless platform, you can trigger workflows using Mailgun events, such as inbound emails or delivery status changes, and connect them to hundreds of other services to streamline communication, marketing, and notification systems within your ecosystem.

Trigger Code#

import common from "../common/http-based.mjs";

export default {
  ...common,
  key: "mailgun-new-open",
  name: "New Open (Instant)",
  type: "source",
  description: "Emit new event when the email recipient opened the email and enabled image " +
    "viewing. Open tracking must be enabled in the Mailgun control panel, and the CNAME record " +
    "must be pointing to mailgun.org. See more at the Mailgun User's Manual [Tracking Messages]" +
    "(https://documentation.mailgun.com/en/latest/user_manual.html#tracking-messages) section",
  version: "0.0.2",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getEventName() {
      return [
        "opened",
      ];
    },
    getEventType() {
      return [
        "OPENED",
        "opened",
      ];
    },
    generateMeta(payload) {
      const id = payload.message.headers["message-id"];
      return {
        id: `${payload.id}${payload.timestamp}`,
        summary: `New Open on message ${id} by ${payload.recipient}`,
        ts: payload.timestamp,
      };
    },
  },
};

Trigger Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Mailgun	`mailgun`	`app`	This component uses the Mailgun app.
Domain Name	`domain`	`string`	Select a value from the drop down menu.
Mailgun webhook signing key	`webhookSigningKey`	`string`	Your Mailgun webhook signing key, found in your Mailgun dashboard, located under Settings on the left-hand nav and then in API Keys look for webhook signing key. Required to compute the authentication signature of events.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.

Trigger Authentication#

Mailgun uses API keys for authentication. When you connect your Mailgun account, Pipedream securely stores the keys so you can easily authenticate to Mailgun APIs in both code and no-code steps.

About Mailgun#

Mailgun is an email automation service built for developers. Powerful transactional email APIs enable you to send, receive, and track emails.

Action#

Create Report on Google Ads

Description:Generates a report from your Google Ads data. [See the documentation](https://developers.google.com/google-ads/api/fields/v18/overview)

Version:0.1.1

Key:google_ads-create-report

View on GitHub

Google Ads Overview#

The Google Ads API lets you programmatically manage your Google Ads data and
campaigns. You can use the API to automate common tasks, such as:

Creating and managing campaigns
Adding and removing keywords
Adjusting bids

You can also use the API to get information about your campaigns, such as:

Campaign stats
Keyword stats
Ad performance

The Google Ads API is a powerful tool that lets you manage your Google Ads data
and campaigns programmatically. With the API, you can automate common tasks,
such as creating and managing campaigns, adding and removing keywords, and
adjusting bids. You can also use the API to get information about your
campaigns, such as campaign stats, keyword stats, and ad performance.

Customizing API requests with the Pipedream proxy

The Pipedream components interact with Google Ads API through Pipedream's proxy service, which handles authentication and developer token requirements.

The components accept a standard Google Ads API request object with the following structure:

const googleAdsReq = {
  method: "get|post|put|delete",  // HTTP method
  url: "/v16/...",                // Google Ads API endpoint path
  headers: {
    "Authorization": `Bearer ${this.googleAds.$auth.oauth_access_token}`
  },
  data: {}                        // Optional request body for POST/PUT requests
}

To make different API calls while using the proxy:

Modify the url path to match your desired Google Ads API endpoint
Update the method to match the required HTTP method
Add any necessary request body data in the data field
Include any required headers (Authorization is automatically included)

Example for a custom query:

const googleAdsReq = {
  method: "post",
  url: "/v16/customers/1234567890/googleAds:search",
  headers: {
    "Authorization": `Bearer ${this.googleAds.$auth.oauth_access_token}`
  },
  data: {
    query: "SELECT campaign.id, campaign.name FROM campaign"
  }
}

The proxy endpoint will remain the same: https://eolid4dq1k0t9hi.m.pipedream.net

Action Code#

import common from "../common/common.mjs";
import { adGroup } from "../../common/resources/adGroup.mjs";
import { ad } from "../../common/resources/ad.mjs";
import { campaign } from "../../common/resources/campaign.mjs";
import { customer } from "../../common/resources/customer.mjs";
import { ConfigurationError } from "@pipedream/platform";
import { DATE_RANGE_OPTIONS } from "./common-constants.mjs";
import { checkPrefix } from "../../common/utils.mjs";

const RESOURCES = [
  adGroup,
  ad,
  campaign,
  customer,
];

export default {
  ...common,
  key: "google_ads-create-report",
  name: "Create Report",
  description: "Generates a report from your Google Ads data. [See the documentation](https://developers.google.com/google-ads/api/fields/v18/overview)",
  version: "0.1.1",
  type: "action",
  props: {
    ...common.props,
    resource: {
      type: "string",
      label: "Resource",
      description: "The resource to generate a report for.",
      options: RESOURCES.map((r) => r.resourceOption),
      reloadProps: true,
    },
  },
  additionalProps() {
    const resource = RESOURCES.find((r) => r.resourceOption.value === this.resource);
    if (!resource) throw new ConfigurationError("Select one of the available resources.");

    const {
      label, value,
    } = resource.resourceOption;

    return {
      docsAlert: {
        type: "alert",
        alertType: "info",
        content: `[See the documentation](https://developers.google.com/google-ads/api/fields/v18/${value}) for more information on available fields, segments and metrics.`,
      },
      objectFilter: {
        type: "string[]",
        label: `Filter by ${label}s`,
        description: `Select the ${label}s to generate a report for (or leave blank for all ${label}s)`,
        optional: true,
        useQuery: true,
        options: async ({
          query, prevContext: { nextPageToken: pageToken },
        }) => {
          const {
            accountId, customerClientId, resource,
          } = this;
          const {
            results, nextPageToken,
          } = await this.googleAds.listResources({
            accountId,
            customerClientId,
            resource,
            query,
            pageToken,
          });
          const options = results?.map?.((item) => this.getResourceOption(item, resource));
          return {
            options,
            context: {
              nextPageToken,
            },
          };
        },
      },
      dateRange: {
        type: "string",
        label: "Date Range",
        description: "Select a date range for the report",
        options: DATE_RANGE_OPTIONS,
        optional: true,
        reloadProps: true,
      },
      ...(this.dateRange === "CUSTOM" && {
        startDate: {
          type: "string",
          label: "Start Date",
          description: "The start date, in `YYYY-MM-DD` format",
        },
        endDate: {
          type: "string",
          label: "End Date",
          description: "The end date, in `YYYY-MM-DD` format",
        },
      }),
      fields: {
        type: "string[]",
        label: "Fields",
        description: "Select any fields you want to include in your report.",
        options: resource.fields,
        optional: true,
        reloadProps: true,
      },
      segments: {
        type: "string[]",
        label: "Segments",
        description: "Select any segments you want to include in your report. See the documentation [here](https://developers.google.com/google-ads/api/fields/v18/segments)",
        options: resource.segments,
        default: [
          "segments.date",
        ],
        optional: true,
        reloadProps: true,
      },
      metrics: {
        type: "string[]",
        label: "Metrics",
        description: "Select any metrics you want to include in your report. See the documentation [here](https://developers.google.com/google-ads/api/fields/v18/metrics)",
        options: resource.metrics,
        optional: true,
        reloadProps: true,
      },
      orderBy: {
        type: "string",
        label: "Order By",
        description: "The field to order the results by",
        optional: true,
        options: [
          this.fields,
          this.segments,
          this.metrics,
        ].filter((v) => v).flatMap((value) => {
          let returnValue = value;
          if (typeof value === "string") {
            try {
              returnValue = JSON.parse(value);
            } catch (err) {
              returnValue = value.split(",");
            }
          }
          return returnValue?.map?.((str) => str.trim());
        }),
      },
      direction: {
        type: "string",
        label: "Direction",
        description: "The direction to order the results by, if `Order By` is specified",
        optional: true,
        options: [
          {
            label: "Ascending",
            value: "ASC",
          },
          {
            label: "Descending",
            value: "DESC",
          },
        ],
        default: "ASC",
      },
      limit: {
        type: "integer",
        label: "Limit",
        description: "The maximum number of results to return",
        optional: true,
      },
    };
  },
  methods: {
    getResourceOption(item, resource) {
      let label, value;
      switch (resource) {
      case "campaign":
        label = item.campaign.name;
        value = item.campaign.id;
        break;

      case "customer":
        label = item.customer.descriptiveName;
        value = item.customer.id;
        break;

      case "ad_group":
        label = item.adGroup.name;
        value = item.adGroup.id;
        break;

      case "ad_group_ad":
        label = item.adGroupAd.ad.name;
        value = item.adGroupAd.ad.id;
        break;
      }

      return {
        label,
        value,
      };
    },
    buildQuery() {
      const {
        resource, fields, segments, metrics, limit, orderBy, direction, objectFilter, dateRange,
      } = this;

      const filteredSegments = dateRange
        ? segments
        : segments?.filter((i) => i !== "segments.date");

      const selection = [
        ...checkPrefix(fields, resource),
        ...checkPrefix(filteredSegments, "segments"),
        ...checkPrefix(metrics, "metrics"),
      ];

      if (!selection.length) {
        throw new ConfigurationError("Select at least one field, segment or metric.");
      }

      let query = `SELECT ${selection.join(", ")} FROM ${resource}`;
      if (objectFilter) {
        query += ` WHERE ${resource === "ad_group_ad"
          ? "ad_group_ad.ad"
          : resource}.id IN (${objectFilter.join?.(", ") ?? objectFilter})`;
      }
      if (dateRange) {
        const dateClause = dateRange === "CUSTOM"
          ? `BETWEEN '${this.startDate}' AND '${this.endDate}'`
          : `DURING ${dateRange}`;
        query += ` ${objectFilter
          ? "AND"
          : "WHERE"} segments.date ${dateClause}`;
      }

      if (orderBy && direction) {
        query += ` ORDER BY ${orderBy} ${direction}`;
      }
      if (limit) {
        query += ` LIMIT ${limit}`;
      }

      return query;
    },
  },
  async run({ $ }) {
    const query = this.buildQuery();
    const results = (await this.googleAds.createReport({
      $,
      accountId: this.accountId,
      customerClientId: this.customerClientId,
      data: {
        query,
      },
    })) ?? [];

    const { length } = results;

    $.export("$summary", `Successfully obtained ${length} result${length === 1
      ? ""
      : "s"}`);
    return {
      query,
      results,
    };
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
Google Ads	`googleAds`	`app`	This component uses the Google Ads app.
Use Google Ads As	`accountId`	`string`	Select a value from the drop down menu.
Managed Account	`customerClientId`	`string`	Select a value from the drop down menu.
Resource	`resource`	`string`	Select a value from the drop down menu:`{ "label": "Ad Group", "value": "ad_group" }{ "label": "Ad", "value": "ad_group_ad" }{ "label": "Campaign", "value": "campaign" }{ "label": "Customer", "value": "customer" }`

Action Authentication#

Google Ads uses OAuth authentication. When you connect your Google Ads account, Pipedream will open a popup window where you can sign into Google Ads and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Google Ads API.

Pipedream requests the following authorization scopes when you connect your account:

emailprofilehttps://www.googleapis.com/auth/adwords

About Google Ads#

Reach customers wherever they are. Show up at the right time and place across the vast Google Ads ecosystem.

More Ways to Connect Google Ads + Mailgun#

Other Popular Integrations#

Add Contact to Customer List by Email with Google Ads API on New Bounce (Instant) from Mailgun API

Mailgun + Google Ads

Create Report with Google Ads API on New Open (Instant) from Mailgun API

Pipedream makes it easy to connect APIs for Google Ads, Mailgun and 2,500+ other apps remarkably fast.

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Customizing API requests with the Pipedream proxy

1-24of2,500+apps by most popular

1
-
24
of
2,500+
apps by most popular