@pipedream/google_ads 0.7.0 → 0.8.0

package/google_ads.app.mjs

@@ -1,7 +1,9 @@
 import { axios } from "@pipedream/platform";
 import { CORE_DATE_SEGMENTS } from "./common/constants.mjs";
 import { QUERIES } from "./common/queries.mjs";
-import { getResourceOption } from "./common/utils.mjs";
+import {
+  getResourceOption, sanitizeGaqlString,
+} from "./common/utils.mjs";
 
 export default {
   type: "app",
@@ -124,6 +126,313 @@ export default {
           .filter((v) => dateRange || !CORE_DATE_SEGMENTS.includes(v));
       },
     },
+    campaignId: {
+      type: "string",
+      label: "Campaign",
+      description: "Numeric campaign ID (e.g., `1234567890`). Use the **List Campaigns** action to discover valid IDs.",
+      useQuery: true,
+      async options({
+        accountId, customerClientId, query, prevContext,
+      }) {
+        const pageToken = prevContext?.nextPageToken;
+        const {
+          results, nextPageToken,
+        } = await this.listResources({
+          accountId,
+          customerClientId,
+          resource: "campaign",
+          query,
+          pageToken,
+        });
+        const options = results?.map?.((item) => this.getResourceOption(item, "campaign")) ?? [];
+        return {
+          options,
+          context: {
+            nextPageToken,
+          },
+        };
+      },
+    },
+    campaignSharedSetId: {
+      type: "string",
+      label: "Campaign Shared Set",
+      description: "Campaign shared set resource name (e.g., `customers/123/campaignSharedSets/456~789`). Use the **List Campaign Shared Sets** action to discover valid values.",
+      useQuery: true,
+      async options({
+        accountId, customerClientId, query, prevContext,
+      }) {
+        const pageToken = prevContext?.nextPageToken;
+        const {
+          results, nextPageToken,
+        } = await this.listCampaignSharedSets({
+          accountId,
+          customerClientId,
+          query,
+          pageToken,
+        });
+        const options = results?.map?.((item) => ({
+          label: `${item.campaign?.name} → ${item.sharedSet?.name}`,
+          value: item.campaignSharedSet?.resourceName,
+        })) ?? [];
+        return {
+          options,
+          context: {
+            nextPageToken,
+          },
+        };
+      },
+    },
+    sharedCriterionId: {
+      type: "string",
+      label: "Shared Criterion",
+      description: "Shared criterion resource name (e.g., `customers/123/sharedCriteria/456~789`). Use the **List Shared Criteria** action to discover valid values.",
+      useQuery: true,
+      async options({
+        accountId, customerClientId, query, prevContext,
+      }) {
+        const pageToken = prevContext?.nextPageToken;
+        const {
+          results, nextPageToken,
+        } = await this.listSharedCriteria({
+          accountId,
+          customerClientId,
+          query,
+          pageToken,
+        });
+        const options = results?.map?.((item) => {
+          const criterion = item.sharedCriterion;
+          const sharedSetName = item.sharedSet?.name;
+          let criterionLabel;
+          if (criterion?.type === "KEYWORD") {
+            criterionLabel = `[${criterion.keyword?.matchType}] ${criterion.keyword?.text}`;
+          } else {
+            criterionLabel = `[${criterion?.type}] ${criterion?.criterionId}`;
+          }
+          return {
+            label: `${criterionLabel} (${sharedSetName})`,
+            value: criterion?.resourceName,
+          };
+        }) ?? [];
+        return {
+          options,
+          context: {
+            nextPageToken,
+          },
+        };
+      },
+    },
+    sharedSetId: {
+      type: "string",
+      label: "Shared Set",
+      description: "Numeric shared set ID (e.g., `1234567890`). Use the **List Shared Sets** action to discover valid IDs.",
+      useQuery: true,
+      async options({
+        accountId, customerClientId, query, prevContext,
+      }) {
+        const pageToken = prevContext?.nextPageToken;
+        const {
+          results, nextPageToken,
+        } = await this.listAllSharedSets({
+          accountId,
+          customerClientId,
+          query,
+          pageToken,
+        });
+        const options = results?.map?.((item) => ({
+          label: `[${item.sharedSet?.type}] ${item.sharedSet?.name}`,
+          value: item.sharedSet?.id,
+        })) ?? [];
+        return {
+          options,
+          context: {
+            nextPageToken,
+          },
+        };
+      },
+    },
+    adGroupCriterionId: {
+      type: "string",
+      label: "Keyword",
+      description: "Keyword criterion resource name (e.g., `customers/123/adGroupCriteria/456~789`). Use the **List Keywords** action to discover valid values.",
+      useQuery: true,
+      async options({
+        accountId, customerClientId, query, prevContext,
+      }) {
+        const pageToken = prevContext?.nextPageToken;
+        const {
+          results, nextPageToken,
+        } = await this.listKeywords({
+          accountId,
+          customerClientId,
+          query,
+          pageToken,
+        });
+        const options = results?.map?.((item) => ({
+          label: `[${item.adGroupCriterion?.keyword?.matchType}] ${item.adGroupCriterion?.keyword?.text}`,
+          value: item.adGroupCriterion?.resourceName,
+        })) ?? [];
+        return {
+          options,
+          context: {
+            nextPageToken,
+          },
+        };
+      },
+    },
+    adGroupAdId: {
+      type: "string",
+      label: "Ad Group Ad",
+      description: "Ad group ad resource name (e.g., `customers/123/adGroupAds/456~789`). Use the **List Ad Group Ads** action to discover valid values.",
+      useQuery: true,
+      async options({
+        accountId, customerClientId, query, prevContext,
+      }) {
+        const pageToken = prevContext?.nextPageToken;
+        const {
+          results, nextPageToken,
+        } = await this.listResources({
+          accountId,
+          customerClientId,
+          resource: "ad_group_ad",
+          query,
+          pageToken,
+        });
+        const options = results?.map?.((item) => ({
+          label: item.adGroupAd?.ad?.name ?? `Ad ${item.adGroupAd?.ad?.id}`,
+          value: item.adGroupAd?.resourceName,
+        })) ?? [];
+        return {
+          options,
+          context: {
+            nextPageToken,
+          },
+        };
+      },
+    },
+    adGroupId: {
+      type: "string",
+      label: "Ad Group",
+      description: "Numeric ad group ID (e.g., `1234567890`). Use the **List Ad Groups** action to discover valid IDs.",
+      useQuery: true,
+      async options({
+        accountId, customerClientId, query, prevContext,
+      }) {
+        const pageToken = prevContext?.nextPageToken;
+        const {
+          results, nextPageToken,
+        } = await this.listResources({
+          accountId,
+          customerClientId,
+          resource: "ad_group",
+          query,
+          pageToken,
+        });
+        const options = results?.map?.((item) => this.getResourceOption(item, "ad_group")) ?? [];
+        return {
+          options,
+          context: {
+            nextPageToken,
+          },
+        };
+      },
+    },
+    campaignBudgetId: {
+      type: "string",
+      label: "Campaign Budget",
+      description: "Numeric budget ID (e.g., `1234567890`). Use the **List Campaign Budgets** action to discover valid IDs.",
+      useQuery: true,
+      async options({
+        accountId, customerClientId, query, prevContext,
+      }) {
+        const pageToken = prevContext?.nextPageToken;
+        const {
+          results, nextPageToken,
+        } = await this.listAllCampaignBudgets({
+          accountId,
+          customerClientId,
+          query,
+          pageToken,
+        });
+        const options = results?.map?.((item) => ({
+          label: item.campaignBudget?.name ?? `Budget ${item.campaignBudget?.id}`,
+          value: item.campaignBudget?.id,
+        })) ?? [];
+        return {
+          options,
+          context: {
+            nextPageToken,
+          },
+        };
+      },
+    },
+    campaignCriterionId: {
+      type: "string",
+      label: "Campaign Criterion",
+      description: "Campaign criterion resource name (e.g., `customers/123/campaignCriteria/456~789`). Use the **List Campaign Criteria** action to discover valid values.",
+      useQuery: true,
+      async options({
+        accountId, customerClientId, query, prevContext,
+      }) {
+        const pageToken = prevContext?.nextPageToken;
+        const {
+          results, nextPageToken,
+        } = await this.listCampaignCriteria({
+          accountId,
+          customerClientId,
+          query,
+          pageToken,
+        });
+        const options = results?.map?.((item) => {
+          const criterion = item.campaignCriterion;
+          const campaignName = item.campaign?.name;
+          let criterionLabel;
+          if (criterion?.type === "KEYWORD") {
+            criterionLabel = `[${criterion.keyword?.matchType}] ${criterion.keyword?.text}`;
+          } else {
+            criterionLabel = `[${criterion?.type}] ${criterion?.criterionId}`;
+          }
+          return {
+            label: `${criterionLabel} (${campaignName})`,
+            value: criterion?.resourceName,
+          };
+        }) ?? [];
+        return {
+          options,
+          context: {
+            nextPageToken,
+          },
+        };
+      },
+    },
+    biddingStrategyId: {
+      type: "string",
+      label: "Bidding Strategy",
+      description: "Numeric bidding strategy ID (e.g., `1234567890`). Use the **List Bidding Strategies** action to discover valid IDs.",
+      useQuery: true,
+      async options({
+        accountId, customerClientId, query, prevContext,
+      }) {
+        const pageToken = prevContext?.nextPageToken;
+        const {
+          results, nextPageToken,
+        } = await this.listAllBiddingStrategies({
+          accountId,
+          customerClientId,
+          query,
+          pageToken,
+        });
+        const options = results?.map?.((item) => ({
+          label: `[${item.biddingStrategy?.type}] ${item.biddingStrategy?.name}`,
+          value: item.biddingStrategy?.id,
+        })) ?? [];
+        return {
+          options,
+          context: {
+            nextPageToken,
+          },
+        };
+      },
+    },
     leadFormId: {
       type: "string",
       label: "Lead Form ID",
@@ -311,5 +620,284 @@ export default {
         ...opts,
       });
     },
