@pipedream/google_ads 0.0.3 → 0.1.0

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

@@ -0,0 +1,64 @@
+import crypto from "crypto";
+import googleAds from "../../google_ads.app.mjs";
+
+export default {
+  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",
+  type: "action",
+  props: {
+    googleAds,
+    contactEmail: {
+      propDefinition: [
+        googleAds,
+        "contactEmail",
+      ],
+    },
+    userListId: {
+      propDefinition: [
+        googleAds,
+        "userListId",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const offlineUserDataJob = await this.googleAds.createOfflineUserDataJob({
+      data: {
+        job: {
+          customerMatchUserListMetadata: {
+            userList: `customers/${this.googleAds.$auth.login_customer_id}/userLists/${this.userListId}`,
+          },
+          type: "CUSTOMER_MATCH_USER_LIST",
+        },
+      },
+    });
+
+    await this.googleAds.addContactToCustomerList({
+      $,
+      path: offlineUserDataJob.resourceName,
+      data: {
+        operations: [
+          {
+            create: {
+              userIdentifiers: [
+                {
+                  hashedEmail: crypto.createHash("sha256").update(this.contactEmail)
+                    .digest("hex"),
+                },
+              ],
+            },
+          },
+        ],
+      },
+    });
+
+    const response = await this.googleAds.runOfflineUserDataJob({
+      $,
+      path: offlineUserDataJob.resourceName,
+    });
+
+    $.export("$summary", `Added contact ${this.contactEmail} to the user list ${this.userListId}`);
+    return response;
+  },
+};

package/google_ads.app.mjs

@@ -0,0 +1,84 @@
+import { axios } from "@pipedream/platform";
+
+export default {
+  type: "app",
+  app: "google_ads",
+  propDefinitions: {
+    contactEmail: {
+      type: "string",
+      label: "Contact Email",
+      description: "Email address of the contact to add to the customer list.",
+    },
+    userListId: {
+      type: "string",
+      label: "User List ID",
+      description: "The ID of the user list to add the contact to.",
+      async options() {
+        const { results = [] } = await this.listLists();
+
+        return results.map(({
+          userList: {
+            id: value, name: label,
+          },
+        }) => ({
+          label,
+          value,
+        }));
+      },
+    },
+  },
+  methods: {
+    _baseUrl() {
+      return "https://googleads.googleapis.com";
+    },
+    _headers() {
+      return {
+        "Authorization": `Bearer ${this.$auth.oauth_access_token}`,
+        "developer-token": `${this.$auth.developer_token}`,
+      };
+    },
+    _makeRequest({
+      $ = this, path, ...opts
+    }) {
+      return axios($, {
+        url: this._baseUrl() + path,
+        headers: this._headers(),
+        ...opts,
+      });
+    },
+    addContactToCustomerList({
+      path, ...opts
+    }) {
+      return this._makeRequest({
+        method: "POST",
+        path: `/v15/${path}:addOperations`,
+        ...opts,
+      });
+    },
+    createOfflineUserDataJob(opts = {}) {
+      return this._makeRequest({
+        method: "POST",
+        path: `/v15/customers/${this.$auth.login_customer_id}/offlineUserDataJobs:create`,
+        ...opts,
+      });
+    },
+    runOfflineUserDataJob({ path }) {
+      return this._makeRequest({
+        method: "POST",
+        path: `/v15/${path}:run`,
+      });
+    },
+    listLists() {
+      return this._makeRequest({
+        method: "POST",
+        path: `/v15/customers/${this.$auth.login_customer_id}/googleAds:search`,
+        data: {
+          query: `SELECT
+            user_list.id,
+            user_list.name
+            FROM user_list`,
+        },
+      });
+    },
+  },
+};

package/package.json

@@ -1,18 +1,19 @@
 {
   "name": "@pipedream/google_ads",
-  "version": "0.0.3",
+  "version": "0.1.0",
   "description": "Pipedream Google Ads Components",
-  "main": "dist/app/google_ads.app.mjs",
+  "main": "google_ads.app.mjs",
   "keywords": [
     "pipedream",
     "google_ads"
   ],
-  "files": [
-    "dist"
-  ],
   "homepage": "https://pipedream.com/apps/google_ads",
   "author": "Pipedream <support@pipedream.com> (https://pipedream.com/)",
   "publishConfig": {
     "access": "public"
+  },
+  "dependencies": {
+    "@pipedream/platform": "^1.5.1",
+    "crypto": "^1.0.1"
   }
 }