Create Customer List with Google Ads API

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

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Create Customer List 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 Create Customer List with the Google Ads API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Create Customer List action
1. Connect your Google Ads account
2. Select a Use Google Ads As
3. Optional- Select a Managed Account
4. Configure Name
5. Optional- Configure Description
6. Select a List Type
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#

Create Customer List with Google Ads API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Google Ads

Try it

Create Customer List with Google Ads API on New Submission from Typeform API

Typeform + Google Ads

Try it

Create Customer List with Google Ads API on New Submission (Instant) from Jotform API

Jotform + Google Ads

Try it

Create Customer List with Google Ads API on New Scheduled Tasks from Pipedream API

Pipedream + Google Ads

Try it

Create Customer List with Google Ads API on npm Download Counts from npm API

npm + 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.

Create Customer List on Google Ads

Description:Create a new customer list in Google Ads. [See the documentation](https://developers.google.com/google-ads/api/rest/reference/rest/v16/UserList)

Version:0.0.2

Key:google_ads-create-customer-list

View on GitHub

Code#

import {
  USER_LIST_TYPES, USER_LIST_TYPE_OPTIONS,
} from "./common-constants.mjs";
import {
  parseObject, parseStringObject,
} from "../../common/utils.mjs";
import common from "../common/common.mjs";
import {
  getAdditionalFields, getListTypeInfo,
} from "../common/props.mjs";
import { ConfigurationError } from "@pipedream/platform";

export default {
  ...common,
  key: "google_ads-create-customer-list",
  name: "Create Customer List",
  description:
    "Create a new customer list in Google Ads. [See the documentation](https://developers.google.com/google-ads/api/rest/reference/rest/v16/UserList)",
  version: "0.0.2",
  type: "action",
  props: {
    ...common.props,
    name: {
      type: "string",
      label: "Name",
      description: "The name of the customer list.",
    },
    description: {
      type: "string",
      label: "Description",
      description: "Description of the customer list.",
      optional: true,
    },
    listType: {
      type: "string",
      label: "List Type",
      description:
        "The [type of customer list](https://developers.google.com/google-ads/api/rest/reference/rest/v16/UserList#CrmBasedUserListInfo) to create.",
      options: USER_LIST_TYPE_OPTIONS.map(({
        label, value,
      }) => ({
        label,
        value,
      })),
      reloadProps: true,
    },
  },
  methods: {
    parseFields(obj) {
      switch (this.listType) {
      case USER_LIST_TYPES.CRM_BASED:
        break;

      case USER_LIST_TYPES.RULE_BASED:
        if (obj.prepopulationStatus) {
          obj.prepopulationStatus = "REQUESTED";
        }
        if (obj.flexibleRuleUserList) {
          obj.flexibleRuleUserList = parseObject(obj.flexibleRuleUserList);
        }
        break;

      case USER_LIST_TYPES.LOGICAL: {
        let { rules } = obj;
        if (rules) {
          rules = rules.map?.((rule) => parseStringObject(rule)) ?? parseStringObject(rules);
        }
        break;
      }

      case USER_LIST_TYPES.BASIC:
        if (obj?.conversionActions?.length || obj?.remarketingActions?.length) {
          obj.actions = [
            ...(obj.conversionActions ?? []).map((conversionAction) => ({
              conversionAction,
            })),
            ...(obj.remarketingActions ?? []).map((remarketingAction) => ({
              remarketingAction,
            })),
          ];
          delete obj.conversionActions;
          delete obj.remarketingActions;
        } else {
          throw new ConfigurationError("Select at least one Conversion or Remarketing action to build the list with");
        }
        break;

      case USER_LIST_TYPES.LOOKALIKE:
        break;
      }

      return obj;
    },
  },
  additionalProps() {
    const { listType } = this;

    const option = USER_LIST_TYPE_OPTIONS.find(
      ({ value }) => value === listType,
    );
    if (!option) {
      throw new ConfigurationError("Select a valid List Type to proceed.");
    }

    const {
      docsLink, props,
    } = option;

    const newProps = {
      listTypeInfo: getListTypeInfo(docsLink),
    };

    Object.assign(newProps, props);

    newProps.additionalFields = getAdditionalFields(docsLink);

    return newProps;
  },
  async run({ $ }) {
    const {
      googleAds,
      accountId,
      customerClientId,
      name,
      description,
      listType,
      additionalFields,
      ...data
    } = this;
    const { results: { [0]: response } } = await googleAds.createUserList({
      $,
      accountId,
      customerClientId,
      data: {
        operations: [
          {
            create: {
              name,
              description,
              [listType]: this.parseFields(data),
              ...parseObject(additionalFields),
            },
          },
        ],
      },
    });

    const id = response.resourceName.split("/").pop();

    $.export(
      "$summary",
      `Created customer list of type \`${listType}\` with ID \`${id}\``,
    );
    return {
      id,
      ...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.
Name	`name`	`string`	The name of the customer list.
Description	`description`	`string`	Description of the customer list.
List Type	`listType`	`string`	Select a value from the drop down menu:`{ "label": "CRM-based - a list of provided customers", "value": "crmBasedUserList" }{ "label": "Rule-Based - a customer list generated by a rule", "value": "ruleBasedUserList" }{ "label": "Logical - a custom combination of customer lists", "value": "logicalUserList" }{ "label": "Basic - a customer list targeting as a collection of conversions or remarketing actions", "value": "basicUserList" }{ "label": "Lookalike - a list composed of customers similar to those of a configurable seed", "value": "lookalikeUserList" }`

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