@segment/action-destinations 3.421.1-staging-e3064f0f4.0 → 3.421.1-staging-a34dd23ea.0

package/dist/destinations/ms-bing-ads-audiences/constants.d.ts

@@ -0,0 +1,2 @@
+export declare const BASE_URL = "https://campaign.api.bingads.microsoft.com/CampaignManagement/v13";
+export declare const TOKEN_URL = "https://login.microsoftonline.com/common/oauth2/v2.0/token";

package/dist/destinations/ms-bing-ads-audiences/constants.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TOKEN_URL = exports.BASE_URL = void 0;
+const API_VERSION = 'v13';
+exports.BASE_URL = `https://campaign.api.bingads.microsoft.com/CampaignManagement/${API_VERSION}`;
+exports.TOKEN_URL = 'https://login.microsoftonline.com/common/oauth2/v2.0/token';
+//# sourceMappingURL=constants.js.map

package/dist/destinations/ms-bing-ads-audiences/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../src/destinations/ms-bing-ads-audiences/constants.ts"],"names":[],"mappings":";;;AAAA,MAAM,WAAW,GAAG,KAAK,CAAA;AACZ,QAAA,QAAQ,GAAG,iEAAiE,WAAW,EAAE,CAAA;AACzF,QAAA,SAAS,GAAG,4DAA4D,CAAA"}

package/dist/destinations/ms-bing-ads-audiences/generated-types.d.ts

@@ -1,2 +1,5 @@
 export interface Settings {
+    developerToken: string;
+    customerAccountId: string;
+    customerId: string;
 }

package/dist/destinations/ms-bing-ads-audiences/index.d.ts

@@ -1,4 +1,4 @@
-import type { AudienceDestinationDefinition } from '@segment/actions-core';
+import { AudienceDestinationDefinition } from '@segment/actions-core';
 import type { Settings } from './generated-types';
 declare const destination: AudienceDestinationDefinition<Settings>;
 export default destination;

package/dist/destinations/ms-bing-ads-audiences/index.js

@@ -3,19 +3,59 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+const actions_core_1 = require("@segment/actions-core");
 const syncAudiences_1 = __importDefault(require("./syncAudiences"));