+    async mutateCampaign(opts = {}) {
+      return this._makeRequest({
+        method: "POST",
+        path: "/v21/customers/{customerClientId}/campaigns:mutate",
+        ...opts,
+      });
+    },
+    async mutateAdGroup(opts = {}) {
+      return this._makeRequest({
+        method: "POST",
+        path: "/v21/customers/{customerClientId}/adGroups:mutate",
+        ...opts,
+      });
+    },
+    async listAllCampaigns({
+      query, pageToken, ...args
+    }) {
+      const filter = query
+        ? ` WHERE campaign.name LIKE '%${sanitizeGaqlString(query)}%'`
+        : "";
+      return this.search({
+        query: `SELECT campaign.id, campaign.name, campaign.status, campaign.advertising_channel_type, campaign.start_date, campaign.end_date FROM campaign${filter}`,
+        params: {
+          pageToken,
+        },
+        ...args,
+      });
+    },
+    async listAllAdGroups({
+      query, pageToken, ...args
+    }) {
+      const filter = query
+        ? ` WHERE ad_group.name LIKE '%${sanitizeGaqlString(query)}%'`
+        : "";
+      return this.search({
+        query: `SELECT ad_group.id, ad_group.name, ad_group.status, ad_group.campaign, ad_group.type FROM ad_group${filter}`,
+        params: {
+          pageToken,
+        },
+        ...args,
+      });
+    },
+    async listAllAdGroupAds({
+      query, pageToken, ...args
+    }) {
+      const filter = query
+        ? ` WHERE ad_group_ad.ad.name LIKE '%${sanitizeGaqlString(query)}%'`
+        : "";
+      return this.search({
+        query: `SELECT ad_group_ad.resource_name, ad_group_ad.ad.id, ad_group_ad.ad.name, ad_group_ad.ad.type, ad_group_ad.status, ad_group.id, ad_group.name FROM ad_group_ad${filter}`,
+        params: {
+          pageToken,
+        },
+        ...args,
+      });
+    },
+    async listAllKeywords({
+      query, pageToken, ...args
+    }) {
+      const filter = query
+        ? ` AND ad_group_criterion.keyword.text LIKE '%${sanitizeGaqlString(query)}%'`
+        : "";
+      return this.search({
+        query: `SELECT ad_group_criterion.criterion_id, ad_group_criterion.resource_name, ad_group_criterion.keyword.text, ad_group_criterion.keyword.match_type, ad_group_criterion.status, ad_group_criterion.cpc_bid_micros, ad_group_criterion.negative, ad_group.id, ad_group.name FROM ad_group_criterion WHERE ad_group_criterion.type = 'KEYWORD'${filter}`,
+        params: {
+          pageToken,
+        },
+        ...args,
+      });
+    },
+    async listKeywords({
+      query, pageToken, ...args
+    }) {
+      const filter = query
+        ? ` AND ad_group_criterion.keyword.text LIKE '%${sanitizeGaqlString(query)}%'`
+        : "";
+      return this.search({
+        query: `SELECT ad_group_criterion.resource_name, ad_group_criterion.keyword.text, ad_group_criterion.keyword.match_type FROM ad_group_criterion WHERE ad_group_criterion.type = 'KEYWORD'${filter}`,
+        params: {
+          pageToken,
+        },
+        ...args,
+      });
+    },
+    async mutateAdGroupCriteria(opts = {}) {
+      return this._makeRequest({
+        method: "POST",
+        path: "/v21/customers/{customerClientId}/adGroupCriteria:mutate",
+        ...opts,
+      });
+    },
+    async mutateAdGroupAd(opts = {}) {
+      return this._makeRequest({
+        method: "POST",
+        path: "/v21/customers/{customerClientId}/adGroupAds:mutate",
+        ...opts,
+      });
+    },
+    async listAllSharedSets({
+      query, pageToken, ...args
+    }) {
+      const filter = query
+        ? ` AND shared_set.name LIKE '%${sanitizeGaqlString(query)}%'`
+        : "";
+      return this.search({
+        query: `SELECT shared_set.id, shared_set.name, shared_set.type, shared_set.status FROM shared_set WHERE shared_set.status = 'ENABLED'${filter}`,
+        params: {
+          pageToken,
+        },
+        ...args,
+      });
+    },
+    async mutateSharedSets(opts = {}) {
+      return this._makeRequest({
+        method: "POST",
+        path: "/v21/customers/{customerClientId}/sharedSets:mutate",
+        ...opts,
+      });
+    },
+    async listSharedCriteria({
+      query, pageToken, ...args
+    }) {
+      const filter = query
+        ? ` AND shared_criterion.keyword.text LIKE '%${sanitizeGaqlString(query)}%'`
+        : "";
+      return this.search({
+        query: `SELECT shared_criterion.resource_name, shared_criterion.criterion_id, shared_criterion.type, shared_criterion.keyword.text, shared_criterion.keyword.match_type, shared_set.id, shared_set.name FROM shared_criterion WHERE shared_criterion.type = 'KEYWORD'${filter}`,
+        params: {
+          pageToken,
+        },
+        ...args,
+      });
+    },
+    async mutateSharedCriteria(opts = {}) {
+      return this._makeRequest({
+        method: "POST",
+        path: "/v21/customers/{customerClientId}/sharedCriteria:mutate",
+        ...opts,
+      });
+    },
+    async listCampaignSharedSets({
+      query, pageToken, ...args
+    }) {
+      const filter = query
+        ? ` AND (campaign.name LIKE '%${sanitizeGaqlString(query)}%' OR shared_set.name LIKE '%${sanitizeGaqlString(query)}%')`
+        : "";
+      return this.search({
+        query: `SELECT campaign_shared_set.resource_name, campaign_shared_set.status, campaign.id, campaign.name, shared_set.id, shared_set.name FROM campaign_shared_set WHERE campaign_shared_set.status = 'ENABLED'${filter}`,
+        params: {
+          pageToken,
+        },
+        ...args,
+      });
+    },
+    async mutateCampaignSharedSets(opts = {}) {
+      return this._makeRequest({
+        method: "POST",
+        path: "/v21/customers/{customerClientId}/campaignSharedSets:mutate",
+        ...opts,
+      });
+    },
+    async listAllSharedCriteria({
+      query, pageToken, ...args
+    }) {
+      const filter = query
+        ? ` WHERE shared_set.name LIKE '%${sanitizeGaqlString(query)}%'`
+        : "";
+      return this.search({
+        query: `SELECT shared_criterion.resource_name, shared_criterion.criterion_id, shared_criterion.type, shared_criterion.keyword.text, shared_criterion.keyword.match_type, shared_set.id, shared_set.name FROM shared_criterion${filter}`,
+        params: {
+          pageToken,
+        },
+        ...args,
+      });
+    },
+    async listAllAdGroupCriteria({
+      query, pageToken, ...args
+    }) {
+      const filter = query
+        ? ` WHERE ad_group.name LIKE '%${sanitizeGaqlString(query)}%'`
+        : "";
+      return this.search({
+        query: `SELECT ad_group_criterion.criterion_id, ad_group_criterion.resource_name, ad_group_criterion.type, ad_group_criterion.status, ad_group_criterion.negative, ad_group_criterion.keyword.text, ad_group_criterion.keyword.match_type, ad_group_criterion.cpc_bid_micros, ad_group.id, ad_group.name FROM ad_group_criterion${filter}`,
+        params: {
+          pageToken,
+        },
+        ...args,
+      });
+    },
+    async listAllCampaignBudgets({
+      query, pageToken, ...args
+    }) {
+      const filter = query
+        ? ` AND campaign_budget.name LIKE '%${sanitizeGaqlString(query)}%'`
+        : "";
+      return this.search({
+        query: `SELECT campaign_budget.id, campaign_budget.name, campaign_budget.amount_micros, campaign_budget.delivery_method, campaign_budget.period, campaign_budget.status FROM campaign_budget WHERE campaign_budget.status = 'ENABLED'${filter}`,
+        params: {
+          pageToken,
+        },
+        ...args,
+      });
+    },
+    async mutateCampaignBudgets(opts = {}) {
+      return this._makeRequest({
+        method: "POST",
+        path: "/v21/customers/{customerClientId}/campaignBudgets:mutate",
+        ...opts,
+      });
+    },
+    async listCampaignCriteria({
+      query, pageToken, ...args
+    }) {
+      const filter = query
+        ? ` AND campaign.name LIKE '%${sanitizeGaqlString(query)}%'`
+        : "";
+      return this.search({
+        query: `SELECT campaign_criterion.resource_name, campaign_criterion.criterion_id, campaign_criterion.type, campaign_criterion.status, campaign_criterion.negative, campaign_criterion.keyword.text, campaign_criterion.keyword.match_type, campaign.id, campaign.name FROM campaign_criterion WHERE campaign_criterion.type = 'KEYWORD'${filter}`,
+        params: {
+          pageToken,
+        },
+        ...args,
+      });
+    },
+    async mutateCampaignCriteria(opts = {}) {
+      return this._makeRequest({
+        method: "POST",
+        path: "/v21/customers/{customerClientId}/campaignCriteria:mutate",
+        ...opts,
+      });
+    },
+    async listAllCampaignCriteria({
+      query, pageToken, ...args
+    }) {
+      const filter = query
+        ? ` WHERE campaign.name LIKE '%${sanitizeGaqlString(query)}%'`
+        : "";
+      return this.search({
+        query: `SELECT campaign_criterion.resource_name, campaign_criterion.criterion_id, campaign_criterion.type, campaign_criterion.status, campaign_criterion.negative, campaign_criterion.keyword.text, campaign_criterion.keyword.match_type, campaign.id, campaign.name FROM campaign_criterion${filter}`,
+        params: {
+          pageToken,
+        },
+        ...args,
+      });
+    },
+    async listAllBiddingStrategies({
+      query, pageToken, ...args
+    }) {
+      const filter = query
+        ? ` AND bidding_strategy.name LIKE '%${sanitizeGaqlString(query)}%'`
+        : "";
+      return this.search({
+        query: `SELECT bidding_strategy.id, bidding_strategy.name, bidding_strategy.type, bidding_strategy.status FROM bidding_strategy WHERE bidding_strategy.status = 'ENABLED'${filter}`,
+        params: {
+          pageToken,
+        },
+        ...args,
+      });
+    },
+    async mutateBiddingStrategies(opts = {}) {
+      return this._makeRequest({
+        method: "POST",
+        path: "/v21/customers/{customerClientId}/biddingStrategies:mutate",
+        ...opts,
+      });
+    },
+    async listKeywordQualityScores({
+      campaignId, adGroupId, dateRange, ...args
+    }) {
+      const conditions = [
+        `segments.date DURING ${dateRange ?? "LAST_30_DAYS"}`,
+      ];
+      if (campaignId) conditions.push(`campaign.id = ${Number(campaignId)}`);
+      if (adGroupId) conditions.push(`ad_group.id = ${Number(adGroupId)}`);
+      return this.search({
+        query: `SELECT keyword_view.resource_name, ad_group_criterion.keyword.text, ad_group_criterion.keyword.match_type, ad_group_criterion.status, ad_group_criterion.quality_info.quality_score, ad_group_criterion.quality_info.creative_quality_score, ad_group_criterion.quality_info.post_click_quality_score, ad_group_criterion.quality_info.search_predicted_ctr, metrics.historical_quality_score, metrics.historical_creative_quality_score, metrics.historical_landing_page_quality_score, metrics.historical_search_predicted_ctr, ad_group.id, ad_group.name, campaign.id, campaign.name FROM keyword_view WHERE ${conditions.join(" AND ")}`,
+        ...args,
+      });
+    },
   },
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/google_ads",
-  "version": "0.7.0",
+  "version": "0.8.0",
   "description": "Pipedream Google Ads Components",
   "main": "google_ads.app.mjs",
   "keywords": [

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

@@ -7,7 +7,7 @@ export default {
   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/reference/rpc/v21/GoogleAdsService/Search?transport=rest)",
-  version: "0.0.8",
+  version: "0.0.9",
   type: "source",
   dedupe: "unique",
   sampleEmit,

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

@@ -8,7 +8,7 @@ export default {
   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/reference/rpc/v21/GoogleAdsService/Search?transport=rest)",
-  version: "0.0.8",
+  version: "0.0.9",
   type: "source",
   dedupe: "unique",
   sampleEmit,