@pipedream/google_ads 0.5.0 → 0.7.0

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

@@ -7,7 +7,7 @@ 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.1.7",
+  version: "0.1.8",
   annotations: {
     destructiveHint: true,
     openWorldHint: true,

package/actions/create-ad-group-report/create-ad-group-report.mjs

@@ -6,7 +6,7 @@ export default {
   key: "google_ads-create-ad-group-report",
   name: "Create Ad Group Report",
   description: "Creates a report for the Ad Group resource. [See the documentation](https://developers.google.com/google-ads/api/reference/rpc/v21/GoogleAdsService/Search?transport=rest)",
-  version: "0.0.1",
+  version: "0.0.2",
   annotations: {
     destructiveHint: false,
     openWorldHint: true,

package/actions/create-ad-report/create-ad-report.mjs

@@ -6,7 +6,7 @@ export default {
   key: "google_ads-create-ad-report",
   name: "Create Ad Report",
   description: "Creates a report for the Ad resource. [See the documentation](https://developers.google.com/google-ads/api/reference/rpc/v21/GoogleAdsService/Search?transport=rest)",
-  version: "0.0.1",
+  version: "0.0.2",
   annotations: {
     destructiveHint: false,
     openWorldHint: true,

package/actions/create-campaign-report/create-campaign-report.mjs

@@ -6,7 +6,7 @@ export default {
   key: "google_ads-create-campaign-report",
   name: "Create Campaign Report",
   description: "Creates a report for the Campaign resource. [See the documentation](https://developers.google.com/google-ads/api/reference/rpc/v21/GoogleAdsService/Search?transport=rest)",
-  version: "0.0.1",
+  version: "0.0.2",
   annotations: {
     destructiveHint: false,
     openWorldHint: true,

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

@@ -15,7 +15,7 @@ export default {
   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/reference/rpc/v21/UserList)",
-  version: "0.0.8",
+  version: "0.0.9",
   annotations: {
     destructiveHint: false,
     openWorldHint: true,

package/actions/create-customer-report/create-customer-report.mjs

@@ -6,7 +6,7 @@ export default {
   key: "google_ads-create-customer-report",
   name: "Create Customer Report",
   description: "Creates a report for the Customer resource. [See the documentation](https://developers.google.com/google-ads/api/reference/rpc/v21/GoogleAdsService/Search?transport=rest)",
-  version: "0.0.1",
+  version: "0.0.2",
   annotations: {
     destructiveHint: false,
     openWorldHint: true,

package/actions/create-report/create-report.mjs

@@ -20,7 +20,7 @@ export default {
   key: "google_ads-create-report",
   name: "Create Report",
   description: "Generates a report from your Google Ads data. [See the documentation](https://developers.google.com/google-ads/api/reference/rpc/v21/GoogleAdsService/Search?transport=rest)",
-  version: "0.1.6",
+  version: "0.2.0",
   annotations: {
     destructiveHint: false,
     openWorldHint: true,
@@ -34,106 +34,100 @@ export default {
       label: "Resource",
       description: "The resource to generate a report for.",
       options: RESOURCES.map((r) => r.resourceOption),
-      reloadProps: true,
     },
-  },
-  additionalProps() {
-    const resource = RESOURCES.find((r) => r.resourceOption.value === this.resource);
-    if (!resource) throw new ConfigurationError("Select one of the available resources.");
-
-    const {
-      label, value,
-    } = resource.resourceOption;
-
-    return {
-      docsAlert: {
-        type: "alert",
-        alertType: "info",
-        content: `[See the documentation](https://developers.google.com/google-ads/api/fields/v21/${value}) for more information on available fields, segments and metrics.`,
-      },
-      objectFilter: {
-        type: "string[]",
-        label: `Filter by ${label}s`,
-        description: `Select the ${label}s to generate a report for (or leave blank for all ${label}s)`,
-        optional: true,
-        useQuery: true,
-        options: async ({
-          query, prevContext: { nextPageToken: pageToken },
-        }) => {
-          const {
-            accountId, customerClientId, resource,
-          } = this;
-          const {
-            results, nextPageToken,
-          } = await this.googleAds.listResources({
-            accountId,
-            customerClientId,
-            resource,
-            query,
-            pageToken,
-          });
-          const options = results?.map?.((item) => this.getResourceOption(item, resource));
-          return {
-            options,
-            context: {
-              nextPageToken,
-            },
-          };
-        },
-      },
-      dateRange: {
-        type: "string",
-        label: "Date Range",
-        description: "Select a date range for the report",
-        options: DATE_RANGE_OPTIONS,
-        optional: true,
-        reloadProps: true,
+    objectFilter: {
+      type: "string[]",
+      label: "Filter by Resources",
+      description: "Google Ads resource IDs to limit the report to. Pass a string array of numeric IDs (e.g. `[\"1234567890\", \"9876543210\"]`). Omit to include all resources.",
+      optional: true,
+      useQuery: true,
+      async options({
+        query, prevContext = {},
+      }) {
+        const { nextPageToken: pageToken } = prevContext;
+        const {
+          accountId, customerClientId, resource,
+        } = this;
+        const {
+          results, nextPageToken,
+        } = await this.googleAds.listResources({
+          accountId,
+          customerClientId,
+          resource,
+          query,
+          pageToken,
+        });
+        const options = results?.map?.((item) => this.getResourceOption(item, resource));
+        return {
+          options,
+          context: {
+            nextPageToken,
+          },
+        };
       },
-      ...(this.dateRange === "CUSTOM" && {
-        startDate: {
-          type: "string",
-          label: "Start Date",
-          description: "The start date, in `YYYY-MM-DD` format",
-        },
-        endDate: {
-          type: "string",
-          label: "End Date",
-          description: "The end date, in `YYYY-MM-DD` format",
-        },
-      }),
-      fields: {
-        type: "string[]",
-        label: "Fields",
-        description: "Select any fields you want to include in your report.",
-        options: resource.fields,
-        optional: true,
-        reloadProps: true,
+    },
+    dateRange: {
+      type: "string",
+      label: "Date Range",
+      description: "Predefined Google Ads date range keyword (e.g. `LAST_30_DAYS`, `THIS_MONTH`). For a custom range, use `CUSTOM` with `startDate` and `endDate` in `YYYY-MM-DD` format (e.g. `2024-01-01`, `2024-01-31`).",
+      options: DATE_RANGE_OPTIONS,
+      optional: true,
+    },
+    startDate: {
+      type: "string",
+      label: "Start Date",
+      description: "The start date in `YYYY-MM-DD` format (e.g. `2024-01-01`). Only relevant if `Date Range` is set to `CUSTOM`.",
+      optional: true,
+    },
+    endDate: {
+      type: "string",
+      label: "End Date",
+      description: "The end date in `YYYY-MM-DD` format (e.g. `2024-01-31`). Only relevant if `Date Range` is set to `CUSTOM`.",
+      optional: true,
+    },
+    fields: {
+      type: "string[]",
+      label: "Fields",
+      description: "Resource field names for the GAQL SELECT clause. Pass a string array (e.g. `[\"id\", \"name\"]` or `[\"campaign.id\", \"campaign.name\"]` for campaign reports).",
+      options() {
+        const resource = RESOURCES.find((r) => r.resourceOption.value === this.resource);
+        if (!resource) throw new ConfigurationError("Select one of the available resources.");
+        return resource.fields;
       },
-      segments: {
-        type: "string[]",
-        label: "Segments",
-        description: "Select any segments you want to include in your report. See the documentation [here](https://developers.google.com/google-ads/api/reference/rpc/v21/Segments)",
-        options: resource.segments,
-        default: [
-          "segments.date",
-        ],
-        optional: true,
-        reloadProps: true,
+      optional: true,
+    },
+    segments: {
+      type: "string[]",
+      label: "Segments",
+      description: "Segment field names to include (e.g. `[\"date\"]` or `[\"segments.date\"]`). See the documentation [here](https://developers.google.com/google-ads/api/reference/rpc/v21/Segments).",
+      options() {
+        const resource = RESOURCES.find((r) => r.resourceOption.value === this.resource);
+        if (!resource) throw new ConfigurationError("Select one of the available resources.");
+        return resource.segments;
       },
-      metrics: {
-        type: "string[]",
-        label: "Metrics",
-        description: "Select any metrics you want to include in your report. See the documentation [here](https://developers.google.com/google-ads/api/reference/rpc/v21/Metrics)",
-        options: resource.metrics,
-        optional: true,
-        reloadProps: true,
+      default: [
+        "segments.date",
+      ],
+      optional: true,
+    },
+    metrics: {
+      type: "string[]",
+      label: "Metrics",
+      description: "Metric field names to include (e.g. `[\"impressions\", \"clicks\"]` or `[\"metrics.impressions\", \"metrics.clicks\"]`). See the documentation [here](https://developers.google.com/google-ads/api/reference/rpc/v21/Metrics).",
+      options() {
+        const resource = RESOURCES.find((r) => r.resourceOption.value === this.resource);
+        if (!resource) throw new ConfigurationError("Select one of the available resources.");
+        return resource.metrics;
       },
-      orderBy: {
-        type: "string",
-        label: "Order By",
-        description: "The field to order the results by",
-        optional: true,
-        options: [
+      optional: true,
+    },
+    orderBy: {
+      type: "string",
+      label: "Order By",
+      description: "The field to order the results by",
+      optional: true,
+      options() {
+        return [
           this.fields,
           this.segments,
           this.metrics,
@@ -147,32 +141,32 @@ export default {
             }
           }
           return returnValue?.map?.((str) => str.trim());
-        }),
+        });
       },
-      direction: {
-        type: "string",
-        label: "Direction",
-        description: "The direction to order the results by, if `Order By` is specified",
-        optional: true,
-        options: [
-          {
-            label: "Ascending",
-            value: "ASC",
-          },
-          {
-            label: "Descending",
-            value: "DESC",
-          },
-        ],
-        default: "ASC",
-      },
-      limit: {
-        type: "integer",
-        label: "Limit",
-        description: "The maximum number of results to return",
-        optional: true,
-      },
-    };
+    },
+    direction: {
+      type: "string",
+      label: "Direction",
+      description: "The direction to order the results by, if `Order By` is specified",
+      optional: true,
+      options: [
+        {
+          label: "Ascending",
+          value: "ASC",
+        },
+        {
+          label: "Descending",
+          value: "DESC",
+        },
+      ],
+      default: "ASC",
+    },
+    limit: {
+      type: "integer",
+      label: "Limit",
+      description: "The maximum number of results to return",
+      optional: true,
+    },
   },
   methods: {
     getResourceOption(item, resource) {
@@ -249,6 +243,14 @@ export default {
     },
   },
   async run({ $ }) {
+    if (!RESOURCES.find((r) => r.resourceOption.value === this.resource)) {
+      throw new ConfigurationError("Select one of the available resources.");
+    }
+
+    if (this.dateRange === "CUSTOM" && (!this.startDate || !this.endDate)) {
+      throw new ConfigurationError("Start and end dates are required if using a custom date range.");
+    }
+
     const query = this.buildQuery();
     const results = (await this.googleAds.createReport({
       $,

package/actions/generate-keyword-ideas/generate-keyword-ideas.mjs

@@ -9,7 +9,7 @@ export default {
   key: "google_ads-generate-keyword-ideas",
   name: "Generate Keyword Ideas",
   description: `Generate keyword ideas using the Google Ads API. [See the documentation](${docLink})`,
-  version: "0.0.2",
+  version: "0.0.3",
   type: "action",
   annotations: {
     destructiveHint: false,

package/actions/list-account-id-options/list-account-id-options.mjs

@@ -0,0 +1,24 @@
+import google_ads from "../../google_ads.app.mjs";
+
+export default {
+  key: "google_ads-list-account-id-options",
+  name: "List Account ID Options",
+  description: "Retrieves available options for the Account ID field.",
+  version: "0.0.2",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    google_ads,
+  },
+  async run({ $ }) {
+    const options = await google_ads.propDefinitions.accountId.options.call(this.google_ads);
+    $.export("$summary", `Successfully retrieved ${options.length} option${options.length === 1
+      ? ""
+      : "s"}`);
+    return options;
+  },
+};

package/actions/list-customer-clients/list-customer-clients.mjs

@@ -0,0 +1,43 @@
+import googleAds from "../../google_ads.app.mjs";
+
+export default {
+  key: "google_ads-list-customer-clients",
+  name: "List Customer Clients",
+  description: "List all customer clients for a given account. [See the documentation](https://developers.google.com/google-ads/api/reference/rpc/v21/GoogleAdsService/Search?transport=rest)",
+  version: "0.0.1",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  type: "action",
+  props: {
+    googleAds,
+    accountId: {
+      propDefinition: [
+        googleAds,
+        "accountId",
+      ],
+    },
+    query: {
+      type: "string",
+      label: "Query",
+      description: "Partial match text for the customer client descriptive name (e.g. `Acme` matches names containing \"Acme\"). Omit to return clients up to level 3.",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const response = await this.googleAds.listCustomerClients({
+      $,
+      accountId: this.accountId,
+      query: this.query,
+    });
+    const clients = Array.isArray(response)
+      ? response
+      : [];
+    $.export("$summary", `Successfully retrieved ${clients.length} customer client${clients.length === 1
+      ? ""
+      : "s"}`);
+    return clients;
+  },
+};

package/actions/send-offline-conversion/send-offline-conversion.mjs

@@ -8,7 +8,7 @@ export default {
   key: "google_ads-send-offline-conversion",
   name: "Send Offline Conversion",
   description: "Send an event to Google Ads to track offline conversions. [See the documentation](https://developers.google.com/google-ads/api/reference/rpc/v21/ConversionAction)",
-  version: "0.0.8",
+  version: "0.0.9",
   annotations: {
     destructiveHint: false,
     openWorldHint: true,

package/google_ads.app.mjs

@@ -36,7 +36,7 @@ export default {
     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/reference/rpc/v21/CustomerService/ListAccessibleCustomers?transport=rest). This is usually a **Manager Account**, used as `login-customer-id`",
+      description: "The ID of an account of a [customer directly accessible by the authenticated user](https://developers.google.com/google-ads/api/reference/rpc/v21/CustomerService/ListAccessibleCustomers?transport=rest). This is usually a Manager Account, used as `login-customer-id` (e.g., `1234567890`). Use the **List Account ID Options** action to get the list of accessible accounts.",
       async options() {
         const response = await this.listAccessibleCustomers();
         return response?.map(((resourceName) => ({
@@ -48,7 +48,7 @@ export default {
     customerClientId: {
       type: "string",
       label: "Managed Account",
-      description: "Select a [customer client](https://developers.google.com/google-ads/api/reference/rpc/v21/CustomerClient) from the list of [customers linked to the selected account](https://developers.google.com/google-ads/api/docs/account-management/get-account-hierarchy).",
+      description: "The ID of a [customer client](https://developers.google.com/google-ads/api/reference/rpc/v21/CustomerClient) from the list of [customers linked to the selected account](https://developers.google.com/google-ads/api/docs/account-management/get-account-hierarchy) (e.g., `1234567890`). Use the **List Customer Clients** action to get the list of customer clients.",
       useQuery: true,
       optional: true,
       async options({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/google_ads",
-  "version": "0.5.0",
+  "version": "0.7.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.7",
+  version: "0.0.8",
   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.7",
+  version: "0.0.8",
   type: "source",
   dedupe: "unique",
   sampleEmit,