@pipedream/google_ads 0.1.1 → 0.2.0

package/google_ads.app.mjs

@@ -1,4 +1,5 @@
 import { axios } from "@pipedream/platform";
+import { QUERIES } from "./common/queries.mjs";
 
 export default {
   type: "app",
@@ -11,18 +12,82 @@ export default {
     },
     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(({
+      label: "Customer List ID",
+      description: "Select a Customer List to add the contact to, or provide a custom Customer List ID.",
+      async options({
+        accountId, customerClientId,
+      }) {
+        const response = await this.listUserLists({
+          accountId,
+          customerClientId,
+        });
+        return response?.map(({
           userList: {
-            id: value, name: label,
+            id, name,
           },
         }) => ({
-          label,
-          value,
+          label: name,
+          value: id,
+        }));
+      },
+    },
+    accountId: {
+      type: "string",
+      label: "Use Google Ads As",
+      description: "Select an account from the list of [customers directly accessible by the authenticated user](https://developers.google.com/google-ads/api/rest/reference/rest/v16/customers/listAccessibleCustomers). This is usually a **Manager Account**, used as `login-customer-id`",
+      async options() {
+        const response = await this.listAccessibleCustomers();
+        return response?.map(((resourceName) => ({
+          label: resourceName,
+          value: resourceName.split("/").pop(),
+        })));
+      },
+    },
+    customerClientId: {
+      type: "string",
+      label: "Managed Account",
+      description: "Select a [customer client](https://developers.google.com/google-ads/api/reference/rpc/v16/CustomerClient) from the list of [customers linked to the selected account](https://developers.google.com/google-ads/api/docs/account-management/get-account-hierarchy).",
+      useQuery: true,
+      optional: true,
+      async options({
+        accountId, query,
+      }) {
+        const response = await this.listCustomerClients({
+          accountId,
+          query,
+        });
+        return response?.map(({
+          customerClient: {
+            descriptiveName, id, manager,
+          },
+        }) => ({
+          label: `${manager
+            ? "[Manager] "
+            : ""}${descriptiveName}`,
+          value: id,
+        })).filter(({ value }) => value !== accountId);
+      },
+    },
+    leadFormId: {
+      type: "string",
+      label: "Lead Form ID",
+      description: "Select a [Lead Form](https://developers.google.com/google-ads/api/rest/reference/rest/v16/Asset#LeadFormAsset) to watch for new entries.",
+      async options({
+        accountId, customerClientId,
+      }) {
+        const response = await this.listLeadForms({
+          accountId,
+          customerClientId,
+        });
+        return response?.map(({
+          asset: {
+            id, leadFormAsset: {
+              businessName, headline,
+            },
+          },
+        }) => ({
+          label: `${businessName} - ${headline}`,
+          value: id,
         }));
       },
     },
@@ -31,55 +96,136 @@ export default {
     _baseUrl() {
       return "https://eolid4dq1k0t9hi.m.pipedream.net";
     },
-    _headers() {
+    _headers(accountId) {
       return {
         "Authorization": `Bearer ${this.$auth.oauth_access_token}`,
+        "login-customer-id": accountId,
       };
     },
     _makeRequest({
-      $ = this, ...opts
+      $ = this, accountId, customerClientId, path, ...opts
     }) {
-      const googleAdsRequest = {
-        headers: this._headers(),
+      const data = {
+        headers: this._headers(accountId),
+        path: path.replace("{customerClientId}", customerClientId ?? accountId),
         ...opts,
       };
       return axios($, {
+        method: "post",
         url: this._baseUrl(),
-        data: googleAdsRequest,
+        data,
       });
     },
-    addContactToCustomerList({
-      path, ...opts
+    async search({
+      query, ...args
     }) {
-      return this._makeRequest({
-        method: "POST",
-        path: `/v15/${path}:addOperations`,
-        ...opts,
+      console.log("Executing query: ", query);
+      const response = await this._makeRequest({
+        path: "/v16/customers/{customerClientId}/googleAds:search",
+        method: "post",
+        data: {
+          query,
+        },
+        ...args,
+      });
+      return response.results;
+    },
+    async listAccessibleCustomers() {
+      const response = await this._makeRequest({
+        path: "/v16/customers:listAccessibleCustomers",
       });
+      return response.resourceNames;
     },
-    createOfflineUserDataJob(opts = {}) {
+    async listCustomerClients({
+      query, ...args
+    }) {
+      return this.search({
+        query: QUERIES.listCustomerClients(query),
+        ...args,
+      });
+    },
+    async createReport(args) {
+      return this.search(args);
+    },
+    async createUserList(args) {
+      const response = await this._makeRequest({
+        path: "v16/customers/{customerClientId}/userLists:mutate",
+        method: "post",
+        ...args,
+      });
+      return response;
+    },
+    async listUserLists(args) {
+      return this.search({
+        query: QUERIES.listUserLists(),
+        ...args,
+      });
+    },
+    async listConversionActions(args) {
+      return this.search({
+        query: QUERIES.listConversionActions(),
+        ...args,
+      });
+    },
+    async listRemarketingActions(args) {
+      return this.search({
+        query: QUERIES.listRemarketingActions(),
+        ...args,
+      });
+    },
+    async listLeadForms(args) {
+      return this.search({
+        query: QUERIES.listLeadForms(),
+        ...args,
+      });
+    },
+    async listCampaigns({
+      query, ...args
+    }) {
+      return this.search({
+        query: QUERIES.listCampaigns(query),
+        ...args,
+      });
+    },
+    async getLeadFormData({
+      leadFormId, ...args
+    }) {
+      return this.search({
+        query: QUERIES.listLeadFormSubmissionData(leadFormId),
+        ...args,
+      });
+    },
+    async createConversionAction(args) {
+      const response = await this._makeRequest({
+        path: "v16/customers/{customerClientId}/conversionActions:mutate",
+        method: "post",
+        ...args,
+      });
+      return response;
+    },
+    async addContactToCustomerList({
+      path, ...opts
+    }) {
       return this._makeRequest({
         method: "POST",
-        path: `/v15/customers/${this.$auth.login_customer_id}/offlineUserDataJobs:create`,
+        path: `/v16/${path}:addOperations`,
         ...opts,
       });
     },
-    runOfflineUserDataJob({ path }) {
+    async createOfflineUserDataJob(opts = {}) {
       return this._makeRequest({
         method: "POST",
-        path: `/v15/${path}:run`,
+        path: "/v16/customers/{customerClientId}/offlineUserDataJobs:create",
+        ...opts,
       });
     },
-    listLists() {
+    async runOfflineUserDataJob({
+      path, ...args
+    }) {
       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`,
-        },
+        path: `/v16/${path}:run`,
+        ...args,
       });
     },
   },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/google_ads",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "Pipedream Google Ads Components",
   "main": "google_ads.app.mjs",
   "keywords": [
@@ -13,7 +13,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@pipedream/platform": "^1.5.1",
+    "@pipedream/platform": "^1.6.5",
     "crypto": "^1.0.1"
   }
 }

package/sources/common/common.mjs

@@ -0,0 +1,54 @@
+import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
+import props from "../../common/props.mjs";
+
+export default {
+  props: {
+    ...props,
+    db: "$.service.db",
+    timer: {
+      type: "$.interface.timer",
+      default: {
+        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
+      },
+    },
+  },
+  hooks: {
+    async deploy() {
+      await this.getAndProcessData(5);
+    },
+  },
+  methods: {
+    _getSavedIds() {
+      return this.db.get("savedIds") ?? [];
+    },
+    _setSavedIds(value) {
+      this.db.set("savedIds", value);
+    },
+    getTimestamp() {
+      return Date.now();
+    },
+    getItemId({ id }) {
+      return id;
+    },
+    async getAndProcessData(max = 0) {
+      const savedIds = this._getSavedIds();
+      const items = await this.getItems(savedIds);
+      items?.filter((item) => !savedIds.includes(this.getItemId(item)))
+        .forEach((item, index) => {
+          const id = this.getItemId(item);
+          if (!max || index < max) {
+            this.$emit(item, {
+              id,
+              summary: this.getSummary(item),
+              ts: this.getTimestamp(item),
+            });
+          }
+          savedIds.push(id);
+        });
+      this._setSavedIds(savedIds);
+    },
+  },
+  async run() {
+    await this.getAndProcessData();
+  },
+};

package/sources/new-campaign-created/new-campaign-created.mjs

@@ -0,0 +1,52 @@
+import common from "../common/common.mjs";
+import { campaign } from "../../common/resources/campaign.mjs";
+import sampleEmit from "./test-event.mjs";
+
+export default {
+  ...common,
+  key: "google_ads-new-campaign-created",
+  name: "New Campaign Created",
+  description: "Emit new event when a new campaign is created. [See the documentation](https://developers.google.com/google-ads/api/fields/v16/campaign)",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  sampleEmit,
+  props: {
+    ...common.props,
+    customerClientId: {
+      ...common.props.customerClientId,
+      optional: false,
+    },
+    fields: {
+      type: "string[]",
+      label: "Extra Fields",
+      description: "Additional [campaign fields](https://developers.google.com/google-ads/api/fields/v16/campaign) to emit in the event",
+      options: campaign.fields,
+      optional: true,
+      default: [
+        "id",
+        "name",
+      ],
+    },
+  },
+  methods: {
+    ...common.methods,
+    getSummary({ name }) {
+      return `New Campaign: "${name}"`;
+    },
+    async getItems(savedIds) {
+      const {
+        accountId, customerClientId, fields,
+      } = this;
+      const items = await this.googleAds.listCampaigns({
+        accountId,
+        customerClientId,
+        query: {
+          fields,
+          savedIds,
+        },
+      });
+      return items?.map(({ campaign }) => campaign);
+    },
+  },
+};

package/sources/new-campaign-created/test-event.mjs

@@ -0,0 +1,5 @@
+export default {
+  resourceName: "customers/123/campaigns/456",
+  name: "Campaign Name",
+  id: "456",
+};

package/sources/new-lead-form-entry/new-lead-form-entry.mjs

@@ -0,0 +1,51 @@
+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/v16/lead_form_submission_data)",
+  version: "0.0.1",
+  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/v16/LeadFormSubmissionField) and [custom submission fields](https://developers.google.com/google-ads/api/reference/rpc/v16/CustomLeadFormSubmissionField).",
+    },
+  },
+  methods: {
+    ...common.methods,
+    getSummary() {
+      return "New Lead";
+    },
+    getItems() {
+      const {
+        accountId, customerClientId, leadFormId,
+      } = this;
+      return this.googleAds.getLeadFormData({
+        accountId,
+        customerClientId,
+        leadFormId,
+      });
+    },
+  },
+};

package/sources/new-lead-form-entry/test-event.mjs

@@ -0,0 +1,18 @@
+export default {
+  resourceName: "customers/123/leadFormSubmissionData/456",
+  custom_lead_form_submission_fields: [
+    {
+      question_text: "Text",
+      field_value: "Value"
+    }
+  ],
+  gclid: "789",
+  id: "456",
+  lead_form_submission_fields: [
+    {
+      field_type: "TYPE",
+      field_value: "Value"
+    }
+  ],
+  submission_date_time: "2019-01-01 12:32:45-08:00",
+};