@pipedream/google_ads 0.6.0 → 0.8.0

package/actions/update-campaign-ai-max-settings/update-campaign-ai-max-settings.mjs

@@ -0,0 +1,167 @@
+import { ConfigurationError } from "@pipedream/platform";
+import googleAds from "../../google_ads.app.mjs";
+import { ASSET_AUTOMATION_STATUSES } 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/docs/campaigns/ai-max-for-search-campaigns/getting-started";
+
+export default {
+  key: "google_ads-update-campaign-ai-max-settings",
+  name: "Update Campaign AI Max Settings",
+  description: `Enables or configures AI Max for Search settings on a campaign. Only supported on Search campaigns. Toggling AI Max while simultaneously editing brand or text customization settings on the same campaign may fail — update them separately. Ad group-level search term matching is controlled via the **Create or Update Ad Group** action. [See the documentation](${docLink})`,
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  props: {
+    googleAds,
+    accountId: {
+      propDefinition: [
+        googleAds,
+        "accountId",
+      ],
+    },
+    customerClientId: {
+      propDefinition: [
+        googleAds,
+        "customerClientId",
+        ({ accountId }) => ({
+          accountId,
+        }),
+      ],
+      optional: true,
+    },
+    campaignId: {
+      propDefinition: [
+        googleAds,
+        "campaignId",
+        ({
+          accountId, customerClientId,
+        }) => ({
+          accountId,
+          customerClientId,
+        }),
+      ],
+    },
+    enableAiMax: {
+      type: "boolean",
+      label: "Enable AI Max",
+      description: "Whether to enable AI Max for Search on this campaign (`aiMaxSetting.enableAiMax`).",
+      optional: true,
+    },
+    bundlingRequired: {
+      type: "boolean",
+      label: "Bundling Required",
+      description: "Whether bundling is required for AI Max asset serving (`aiMaxSetting.bundlingRequired`).",
+      optional: true,
+    },
+    textAssetAutomation: {
+      type: "string",
+      label: "Text Asset Automation",
+      description: "Opt in or out of automatically generated text assets (`TEXT_ASSET_AUTOMATION`).",
+      options: ASSET_AUTOMATION_STATUSES,
+      optional: true,
+    },
+    finalUrlExpansionAutomation: {
+      type: "string",
+      label: "Final URL Expansion Automation",
+      description: "Opt in or out of automatically expanding final URLs (`FINAL_URL_EXPANSION_TEXT_ASSET_AUTOMATION`).",
+      options: ASSET_AUTOMATION_STATUSES,
+      optional: true,
+    },
+    additionalFields: getAdditionalFields(docLink),
+  },
+  async run({ $ }) {
+    const {
+      googleAds,
+      accountId,
+      customerClientId,
+      campaignId,
+      enableAiMax,
+      bundlingRequired,
+      textAssetAutomation,
+      finalUrlExpansionAutomation,
+      additionalFields,
+    } = this;
+
+    const updateMaskFields = [];
+    const aiMaxSetting = {};
+
+    if (enableAiMax !== undefined) {
+      aiMaxSetting.enableAiMax = enableAiMax;
+      updateMaskFields.push("aiMaxSetting.enableAiMax");
+    }
+    if (bundlingRequired !== undefined) {
+      aiMaxSetting.bundlingRequired = bundlingRequired;
+      updateMaskFields.push("aiMaxSetting.bundlingRequired");
+    }
+
+    const assetAutomationSettings = [];
+    if (textAssetAutomation) {
+      assetAutomationSettings.push({
+        assetAutomationType: "TEXT_ASSET_AUTOMATION",
+        assetAutomationStatus: textAssetAutomation,
+      });
+    }
+    if (finalUrlExpansionAutomation) {
+      assetAutomationSettings.push({
+        assetAutomationType: "FINAL_URL_EXPANSION_TEXT_ASSET_AUTOMATION",
+        assetAutomationStatus: finalUrlExpansionAutomation,
+      });
+    }
+    if (assetAutomationSettings.length) {
+      updateMaskFields.push("assetAutomationSettings");
+    }
+
+    const extraFields = parseObject(additionalFields);
+    const extraKeys = Object.keys(extraFields);
+    if (extraKeys.length) {
+      updateMaskFields.push(...extraKeys);
+    }
+
+    if (!updateMaskFields.length) {
+      throw new ConfigurationError(
+        "At least one AI Max setting must be provided.",
+      );
+    }
+
+    const customerId = customerClientId ?? accountId;
+    const resourceName = `customers/${customerId}/campaigns/${campaignId}`;
+
+    const campaignData = {
+      resourceName,
+      ...(Object.keys(aiMaxSetting).length && {
+        aiMaxSetting,
+      }),
+      ...(assetAutomationSettings.length && {
+        assetAutomationSettings,
+      }),
+      ...extraFields,
+    };
+
+    const response = await googleAds.mutateCampaign({
+      $,
+      accountId,
+      customerClientId,
+      data: {
+        operations: [
+          {
+            update: campaignData,
+            updateMask: updateMaskFields.join(","),
+          },
+        ],
+      },
+    });
+
+    $.export(
+      "$summary",
+      `Successfully updated AI Max settings for campaign \`${campaignId}\`.`,
+    );
+    return response;
+  },
+};

