@pipedream/google_ads 0.7.0 → 0.8.0

package/actions/get-keyword-quality-scores/get-keyword-quality-scores.mjs

@@ -0,0 +1,107 @@
+import { ConfigurationError } from "@pipedream/platform";
+import googleAds from "../../google_ads.app.mjs";
+import { DATE_RANGE_OPTIONS } from "../../common/constants.mjs";
+
+const docLink =
+  "https://developers.google.com/google-ads/api/fields/v21/keyword_view";
+
+export default {
+  key: "google_ads-get-keyword-quality-scores",
+  name: "Get Keyword Quality Scores",
+  description: `Retrieves current and historical quality score data (Quality Score, Ad Relevance, Landing Page Experience, Expected CTR) for keywords in a customer account. Current scores reflect the latest evaluation; historical scores are averaged over the selected date range. [See the documentation](${docLink})`,
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    googleAds,
+    accountId: {
+      propDefinition: [
+        googleAds,
+        "accountId",
+      ],
+    },
+    customerClientId: {
+      propDefinition: [
+        googleAds,
+        "customerClientId",
+        ({ accountId }) => ({
+          accountId,
+        }),
+      ],
+      optional: true,
+    },
+    campaignId: {
+      propDefinition: [
+        googleAds,
+        "campaignId",
+        ({
+          accountId, customerClientId,
+        }) => ({
+          accountId,
+          customerClientId,
+        }),
+      ],
+      description: "Filter results to a specific campaign. Use the **List Campaigns** action to discover options.",
+      optional: true,
+    },
+    adGroupId: {
+      propDefinition: [
+        googleAds,
+        "adGroupId",
+        ({
+          accountId, customerClientId,
+        }) => ({
+          accountId,
+          customerClientId,
+        }),
+      ],
+      description: "Filter results to a specific ad group. Use the **List Ad Groups** action to discover options.",
+      optional: true,
+    },
+    dateRange: {
+      type: "string",
+      label: "Date Range",
+      description: "The date range for historical quality score metrics (`metrics.historical_*`). Current quality scores (`quality_info.*`) are always the latest values regardless of this setting.",
+      options: DATE_RANGE_OPTIONS.filter(({ value }) => value !== "CUSTOM"),
+      default: "LAST_30_DAYS",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const {
+      accountId,
+      customerClientId,
+      campaignId,
+      adGroupId,
+      dateRange,
+    } = this;
+
+    if (campaignId && adGroupId) {
+      throw new ConfigurationError(
+        "Specify either **Campaign** or **Ad Group** as a filter, not both.",
+      );
+    }
+
+    const { results } = await this.googleAds.listKeywordQualityScores({
+      $,
+      accountId,
+      customerClientId,
+      campaignId,
+      adGroupId,
+      dateRange,
+    });
+
+    const items = results ?? [];
+    $.export(
+      "$summary",
+      `Successfully retrieved quality scores for ${items.length} keyword${items.length === 1
+        ? ""
+        : "s"}.`,
+    );
+    return items;
+  },
+};

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

