Run Actor with Apify API on New Lead Form Entry from Google Ads API

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

Trigger workflow on

New Lead Form Entry from the Google Ads API

Next, do this

Run Actor with the Apify 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 Google Ads trigger and Apify action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Lead Form Entry trigger
1. Connect your Google Ads account
2. Select a Use Google Ads As
3. Optional- Select a Managed Account
4. Configure timer
5. Select a Lead Form ID
6. Configure docsAlert
Configure the Run Actor action
1. Connect your Apify account
2. Select a Actor ID
3. Select a Build
4. Configure Run Asynchronously
5. Optional- Configure Timeout
6. Optional- Configure Memory
7. Optional- Configure Max Items
8. Optional- Configure Max Total Charge USD
9. Optional- Configure Webhook
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 Lead Form Entry on Google Ads

Description:Emit new event for new leads on a Lead Form. [See the documentation](https://developers.google.com/google-ads/api/fields/v18/lead_form_submission_data)

Version:0.0.4

Key:google_ads-new-lead-form-entry

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 from within the Pipedream workflow builder

The Pipedream components interact with Google Ads API through an interal proxy service, which protects Pipedream's developer token.

The component accepts a standard Google Ads API request object with the following structure:

const googleAdsReq = {
  method: "get|post|put|delete", // HTTP method
  url: "/v18/...", // 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://googleads.m.pipedream.net

Using Google Ads with the Connect API Proxy

To interface with Google Ads via the Connect API Proxy, you need to nest the request like this:

Important notes:

The upstream URL in this case is Pipedream's proxy service for Google Ads: https://googleads.m.pipedream.net
Like in the above examples, you'll define the Google Ads URL with the url param in the body
The method to the Connect Proxy should always be a POST, since it's actually targeting the Google Ads proxy (you can define the method for the Google Ads request in options.body.method)

Using the Pipedream SDK

const pd = createBackendClient({
  apiHost: process.env.API_HOST,
  credentials: {
    clientId: process.env.CLIENT_ID,
    clientSecret: process.env.CLIENT_SECRET,
  },
  environment: process.env.ENVIRONMENT,
  projectId: process.env.PROJECT_ID,
});

const pdGoogleAdsUrl = "https://googleads.m.pipedream.net";

const resp = await pd.makeProxyRequest(
  {
    searchParams: {
      external_user_id: process.env.EXTERNAL_USER_ID,
      account_id: process.env.ACCOUNT_ID,
    },
  },
  {
    url: pdGoogleAdsUrl,
    options: {
      method: "POST",
      body: {
        url: "/v19/customers:listAccessibleCustomers",
        method: "GET",
        // data: {} // If you need to send a body with a POST request, define it here
      },
    },
  }
);

Using the Connect REST API

Remember to use the Base64 encoded Pipedream endpoint for Google Ads: https://googleads.m.pipedream.net

curl -X POST "https://api.pipedream.com/v1/connect/{your_project_id}/proxy/{url_safe_base64_encoded_url}?external_user_id={external_user_id}&account_id={apn_xxxxxxx}" \
  -H "Authorization: Bearer {access_token}" \
  -H "x-pd-environment: {development | production}" \
  -d '{
    "url": "/v19/customers:listAccessibleCustomers",
    "method": "GET",
    # "data": {} # If you need to send a body with a POST request, define it here
  }'

Trigger Code#

import common from "../common/common.mjs";
import sampleEmit from "./test-event.mjs";

const { googleAds } = common.props;

export default {
  ...common,
  key: "google_ads-new-lead-form-entry",
  name: "New Lead Form Entry",
  description: "Emit new event for new leads on a Lead Form. [See the documentation](https://developers.google.com/google-ads/api/fields/v18/lead_form_submission_data)",
  version: "0.0.4",
  type: "source",
  dedupe: "unique",
  sampleEmit,
  props: {
    ...common.props,
    leadFormId: {
      propDefinition: [
        googleAds,
        "leadFormId",
        (({
          accountId, customerClientId,
        }) => ({
          accountId,
          customerClientId,
        })),
      ],
    },
    docsAlert: {
      type: "alert",
      alertType: "info",
      content: "If needed, see Google's documentation on [submission fields](https://developers.google.com/google-ads/api/reference/rpc/v18/LeadFormSubmissionField) and [custom submission fields](https://developers.google.com/google-ads/api/reference/rpc/v18/CustomLeadFormSubmissionField).",
    },
  },
  methods: {
    ...common.methods,
    getSummary() {
      return "New Lead";
    },
    getItems() {
      const {
        accountId, customerClientId, leadFormId,
      } = this;
      return this.googleAds.getLeadFormData({
        accountId,
        customerClientId,
        leadFormId,
      });
    },
  },
};

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
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.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Lead Form ID	`leadFormId`	`string`	Select a value from the drop down menu.

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

Action#

Run Actor on Apify

Description:Performs an execution of a selected actor in Apify. [See the documentation](https://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor)

Version:0.0.3

Key:apify-run-actor

View on GitHub

Apify Overview#

The Apify API unleashes the power to automate web scraping, process data, and orchestrate web automation workflows. By utilizing Apify on Pipedream, you can create dynamic serverless workflows to manage tasks like extracting data from websites, running browser automation, and scheduling these jobs to run autonomously. It integrates smoothly with Pipedream's capabilities to trigger actions on various other apps, store the results, and manage complex data flow with minimal setup.

Action Code#

/* eslint-disable no-unused-vars */
import apify from "../../apify.app.mjs";
import { parseObject } from "../../common/utils.mjs";
import { EVENT_TYPES } from "../../common/constants.mjs";

export default {
  key: "apify-run-actor",
  name: "Run Actor",
  description: "Performs an execution of a selected actor in Apify. [See the documentation](https://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor)",
  version: "0.0.3",
  type: "action",
  props: {
    apify,
    actorId: {
      propDefinition: [
        apify,
        "actorId",
      ],
    },
    buildId: {
      propDefinition: [
        apify,
        "buildId",
        (c) => ({
          actorId: c.actorId,
        }),
      ],
      reloadProps: true,
    },
    runAsynchronously: {
      type: "boolean",
      label: "Run Asynchronously",
      description: "Set to `true` to run the actor asynchronously",
      reloadProps: true,
    },
    timeout: {
      type: "string",
      label: "Timeout",
      description: "Optional timeout for the run, in seconds. By default, the run uses a timeout specified in the default run configuration for the Actor.",
      optional: true,
    },
    memory: {
      type: "string",
      label: "Memory",
      description: "Memory limit for the run, in megabytes. The amount of memory can be set to a power of 2 with a minimum of 128. By default, the run uses a memory limit specified in the default run configuration for the Actor.",
      optional: true,
    },
    maxItems: {
      type: "string",
      label: "Max Items",
      description: "The maximum number of items that the Actor run should return. This is useful for pay-per-result Actors, as it allows you to limit the number of results that will be charged to your subscription. You can access the maximum number of items in your Actor by using the ACTOR_MAX_PAID_DATASET_ITEMS environment variable.",
      optional: true,
    },
    maxTotalChargeUsd: {
      type: "string",
      label: "Max Total Charge USD",
      description: "Specifies the maximum cost of the Actor run. This parameter is useful for pay-per-event Actors, as it allows you to limit the amount charged to your subscription. You can access the maximum cost in your Actor by using the ACTOR_MAX_TOTAL_CHARGE_USD environment variable.",
      optional: true,
    },
    webhook: {
      type: "string",
      label: "Webhook",
      description: "Specifies optional webhook associated with the Actor run, which can be used to receive a notification e.g. when the Actor finished or failed.",
      optional: true,
      reloadProps: true,
    },
  },
  methods: {
    getType(type) {
      return [
        "string",
        "object",
        "integer",
        "boolean",
      ].includes(type)
        ? type
        : "string[]";
    },
    async getSchema(buildId) {
      const { data: { inputSchema } } = await this.apify.getBuild(buildId);
      return JSON.parse(inputSchema);
    },
    async prepareData(data) {
      const newData = {};

      const { properties } = await this.getSchema(this.buildId);
      for (const [
        key,
        value,
      ] of Object.entries(data)) {
        const editor = properties[key].editor;
        newData[key] = (Array.isArray(value))
          ? value.map((item) => this.setValue(editor, item))
          : value;
      }
      return newData;
    },
    prepareOptions(value) {
      let options = [];
      if (value.enum && value.enumTitles) {
        for (const [
          index,
          val,
        ] of value.enum.entries()) {
          if (val) {
            options.push({
              value: val,
              label: value.enumTitles[index],
            });
          }
        }
      }
      return options.length
        ? options
        : undefined;
    },
    setValue(editor, item) {
      switch (editor) {
      case "requestListSources" : return {
        url: item,
      };
      case "pseudoUrls" : return {
        purl: item,
      };
      case "globs" : return {
        glob: item,
      };
      default: return item;
      }
    },
  },
  async additionalProps() {
    const props = {};
    if (this.buildId) {
      try {
        const {
          properties, required: requiredProps = [],
        } = await this.getSchema(this.buildId);

        for (const [
          key,
          value,
        ] of Object.entries(properties)) {
          if (value.editor === "hidden") continue;

          props[key] = {
            type: this.getType(value.type),
            label: value.title,
            description: value.description,
            optional: !requiredProps.includes(key),
          };
          const options = this.prepareOptions(value);
          if (options) props[key].options = options;
          if (value.default) {
            props[key].description += ` Default: \`${JSON.stringify(value.default)}\``;
            if (props[key].type !== "object") { // default values don't work properly for object props
              props[key].default = value.default;
            }
          }
        }
      } catch {
        props.properties = {
          type: "object",
          label: "Properties",
          description: "Properties to set for this actor",
        };
      }
      if (this.runAsynchronously) {
        props.outputRecordKey = {
          type: "string",
          label: "Output Record Key",
          description: "Key of the record from run's default key-value store to be returned in the response. By default, it is OUTPUT.",
          optional: true,
        };
      } else {
        props.waitForFinish = {
          type: "string",
          label: "Wait For Finish",
          description: "The maximum number of seconds the server waits for the run to finish. By default, it is 0, the maximum value is 60. If the build finishes in time then the returned run object will have a terminal status (e.g. SUCCEEDED), otherwise it will have a transitional status (e.g. RUNNING).",
          optional: true,
        };
      }
    }
    if (this.webhook) {
      props.eventTypes = {
        type: "string[]",
        label: "Event Types",
        description: "The types of events to send to the webhook",
        options: EVENT_TYPES,
      };
    }
    return props;
  },
  async run({ $ }) {
    const {
      getType,
      getSchema,
      prepareOptions,
      setValue,
      prepareData,
      apify,
      actorId,
      buildId,
      properties,
      runAsynchronously,
      outputRecordKey,
      timeout,
      memory,
      maxItems,
      maxTotalChargeUsd,
      waitForFinish,
      webhook,
      eventTypes,
      ...data
    } = this;

    const fn = runAsynchronously
      ? apify.runActorAsynchronously
      : apify.runActor;

    const response = await fn({
      actorId,
      data: properties
        ? parseObject(properties)
        : await prepareData(data),
      params: {
        outputRecordKey,
        timeout,
        memory,
        maxItems,
        maxTotalChargeUsd,
        waitForFinish,
        webhooks: webhook
          ? btoa(JSON.stringify([
            {
              eventTypes,
              requestUrl: webhook,
            },
          ]))
          : undefined,
      },
    });
    const summary = this.runAsynchronously
      ? `Successfully started actor run with ID: ${response.data.id}`
      : `Successfully ran actor with ID: ${this.actorId}`;
    $.export("$summary", `${summary}`);
    return response;
  },
};

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
Apify	`apify`	`app`	This component uses the Apify app.
Actor ID	`actorId`	`string`	Select a value from the drop down menu.
Build	`buildId`	`string`	Select a value from the drop down menu.
Run Asynchronously	`runAsynchronously`	`boolean`	Set to `true` to run the actor asynchronously
Timeout	`timeout`	`string`	Optional timeout for the run, in seconds. By default, the run uses a timeout specified in the default run configuration for the Actor.
Memory	`memory`	`string`	Memory limit for the run, in megabytes. The amount of memory can be set to a power of 2 with a minimum of 128. By default, the run uses a memory limit specified in the default run configuration for the Actor.
Max Items	`maxItems`	`string`	The maximum number of items that the Actor run should return. This is useful for pay-per-result Actors, as it allows you to limit the number of results that will be charged to your subscription. You can access the maximum number of items in your Actor by using the ACTOR_MAX_PAID_DATASET_ITEMS environment variable.
Max Total Charge USD	`maxTotalChargeUsd`	`string`	Specifies the maximum cost of the Actor run. This parameter is useful for pay-per-event Actors, as it allows you to limit the amount charged to your subscription. You can access the maximum cost in your Actor by using the ACTOR_MAX_TOTAL_CHARGE_USD environment variable.
Webhook	`webhook`	`string`	Specifies optional webhook associated with the Actor run, which can be used to receive a notification e.g. when the Actor finished or failed.