@pipedream/google_ads 0.1.0 → 0.2.0

package/actions/add-contact-to-list-by-email/add-contact-to-list-by-email.mjs

@@ -1,14 +1,16 @@
 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.0.1",
+  version: "0.1.0",
   type: "action",
   props: {
-    googleAds,
+    ...common.props,
     contactEmail: {
       propDefinition: [
         googleAds,
@@ -19,23 +21,37 @@ export default {
       propDefinition: [
         googleAds,
         "userListId",
+        ({
+          accountId, customerClientId,
+        }) => ({
+          accountId,
+          customerClientId,
+        }),
       ],
     },
   },
   async run({ $ }) {
-    const offlineUserDataJob = await this.googleAds.createOfflineUserDataJob({
+    const {
+      googleAds, accountId, customerClientId, contactEmail, userListId,
+    } = this;
+    const offlineUserDataJob = await googleAds.createOfflineUserDataJob({
+      $,
+      accountId,
+      customerClientId,
       data: {
         job: {
           customerMatchUserListMetadata: {
-            userList: `customers/${this.googleAds.$auth.login_customer_id}/userLists/${this.userListId}`,
+            userList: `customers/${customerClientId ?? accountId}/userLists/${userListId}`,
           },
           type: "CUSTOMER_MATCH_USER_LIST",
         },
       },
     });
 
-    await this.googleAds.addContactToCustomerList({
+    await googleAds.addContactToCustomerList({
       $,
+      accountId,
+      customerClientId,
       path: offlineUserDataJob.resourceName,
       data: {
         operations: [
@@ -43,7 +59,7 @@ export default {
             create: {
               userIdentifiers: [
                 {
-                  hashedEmail: crypto.createHash("sha256").update(this.contactEmail)
+                  hashedEmail: crypto.createHash("sha256").update(contactEmail)
                     .digest("hex"),
                 },
               ],
@@ -53,12 +69,14 @@ export default {
       },
     });
 
-    const response = await this.googleAds.runOfflineUserDataJob({
+    const response = await googleAds.runOfflineUserDataJob({
       $,
+      accountId,
+      customerClientId,
       path: offlineUserDataJob.resourceName,
     });
 
-    $.export("$summary", `Added contact ${this.contactEmail} to the user list ${this.userListId}`);
+    $.export("$summary", `Added contact ${contactEmail} to user list ${userListId}`);
     return response;
   },
 };

package/actions/common/common.mjs

@@ -0,0 +1,5 @@
+import props from "../../common/props.mjs";
+
+export default {
+  props,
+};

package/actions/common/props.mjs

@@ -0,0 +1,15 @@
+const DEFAULT_DOCS =
+  "https://developers.google.com/google-ads/api/rest/reference/rest/v16/UserList";
+
+export const getAdditionalFields = (docsLink = DEFAULT_DOCS) => ({
+  type: "object",
+  label: "Additional Fields",
+  description: `Additional fields and values to be created. [See the documentation](${docsLink}) for available fields. Values will be parsed as JSON where applicable.`,
+  optional: true,
+});
+
+export const getListTypeInfo = (docsLink = DEFAULT_DOCS) => ({
+  type: "alert",
+  alertType: "info",
+  content: `[See the documentation](${docsLink}) for more information on this type of customer list.`,
+});

package/actions/create-customer-list/common-constants.mjs

@@ -0,0 +1,234 @@
+import countryCodeOptions from "./common-country-code-options.mjs";
+
+export const USER_LIST_TYPES = {
+  CRM_BASED: "crmBasedUserList",
+  RULE_BASED: "ruleBasedUserList",
+  LOGICAL: "logicalUserList",
+  BASIC: "basicUserList",
+  LOOKALIKE: "lookalikeUserList",
+};
+
+const USER_LIST_CRM_BASED_PROPS = {
+  uploadKeyType: {
+    type: "string",
+    label: "Upload Key Type",
+    description:
+      "Matching key type of the list. Mixed data types are not allowed on the same list.",
+    options: [
+      {
+        label:
+          "Members are matched from customer info such as email address, phone number or physical address.",
+        value: "CONTACT_INFO",
+      },
+      {
+        label:
+          "Members are matched from a user id generated and assigned by the advertiser.",
+        value: "CRM_ID",
+      },
+      {
+        label: "Members are matched from mobile advertising IDs.",
+        value: "MOBILE_ADVERTISING_ID",
+      },
+    ],
+  },
+  dataSourceType: {
+    type: "string",
+    label: "Data Source Type",
+    description:
+      "Data source of the list. Only customers on the allow-list can create third-party sourced CRM lists.",
+    optional: true,
+    default: "FIRST_PARTY",
+    options: [
+      {
+        label: "The uploaded data is first-party data.",
+        value: "FIRST_PARTY",
+      },
+      {
+        label: "The uploaded data is from a third-party credit bureau,",
+        value: "THIRD_PARTY_CREDIT_BUREAU",
+      },
+      {
+        label: "The uploaded data is from a third-party voter file.",
+        value: "THIRD_PARTY_VOTER_FILE",
+      },
+    ],
+  },
+  appId: {
+    type: "string",
+    label: "App ID",
+    description:
+      "A string that uniquely identifies a mobile application from which the data was collected. [See the documentation](https://developers.google.com/google-ads/api/rest/reference/rest/v16/UserList#CrmBasedUserListInfo) for more details.",
+    optional: true,
+  },
+};
+
+const USER_LIST_RULE_BASED_PROPS = {
+  prepopulationStatus: {
+    type: "boolean",
+    label: "Request Prepopulation",
+    description:
+      "If true, past site visitors or app users who match the list definition will be included in the list. This will only add past users from within the last 30 days, depending on the list's membership duration and the date when the remarketing tag is added.",
+    optional: true,
+  },
+  flexibleRuleUserList: {
+    type: "object",
+    label: "Flexible Rule Customer List",
+    description:
+      "Flexible rule representation of visitors with one or multiple actions. [See the documentation](https://developers.google.com/google-ads/api/rest/reference/rest/v16/UserList#FlexibleRuleUserListInfo) on how to build this object. Values will be parsed as JSON where applicable.",
+    optional: true,
+  },
+};
+
+const USER_LIST_LOGICAL_PROPS = {
+  rules: {
+    type: "string[]",
+    label: "Rules",
+    description:
+      "Logical list rules that define this customer list. [See the documentation](https://developers.google.com/google-ads/api/rest/reference/rest/v16/UserList#UserListLogicalRuleInfo) on how to build each object. Values will be parsed as JSON where applicable.",
+  },
+};
+
+const USER_LIST_BASIC_PROPS = {
+  conversionActions: {
+    type: "string[]",
+    label: "Conversion action(s)",
+    description: "One or more [conversion actions](https://developers.google.com/google-ads/api/rest/reference/rest/v16/ConversionAction) to build the list with.",
+    optional: true,
+    options: async() => {
+      const {
+        accountId, customerClientId,
+      } = this;
+      const response = await this.googleAds.listConversionActions({
+        accountId,
+        customerClientId,
+      });
+      return response?.map(({
+        conversionAction: {
+          resourceName, name,
+        },
+      }) => ({
+        label: name,
+        value: resourceName,
+      }));
+    },
+  },
+  remarketingActions: {
+    type: "string[]",
+    label: "Remarketing action(s)",
+    description: "One or more [remarketing actions](https://developers.google.com/google-ads/api/rest/reference/rest/v16/RemarketingAction).",
+    optional: true,
+    options: async() => {
+      const {
+        accountId, customerClientId,
+      } = this;
+      const response = await this.googleAds.listRemarketingActions({
+        accountId,
+        customerClientId,
+      });
+      return response?.map(({
+        remarketingAction: {
+          resourceName, name,
+        },
+      }) => ({
+        label: name,
+        value: resourceName,
+      }));
+    },
+  },
+};
+
+const USER_LIST_LOOKALIKE_PROPS = {
+  seedUserListIds: {
+    type: "string[]",
+    label: "Seed User List(s)",
+    description: "One or more customer lists from which this list is derived.",
+    options: async() => {
+      const {
+        accountId, customerClientId,
+      } = this;
+      const response = await this.googleAds.listUserLists({
+        accountId,
+        customerClientId,
+      });
+      return response?.map(({
+        userList: {
+          id, name,
+        },
+      }) => ({
+        label: name,
+        value: id,
+      }));
+    },
+  },
+  expansionLevel: {
+    type: "string",
+    label: "Expansion Level",
+    description:
+      "Expansion level, reflecting the size of the lookalike audience",
+    optional: true,
+    options: [
+      {
+        label:
+          "Expansion to a small set of users that are similar to the seed lists",
+        value: "NARROW",
+      },
+      {
+        label:
+          "Expansion to a medium set of users that are similar to the seed lists. Includes all users of NARROW, and more.",
+        value: "BALANCED",
+      },
+      {
+        label:
+          "Expansion to a large set of users that are similar to the seed lists. Includes all users of BALANCED, and more.",
+        value: "BROAD",
+      },
+    ],
+  },
+  countryCodes: {
+    type: "string[]",
+    label: "Country Codes",
+    description: "Countries targeted by the Lookalike.",
+    optional: true,
+    options: countryCodeOptions,
+  },
+};
+
+export const USER_LIST_TYPE_OPTIONS = [
+  {
+    label: "CRM-based - a list of provided customers",
+    value: USER_LIST_TYPES.CRM_BASED,
+    docsLink:
+      "https://developers.google.com/google-ads/api/rest/reference/rest/v16/UserList#CrmBasedUserListInfo",
+    props: USER_LIST_CRM_BASED_PROPS,
+  },
+  {
+    label: "Rule-Based - a customer list generated by a rule",
+    value: USER_LIST_TYPES.RULE_BASED,
+    docsLink:
+      "https://developers.google.com/google-ads/api/rest/reference/rest/v16/UserList#RuleBasedUserListInfo",
+    props: USER_LIST_RULE_BASED_PROPS,
+  },
+  {
+    label: "Logical - a custom combination of customer lists",
+    value: USER_LIST_TYPES.LOGICAL,
+    docsLink:
+      "https://developers.google.com/google-ads/api/rest/reference/rest/v16/UserList#LogicalUserListInfo",
+    props: USER_LIST_LOGICAL_PROPS,
+  },
+  {
+    label:
+      "Basic - a customer list targeting as a collection of conversions or remarketing actions",
+    value: USER_LIST_TYPES.BASIC,
+    docsLink:
+      "https://developers.google.com/google-ads/api/rest/reference/rest/v16/UserList#BasicUserListInfo",
+    props: USER_LIST_BASIC_PROPS,
+  },
+  {
+    label:
+      "Lookalike - a list composed of customers similar to those of a configurable seed",
+    value: USER_LIST_TYPES.LOOKALIKE,
+    docsLink:
+      "https://developers.google.com/google-ads/api/rest/reference/rest/v16/UserList#LookalikeUserListInfo",
+    props: USER_LIST_LOOKALIKE_PROPS,
+  },
+];