Add Or Update Records with Grist API on New Lead Form Entry from Google Ads API

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

Trigger workflow on

New Lead Form Entry from the Google Ads API

Next, do this

Add Or Update Records with the Grist 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 Grist 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 Add Or Update Records action
1. Connect your Grist account
2. Configure Document ID
3. Select a Table ID
4. Optional- Configure Do Not Parse
5. Optional- Select a On Many
6. Optional- Configure No Add
7. Optional- Configure No Update
8. Configure Data Records
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#

Add Or Update Records on Grist

Description:Add records in a specified table or updates existing matching records. [See the documentation](https://support.getgrist.com/api/#tag/records/operation/replaceRecords)

Version:0.0.2

Key:grist-add-update-records

View on GitHub

Grist Overview#

Grist API on Pipedream enables you to automate data management tasks in your Grist documents. This might mean syncing data across different platforms, triggering notifications based on data changes, or processing data through custom logic. With Pipedream, you can use the Grist API to build workflows that react to events in real-time, connect to hundreds of other services, manipulate data in sophisticated ways, and create custom endpoints to integrate with your Grist data.

Action Code#

import app from "../../grist.app.mjs";
import utils from "../../common/utils.mjs";

export default {
  key: "grist-add-update-records",
  name: "Add Or Update Records",
  description: "Add records in a specified table or updates existing matching records. [See the documentation](https://support.getgrist.com/api/#tag/records/operation/replaceRecords)",
  version: "0.0.2",
  type: "action",
  props: {
    app,
    docId: {
      propDefinition: [
        app,
        "docId",
      ],
    },
    tableId: {
      propDefinition: [
        app,
        "tableId",
        ({ docId }) => ({
          docId,
        }),
      ],
    },
    noParse: {
      propDefinition: [
        app,
        "noParse",
      ],
    },
    onMany: {
      type: "string",
      label: "On Many",
      description: "Which records to update if multiple records are found to match.",
      optional: true,
      options: [
        {
          value: "first",
          label: "The first matching record (default)",
        },
        {
          value: "none",
          label: "Do not update anything",
        },
        {
          value: "all",
          label: "Update all matches",
        },
      ],
    },
    noAdd: {
      type: "boolean",
      label: "No Add",
      description: "Set to true to prohibit adding records.",
      optional: true,
    },
    noUpdate: {
      type: "boolean",
      label: "No Update",
      description: "Set to true to prohibit updating records.",
      optional: true,
    },
    records: {
      description: app.propDefinitions.records.description + " Instead of an id, a `require` object is provided, with the same structure as `fields`. If no query parameter options are set, then the operation is as follows. First, we check if a record exists matching the values specified for columns in `require`. If so, we update it by setting the values specified for columns in fields. If not, we create a new record with a combination of the values in `require` and `fields`, with `fields` taking priority if the same column is specified in both. The query parameters allow for variations on this behavior. Eg. `[ { \"require\": { \"pet\": \"cat\" }, \"fields\": { \"popularity\": 67 } } ]`",
      propDefinition: [
        app,
        "records",
      ],
    },
  },
  methods: {
    addUpdateRecords({
      docId, tableId, ...args
    } = {}) {
      return this.app.put({
        path: `/docs/${docId}/tables/${tableId}/records`,
        ...args,
      });
    },
  },
  async run({ $ }) {
    const {
      addUpdateRecords,
      docId,
      tableId,
      noParse: noparse,
      onMany: onmany,
      noAdd: noadd,
      noUpdate: noupdate,
      records,
    } = this;

    await addUpdateRecords({
      $,
      docId,
      tableId,
      params: {
        noparse,
        onmany,
        noadd,
        noupdate,
      },
      data: {
        records: utils.parseArray(records),
      },
    });

    $.export("$summary", "Successfully ran this action");

    return {
      success: true,
    };
  },
};

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
Grist	`app`	`app`	This component uses the Grist app.
Document ID	`docId`	`string`	The ID of the Grist document to operate on. You can find this in the Settings menu of the document.
Table ID	`tableId`	`string`	Select a value from the drop down menu.
Do Not Parse	`noParse`	`boolean`	Set to `true` to prohibit parsing strings according to the column type.
On Many	`onMany`	`string`	Select a value from the drop down menu:`{ "value": "first", "label": "The first matching record (default)" }{ "value": "none", "label": "Do not update anything" }{ "value": "all", "label": "Update all matches" }`
No Add	`noAdd`	`boolean`	Set to true to prohibit adding records.
No Update	`noUpdate`	`boolean`	Set to true to prohibit updating records.
Data Records	`records`	`string[]`	The data for the records to append or update. Each record should be a JSON-formatted string, mapping column names to cell values. Eg. `[ { "fields": { "pet": "cat", "popularity": 67 } } ]`. Instead of an id, a `require` object is provided, with the same structure as `fields`. If no query parameter options are set, then the operation is as follows. First, we check if a record exists matching the values specified for columns in `require`. If so, we update it by setting the values specified for columns in fields. If not, we create a new record with a combination of the values in `require` and `fields`, with `fields` taking priority if the same column is specified in both. The query parameters allow for variations on this behavior. Eg. `[ { "require": { "pet": "cat" }, "fields": { "popularity": 67 } } ]`

Action Authentication#

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

To retrieve your API key,