+const constants_1 = require("./constants");
 const destination = {
     name: 'Ms Bing Ads Audiences',
     slug: 'actions-ms-bing-ads-audiences',
     mode: 'cloud',
     authentication: {
         scheme: 'oauth2',
-        fields: {}
+        fields: {
+            developerToken: {
+                label: 'Developer Token',
+                description: 'The developer token for authenticating API requests. You can find it in the Microsoft Advertising UI under Settings → Developer Settings.',
+                type: 'string',
+                required: true
+            },
+            customerAccountId: {
+                label: 'Customer Account ID',
+                description: 'The account ID of the Microsoft Advertising account you want to manage. You can find it in the URL when viewing the account in the Microsoft Ads UI.',
+                type: 'string',
+                required: true
+            },
+            customerId: {
+                label: 'Customer ID',
+                description: 'The customer (parent) ID associated with your Microsoft Advertising account. You can also find this in the URL when viewing your account in the Microsoft Ads UI.',
+                type: 'string',
+                required: true
+            }
+        },
+        refreshAccessToken: async (request, { auth }) => {
+            const res = await request(constants_1.TOKEN_URL, {
+                method: 'POST',
+                body: new URLSearchParams({
+                    refresh_token: auth.refreshToken,
+                    client_id: auth.clientId,
+                    client_secret: auth.clientSecret,
+                    grant_type: 'refresh_token',
+                    scope: 'https://ads.microsoft.com/msads.manage offline_access'
+                })
+            });
+            return {
+                accessToken: res?.data?.access_token,
+                refreshToken: res?.data?.refresh_token
+            };
+        }
     },
-    extendRequest({ auth }) {
+    extendRequest({ auth, settings }) {
         return {
             headers: {
-                authorization: `Bearer ${auth?.accessToken}`
+                Authorization: `Bearer ${auth?.accessToken}`,
+                DeveloperToken: settings?.developerToken,
+                CustomerAccountId: settings?.customerAccountId,
+                CustomerId: settings?.customerId
             }
         };
     },
@@ -24,6 +64,45 @@ const destination = {
         mode: {
             type: 'synced',
             full_audience_sync: false
+        },
+        createAudience: async (request, createAudienceInput) => {
+            const audienceName = createAudienceInput?.audienceName;
+            if (!audienceName) {
+                throw new actions_core_1.PayloadValidationError('Missing audience name value');
+            }
+            const response = await request(`${constants_1.BASE_URL}/Audiences`, {
+                method: 'POST',
+                json: {
+                    Audiences: [
+                        {
+                            Name: audienceName,
+                            Type: 'CustomerList'
+                        }
+                    ]
+                }
+            });
+            if (response?.data?.PartialErrors?.length) {
+                const errorObj = response.data.PartialErrors[0];
+                if (errorObj?.ErrorCode === 'CustomerListTermsAndConditionsNotAccepted') {
+                    throw new actions_core_1.IntegrationError("The Customer Match 'Terms And Conditions' are not yet Accepted in the Microsoft Advertising web UI. Please create a Customer List in the Microsoft Advertising UI to accept the terms.", 'TERMS_NOT_ACCEPTED', 400);
+                }
+            }
+            const audienceId = response?.data?.AudienceIds?.[0];
+            if (!audienceId) {
+                throw new actions_core_1.IntegrationError('Failed to create audience: No AudienceId returned', 'NO_AUDIENCE_ID', 400);
+            }
+            return { externalId: audienceId };
+        },
+        getAudience: async (request, getAudienceInput) => {
+            const audienceId = getAudienceInput?.externalId;
+            const response = await request(`${constants_1.BASE_URL}/Audiences/QueryByIds`, {
+                method: 'POST',
+                json: {
+                    AudienceIds: [audienceId],
+                    Type: 'CustomerList'
+                }
+            });
+            return { externalId: response?.data?.Audiences?.[0]?.Id };
         }
     },
     actions: {

package/dist/destinations/ms-bing-ads-audiences/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/destinations/ms-bing-ads-audiences/index.ts"],"names":[],"mappings":";;;;;AAEA,oEAA2C;AAG3C,MAAM,WAAW,GAA4C;IAC3D,IAAI,EAAE,uBAAuB;IAC7B,IAAI,EAAE,+BAA+B;IACrC,IAAI,EAAE,OAAO;IAEb,cAAc,EAAE;QACd,MAAM,EAAE,QAAQ;QAChB,MAAM,EAAE,EAAE;KAoBX;IACD,aAAa,CAAC,EAAE,IAAI,EAAE;QACpB,OAAO;YACL,OAAO,EAAE;gBACP,aAAa,EAAE,UAAU,IAAI,EAAE,WAAW,EAAE;aAC7C;SACF,CAAA;IACH,CAAC;IAED,cAAc,EAAE,EAAE;IAElB,cAAc,EAAE;QACd,IAAI,EAAE;YACJ,IAAI,EAAE,QAAQ;YACd,kBAAkB,EAAE,KAAK;SAC1B;KAaF;IAQD,OAAO,EAAE;QACP,aAAa,EAAb,uBAAa;KACd;CACF,CAAA;AAED,kBAAe,WAAW,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/destinations/ms-bing-ads-audiences/index.ts"],"names":[],"mappings":";;;;;AAAA,wDAA+G;AAE/G,oEAA2C;AAE3C,2CAAiD;AAEjD,MAAM,WAAW,GAA4C;IAC3D,IAAI,EAAE,uBAAuB;IAC7B,IAAI,EAAE,+BAA+B;IACrC,IAAI,EAAE,OAAO;IAEb,cAAc,EAAE;QACd,MAAM,EAAE,QAAQ;QAChB,MAAM,EAAE;YACN,cAAc,EAAE;gBACd,KAAK,EAAE,iBAAiB;gBACxB,WAAW,EACT,2IAA2I;gBAC7I,IAAI,EAAE,QAAQ;gBACd,QAAQ,EAAE,IAAI;aACf;YACD,iBAAiB,EAAE;gBACjB,KAAK,EAAE,qBAAqB;gBAC5B,WAAW,EACT,sJAAsJ;gBACxJ,IAAI,EAAE,QAAQ;gBACd,QAAQ,EAAE,IAAI;aACf;YACD,UAAU,EAAE;gBACV,KAAK,EAAE,aAAa;gBACpB,WAAW,EACT,mKAAmK;gBACrK,IAAI,EAAE,QAAQ;gBACd,QAAQ,EAAE,IAAI;aACf;SACF;QACD,kBAAkB,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE;YAG9C,MAAM,GAAG,GAAG,MAAM,OAAO,CAAuB,qBAAS,EAAE;gBACzD,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,IAAI,eAAe,CAAC;oBACxB,aAAa,EAAE,IAAI,CAAC,YAAY;oBAChC,SAAS,EAAE,IAAI,CAAC,QAAQ;oBACxB,aAAa,EAAE,IAAI,CAAC,YAAY;oBAChC,UAAU,EAAE,eAAe;oBAC3B,KAAK,EAAE,uDAAuD;iBAC/D,CAAC;aACH,CAAC,CAAA;YAEF,OAAO;gBACL,WAAW,EAAE,GAAG,EAAE,IAAI,EAAE,YAAY;gBACpC,YAAY,EAAE,GAAG,EAAE,IAAI,EAAE,aAAa;aACvC,CAAA;QACH,CAAC;KACF;IAED,aAAa,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC9B,OAAO;YACL,OAAO,EAAE;gBACP,aAAa,EAAE,UAAU,IAAI,EAAE,WAAW,EAAE;gBAC5C,cAAc,EAAE,QAAQ,EAAE,cAAc;gBACxC,iBAAiB,EAAE,QAAQ,EAAE,iBAAiB;gBAC9C,UAAU,EAAE,QAAQ,EAAE,UAAU;aACjC;SACF,CAAA;IACH,CAAC;IAED,cAAc,EAAE,EAAE;IAElB,cAAc,EAAE;QACd,IAAI,EAAE;YACJ,IAAI,EAAE,QAAQ;YACd,kBAAkB,EAAE,KAAK;SAC1B;QACD,cAAc,EAAE,KAAK,EAAE,OAAO,EAAE,mBAAmB,EAAE,EAAE;YAIrD,MAAM,YAAY,GAAG,mBAAmB,EAAE,YAAY,CAAA;YAEtD,IAAI,CAAC,YAAY,EAAE,CAAC;gBAClB,MAAM,IAAI,qCAAsB,CAAC,6BAA6B,CAAC,CAAA;YACjE,CAAC;YAED,MAAM,QAAQ,GAA2B,MAAM,OAAO,CAAC,GAAG,oBAAQ,YAAY,EAAE;gBAC9E,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE;oBACJ,SAAS,EAAE;wBACT;4BACE,IAAI,EAAE,YAAY;4BAClB,IAAI,EAAE,cAAc;yBACrB;qBACF;iBACF;aACF,CAAC,CAAA;YAGF,IAAI,QAAQ,EAAE,IAAI,EAAE,aAAa,EAAE,MAAM,EAAE,CAAC;gBAC1C,MAAM,QAAQ,GAAG,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAA;gBAC/C,IAAI,QAAQ,EAAE,SAAS,KAAK,2CAA2C,EAAE,CAAC;oBACxE,MAAM,IAAI,+BAAgB,CACxB,wLAAwL,EACxL,oBAAoB,EACpB,GAAG,CACJ,CAAA;gBACH,CAAC;YACH,CAAC;YAGD,MAAM,UAAU,GAAG,QAAQ,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,CAAA;YACnD,IAAI,CAAC,UAAU,EAAE,CAAC;gBAChB,MAAM,IAAI,+BAAgB,CAAC,mDAAmD,EAAE,gBAAgB,EAAE,GAAG,CAAC,CAAA;YACxG,CAAC;YAED,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,CAAA;QACnC,CAAC;QACD,WAAW,EAAE,KAAK,EAAE,OAAO,EAAE,gBAAgB,EAAE,EAAE;YAG/C,MAAM,UAAU,GAAG,gBAAgB,EAAE,UAAU,CAAA;YAC/C,MAAM,QAAQ,GAAwB,MAAM,OAAO,CAAC,GAAG,oBAAQ,uBAAuB,EAAE;gBACtF,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE;oBACJ,WAAW,EAAE,CAAC,UAAU,CAAC;oBACzB,IAAI,EAAE,cAAc;iBACrB;aACF,CAAC,CAAA;YAEF,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,CAAA;QAC3D,CAAC;KACF;IAED,OAAO,EAAE;QACP,aAAa,EAAb,uBAAa;KACd;CACF,CAAA;AAED,kBAAe,WAAW,CAAA"}

package/dist/destinations/ms-bing-ads-audiences/types.d.ts

@@ -0,0 +1,29 @@
+export interface RefreshTokenResponse {
+    access_token: string;
+    refresh_token?: string;
+}
+export interface CreateAudienceResponse {
+    data: {
+        AudienceIds: string[];
+        PartialErrors: {
+            FieldPath: string | null;
+            ErrorCode: string;
+            Message: string;
+            Code: number;
+            Details: string | null;
+            Index: number;
+            Type: string;
+            ForwardCompatibilityMap: null;
+        }[];
+    };
+}
+export interface GetAudienceResponse {
+    data: {
+        Audiences: [
+            {
+                Id: string;
+            }
+        ];
+        PartialErrors: [];
+    };
+}

package/dist/destinations/ms-bing-ads-audiences/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/destinations/ms-bing-ads-audiences/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/destinations/ms-bing-ads-audiences/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@segment/action-destinations",
   "description": "Destination Actions engine and definitions.",
-  "version": "3.421.1-staging-e3064f0f4.0",
+  "version": "3.421.1-staging-a34dd23ea.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/segmentio/action-destinations",
@@ -91,5 +91,5 @@
       "__tests__/__helpers__/"
     ]
   },
-  "gitHead": "59b456226a762937ea13f709e06b30f5d0809381"
+  "gitHead": "2c74d97fda376035e638c92a5fdc3db5f0f21211"
 }