@pipedream/google_ads 0.7.0 → 0.8.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.8",
+  version: "0.1.9",
   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.2",
+  version: "0.0.3",
   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.2",
+  version: "0.0.3",
   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.2",
+  version: "0.0.3",
   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.9",
+  version: "0.0.10",
   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.2",
+  version: "0.0.3",
   annotations: {
     destructiveHint: false,
     openWorldHint: true,

package/actions/create-or-remove-campaign-criteria/create-or-remove-campaign-criteria.mjs

@@ -0,0 +1,214 @@
+import { ConfigurationError } from "@pipedream/platform";
+import googleAds from "../../google_ads.app.mjs";
+import {
+  CAMPAIGN_STATUSES,
+  CREATE_REMOVE_OPERATION_TYPES,
+  KEYWORD_MATCH_TYPES,
+} from "../../common/constants.mjs";
+import { parseObject } from "../../common/utils.mjs";
+import { getAdditionalFields } from "../common/props.mjs";
+
+const docLink =
+  "https://developers.google.com/google-ads/api/reference/rpc/v21/CampaignCriterionService/MutateCampaignCriteria?transport=rest";
+
+export default {
+  key: "google_ads-create-or-remove-campaign-criteria",
+  name: "Create or Remove Campaign Criteria",
+  description: `Creates or removes criteria for a campaign (e.g., keyword targeting, brand lists). [See the documentation](${docLink})`,
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: true,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  props: {
+    googleAds,
+    accountId: {
+      propDefinition: [
+        googleAds,
+        "accountId",
+      ],
+    },
+    customerClientId: {
+      propDefinition: [
+        googleAds,
+        "customerClientId",
+        ({ accountId }) => ({
+          accountId,
+        }),
+      ],
+      optional: true,
+    },
+    operationType: {
+      type: "string",
+      label: "Operation Type",
+      description: "Whether to create or remove a campaign criterion.",
+      options: CREATE_REMOVE_OPERATION_TYPES,
+    },
+    campaignCriterionId: {
+      propDefinition: [
+        googleAds,
+        "campaignCriterionId",
+        ({
+          accountId, customerClientId,
+        }) => ({
+          accountId,
+          customerClientId,
+        }),
+      ],
+      description: "The campaign criterion to remove. Required for **Remove** operations.",
+      optional: true,
+    },
+    campaignId: {
+      propDefinition: [
+        googleAds,
+        "campaignId",
+        ({
+          accountId, customerClientId,
+        }) => ({
+          accountId,
+          customerClientId,
+        }),
+      ],
+      description: "The campaign to add this criterion to. Required for **Create** operations.",
+      optional: true,
+    },
+    negative: {
+      type: "boolean",
+      label: "Negative",
+      description: "Whether this is a negative criterion (e.g., a keyword to exclude). Immutable after creation.",
+      optional: true,
+    },
+    status: {
+      type: "string",
+      label: "Status",
+      description: "The status of the criterion.",
+      options: CAMPAIGN_STATUSES,
+      optional: true,
+    },
+    keywordText: {
+      type: "string",
+      label: "Keyword Text",
+      description: "The keyword text for keyword criteria (max 80 characters, max 10 words).",
+      optional: true,
+    },
+    keywordMatchType: {
+      type: "string",
+      label: "Keyword Match Type",
+      description: "The match type for the keyword. Required when **Keyword Text** is provided.",
+      options: KEYWORD_MATCH_TYPES,
+      optional: true,
+    },
+    brandListSharedSet: {
+      type: "string",
+      label: "Brand List Shared Set",
+      description: "The resource name of the shared set for brand list criteria (e.g., `customers/123/sharedSets/456`).",
+      optional: true,
+    },
+    additionalFields: getAdditionalFields(docLink),
+  },
+  async run({ $ }) {
+    const {
+      googleAds,
+      accountId,
+      customerClientId,
+      operationType,
+      campaignCriterionId,
+      campaignId,
+      negative,
+      status,
+      keywordText,
+      keywordMatchType,
+      brandListSharedSet,
+      additionalFields,
+    } = this;
+
+    if (operationType === "remove" && !campaignCriterionId) {
+      throw new ConfigurationError(
+        "**Campaign Criterion** is required for Remove operations.",
+      );
+    }
+
+    if (operationType === "create") {
+      if (!campaignId) {
+        throw new ConfigurationError(
+          "**Campaign** is required for Create operations.",
+        );
+      }
+      if (keywordText && !keywordMatchType) {
+        throw new ConfigurationError(
+          "**Keyword Match Type** is required when **Keyword Text** is provided.",
+        );
+      }
+      if (keywordMatchType && !keywordText) {
+        throw new ConfigurationError(
+          "**Keyword Text** is required when **Keyword Match Type** is provided.",
+        );
+      }
+    }
+
+    const customerId = customerClientId ?? accountId;
+    const campaign = campaignId
+      ? `customers/${customerId}/campaigns/${campaignId}`
+      : undefined;
+
+    let operation;
+
+    if (operationType === "remove") {
+      operation = {
+        remove: campaignCriterionId,
+      };
+    } else {
+      const criterionData = {
+        ...(campaign && {
+          campaign,
+        }),
+        ...(negative !== undefined && {
+          negative,
+        }),
+        ...(status && {
+          status,
+        }),
+        ...(keywordText && keywordMatchType && {
+          keyword: {
+            text: keywordText,
+            matchType: keywordMatchType,
+          },
+        }),
+        ...(brandListSharedSet && {
+          brandList: {
+            sharedSet: brandListSharedSet,
+          },
+        }),
+        ...parseObject(additionalFields),
+      };
+
+      operation = {
+        create: criterionData,
+      };
+    }
+
+    const response = await googleAds.mutateCampaignCriteria({
+      $,
+      accountId,
+      customerClientId,
+      data: {
+        operations: [
+          operation,
+        ],
+      },
+    });
+
+    const result = response?.results?.[0];
+    const id = result?.resourceName?.split("~").pop();
+
+    $.export(
+      "$summary",
+      `Successfully ${operationType}d campaign criterion${id
+        ? ` with criterion ID \`${id}\``
+        : ""}.`,
+    );
+    return response;
+  },
+};

package/actions/create-or-remove-campaign-shared-set/create-or-remove-campaign-shared-set.mjs

@@ -0,0 +1,155 @@
+import { ConfigurationError } from "@pipedream/platform";
+import googleAds from "../../google_ads.app.mjs";
+import { CREATE_REMOVE_OPERATION_TYPES } from "../../common/constants.mjs";
+
+const docLink =
+  "https://developers.google.com/google-ads/api/reference/rpc/v21/CampaignSharedSetService/MutateCampaignSharedSets?transport=rest";
+
+export default {
+  key: "google_ads-create-or-remove-campaign-shared-set",
+  name: "Create or Remove Campaign Shared Set",
+  description: `Attaches or detaches a shared set from a campaign. [See the documentation](${docLink})`,
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: true,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  props: {
+    googleAds,
+    accountId: {
+      propDefinition: [
+        googleAds,
+        "accountId",
+      ],
+    },
+    customerClientId: {
+      propDefinition: [
+        googleAds,
+        "customerClientId",
+        ({ accountId }) => ({
+          accountId,
+        }),
+      ],
+      optional: true,
+    },
+    operationType: {
+      type: "string",
+      label: "Operation Type",
+      description: "Whether to attach or detach a shared set from a campaign.",
+      options: CREATE_REMOVE_OPERATION_TYPES,
+    },
+    campaignSharedSetId: {
+      propDefinition: [
+        googleAds,
+        "campaignSharedSetId",
+        ({
+          accountId, customerClientId,
+        }) => ({
+          accountId,
+          customerClientId,
+        }),
+      ],
+      description: "The campaign shared set to remove. Required for **Remove** operations.",
+      optional: true,
+    },
+    campaignId: {
+      propDefinition: [
+        googleAds,
+        "campaignId",
+        ({
+          accountId, customerClientId,
+        }) => ({
+          accountId,
+          customerClientId,
+        }),
+      ],
+      description: "The campaign to attach the shared set to. Required for **Create** operations.",
+      optional: true,
+    },
+    sharedSetId: {
+      propDefinition: [
+        googleAds,
+        "sharedSetId",
+        ({
+          accountId, customerClientId,
+        }) => ({
+          accountId,
+          customerClientId,
+        }),
+      ],
+      description: "The shared set to attach to the campaign. Required for **Create** operations.",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const {
+      googleAds,
+      accountId,
+      customerClientId,
+      operationType,
+      campaignSharedSetId,
+      campaignId,
+      sharedSetId,
+    } = this;
+
+    if (operationType === "remove" && !campaignSharedSetId) {
+      throw new ConfigurationError(
+        "**Campaign Shared Set** is required for Remove operations.",
+      );
+    }
+
+    if (operationType === "create") {
+      if (!campaignId) {
+        throw new ConfigurationError(
+          "**Campaign** is required for Create operations.",
+        );
+      }
+      if (!sharedSetId) {
+        throw new ConfigurationError(
+          "**Shared Set** is required for Create operations.",
+        );
+      }
+    }
+
+    const customerId = customerClientId ?? accountId;
+
+    let operation;
+
+    if (operationType === "remove") {
+      operation = {
+        remove: campaignSharedSetId,
+      };
+    } else {
+      operation = {
+        create: {
+          campaign: `customers/${customerId}/campaigns/${campaignId}`,
+          sharedSet: `customers/${customerId}/sharedSets/${sharedSetId}`,
+        },
+      };
+    }
+
+    const response = await googleAds.mutateCampaignSharedSets({
+      $,
+      accountId,
+      customerClientId,
+      data: {
+        operations: [
+          operation,
+        ],
+      },
+    });
+
+    const result = response?.results?.[0];
+    const resourceId = result?.resourceName?.split("/").pop();
+
+    $.export(
+      "$summary",
+      `Successfully ${operationType}d campaign shared set${resourceId
+        ? ` \`${resourceId}\``
+        : ""}.`,
+    );
+    return response;
+  },
+};

package/actions/create-or-remove-shared-criteria/create-or-remove-shared-criteria.mjs

@@ -0,0 +1,180 @@
+import { ConfigurationError } from "@pipedream/platform";
+import googleAds from "../../google_ads.app.mjs";
+import {
+  CREATE_REMOVE_OPERATION_TYPES,
+  KEYWORD_MATCH_TYPES,
+} from "../../common/constants.mjs";
+import { parseObject } from "../../common/utils.mjs";
+import { getAdditionalFields } from "../common/props.mjs";
+
+const docLink =
+  "https://developers.google.com/google-ads/api/reference/rpc/v21/SharedCriterionService/MutateSharedCriteria?transport=rest";
+
+export default {
+  key: "google_ads-create-or-remove-shared-criteria",
+  name: "Create or Remove Shared Criteria",
+  description: `Creates or removes criteria from a shared set (e.g., negative keywords). [See the documentation](${docLink})`,
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: true,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  props: {
+    googleAds,
+    accountId: {
+      propDefinition: [
+        googleAds,
+        "accountId",
+      ],
+    },
+    customerClientId: {
+      propDefinition: [
+        googleAds,
+        "customerClientId",
+        ({ accountId }) => ({
+          accountId,
+        }),
+      ],
+      optional: true,
+    },
+    operationType: {
+      type: "string",
+      label: "Operation Type",
+      description: "Whether to create or remove a shared criterion.",
+      options: CREATE_REMOVE_OPERATION_TYPES,
+    },
+    sharedCriterionId: {
+      propDefinition: [
+        googleAds,
+        "sharedCriterionId",
+        ({
+          accountId, customerClientId,
+        }) => ({
+          accountId,
+          customerClientId,
+        }),
+      ],
+      description: "The shared criterion to remove. Required for **Remove** operations.",
+      optional: true,
+    },
+    sharedSetId: {
+      propDefinition: [
+        googleAds,
+        "sharedSetId",
+        ({
+          accountId, customerClientId,
+        }) => ({
+          accountId,
+          customerClientId,
+        }),
+      ],
+      description: "The shared set to add this criterion to. Required for **Create** operations.",
+      optional: true,
+    },
+    keywordText: {
+      type: "string",
+      label: "Keyword Text",
+      description: "The keyword text to add to the shared set (max 80 characters, max 10 words). Required for keyword criteria.",
+      optional: true,
+    },
+    keywordMatchType: {
+      type: "string",
+      label: "Keyword Match Type",
+      description: "The match type for the keyword. Required for keyword criteria.",
+      options: KEYWORD_MATCH_TYPES,
+      optional: true,
+    },
+    additionalFields: getAdditionalFields(docLink),
+  },
+  async run({ $ }) {
+    const {
+      googleAds,
+      accountId,
+      customerClientId,
+      operationType,
+      sharedCriterionId,
+      sharedSetId,
+      keywordText,
+      keywordMatchType,
+      additionalFields,
+    } = this;
+
+    if (operationType === "remove" && !sharedCriterionId) {
+      throw new ConfigurationError(
+        "**Shared Criterion** is required for Remove operations.",
+      );
+    }
+
+    if (operationType === "create") {
+      if (!sharedSetId) {
+        throw new ConfigurationError(
+          "**Shared Set** is required for Create operations.",
+        );
+      }
+      if (keywordText && !keywordMatchType) {
+        throw new ConfigurationError(
+          "**Keyword Match Type** is required when **Keyword Text** is provided.",
+        );
+      }
+      if (keywordMatchType && !keywordText) {
+        throw new ConfigurationError(
+          "**Keyword Text** is required when **Keyword Match Type** is provided.",
+        );
+      }
+    }
+
+    const customerId = customerClientId ?? accountId;
+    const sharedSet = sharedSetId
+      ? `customers/${customerId}/sharedSets/${sharedSetId}`
+      : undefined;
+
+    let operation;
+
+    if (operationType === "remove") {
+      operation = {
+        remove: sharedCriterionId,
+      };
+    } else {
+      const criterionData = {
+        ...(sharedSet && {
+          sharedSet,
+        }),
+        ...(keywordText && keywordMatchType && {
+          keyword: {
+            text: keywordText,
+            matchType: keywordMatchType,
+          },
+        }),
+        ...parseObject(additionalFields),
+      };
+
+      operation = {
+        create: criterionData,
+      };
+    }
+
+    const response = await googleAds.mutateSharedCriteria({
+      $,
+      accountId,
+      customerClientId,
+      data: {
+        operations: [
+          operation,
+        ],
+      },
+    });
+
+    const result = response?.results?.[0];
+    const id = result?.resourceName?.split("~").pop();
+
+    $.export(
+      "$summary",
+      `Successfully ${operationType}d shared criterion${id
+        ? ` with criterion ID \`${id}\``
+        : ""}.`,
+    );
+    return response;
+  },
+};