@@ -4,7 +4,7 @@ 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",
+  version: "0.0.3",
   type: "action",
   annotations: {
     destructiveHint: false,

package/actions/list-ad-group-ads/list-ad-group-ads.mjs

@@ -0,0 +1,55 @@
+import googleAds from "../../google_ads.app.mjs";
+
+export default {
+  key: "google_ads-list-ad-group-ads",
+  name: "List Ad Group Ads",
+  description: "List ads within ad groups for a customer account. [See the documentation](https://developers.google.com/google-ads/api/reference/rpc/v21/GoogleAdsService/Search?transport=rest)",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    googleAds,
+    accountId: {
+      propDefinition: [
+        googleAds,
+        "accountId",
+      ],
+    },
+    customerClientId: {
+      propDefinition: [
+        googleAds,
+        "customerClientId",
+        ({ accountId }) => ({
+          accountId,
+        }),
+      ],
+      optional: true,
+    },
+    query: {
+      type: "string",
+      label: "Query",
+      description: "Filter ads by name (partial match).",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const { results } = await this.googleAds.listAllAdGroupAds({
+      $,
+      accountId: this.accountId,
+      customerClientId: this.customerClientId,
+      query: this.query,
+    });
+    const ads = results ?? [];
+    $.export(
+      "$summary",
+      `Successfully retrieved ${ads.length} ad group ad${ads.length === 1
+        ? ""
+        : "s"}.`,
+    );
+    return ads;
+  },
+};

package/actions/list-ad-group-criteria/list-ad-group-criteria.mjs

@@ -0,0 +1,55 @@
+import googleAds from "../../google_ads.app.mjs";
+
+export default {
+  key: "google_ads-list-ad-group-criteria",
+  name: "List Ad Group Criteria",
+  description: "List criteria (keywords, placements, audiences, etc.) for ad groups in a customer account. [See the documentation](https://developers.google.com/google-ads/api/reference/rpc/v21/GoogleAdsService/Search?transport=rest)",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    googleAds,
+    accountId: {
+      propDefinition: [
+        googleAds,
+        "accountId",
+      ],
+    },
+    customerClientId: {
+      propDefinition: [
+        googleAds,
+        "customerClientId",
+        ({ accountId }) => ({
+          accountId,
+        }),
+      ],
+      optional: true,
+    },
+    query: {
+      type: "string",
+      label: "Query",
+      description: "Filter by ad group name (partial match).",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const { results } = await this.googleAds.listAllAdGroupCriteria({
+      $,
+      accountId: this.accountId,
+      customerClientId: this.customerClientId,
+      query: this.query,
+    });
+    const items = results ?? [];
+    $.export(
+      "$summary",
+      `Successfully retrieved ${items.length} ad group ${items.length === 1
+        ? "criterion"
+        : "criteria"}.`,
+    );
+    return items;
+  },
+};

package/actions/list-ad-groups/list-ad-groups.mjs

@@ -0,0 +1,55 @@
+import googleAds from "../../google_ads.app.mjs";
+
+export default {
+  key: "google_ads-list-ad-groups",
+  name: "List Ad Groups",
+  description: "List ad groups for a customer account. [See the documentation](https://developers.google.com/google-ads/api/reference/rpc/v21/GoogleAdsService/Search?transport=rest)",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    googleAds,
+    accountId: {
+      propDefinition: [
+        googleAds,
+        "accountId",
+      ],
+    },
+    customerClientId: {
+      propDefinition: [
+        googleAds,
+        "customerClientId",
+        ({ accountId }) => ({
+          accountId,
+        }),
+      ],
+      optional: true,
+    },
+    query: {
+      type: "string",
+      label: "Query",
+      description: "Filter ad groups by name (partial match).",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const { results } = await this.googleAds.listAllAdGroups({
+      $,
+      accountId: this.accountId,
+      customerClientId: this.customerClientId,
+      query: this.query,
+    });
+    const adGroups = results ?? [];
+    $.export(
+      "$summary",
+      `Successfully retrieved ${adGroups.length} ad group${adGroups.length === 1
+        ? ""
+        : "s"}.`,
+    );
+    return adGroups;
+  },
+};

package/actions/list-bidding-strategies/list-bidding-strategies.mjs

@@ -0,0 +1,55 @@
+import googleAds from "../../google_ads.app.mjs";
+
+export default {
+  key: "google_ads-list-bidding-strategies",
+  name: "List Bidding Strategies",
+  description: "List portfolio bidding strategies for a customer account. [See the documentation](https://developers.google.com/google-ads/api/reference/rpc/v21/GoogleAdsService/Search?transport=rest)",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    googleAds,
+    accountId: {
+      propDefinition: [
+        googleAds,
+        "accountId",
+      ],
+    },
+    customerClientId: {
+      propDefinition: [
+        googleAds,
+        "customerClientId",
+        ({ accountId }) => ({
+          accountId,
+        }),
+      ],
+      optional: true,
+    },
+    query: {
+      type: "string",
+      label: "Query",
+      description: "Filter by bidding strategy name (partial match).",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const { results } = await this.googleAds.listAllBiddingStrategies({
+      $,
+      accountId: this.accountId,
+      customerClientId: this.customerClientId,
+      query: this.query,
+    });
+    const items = results ?? [];
+    $.export(
+      "$summary",
+      `Successfully retrieved ${items.length} bidding strateg${items.length === 1
+        ? "y"
+        : "ies"}.`,
+    );
+    return items;
+  },
+};

package/actions/list-campaign-budgets/list-campaign-budgets.mjs

@@ -0,0 +1,55 @@
+import googleAds from "../../google_ads.app.mjs";
+
+export default {
+  key: "google_ads-list-campaign-budgets",
+  name: "List Campaign Budgets",
+  description: "List campaign budgets for a customer account. [See the documentation](https://developers.google.com/google-ads/api/reference/rpc/v21/GoogleAdsService/Search?transport=rest)",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    googleAds,
+    accountId: {
+      propDefinition: [
+        googleAds,
+        "accountId",
+      ],
+    },
+    customerClientId: {
+      propDefinition: [
+        googleAds,
+        "customerClientId",
+        ({ accountId }) => ({
+          accountId,
+        }),
+      ],
+      optional: true,
+    },
+    query: {
+      type: "string",
+      label: "Query",
+      description: "Filter by campaign budget name (partial match).",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const { results } = await this.googleAds.listAllCampaignBudgets({
+      $,
+      accountId: this.accountId,
+      customerClientId: this.customerClientId,
+      query: this.query,
+    });
+    const items = results ?? [];
+    $.export(
+      "$summary",
+      `Successfully retrieved ${items.length} campaign budget${items.length === 1
+        ? ""
+        : "s"}.`,
+    );
+    return items;
+  },
+};

package/actions/list-campaign-criteria/list-campaign-criteria.mjs

@@ -0,0 +1,55 @@
+import googleAds from "../../google_ads.app.mjs";
+
+export default {
+  key: "google_ads-list-campaign-criteria",
+  name: "List Campaign Criteria",
+  description: "List criteria (keywords, placements, etc.) for campaigns in a customer account. [See the documentation](https://developers.google.com/google-ads/api/reference/rpc/v21/GoogleAdsService/Search?transport=rest)",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    googleAds,
+    accountId: {
+      propDefinition: [
+        googleAds,
+        "accountId",
+      ],
+    },
+    customerClientId: {
+      propDefinition: [
+        googleAds,
+        "customerClientId",
+        ({ accountId }) => ({
+          accountId,
+        }),
+      ],
+      optional: true,
+    },
+    query: {
+      type: "string",
+      label: "Query",
+      description: "Filter by campaign name (partial match).",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const { results } = await this.googleAds.listAllCampaignCriteria({
+      $,
+      accountId: this.accountId,
+      customerClientId: this.customerClientId,
+      query: this.query,
+    });
+    const items = results ?? [];
+    $.export(
+      "$summary",
+      `Successfully retrieved ${items.length} campaign ${items.length === 1
+        ? "criterion"
+        : "criteria"}.`,
+    );
+    return items;
+  },
+};

package/actions/list-campaign-shared-sets/list-campaign-shared-sets.mjs

@@ -0,0 +1,55 @@
+import googleAds from "../../google_ads.app.mjs";
+
+export default {
+  key: "google_ads-list-campaign-shared-sets",
+  name: "List Campaign Shared Sets",
+  description: "List shared sets attached to campaigns for a customer account. [See the documentation](https://developers.google.com/google-ads/api/reference/rpc/v21/GoogleAdsService/Search?transport=rest)",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    googleAds,
+    accountId: {
+      propDefinition: [
+        googleAds,
+        "accountId",
+      ],
+    },
+    customerClientId: {
+      propDefinition: [
+        googleAds,
+        "customerClientId",
+        ({ accountId }) => ({
+          accountId,
+        }),
+      ],
+      optional: true,
+    },
+    query: {
+      type: "string",
+      label: "Query",
+      description: "Filter by campaign name or shared set name (partial match).",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const { results } = await this.googleAds.listCampaignSharedSets({
+      $,
+      accountId: this.accountId,
+      customerClientId: this.customerClientId,
+      query: this.query,
+    });
+    const items = results ?? [];
+    $.export(
+      "$summary",
+      `Successfully retrieved ${items.length} campaign shared set${items.length === 1
+        ? ""
+        : "s"}.`,
+    );
+    return items;
+  },
+};

package/actions/list-campaigns/list-campaigns.mjs

@@ -0,0 +1,55 @@
+import googleAds from "../../google_ads.app.mjs";
+
+export default {
+  key: "google_ads-list-campaigns",
+  name: "List Campaigns",
+  description: "List campaigns for a customer account. [See the documentation](https://developers.google.com/google-ads/api/reference/rpc/v21/GoogleAdsService/Search?transport=rest)",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    googleAds,
+    accountId: {
+      propDefinition: [
+        googleAds,
+        "accountId",
+      ],
+    },
+    customerClientId: {
+      propDefinition: [
+        googleAds,
+        "customerClientId",
+        ({ accountId }) => ({
+          accountId,
+        }),
+      ],
+      optional: true,
+    },
+    query: {
+      type: "string",
+      label: "Query",
+      description: "Filter campaigns by name (partial match).",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const { results } = await this.googleAds.listAllCampaigns({
+      $,
+      accountId: this.accountId,
+      customerClientId: this.customerClientId,
+      query: this.query,
+    });
+    const campaigns = results ?? [];
+    $.export(
+      "$summary",
+      `Successfully retrieved ${campaigns.length} campaign${campaigns.length === 1
+        ? ""
+        : "s"}.`,
+    );
+    return campaigns;
+  },
+};

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

@@ -4,7 +4,7 @@ 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",
+  version: "0.0.2",
   annotations: {
     destructiveHint: false,
     openWorldHint: true,

package/actions/list-keywords/list-keywords.mjs

@@ -0,0 +1,55 @@
+import googleAds from "../../google_ads.app.mjs";
+
+export default {
+  key: "google_ads-list-keywords",
+  name: "List Keywords",
+  description: "List keyword criteria for a customer account. [See the documentation](https://developers.google.com/google-ads/api/reference/rpc/v21/GoogleAdsService/Search?transport=rest)",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    googleAds,
+    accountId: {
+      propDefinition: [
+        googleAds,
+        "accountId",
+      ],
+    },
+    customerClientId: {
+      propDefinition: [
+        googleAds,
+        "customerClientId",
+        ({ accountId }) => ({
+          accountId,
+        }),
+      ],
+      optional: true,
+    },
+    query: {
+      type: "string",
+      label: "Query",
+      description: "Filter keywords by text (partial match).",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const { results } = await this.googleAds.listAllKeywords({
+      $,
+      accountId: this.accountId,
+      customerClientId: this.customerClientId,
+      query: this.query,
+    });
+    const keywords = results ?? [];
+    $.export(
+      "$summary",
+      `Successfully retrieved ${keywords.length} keyword${keywords.length === 1
+        ? ""
+        : "s"}.`,
+    );
+    return keywords;
+  },
+};

package/actions/list-shared-criteria/list-shared-criteria.mjs

@@ -0,0 +1,55 @@
+import googleAds from "../../google_ads.app.mjs";
+
+export default {
+  key: "google_ads-list-shared-criteria",
+  name: "List Shared Criteria",
+  description: "List criteria within shared sets for a customer account. [See the documentation](https://developers.google.com/google-ads/api/reference/rpc/v21/GoogleAdsService/Search?transport=rest)",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    googleAds,
+    accountId: {
+      propDefinition: [
+        googleAds,
+        "accountId",
+      ],
+    },
+    customerClientId: {
+      propDefinition: [
+        googleAds,
+        "customerClientId",
+        ({ accountId }) => ({
+          accountId,
+        }),
+      ],
+      optional: true,
+    },
+    query: {
+      type: "string",
+      label: "Query",
+      description: "Filter by shared set name (partial match).",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const { results } = await this.googleAds.listAllSharedCriteria({
+      $,
+      accountId: this.accountId,
+      customerClientId: this.customerClientId,
+      query: this.query,
+    });
+    const items = results ?? [];
+    $.export(
+      "$summary",
+      `Successfully retrieved ${items.length} shared ${items.length === 1
+        ? "criterion"
+        : "criteria"}.`,
+    );
+    return items;
+  },
+};