package/common/constants.mjs

@@ -1,3 +1,272 @@
+export const SHARED_SET_TYPES = [
+  {
+    label: "Negative Keywords",
+    value: "NEGATIVE_KEYWORDS",
+  },
+  {
+    label: "Negative Placements",
+    value: "NEGATIVE_PLACEMENTS",
+  },
+];
+
+export const CREATE_REMOVE_OPERATION_TYPES = [
+  {
+    label: "Create",
+    value: "create",
+  },
+  {
+    label: "Remove",
+    value: "remove",
+  },
+];
+
+export const CAMPAIGN_OPERATION_TYPES = [
+  {
+    label: "Create",
+    value: "create",
+  },
+  {
+    label: "Update",
+    value: "update",
+  },
+  {
+    label: "Remove",
+    value: "remove",
+  },
+];
+
+export const CAMPAIGN_STATUSES = [
+  "ENABLED",
+  "PAUSED",
+  "REMOVED",
+];
+
+export const ADVERTISING_CHANNEL_TYPES = [
+  {
+    label: "Search",
+    value: "SEARCH",
+  },
+  {
+    label: "Display",
+    value: "DISPLAY",
+  },
+  {
+    label: "Shopping",
+    value: "SHOPPING",
+  },
+  {
+    label: "Hotel",
+    value: "HOTEL",
+  },
+  {
+    label: "Video",
+    value: "VIDEO",
+  },
+  {
+    label: "Multi-Channel (App)",
+    value: "MULTI_CHANNEL",
+  },
+  {
+    label: "Local",
+    value: "LOCAL",
+  },
+  {
+    label: "Smart",
+    value: "SMART",
+  },
+  {
+    label: "Performance Max",
+    value: "PERFORMANCE_MAX",
+  },
+  {
+    label: "Local Services",
+    value: "LOCAL_SERVICES",
+  },
+  {
+    label: "Discovery",
+    value: "DISCOVERY",
+  },
+  {
+    label: "Travel",
+    value: "TRAVEL",
+  },
+  {
+    label: "Demand Gen",
+    value: "DEMAND_GEN",
+  },
+];
+
+export const KEYWORD_MATCH_TYPES = [
+  {
+    label: "Exact",
+    value: "EXACT",
+  },
+  {
+    label: "Phrase",
+    value: "PHRASE",
+  },
+  {
+    label: "Broad",
+    value: "BROAD",
+  },
+];
+
+export const AD_GROUP_STATUSES = [
+  "ENABLED",
+  "PAUSED",
+  "REMOVED",
+];
+
+export const AD_GROUP_TYPES = [
+  {
+    label: "Search Standard",
+    value: "SEARCH_STANDARD",
+  },
+  {
+    label: "Display Standard",
+    value: "DISPLAY_STANDARD",
+  },
+  {
+    label: "Shopping Product Ads",
+    value: "SHOPPING_PRODUCT_ADS",
+  },
+  {
+    label: "Hotel Ads",
+    value: "HOTEL_ADS",
+  },
+  {
+    label: "Shopping Smart Ads",
+    value: "SHOPPING_SMART_ADS",
+  },
+  {
+    label: "Video Bumper",
+    value: "VIDEO_BUMPER",
+  },
+  {
+    label: "Video TrueView In-Stream",
+    value: "VIDEO_TRUE_VIEW_IN_STREAM",
+  },
+  {
+    label: "Video TrueView In-Display",
+    value: "VIDEO_TRUE_VIEW_IN_DISPLAY",
+  },
+  {
+    label: "Video Non-Skippable In-Stream",
+    value: "VIDEO_NON_SKIPPABLE_IN_STREAM",
+  },
+  {
+    label: "Video Outstream",
+    value: "VIDEO_OUTSTREAM",
+  },
+  {
+    label: "Search Dynamic Ads",
+    value: "SEARCH_DYNAMIC_ADS",
+  },
+  {
+    label: "Shopping Comparison Listing Ads",
+    value: "SHOPPING_COMPARISON_LISTING_ADS",
+  },
+  {
+    label: "Promoted Hotel Ads",
+    value: "PROMOTED_HOTEL_ADS",
+  },
+  {
+    label: "Video Responsive",
+    value: "VIDEO_RESPONSIVE",
+  },
+  {
+    label: "Video Efficient Reach",
+    value: "VIDEO_EFFICIENT_REACH",
+  },
+  {
+    label: "Smart Campaign Ads",
+    value: "SMART_CAMPAIGN_ADS",
+  },
+  {
+    label: "Travel Ads",
+    value: "TRAVEL_ADS",
+  },
+];
+
+export const AD_ROTATION_MODES = [
+  {
+    label: "Optimize",
+    value: "OPTIMIZE",
+  },
+  {
+    label: "Rotate Forever",
+    value: "ROTATE_FOREVER",
+  },
+];
+
+export const BUDGET_DELIVERY_METHODS = [
+  {
+    label: "Standard",
+    value: "STANDARD",
+  },
+  {
+    label: "Accelerated",
+    value: "ACCELERATED",
+  },
+];
+
+export const BUDGET_PERIODS = [
+  {
+    label: "Daily",
+    value: "DAILY",
+  },
+  {
+    label: "Custom Period",
+    value: "CUSTOM_PERIOD",
+  },
+];
+
+export const ASSET_AUTOMATION_STATUSES = [
+  {
+    label: "Opted In",
+    value: "OPTED_IN",
+  },
+  {
+    label: "Opted Out",
+    value: "OPTED_OUT",
+  },
+];
+
+export const PORTFOLIO_BIDDING_STRATEGY_TYPES = [
+  {
+    label: "Target CPA",
+    value: "TARGET_CPA",
+  },
+  {
+    label: "Target ROAS",
+    value: "TARGET_ROAS",
+  },
+  {
+    label: "Target Spend",
+    value: "TARGET_SPEND",
+  },
+  {
+    label: "Maximize Conversions",
+    value: "MAXIMIZE_CONVERSIONS",
+  },
+  {
+    label: "Maximize Conversion Value",
+    value: "MAXIMIZE_CONVERSION_VALUE",
+  },
+  {
+    label: "Target Impression Share",
+    value: "TARGET_IMPRESSION_SHARE",
+  },
+  {
+    label: "Enhanced CPC",
+    value: "ENHANCED_CPC",
+  },
+  {
+    label: "Percent CPC",
+    value: "PERCENT_CPC",
+  },
+];
+
 export const CORE_DATE_SEGMENTS = [
   "segments.date",
   "segments.week",

package/common/queries.mjs

@@ -1,3 +1,5 @@
+import { sanitizeGaqlString } from "./utils.mjs";
+
 function listCustomerClients(query) {
   const fields = [
     "client_customer",
@@ -10,7 +12,7 @@ function listCustomerClients(query) {
     .join(", ");
 
   const condition = query
-    ? `customer_client.descriptive_name LIKE '%${query}%'`
+    ? `customer_client.descriptive_name LIKE '%${sanitizeGaqlString(query)}%'`
     : "customer_client.level <= 3";
 
   return `SELECT ${fields} FROM customer_client WHERE ${condition}`;
@@ -105,7 +107,7 @@ function listResources(resource, query) {
 
   let result = `SELECT ${fieldResource}.id, ${fieldResource}.${name} FROM ${resource}`;
   if (query) {
-    result += ` WHERE ${fieldResource}.${name} LIKE '%${query}%'`;
+    result += ` WHERE ${fieldResource}.${name} LIKE '%${sanitizeGaqlString(query)}%'`;
   }
   return result;
 }

package/common/utils.mjs

@@ -68,6 +68,10 @@ export function getResourceOption(item, resource) {
   };
 }
 
+export function sanitizeGaqlString(value) {
+  return String(value).replace(/'/g, "''");
+}
+
 export function checkPrefix(value, prefix) {
   const checkStr = (s) => s && (s?.startsWith?.(prefix)
     ? s