@automate.ax/integration-contracts 0.139.2 → 0.142.0

package/src/google-ads/events.ts

@@ -0,0 +1,131 @@
+import type * as z from "zod"
+import {
+  GOOGLE_ADS_CHANGE_EVENT_PAYLOAD_SCHEMA,
+  GOOGLE_ADS_CHANGE_TRIGGER_CONFIG_SCHEMA,
+} from "./schemas"
+
+const changeContract = {
+  configSchema: GOOGLE_ADS_CHANGE_TRIGGER_CONFIG_SCHEMA,
+  eventSchema: GOOGLE_ADS_CHANGE_EVENT_PAYLOAD_SCHEMA,
+}
+
+export const googleAdsTriggerContracts = {
+  "googleAds.adGroup.created": changeContract,
+  "googleAds.adGroup.removed": changeContract,
+  "googleAds.adGroup.updated": changeContract,
+  "googleAds.adGroupAd.created": changeContract,
+  "googleAds.adGroupAd.removed": changeContract,
+  "googleAds.adGroupAd.updated": changeContract,
+  "googleAds.adGroupAsset.created": changeContract,
+  "googleAds.adGroupAsset.removed": changeContract,
+  "googleAds.adGroupAsset.updated": changeContract,
+  "googleAds.asset.created": changeContract,
+  "googleAds.asset.removed": changeContract,
+  "googleAds.asset.updated": changeContract,
+  "googleAds.campaign.created": changeContract,
+  "googleAds.campaign.removed": changeContract,
+  "googleAds.campaign.updated": changeContract,
+  "googleAds.campaignAsset.created": changeContract,
+  "googleAds.campaignAsset.removed": changeContract,
+  "googleAds.campaignAsset.updated": changeContract,
+  "googleAds.campaignBudget.created": changeContract,
+  "googleAds.campaignBudget.removed": changeContract,
+  "googleAds.campaignBudget.updated": changeContract,
+  "googleAds.change": changeContract,
+} as const
+
+export type GoogleAdsEventType = keyof typeof googleAdsTriggerContracts
+
+/**
+ * Returns the broad and optional semantic event types for one change.
+ *
+ * @param event - Normalized Google Ads change event.
+ */
+export function getGoogleAdsChangeEventTypes(
+  event: z.output<typeof GOOGLE_ADS_CHANGE_EVENT_PAYLOAD_SCHEMA>,
+): GoogleAdsEventType[] {
+  const semanticType = getSemanticEventType(
+    event.event.changeResourceType,
+    event.event.resourceChangeOperation,
+  )
+  return semanticType
+    ? ["googleAds.change", semanticType]
+    : ["googleAds.change"]
+}
+
+/**
+ * Maps provider resource and operation enums to public event types.
+ *
+ * @param resource - Provider change resource enum.
+ * @param operation - Provider mutation operation.
+ */
+function getSemanticEventType(
+  resource: z.output<
+    typeof GOOGLE_ADS_CHANGE_EVENT_PAYLOAD_SCHEMA
+  >["event"]["changeResourceType"],
+  operation: z.output<
+    typeof GOOGLE_ADS_CHANGE_EVENT_PAYLOAD_SCHEMA
+  >["event"]["resourceChangeOperation"],
+): GoogleAdsEventType | undefined {
+  if (operation === "UNSPECIFIED" || operation === "UNKNOWN") return undefined
+  switch (resource) {
+    case "AD_GROUP":
+      return (
+        {
+          CREATE: "googleAds.adGroup.created",
+          REMOVE: "googleAds.adGroup.removed",
+          UPDATE: "googleAds.adGroup.updated",
+        } as const
+      )[operation]
+    case "AD_GROUP_AD":
+      return (
+        {
+          CREATE: "googleAds.adGroupAd.created",
+          REMOVE: "googleAds.adGroupAd.removed",
+          UPDATE: "googleAds.adGroupAd.updated",
+        } as const
+      )[operation]
+    case "AD_GROUP_ASSET":
+      return (
+        {
+          CREATE: "googleAds.adGroupAsset.created",
+          REMOVE: "googleAds.adGroupAsset.removed",
+          UPDATE: "googleAds.adGroupAsset.updated",
+        } as const
+      )[operation]
+    case "ASSET":
+      return (
+        {
+          CREATE: "googleAds.asset.created",
+          REMOVE: "googleAds.asset.removed",
+          UPDATE: "googleAds.asset.updated",
+        } as const
+      )[operation]
+    case "CAMPAIGN":
+      return (
+        {
+          CREATE: "googleAds.campaign.created",
+          REMOVE: "googleAds.campaign.removed",
+          UPDATE: "googleAds.campaign.updated",
+        } as const
+      )[operation]
+    case "CAMPAIGN_ASSET":
+      return (
+        {
+          CREATE: "googleAds.campaignAsset.created",
+          REMOVE: "googleAds.campaignAsset.removed",
+          UPDATE: "googleAds.campaignAsset.updated",
+        } as const
+      )[operation]
+    case "CAMPAIGN_BUDGET":
+      return (
+        {
+          CREATE: "googleAds.campaignBudget.created",
+          REMOVE: "googleAds.campaignBudget.removed",
+          UPDATE: "googleAds.campaignBudget.updated",
+        } as const
+      )[operation]
+    default:
+      return undefined
+  }
+}

