Add Contact to Customer List by Email with Google Ads API

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

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Add Contact to Customer List by Email 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#

Create a workflow to Add Contact to Customer List by Email with the Google Ads API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Add Contact to Customer List by Email action
1. Connect your Google Ads account
2. Select a Use Google Ads As
3. Optional- Select a Managed Account
4. Configure Contact Email
5. Select a Customer List ID
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Add Contact to Customer List by Email with Google Ads API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Google Ads

Try it

Add Contact to Customer List by Email with Google Ads API on New Submission from Typeform API

Typeform + Google Ads

Try it

Add Contact to Customer List by Email with Google Ads API on Custom Events from Zoom API

Zoom + Google Ads

Try it

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

Jotform + Google Ads

Try it

Add Contact to Customer List by Email with Google Ads API on New Scheduled Tasks from Pipedream API

Pipedream + Google Ads

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is 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.

Add Contact to Customer List by Email on Google Ads

Description:Adds a contact to a specific customer list in Google Ads. Lists typically update in 6 to 12 hours after operation. [See the documentation](https://developers.google.com/google-ads/api/docs/remarketing/audience-segments/customer-match/get-started)

Version:0.1.5

Key:google_ads-add-contact-to-list-by-email

View on GitHub

Code#

import crypto from "crypto";
import googleAds from "../../google_ads.app.mjs";
import common from "../common/common.mjs";

export default {
  ...common,
  key: "google_ads-add-contact-to-list-by-email",
  name: "Add Contact to Customer List by Email",
  description: "Adds a contact to a specific customer list in Google Ads. Lists typically update in 6 to 12 hours after operation. [See the documentation](https://developers.google.com/google-ads/api/docs/remarketing/audience-segments/customer-match/get-started)",
  version: "0.1.5",
  annotations: {
    destructiveHint: true,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    ...common.props,
    contactEmail: {
      propDefinition: [
        googleAds,
        "contactEmail",
      ],
    },
    userListId: {
      propDefinition: [
        googleAds,
        "userListId",
        ({
          accountId, customerClientId,
        }) => ({
          accountId,
          customerClientId,
        }),
      ],
    },
  },
  async run({ $ }) {
    const {
      googleAds, accountId, customerClientId, contactEmail, userListId,
    } = this;
    const offlineUserDataJob = await googleAds.createOfflineUserDataJob({
      $,
      accountId,
      customerClientId,
      data: {
        job: {
          customerMatchUserListMetadata: {
            userList: `customers/${customerClientId ?? accountId}/userLists/${userListId}`,
          },
          type: "CUSTOMER_MATCH_USER_LIST",
        },
      },
    });

    await googleAds.addContactToCustomerList({
      $,
      accountId,
      customerClientId,
      path: offlineUserDataJob.resourceName,
      data: {
        operations: [
          {
            create: {
              userIdentifiers: [
                {
                  hashedEmail: crypto.createHash("sha256").update(contactEmail)
                    .digest("hex"),
                },
              ],
            },
          },
        ],
      },
    });

    const response = await googleAds.runOfflineUserDataJob({
      $,
      accountId,
      customerClientId,
      path: offlineUserDataJob.resourceName,
    });

    $.export("$summary", `Added contact ${contactEmail} to user list ${userListId}`);
    return response;
  },
};

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.
Contact Email	`contactEmail`	`string`	Email address of the contact to add to the customer list.
Customer List ID	`userListId`	`string`	Select a value from the drop down menu.

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