package/src/google-ads/index.ts

@@ -0,0 +1,3 @@
+export * from "./api"
+export * from "./events"
+export * from "./schemas"

package/src/google-ads/schemas.ts

@@ -0,0 +1,270 @@
+import * as z from "zod"
+import { GOOGLE_ADS_CUSTOMER_ID_SCHEMA } from "./api"
+
+const DECIMAL_STRING_SCHEMA = z.string().regex(/^\d+$/)
+const GOOGLE_ADS_STATUS_SCHEMA = z.enum([
+  "UNSPECIFIED",
+  "UNKNOWN",
+  "ENABLED",
+  "PAUSED",
+  "REMOVED",
+])
+
+export const GOOGLE_ADS_CUSTOMER_SCHEMA = z
+  .object({
+    autoTaggingEnabled: z.boolean().optional(),
+    currencyCode: z.string().optional(),
+    descriptiveName: z.string().optional(),
+    id: DECIMAL_STRING_SCHEMA.optional(),
+    manager: z.boolean().optional(),
+    resourceName: z.string(),
+    testAccount: z.boolean().optional(),
+    timeZone: z.string().optional(),
+  })
+  .catchall(z.json())
+
+export const GOOGLE_ADS_CUSTOMER_CLIENT_SCHEMA = z
+  .object({
+    clientCustomer: z.string(),
+    currencyCode: z.string().optional(),
+    descriptiveName: z.string().optional(),
+    hidden: z.boolean().optional(),
+    id: DECIMAL_STRING_SCHEMA.optional(),
+    level: z.string().optional(),
+    manager: z.boolean().optional(),
+    resourceName: z.string(),
+    testAccount: z.boolean().optional(),
+    timeZone: z.string().optional(),
+  })
+  .catchall(z.json())
+
+export const GOOGLE_ADS_CAMPAIGN_SCHEMA = z
+  .object({
+    advertisingChannelSubType: z.string().optional(),
+    advertisingChannelType: z.string().optional(),
+    campaignBudget: z.string().optional(),
+    endDateTime: z.string().optional(),
+    id: DECIMAL_STRING_SCHEMA.optional(),
+    name: z.string().optional(),
+    resourceName: z.string(),
+    servingStatus: z.string().optional(),
+    startDateTime: z.string().optional(),
+    status: GOOGLE_ADS_STATUS_SCHEMA.optional(),
+  })
+  .catchall(z.json())
+
+export const GOOGLE_ADS_CAMPAIGN_BUDGET_SCHEMA = z
+  .object({
+    amountMicros: DECIMAL_STRING_SCHEMA.optional(),
+    deliveryMethod: z.string().optional(),
+    explicitlyShared: z.boolean().optional(),
+    id: DECIMAL_STRING_SCHEMA.optional(),
+    name: z.string().optional(),
+    resourceName: z.string(),
+    status: z.string().optional(),
+    totalAmountMicros: DECIMAL_STRING_SCHEMA.optional(),
+  })
+  .catchall(z.json())
+
+export const GOOGLE_ADS_AD_GROUP_SCHEMA = z
+  .object({
+    campaign: z.string().optional(),
+    cpcBidMicros: DECIMAL_STRING_SCHEMA.optional(),
+    id: DECIMAL_STRING_SCHEMA.optional(),
+    name: z.string().optional(),
+    resourceName: z.string(),
+    status: GOOGLE_ADS_STATUS_SCHEMA.optional(),
+    targetCpaMicros: DECIMAL_STRING_SCHEMA.optional(),
+    type: z.string().optional(),
+  })
+  .catchall(z.json())
+
+export const GOOGLE_ADS_AD_SCHEMA = z
+  .object({
+    finalUrls: z.string().array().optional(),
+    id: DECIMAL_STRING_SCHEMA.optional(),
+    name: z.string().optional(),
+    resourceName: z.string(),
+    responsiveSearchAd: z
+      .object({
+        descriptions: z
+          .object({ text: z.string() })
+          .catchall(z.json())
+          .array()
+          .optional(),
+        headlines: z
+          .object({ text: z.string() })
+          .catchall(z.json())
+          .array()
+          .optional(),
+        path1: z.string().optional(),
+        path2: z.string().optional(),
+      })
+      .catchall(z.json())
+      .optional(),
+    type: z.string().optional(),
+  })
+  .catchall(z.json())
+
+export const GOOGLE_ADS_AD_GROUP_AD_SCHEMA = z
+  .object({
+    ad: GOOGLE_ADS_AD_SCHEMA.optional(),
+    adGroup: z.string().optional(),
+    policySummary: z.record(z.string(), z.json()).optional(),
+    resourceName: z.string(),
+    status: GOOGLE_ADS_STATUS_SCHEMA.optional(),
+  })
+  .catchall(z.json())
+
+export const GOOGLE_ADS_ASSET_SCHEMA = z
+  .object({
+    id: DECIMAL_STRING_SCHEMA.optional(),
+    name: z.string().optional(),
+    resourceName: z.string(),
+    type: z.string().optional(),
+  })
+  .catchall(z.json())
+
+export const GOOGLE_ADS_CONVERSION_ACTION_SCHEMA = z
+  .object({
+    category: z.string().optional(),
+    clickThroughLookbackWindowDays: z.string().optional(),
+    countingType: z.string().optional(),
+    id: DECIMAL_STRING_SCHEMA.optional(),
+    name: z.string().optional(),
+    primaryForGoal: z.boolean().optional(),
+    resourceName: z.string(),
+    status: z
+      .enum(["UNSPECIFIED", "UNKNOWN", "ENABLED", "REMOVED", "HIDDEN"])
+      .optional(),
+    type: z.string().optional(),
+    valueSettings: z
+      .object({
+        alwaysUseDefaultValue: z.boolean().optional(),
+        defaultCurrencyCode: z.string().optional(),
+        defaultValue: z.number().optional(),
+      })
+      .catchall(z.json())
+      .optional(),
+  })
+  .catchall(z.json())
+
+export const GOOGLE_ADS_AUDIENCE_SCHEMA = z
+  .object({
+    description: z.string().optional(),
+    dimensions: z.json().array().optional(),
+    id: DECIMAL_STRING_SCHEMA.optional(),
+    name: z.string().optional(),
+    resourceName: z.string(),
+    status: GOOGLE_ADS_STATUS_SCHEMA.optional(),
+  })
+  .catchall(z.json())
+
+export const GOOGLE_ADS_USER_LIST_SCHEMA = z
+  .object({
+    description: z.string().optional(),
+    id: DECIMAL_STRING_SCHEMA.optional(),
+    membershipLifeSpan: z.string().optional(),
+    membershipStatus: z.string().optional(),
+    name: z.string().optional(),
+    resourceName: z.string(),
+    sizeForDisplay: DECIMAL_STRING_SCHEMA.optional(),
+    sizeForSearch: DECIMAL_STRING_SCHEMA.optional(),
+    type: z.string().optional(),
+  })
+  .catchall(z.json())
+
+export const GOOGLE_ADS_SEARCH_ROW_SCHEMA = z
+  .object({
+    adGroup: GOOGLE_ADS_AD_GROUP_SCHEMA.optional(),
+    adGroupAd: GOOGLE_ADS_AD_GROUP_AD_SCHEMA.optional(),
+    asset: GOOGLE_ADS_ASSET_SCHEMA.optional(),
+    audience: GOOGLE_ADS_AUDIENCE_SCHEMA.optional(),
+    campaign: GOOGLE_ADS_CAMPAIGN_SCHEMA.optional(),
+    campaignBudget: GOOGLE_ADS_CAMPAIGN_BUDGET_SCHEMA.optional(),
+    conversionAction: GOOGLE_ADS_CONVERSION_ACTION_SCHEMA.optional(),
+    customer: GOOGLE_ADS_CUSTOMER_SCHEMA.optional(),
+    customerClient: GOOGLE_ADS_CUSTOMER_CLIENT_SCHEMA.optional(),
+    metrics: z.record(z.string(), z.json()).optional(),
+    segments: z.record(z.string(), z.json()).optional(),
+    userList: GOOGLE_ADS_USER_LIST_SCHEMA.optional(),
+  })
+  .catchall(z.json())
+
+export const GOOGLE_ADS_SEARCH_PAGE_SCHEMA = z.object({
+  fieldMask: z.string().optional(),
+  nextPageToken: z.string().optional(),
+  queryResourceConsumption: z.string().optional(),
+  results: GOOGLE_ADS_SEARCH_ROW_SCHEMA.array().prefault([]),
+  summaryRow: GOOGLE_ADS_SEARCH_ROW_SCHEMA.optional(),
+  totalResultsCount: DECIMAL_STRING_SCHEMA.optional(),
+})
+
+export const GOOGLE_ADS_MUTATE_RESULT_SCHEMA = z.object({
+  resourceName: z.string(),
+})
+
+export const GOOGLE_ADS_MUTATE_RESPONSE_SCHEMA = z.object({
+  results: GOOGLE_ADS_MUTATE_RESULT_SCHEMA.array(),
+})
+
+export const GOOGLE_ADS_CUSTOMER_CONTEXT_SCHEMA = z.object({
+  customerId: GOOGLE_ADS_CUSTOMER_ID_SCHEMA,
+  loginCustomerId: GOOGLE_ADS_CUSTOMER_ID_SCHEMA.optional(),
+})
+
+export const GOOGLE_ADS_CHANGE_RESOURCE_TYPE_SCHEMA = z.enum([
+  "UNSPECIFIED",
+  "UNKNOWN",
+  "AD",
+  "AD_GROUP",
+  "AD_GROUP_AD",
+  "AD_GROUP_ASSET",
+  "AD_GROUP_BID_MODIFIER",
+  "AD_GROUP_CRITERION",
+  "AD_GROUP_FEED",
+  "ASSET",
+  "ASSET_SET",
+  "ASSET_SET_ASSET",
+  "CAMPAIGN",
+  "CAMPAIGN_ASSET",
+  "CAMPAIGN_ASSET_SET",
+  "CAMPAIGN_BUDGET",
+  "CAMPAIGN_CRITERION",
+  "CAMPAIGN_FEED",
+  "CUSTOMER_ASSET",
+  "FEED",
+  "FEED_ITEM",
+])
+
+export const GOOGLE_ADS_CHANGE_EVENT_SCHEMA = z.object({
+  adGroup: z.string().optional(),
+  asset: z.string().optional(),
+  campaign: z.string().optional(),
+  changeDateTime: z.string(),
+  changeResourceName: z.string(),
+  changeResourceType: GOOGLE_ADS_CHANGE_RESOURCE_TYPE_SCHEMA,
+  changedFields: z.string().optional(),
+  clientType: z.string().optional(),
+  newResource: z.record(z.string(), z.json()).optional(),
+  oldResource: z.record(z.string(), z.json()).optional(),
+  resourceChangeOperation: z.enum([
+    "UNSPECIFIED",
+    "UNKNOWN",
+    "CREATE",
+    "UPDATE",
+    "REMOVE",
+  ]),
+  resourceName: z.string(),
+  userEmail: z.string().optional(),
+})
+
+export const GOOGLE_ADS_CHANGE_TRIGGER_CONFIG_SCHEMA = z.object({
+  customerId: GOOGLE_ADS_CUSTOMER_ID_SCHEMA,
+  loginCustomerId: GOOGLE_ADS_CUSTOMER_ID_SCHEMA.optional(),
+})
+
+export const GOOGLE_ADS_CHANGE_EVENT_PAYLOAD_SCHEMA = z.object({
+  customerId: GOOGLE_ADS_CUSTOMER_ID_SCHEMA,
+  event: GOOGLE_ADS_CHANGE_EVENT_SCHEMA,
+})