@segment/action-destinations 3.437.1-staging-ea6c83c19.0 → 3.437.1-staging-40f1a8151.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (43) hide show
  1. package/dist/destinations/linkedin-audiences/api.d.ts +4 -5
  2. package/dist/destinations/linkedin-audiences/api.js +10 -11
  3. package/dist/destinations/linkedin-audiences/api.js.map +1 -1
  4. package/dist/destinations/linkedin-audiences/common-functions.d.ts +9 -0
  5. package/dist/destinations/linkedin-audiences/common-functions.js +87 -0
  6. package/dist/destinations/linkedin-audiences/common-functions.js.map +1 -0
  7. package/dist/destinations/linkedin-audiences/constants.d.ts +8 -0
  8. package/dist/destinations/linkedin-audiences/constants.js +9 -1
  9. package/dist/destinations/linkedin-audiences/constants.js.map +1 -1
  10. package/dist/destinations/linkedin-audiences/index.js +5 -3
  11. package/dist/destinations/linkedin-audiences/index.js.map +1 -1
  12. package/dist/destinations/linkedin-audiences/types.d.ts +53 -8
  13. package/dist/destinations/linkedin-audiences/types.js.map +1 -1
  14. package/dist/destinations/linkedin-audiences/updateAudience/fields.js +36 -21
  15. package/dist/destinations/linkedin-audiences/updateAudience/fields.js.map +1 -1
  16. package/dist/destinations/linkedin-audiences/updateAudience/functions.d.ts +9 -4
  17. package/dist/destinations/linkedin-audiences/updateAudience/functions.js +83 -95
  18. package/dist/destinations/linkedin-audiences/updateAudience/functions.js.map +1 -1
  19. package/dist/destinations/linkedin-audiences/updateAudience/generated-types.d.ts +2 -1
  20. package/dist/destinations/linkedin-audiences/updateAudience/index.js +6 -4
  21. package/dist/destinations/linkedin-audiences/updateAudience/index.js.map +1 -1
  22. package/dist/destinations/linkedin-audiences/updateCompanyAudience/fields.d.ts +2 -0
  23. package/dist/destinations/linkedin-audiences/updateCompanyAudience/fields.js +109 -0
  24. package/dist/destinations/linkedin-audiences/updateCompanyAudience/fields.js.map +1 -0
  25. package/dist/destinations/linkedin-audiences/updateCompanyAudience/functions.d.ts +9 -0
  26. package/dist/destinations/linkedin-audiences/updateCompanyAudience/functions.js +50 -0
  27. package/dist/destinations/linkedin-audiences/updateCompanyAudience/functions.js.map +1 -0
  28. package/dist/destinations/linkedin-audiences/updateCompanyAudience/generated-types.d.ts +15 -0
  29. package/dist/destinations/linkedin-audiences/updateCompanyAudience/generated-types.js +3 -0
  30. package/dist/destinations/linkedin-audiences/updateCompanyAudience/generated-types.js.map +1 -0
  31. package/dist/destinations/linkedin-audiences/updateCompanyAudience/index.d.ts +5 -0
  32. package/dist/destinations/linkedin-audiences/updateCompanyAudience/index.js +20 -0
  33. package/dist/destinations/linkedin-audiences/updateCompanyAudience/index.js.map +1 -0
  34. package/dist/destinations/linkedin-conversions/api/index.js +4 -2
  35. package/dist/destinations/linkedin-conversions/api/index.js.map +1 -1
  36. package/dist/destinations/linkedin-conversions/streamConversion/generated-types.d.ts +1 -0
  37. package/dist/destinations/linkedin-conversions/streamConversion/index.js +7 -0
  38. package/dist/destinations/linkedin-conversions/streamConversion/index.js.map +1 -1
  39. package/dist/destinations/ms-bing-ads-audiences/index.js +1 -1
  40. package/dist/destinations/ms-bing-ads-audiences/index.js.map +1 -1
  41. package/dist/destinations/ms-bing-ads-audiences/syncAudiences/fields.js +13 -17
  42. package/dist/destinations/ms-bing-ads-audiences/syncAudiences/fields.js.map +1 -1
  43. package/package.json +2 -2
@@ -1,13 +1,12 @@
1
1
  import type { RequestClient, ModifiedResponse } from '@segment/actions-core';
2
2
  import type { Settings } from './generated-types';
3
- import type { Payload } from './updateAudience/generated-types';
4
- import type { ProfileAPIResponse, AdAccountUserResponse, LinkedInAudiencePayload } from './types';
3
+ import type { ProfileAPIResponse, AdAccountUserResponse, AudienceJSON, LinkedInBatchUpdateResponse, CreateDMPSegmentResponse, GetDMPSegmentResponse, SegmentType } from './types';
5
4
  export declare class LinkedInAudiences {
6
5
  request: RequestClient;
7
6
  constructor(request: RequestClient);
8
7
  getProfile(): Promise<ModifiedResponse<ProfileAPIResponse>>;
9
8
  getAdAccountUserProfile(settings: Settings, userId: string): Promise<ModifiedResponse<AdAccountUserResponse>>;
10
- getDmpSegment(settings: Settings, payload: Payload): Promise<ModifiedResponse>;
11
- createDmpSegment(settings: Settings, payload: Payload): Promise<ModifiedResponse>;
12
- batchUpdate(dmpSegmentId: string, elements: LinkedInAudiencePayload[]): Promise<ModifiedResponse>;
9
+ getDmpSegment(settings: Settings, sourceSegmentId?: string): Promise<ModifiedResponse<GetDMPSegmentResponse>>;
10
+ createDmpSegment(settings: Settings, sourceSegmentId: string, segmentName: string, segmentType: SegmentType): Promise<ModifiedResponse<CreateDMPSegmentResponse>>;
11
+ batchUpdate<E>(dmpSegmentId: string, json: AudienceJSON<E>, segmentType: SegmentType): Promise<ModifiedResponse<LinkedInBatchUpdateResponse>>;
13
12
  }
@@ -16,26 +16,26 @@ class LinkedInAudiences {
16
16
  method: 'GET'
17
17
  });
18
18
  }
19
- async getDmpSegment(settings, payload) {
19
+ async getDmpSegment(settings, sourceSegmentId = '') {
20
20
  return this.request(`${constants_1.BASE_URL}/dmpSegments`, {
21
21
  method: 'GET',
22
22
  searchParams: {
23
23
  q: 'account',
24
24
  account: `urn:li:sponsoredAccount:${settings.ad_account_id}`,
25
- sourceSegmentId: payload.personas_audience_key || '',
25
+ sourceSegmentId,
26
26
  sourcePlatform: constants_1.LINKEDIN_SOURCE_PLATFORM
27
27
  }
28
28
  });
29
29
  }
30
- async createDmpSegment(settings, payload) {
30
+ async createDmpSegment(settings, sourceSegmentId, segmentName, segmentType) {
31
31
  return this.request(`${constants_1.BASE_URL}/dmpSegments`, {
32
32
  method: 'POST',
33
33
  json: {
34
- name: payload.dmp_segment_name,
34
+ name: segmentName,
35
35
  sourcePlatform: constants_1.LINKEDIN_SOURCE_PLATFORM,
36
- sourceSegmentId: payload.personas_audience_key,
36
+ sourceSegmentId,
37
37
  account: `urn:li:sponsoredAccount:${settings.ad_account_id}`,
38
- type: 'USER',
38
+ type: segmentType,
39
39
  destinations: [
40
40
  {
41
41
  destination: 'LINKEDIN'
@@ -44,15 +44,14 @@ class LinkedInAudiences {
44
44
  }
45
45
  });
46
46
  }
47
- async batchUpdate(dmpSegmentId, elements) {
48
- return this.request(`${constants_1.BASE_URL}/dmpSegments/${dmpSegmentId}/users`, {
47
+ async batchUpdate(dmpSegmentId, json, segmentType) {
48
+ const url = `${constants_1.BASE_URL}/dmpSegments/${dmpSegmentId}/${segmentType === constants_1.SEGMENT_TYPES.COMPANY ? 'companies' : 'users'}`;
49
+ return this.request(url, {
49
50
  method: 'POST',
50
51
  headers: {
51
52
  'X-RestLi-Method': 'BATCH_CREATE'
52
53
  },
53
- json: {
54
- elements
55
- },
54
+ json,
56
55
  throwHttpErrors: false
57
56
  });
58
57
  }
@@ -1 +1 @@
1
- {"version":3,"file":"api.js","sourceRoot":"","sources":["../../../src/destinations/linkedin-audiences/api.ts"],"names":[],"mappings":";;;AAIA,2CAAgE;AAGhE,MAAa,iBAAiB;IAG5B,YAAY,OAAsB;QAChC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;IACxB,CAAC;IAED,KAAK,CAAC,UAAU;QACd,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,oBAAQ,KAAK,EAAE;YACpC,MAAM,EAAE,KAAK;SACd,CAAC,CAAA;IACJ,CAAC;IAED,KAAK,CAAC,uBAAuB,CAAC,QAAkB,EAAE,MAAc;QAC9D,OAAO,IAAI,CAAC,OAAO,CACjB,GAAG,oBAAQ,mDAAmD,QAAQ,CAAC,aAAa,uBAAuB,MAAM,EAAE,EACnH;YACE,MAAM,EAAE,KAAK;SACd,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,QAAkB,EAAE,OAAgB;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,oBAAQ,cAAc,EAAE;YAC7C,MAAM,EAAE,KAAK;YACb,YAAY,EAAE;gBACZ,CAAC,EAAE,SAAS;gBACZ,OAAO,EAAE,2BAA2B,QAAQ,CAAC,aAAa,EAAE;gBAC5D,eAAe,EAAE,OAAO,CAAC,qBAAqB,IAAI,EAAE;gBACpD,cAAc,EAAE,oCAAwB;aACzC;SACF,CAAC,CAAA;IACJ,CAAC;IAED,KAAK,CAAC,gBAAgB,CAAC,QAAkB,EAAE,OAAgB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,oBAAQ,cAAc,EAAE;YAC7C,MAAM,EAAE,MAAM;YACd,IAAI,EAAE;gBACJ,IAAI,EAAE,OAAO,CAAC,gBAAgB;gBAC9B,cAAc,EAAE,oCAAwB;gBACxC,eAAe,EAAE,OAAO,CAAC,qBAAqB;gBAC9C,OAAO,EAAE,2BAA2B,QAAQ,CAAC,aAAa,EAAE;gBAC5D,IAAI,EAAE,MAAM;gBACZ,YAAY,EAAE;oBACZ;wBACE,WAAW,EAAE,UAAU;qBACxB;iBACF;aACF;SACF,CAAC,CAAA;IACJ,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,YAAoB,EAAE,QAAmC;QACzE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,oBAAQ,gBAAgB,YAAY,QAAQ,EAAE;YACnE,MAAM,EAAE,MAAM;YACd,OAAO,EAAE;gBACP,iBAAiB,EAAE,cAAc;aAClC;YACD,IAAI,EAAE;gBACJ,QAAQ;aACT;YACD,eAAe,EAAE,KAAK;SACvB,CAAC,CAAA;IACJ,CAAC;CACF;AAhED,8CAgEC"}
1
+ {"version":3,"file":"api.js","sourceRoot":"","sources":["../../../src/destinations/linkedin-audiences/api.ts"],"names":[],"mappings":";;;AAEA,2CAA+E;AAW/E,MAAa,iBAAiB;IAG5B,YAAY,OAAsB;QAChC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;IACxB,CAAC;IAED,KAAK,CAAC,UAAU;QACd,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,oBAAQ,KAAK,EAAE;YACpC,MAAM,EAAE,KAAK;SACd,CAAC,CAAA;IACJ,CAAC;IAED,KAAK,CAAC,uBAAuB,CAAC,QAAkB,EAAE,MAAc;QAC9D,OAAO,IAAI,CAAC,OAAO,CACjB,GAAG,oBAAQ,mDAAmD,QAAQ,CAAC,aAAa,uBAAuB,MAAM,EAAE,EACnH;YACE,MAAM,EAAE,KAAK;SACd,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,QAAkB,EAAE,eAAe,GAAG,EAAE;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,oBAAQ,cAAc,EAAE;YAC7C,MAAM,EAAE,KAAK;YACb,YAAY,EAAE;gBACZ,CAAC,EAAE,SAAS;gBACZ,OAAO,EAAE,2BAA2B,QAAQ,CAAC,aAAa,EAAE;gBAC5D,eAAe;gBACf,cAAc,EAAE,oCAAwB;aACzC;SACF,CAAC,CAAA;IACJ,CAAC;IAED,KAAK,CAAC,gBAAgB,CAAC,QAAkB,EAAE,eAAuB,EAAE,WAAmB,EAAE,WAAwB;QAC/G,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,oBAAQ,cAAc,EAAE;YAC7C,MAAM,EAAE,MAAM;YACd,IAAI,EAAE;gBACJ,IAAI,EAAE,WAAW;gBACjB,cAAc,EAAE,oCAAwB;gBACxC,eAAe;gBACf,OAAO,EAAE,2BAA2B,QAAQ,CAAC,aAAa,EAAE;gBAC5D,IAAI,EAAE,WAAW;gBACjB,YAAY,EAAE;oBACZ;wBACE,WAAW,EAAE,UAAU;qBACxB;iBACF;aACF;SACF,CAAC,CAAA;IACJ,CAAC;IAED,KAAK,CAAC,WAAW,CAAI,YAAoB,EAAE,IAAqB,EAAE,WAAwB;QACxF,MAAM,GAAG,GAAG,GAAG,oBAAQ,gBAAgB,YAAY,IAAI,WAAW,KAAK,yBAAa,CAAC,OAAO,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,OAAO,EAAE,CAAA;QACtH,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE;YACvB,MAAM,EAAE,MAAM;YACd,OAAO,EAAE;gBACP,iBAAiB,EAAE,cAAc;aAClC;YACD,IAAI;YACJ,eAAe,EAAE,KAAK;SACvB,CAAC,CAAA;IACJ,CAAC;CACF;AA/DD,8CA+DC"}
@@ -0,0 +1,9 @@
1
+ import { StatsContext, MultiStatusResponse, RequestClient } from '@segment/actions-core';
2
+ import type { Settings } from './generated-types';
3
+ import { SegmentType, AudienceJSON } from './types';
4
+ export declare function send<P, E>(request: RequestClient, getSegmentSourceIdAndName: (payload: P) => {
5
+ sourceSegmentId: string;
6
+ segmentName: string;
7
+ }, buildJSON: (payloads: P[], settings: Settings) => AudienceJSON<E>, validate: (payloads: P[], msResponse: MultiStatusResponse, isBatch: boolean, settings: Settings) => (P & {
8
+ index: number;
9
+ })[], settings: Settings, payloads: P[], segmentType: SegmentType, isBatch: boolean, statsContext: StatsContext | undefined): Promise<MultiStatusResponse | import("@segment/actions-core/src").ModifiedResponse<import("./types").LinkedInBatchUpdateResponse>>;
@@ -0,0 +1,87 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.send = send;
4
+ const actions_core_1 = require("@segment/actions-core");
5
+ const api_1 = require("./api");
6
+ const constants_1 = require("./constants");
7
+ async function send(request, getSegmentSourceIdAndName, buildJSON, validate, settings, payloads, segmentType, isBatch, statsContext) {
8
+ const msResponse = new actions_core_1.MultiStatusResponse();
9
+ const validPayloads = validate(payloads, msResponse, isBatch, settings);
10
+ if (validPayloads.length === 0) {
11
+ if (isBatch) {
12
+ return msResponse;
13
+ }
14
+ else {
15
+ throw new actions_core_1.PayloadValidationError('No valid payloads to process after validation.');
16
+ }
17
+ }
18
+ const { sourceSegmentId, segmentName } = getSegmentSourceIdAndName(payloads[0]);
19
+ const linkedinApiClient = new api_1.LinkedInAudiences(request);
20
+ const { id, type } = await getDmpSegmentIdAndType(linkedinApiClient, settings, sourceSegmentId, segmentName, segmentType, statsContext);
21
+ if (type != segmentType) {
22
+ if (isBatch) {
23
+ payloads.forEach((_, index) => {
24
+ msResponse.setErrorResponseAtIndex(index, {
25
+ status: 400,
26
+ errortype: 'PAYLOAD_VALIDATION_FAILED',
27
+ errormessage: `The existing DMP Segment with Source Segment Id ${sourceSegmentId} is of type ${type} and cannot be used to update a segment of type ${segmentType}.`
28
+ });
29
+ });
30
+ return msResponse;
31
+ }
32
+ else {
33
+ throw new actions_core_1.PayloadValidationError(`The existing DMP Segment with Source Segment Id ${sourceSegmentId} is of type ${type} and cannot be used to update a segment of type ${segmentType}.`);
34
+ }
35
+ }
36
+ const json = buildJSON(validPayloads, settings);
37
+ statsContext?.statsClient?.incr('oauth_app_api_call', 1, [
38
+ ...statsContext?.tags,
39
+ `endpoint:add-or-remove-users-from-${segmentType === constants_1.SEGMENT_TYPES.COMPANY ? 'abm-' : ''}dmpSegment`
40
+ ]);
41
+ const response = await linkedinApiClient.batchUpdate(id, json, segmentType);
42
+ if (response.status !== 200) {
43
+ throw new actions_core_1.RetryableError('Error while attempting to update LinkedIn DMP Segment. This batch will be retried.');
44
+ }
45
+ if (isBatch) {
46
+ const sentElements = json.elements;
47
+ validPayloads.forEach((payload, index) => {
48
+ const e = response.data.elements[index];
49
+ if (e.status >= 200 && e.status < 300) {
50
+ msResponse.setSuccessResponseAtIndex(payload.index, {
51
+ status: e.status,
52
+ sent: payload,
53
+ body: { elements: [sentElements[index]] }
54
+ });
55
+ }
56
+ else {
57
+ msResponse.setErrorResponseAtIndex(payload.index, {
58
+ status: e.status,
59
+ errortype: 'BAD_REQUEST',
60
+ errormessage: e.message || 'Failed to update LinkedIn Audience',
61
+ sent: payload,
62
+ body: { elements: [sentElements[index]] }
63
+ });
64
+ }
65
+ });
66
+ return msResponse;
67
+ }
68
+ else {
69
+ return response;
70
+ }
71
+ }
72
+ async function getDmpSegmentIdAndType(linkedinApiClient, settings, sourceSegmentId, segmentName, segmentType, statsContext) {
73
+ statsContext?.statsClient?.incr('oauth_app_api_call', 1, [...statsContext?.tags, `endpoint:get-${segmentType === constants_1.SEGMENT_TYPES.COMPANY ? 'abm-' : ''}dmpSegment`]);
74
+ const response = await linkedinApiClient.getDmpSegment(settings, sourceSegmentId);
75
+ const { id, type } = response.data?.elements?.[0] || {};
76
+ if (id && type) {
77
+ return { id, type };
78
+ }
79
+ return createDmpSegment(linkedinApiClient, settings, sourceSegmentId, segmentName, segmentType, statsContext);
80
+ }
81
+ async function createDmpSegment(linkedinApiClient, settings, sourceSegmentId, segmentName, segmentType, statsContext) {
82
+ statsContext?.statsClient?.incr('oauth_app_api_call', 1, [...statsContext?.tags, `endpoint:create-${segmentType === constants_1.SEGMENT_TYPES.COMPANY ? 'abm-' : ''}dmpSegment`]);
83
+ const res = await linkedinApiClient.createDmpSegment(settings, sourceSegmentId, segmentName, segmentType);
84
+ const { id, type } = res.data;
85
+ return { id, type };
86
+ }
87
+ //# sourceMappingURL=common-functions.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"common-functions.js","sourceRoot":"","sources":["../../../src/destinations/linkedin-audiences/common-functions.ts"],"names":[],"mappings":";;AAMA,oBAyFC;AA/FD,wDAAgJ;AAEhJ,+BAAyC;AAEzC,2CAA2C;AAEpC,KAAK,UAAU,IAAI,CACxB,OAAsB,EACtB,yBAA2F,EAC3F,SAAiE,EACjE,QAA6H,EAC7H,QAAkB,EAClB,QAAa,EACb,WAAwB,EACxB,OAAgB,EAChB,YAAsC;IAEtC,MAAM,UAAU,GAAG,IAAI,kCAAmB,EAAE,CAAA;IAC5C,MAAM,aAAa,GAAG,QAAQ,CAAC,QAAQ,EAAE,UAAU,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAA;IAEvE,IAAG,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC9B,IAAG,OAAO,EAAC,CAAC;YACV,OAAO,UAAU,CAAA;QACnB,CAAC;aACI,CAAC;YACJ,MAAM,IAAI,qCAAsB,CAAC,gDAAgD,CAAC,CAAA;QACpF,CAAC;IACH,CAAC;IAED,MAAM,EAAE,eAAe,EAAE,WAAW,EAAE,GAAG,yBAAyB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAA;IAC/E,MAAM,iBAAiB,GAAsB,IAAI,uBAAiB,CAAC,OAAO,CAAC,CAAA;IAC3E,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,MAAM,sBAAsB,CAAC,iBAAiB,EAAE,QAAQ,EAAE,eAAe,EAAE,WAAW,EAAE,WAAW,EAAE,YAAY,CAAC,CAAA;IAEvI,IAAG,IAAI,IAAI,WAAW,EAAE,CAAC;QAEvB,IAAG,OAAO,EAAC,CAAC;YACV,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE;gBAC5B,UAAU,CAAC,uBAAuB,CAAC,KAAK,EAAE;oBACxC,MAAM,EAAE,GAAG;oBACX,SAAS,EAAE,2BAA2B;oBACtC,YAAY,EAAE,mDAAmD,eAAe,eAAe,IAAI,mDAAmD,WAAW,GAAG;iBACrK,CAAC,CAAA;YACJ,CAAC,CAAC,CAAA;YACF,OAAO,UAAU,CAAA;QACnB,CAAC;aACI,CAAC;YACJ,MAAM,IAAI,qCAAsB,CAAC,mDAAmD,eAAe,eAAe,IAAI,mDAAmD,WAAW,GAAG,CAAC,CAAA;QAC1L,CAAC;IACH,CAAC;IAID,MAAM,IAAI,GAAG,SAAS,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAA;IAE/C,YAAY,EAAE,WAAW,EAAE,IAAI,CAAC,oBAAoB,EAAE,CAAC,EAAE;QACvD,GAAG,YAAY,EAAE,IAAI;QACrB,qCAAqC,WAAW,KAAK,yBAAa,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,YAAY;KACrG,CAAC,CAAA;IAEF,MAAM,QAAQ,GAAG,MAAM,iBAAiB,CAAC,WAAW,CAAC,EAAE,EAAE,IAAI,EAAE,WAAW,CAAC,CAAA;IAM3E,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;QAC5B,MAAM,IAAI,6BAAc,CAAC,oFAAoF,CAAC,CAAA;IAChH,CAAC;IACD,IAAG,OAAO,EAAE,CAAC;QACX,MAAM,YAAY,GAAG,IAAI,CAAC,QAAQ,CAAA;QAElC,aAAa,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,KAAK,EAAE,EAAE;YACvC,MAAM,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAA;YACvC,IAAG,CAAC,CAAC,MAAM,IAAI,GAAG,IAAI,CAAC,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC;gBACrC,UAAU,CAAC,yBAAyB,CAAC,OAAO,CAAC,KAAK,EAAE;oBAClD,MAAM,EAAE,CAAC,CAAC,MAAM;oBAChB,IAAI,EAAE,OAAyB;oBAC/B,IAAI,EAAE,EAAE,QAAQ,EAAE,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,EAAmB;iBAC3D,CAAC,CAAA;YACJ,CAAC;iBACI,CAAC;gBACJ,UAAU,CAAC,uBAAuB,CAAC,OAAO,CAAC,KAAK,EAAE;oBAChD,MAAM,EAAE,CAAC,CAAC,MAAM;oBAChB,SAAS,EAAE,aAAa;oBACxB,YAAY,EAAE,CAAC,CAAC,OAAO,IAAI,oCAAoC;oBAC/D,IAAI,EAAE,OAAyB;oBAC/B,IAAI,EAAE,EAAE,QAAQ,EAAE,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,EAAmB;iBAC3D,CAAC,CAAA;YACJ,CAAC;QACH,CAAC,CAAC,CAAA;QACF,OAAO,UAAU,CAAA;IACnB,CAAC;SACI,CAAC;QACJ,OAAO,QAAQ,CAAA;IACjB,CAAC;AACH,CAAC;AAED,KAAK,UAAU,sBAAsB,CACnC,iBAAoC,EACpC,QAAkB,EAClB,eAAuB,EACvB,WAAmB,EACnB,WAAwB,EACxB,YAAsC;IAEtC,YAAY,EAAE,WAAW,EAAE,IAAI,CAAC,oBAAoB,EAAE,CAAC,EAAE,CAAC,GAAG,YAAY,EAAE,IAAI,EAAE,gBAAgB,WAAW,KAAK,yBAAa,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC,CAAA;IAClK,MAAM,QAAQ,GAAG,MAAM,iBAAiB,CAAC,aAAa,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAA;IACjF,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,QAAQ,CAAC,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAA;IACvD,IAAI,EAAE,IAAI,IAAI,EAAE,CAAC;QACf,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,CAAA;IACrB,CAAC;IACD,OAAO,gBAAgB,CAAC,iBAAiB,EAAE,QAAQ,EAAE,eAAe,EAAE,WAAW,EAAE,WAAW,EAAE,YAAY,CAAC,CAAA;AAC/G,CAAC;AAED,KAAK,UAAU,gBAAgB,CAC7B,iBAAoC,EACpC,QAAkB,EAClB,eAAuB,EACvB,WAAmB,EACnB,WAAwB,EACxB,YAAsC;IAEtC,YAAY,EAAE,WAAW,EAAE,IAAI,CAAC,oBAAoB,EAAE,CAAC,EAAE,CAAC,GAAG,YAAY,EAAE,IAAI,EAAE,mBAAmB,WAAW,KAAK,yBAAa,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC,CAAA;IACrK,MAAM,GAAG,GAAG,MAAM,iBAAiB,CAAC,gBAAgB,CAAC,QAAQ,EAAE,eAAe,EAAE,WAAW,EAAE,WAAW,CAAC,CAAA;IACzG,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,GAAG,CAAC,IAAI,CAAA;IAC7B,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,CAAA;AACrB,CAAC"}
@@ -1,3 +1,11 @@
1
1
  export declare const LINKEDIN_API_VERSION = "202505";
2
2
  export declare const BASE_URL = "https://api.linkedin.com/rest";
3
3
  export declare const LINKEDIN_SOURCE_PLATFORM = "SEGMENT";
4
+ export declare const SEGMENT_TYPES: {
5
+ readonly USER: "USER";
6
+ readonly COMPANY: "COMPANY";
7
+ };
8
+ export declare const AUDIENCE_ACTION: {
9
+ readonly ADD: "ADD";
10
+ readonly REMOVE: "REMOVE";
11
+ };
@@ -1,7 +1,15 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.LINKEDIN_SOURCE_PLATFORM = exports.BASE_URL = exports.LINKEDIN_API_VERSION = void 0;
3
+ exports.AUDIENCE_ACTION = exports.SEGMENT_TYPES = exports.LINKEDIN_SOURCE_PLATFORM = exports.BASE_URL = exports.LINKEDIN_API_VERSION = void 0;
4
4
  exports.LINKEDIN_API_VERSION = '202505';
5
5
  exports.BASE_URL = 'https://api.linkedin.com/rest';
6
6
  exports.LINKEDIN_SOURCE_PLATFORM = 'SEGMENT';
7
+ exports.SEGMENT_TYPES = {
8
+ USER: 'USER',
9
+ COMPANY: 'COMPANY'
10
+ };
11
+ exports.AUDIENCE_ACTION = {
12
+ ADD: 'ADD',
13
+ REMOVE: 'REMOVE'
14
+ };
7
15
  //# sourceMappingURL=constants.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../src/destinations/linkedin-audiences/constants.ts"],"names":[],"mappings":";;;AAAa,QAAA,oBAAoB,GAAG,QAAQ,CAAA;AAC/B,QAAA,QAAQ,GAAG,+BAA+B,CAAA;AAC1C,QAAA,wBAAwB,GAAG,SAAS,CAAA"}
1
+ {"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../src/destinations/linkedin-audiences/constants.ts"],"names":[],"mappings":";;;AAAa,QAAA,oBAAoB,GAAG,QAAQ,CAAA;AAC/B,QAAA,QAAQ,GAAG,+BAA+B,CAAA;AAC1C,QAAA,wBAAwB,GAAG,SAAS,CAAA;AACpC,QAAA,aAAa,GAAG;IAC3B,IAAI,EAAE,MAAM;IACZ,OAAO,EAAE,SAAS;CACV,CAAA;AAEG,QAAA,eAAe,GAAG;IAC7B,GAAG,EAAE,KAAK;IACV,MAAM,EAAE,QAAQ;CACR,CAAA"}
@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
6
6
  const https_1 = __importDefault(require("https"));
7
7
  const actions_core_1 = require("@segment/actions-core");
8
8
  const updateAudience_1 = __importDefault(require("./updateAudience"));
9
+ const updateCompanyAudience_1 = __importDefault(require("./updateCompanyAudience"));
9
10
  const constants_1 = require("./constants");
10
11
  const api_1 = require("./api");
11
12
  const destination = {
@@ -23,14 +24,14 @@ const destination = {
23
24
  },
24
25
  send_email: {
25
26
  label: 'Send Email',
26
- description: 'Whether to send `email` to LinkedIn. This setting applies to all mappings you create in this destination instance.',
27
+ description: 'Whether to send `email` to LinkedIn when using a User LinkedIn Segment.',
27
28
  type: 'boolean',
28
29
  default: true,
29
30
  required: true
30
31
  },
31
32
  send_google_advertising_id: {
32
33
  label: 'Send Google Advertising ID',
33
- description: 'Whether to send Google Advertising ID to LinkedIn. This setting applies to all mappings you create in this destination instance.',
34
+ description: 'Whether to send Google Advertising ID to LinkedIn when using a User LinkedIn Segment.',
34
35
  type: 'boolean',
35
36
  default: true,
36
37
  required: true
@@ -107,7 +108,8 @@ const destination = {
107
108
  };
108
109
  },
109
110
  actions: {
110
- updateAudience: updateAudience_1.default
111
+ updateAudience: updateAudience_1.default,
112
+ updateCompanyAudience: updateCompanyAudience_1.default
111
113
  }
112
114
  };
113
115
  exports.default = destination;
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/destinations/linkedin-audiences/index.ts"],"names":[],"mappings":";;;;;AAAA,kDAAyB;AAGzB,wDAAgG;AAGhG,sEAA6C;AAC7C,2CAAkD;AAClD,+BAAyC;AASzC,MAAM,WAAW,GAAoC;IAEnD,IAAI,EAAE,oBAAoB;IAC1B,IAAI,EAAE,4BAA4B;IAClC,IAAI,EAAE,OAAO;IAEb,cAAc,EAAE;QACd,MAAM,EAAE,QAAQ;QAChB,MAAM,EAAE;YACN,aAAa,EAAE;gBACb,KAAK,EAAE,wBAAwB;gBAC/B,WAAW,EACT,wLAAwL;gBAC1L,IAAI,EAAE,QAAQ;gBACd,QAAQ,EAAE,IAAI;aACf;YACD,UAAU,EAAE;gBACV,KAAK,EAAE,YAAY;gBACnB,WAAW,EACT,oHAAoH;gBACtH,IAAI,EAAE,SAAS;gBACf,OAAO,EAAE,IAAI;gBACb,QAAQ,EAAE,IAAI;aACf;YACD,0BAA0B,EAAE;gBAC1B,KAAK,EAAE,4BAA4B;gBACnC,WAAW,EACT,kIAAkI;gBACpI,IAAI,EAAE,SAAS;gBACf,OAAO,EAAE,IAAI;gBACb,QAAQ,EAAE,IAAI;aACf;SACF;QACD,kBAAkB,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE,EAAE;YACxD,IAAI,CAAC,IAAI,EAAE,WAAW,EAAE,CAAC;gBACvB,MAAM,IAAI,yCAA0B,CAClC,+FAA+F,CAChG,CAAA;YACH,CAAC;YAED,IAAI,CAAC,QAAQ,CAAC,UAAU,IAAI,CAAC,QAAQ,CAAC,0BAA0B,EAAE,CAAC;gBACjE,MAAM,IAAI,KAAK,CAAC,qFAAqF,CAAC,CAAA;YACxG,CAAC;YAED,MAAM,iBAAiB,GAAsB,IAAI,uBAAiB,CAAC,OAAO,CAAC,CAAA;YAE3E,IAAI,QAA8C,CAAA;YAElD,IAAI,CAAC;gBAGH,QAAQ,GAAG,MAAM,iBAAiB,CAAC,UAAU,EAAE,CAAA;YACjD,CAAC;YAAC,OAAO,CAAM,EAAE,CAAC;gBAChB,MAAM,KAAK,GAAG,CAAoC,CAAA;gBAClD,IAAI,KAAK,CAAC,OAAO,KAAK,cAAc,EAAE,CAAC;oBACrC,MAAM,IAAI,KAAK,CACb,6JAA6J,CAC9J,CAAA;gBACH,CAAC;gBACD,MAAM,CAAC,CAAA;YACT,CAAC;YAED,MAAM,MAAM,GAAG,QAAQ,EAAE,IAAI,EAAE,EAAE,CAAA;YAEjC,IAAI,SAAkD,CAAA;YAEtD,IAAI,CAAC;gBAGH,SAAS,GAAG,MAAM,iBAAiB,CAAC,uBAAuB,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;YAC/E,CAAC;YAAC,OAAO,CAAM,EAAE,CAAC;gBAChB,MAAM,KAAK,GAAG,CAAoC,CAAA;gBAClD,IAAI,KAAK,CAAC,OAAO,KAAK,WAAW,EAAE,CAAC;oBAClC,MAAM,IAAI,KAAK,CACb,mHAAmH,CACpH,CAAA;gBACH,CAAC;gBACD,MAAM,CAAC,CAAA;YACT,CAAC;YAED,MAAM,QAAQ,GAAG,SAAS,EAAE,IAAI,CAAC,IAAI,CAAA;YAErC,IAAI,QAAQ,KAAK,QAAQ,EAAE,CAAC;gBAC1B,MAAM,IAAI,KAAK,CACb,mKAAmK,CACpK,CAAA;YACH,CAAC;YAED,OAAO,IAAI,CAAA;QACb,CAAC;QACD,kBAAkB,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE;YAC9C,IAAI,GAAG,CAAA;YAEP,IAAI,CAAC;gBACH,GAAG,GAAG,MAAM,OAAO,CAAuB,+CAA+C,EAAE;oBACzF,MAAM,EAAE,MAAM;oBACd,IAAI,EAAE,IAAI,eAAe,CAAC;wBACxB,aAAa,EAAE,IAAI,CAAC,YAAY;wBAChC,SAAS,EAAE,IAAI,CAAC,QAAQ;wBACxB,aAAa,EAAE,IAAI,CAAC,YAAY;wBAChC,UAAU,EAAE,eAAe;qBAC5B,CAAC;iBACH,CAAC,CAAA;YACJ,CAAC;YAAC,OAAO,CAAM,EAAE,CAAC;gBAChB,MAAM,KAAK,GAAG,CAA8B,CAAA;gBAC5C,IAAI,KAAK,CAAC,QAAQ,EAAE,IAAI,EAAE,KAAK,KAAK,eAAe,EAAE,CAAC;oBACpD,MAAM,IAAI,+BAAgB,CACxB,wHAAwH,EACxH,yBAAU,CAAC,qBAAqB,EAChC,GAAG,CACJ,CAAA;gBACH,CAAC;gBAED,MAAM,IAAI,+BAAgB,CACxB,+CAA+C,KAAK,CAAC,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,EAC5E,yBAAU,CAAC,oBAAoB,EAC/B,GAAG,CACJ,CAAA;YACH,CAAC;YAED,OAAO,EAAE,WAAW,EAAE,GAAG,EAAE,IAAI,EAAE,YAAY,EAAE,CAAA;QACjD,CAAC;KACF;IACD,aAAa,CAAC,EAAE,IAAI,EAAE;QAGpB,MAAM,KAAK,GAAG,IAAI,eAAK,CAAC,KAAK,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;QAElD,OAAO;YACL,OAAO,EAAE;gBACP,aAAa,EAAE,UAAU,IAAI,EAAE,WAAW,EAAE;gBAC5C,kBAAkB,EAAE,gCAAoB;aACzC;YACD,KAAK;SACN,CAAA;IACH,CAAC;IAED,OAAO,EAAE;QACP,cAAc,EAAd,wBAAc;KACf;CACF,CAAA;AAED,kBAAe,WAAW,CAAA"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/destinations/linkedin-audiences/index.ts"],"names":[],"mappings":";;;;;AAAA,kDAAyB;AAEzB,wDAAgG;AAEhG,sEAA6C;AAC7C,oFAA2D;AAC3D,2CAAkD;AAClD,+BAAyC;AASzC,MAAM,WAAW,GAAoC;IAEnD,IAAI,EAAE,oBAAoB;IAC1B,IAAI,EAAE,4BAA4B;IAClC,IAAI,EAAE,OAAO;IAEb,cAAc,EAAE;QACd,MAAM,EAAE,QAAQ;QAChB,MAAM,EAAE;YACN,aAAa,EAAE;gBACb,KAAK,EAAE,wBAAwB;gBAC/B,WAAW,EACT,wLAAwL;gBAC1L,IAAI,EAAE,QAAQ;gBACd,QAAQ,EAAE,IAAI;aACf;YACD,UAAU,EAAE;gBACV,KAAK,EAAE,YAAY;gBACnB,WAAW,EAAE,yEAAyE;gBACtF,IAAI,EAAE,SAAS;gBACf,OAAO,EAAE,IAAI;gBACb,QAAQ,EAAE,IAAI;aACf;YACD,0BAA0B,EAAE;gBAC1B,KAAK,EAAE,4BAA4B;gBACnC,WAAW,EAAE,uFAAuF;gBACpG,IAAI,EAAE,SAAS;gBACf,OAAO,EAAE,IAAI;gBACb,QAAQ,EAAE,IAAI;aACf;SACF;QACD,kBAAkB,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE,EAAE;YACxD,IAAI,CAAC,IAAI,EAAE,WAAW,EAAE,CAAC;gBACvB,MAAM,IAAI,yCAA0B,CAClC,+FAA+F,CAChG,CAAA;YACH,CAAC;YAED,IAAI,CAAC,QAAQ,CAAC,UAAU,IAAI,CAAC,QAAQ,CAAC,0BAA0B,EAAE,CAAC;gBACjE,MAAM,IAAI,KAAK,CAAC,qFAAqF,CAAC,CAAA;YACxG,CAAC;YAED,MAAM,iBAAiB,GAAsB,IAAI,uBAAiB,CAAC,OAAO,CAAC,CAAA;YAE3E,IAAI,QAA8C,CAAA;YAElD,IAAI,CAAC;gBAGH,QAAQ,GAAG,MAAM,iBAAiB,CAAC,UAAU,EAAE,CAAA;YACjD,CAAC;YAAC,OAAO,CAAM,EAAE,CAAC;gBAChB,MAAM,KAAK,GAAG,CAAoC,CAAA;gBAClD,IAAI,KAAK,CAAC,OAAO,KAAK,cAAc,EAAE,CAAC;oBACrC,MAAM,IAAI,KAAK,CACb,6JAA6J,CAC9J,CAAA;gBACH,CAAC;gBACD,MAAM,CAAC,CAAA;YACT,CAAC;YAED,MAAM,MAAM,GAAG,QAAQ,EAAE,IAAI,EAAE,EAAE,CAAA;YAEjC,IAAI,SAAkD,CAAA;YAEtD,IAAI,CAAC;gBAGH,SAAS,GAAG,MAAM,iBAAiB,CAAC,uBAAuB,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;YAC/E,CAAC;YAAC,OAAO,CAAM,EAAE,CAAC;gBAChB,MAAM,KAAK,GAAG,CAAoC,CAAA;gBAClD,IAAI,KAAK,CAAC,OAAO,KAAK,WAAW,EAAE,CAAC;oBAClC,MAAM,IAAI,KAAK,CACb,mHAAmH,CACpH,CAAA;gBACH,CAAC;gBACD,MAAM,CAAC,CAAA;YACT,CAAC;YAED,MAAM,QAAQ,GAAG,SAAS,EAAE,IAAI,CAAC,IAAI,CAAA;YAErC,IAAI,QAAQ,KAAK,QAAQ,EAAE,CAAC;gBAC1B,MAAM,IAAI,KAAK,CACb,mKAAmK,CACpK,CAAA;YACH,CAAC;YAED,OAAO,IAAI,CAAA;QACb,CAAC;QACD,kBAAkB,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE;YAC9C,IAAI,GAAG,CAAA;YAEP,IAAI,CAAC;gBACH,GAAG,GAAG,MAAM,OAAO,CAAuB,+CAA+C,EAAE;oBACzF,MAAM,EAAE,MAAM;oBACd,IAAI,EAAE,IAAI,eAAe,CAAC;wBACxB,aAAa,EAAE,IAAI,CAAC,YAAY;wBAChC,SAAS,EAAE,IAAI,CAAC,QAAQ;wBACxB,aAAa,EAAE,IAAI,CAAC,YAAY;wBAChC,UAAU,EAAE,eAAe;qBAC5B,CAAC;iBACH,CAAC,CAAA;YACJ,CAAC;YAAC,OAAO,CAAM,EAAE,CAAC;gBAChB,MAAM,KAAK,GAAG,CAA8B,CAAA;gBAC5C,IAAI,KAAK,CAAC,QAAQ,EAAE,IAAI,EAAE,KAAK,KAAK,eAAe,EAAE,CAAC;oBACpD,MAAM,IAAI,+BAAgB,CACxB,wHAAwH,EACxH,yBAAU,CAAC,qBAAqB,EAChC,GAAG,CACJ,CAAA;gBACH,CAAC;gBAED,MAAM,IAAI,+BAAgB,CACxB,+CAA+C,KAAK,CAAC,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,EAC5E,yBAAU,CAAC,oBAAoB,EAC/B,GAAG,CACJ,CAAA;YACH,CAAC;YAED,OAAO,EAAE,WAAW,EAAE,GAAG,EAAE,IAAI,EAAE,YAAY,EAAE,CAAA;QACjD,CAAC;KACF;IACD,aAAa,CAAC,EAAE,IAAI,EAAE;QAGpB,MAAM,KAAK,GAAG,IAAI,eAAK,CAAC,KAAK,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;QAElD,OAAO;YACL,OAAO,EAAE;gBACP,aAAa,EAAE,UAAU,IAAI,EAAE,WAAW,EAAE;gBAC5C,kBAAkB,EAAE,gCAAoB;aACzC;YACD,KAAK;SACN,CAAA;IACH,CAAC;IAED,OAAO,EAAE;QACP,cAAc,EAAd,wBAAc;QACd,qBAAqB,EAArB,+BAAqB;KACtB;CACF,CAAA;AAED,kBAAe,WAAW,CAAA"}
@@ -1,4 +1,44 @@
1
1
  import { HTTPError } from '@segment/actions-core';
2
+ import { SEGMENT_TYPES, AUDIENCE_ACTION } from './constants';
3
+ import { Payload as UserPayload } from './updateAudience/generated-types';
4
+ import { Payload as CompanyPayload } from './updateCompanyAudience/generated-types';
5
+ export type SegmentType = typeof SEGMENT_TYPES[keyof typeof SEGMENT_TYPES];
6
+ export type AudienceAction = typeof AUDIENCE_ACTION[keyof typeof AUDIENCE_ACTION];
7
+ export type ValidUserPayload = (UserPayload & {
8
+ index: number;
9
+ });
10
+ export type ValidCompanyPayload = (CompanyPayload & {
11
+ index: number;
12
+ });
13
+ export interface AudienceJSON<E> {
14
+ elements: E[];
15
+ }
16
+ export interface LinkedInCompanyAudienceElement {
17
+ action: 'ADD' | 'REMOVE';
18
+ companyIds: ({
19
+ idType: 'DOMAIN';
20
+ idValue: string;
21
+ } | {
22
+ idType: 'LINKEDIN_COMPANY_ID';
23
+ idValue: string;
24
+ })[];
25
+ }
26
+ export interface LinkedInUserAudienceElement {
27
+ action: 'ADD' | 'REMOVE';
28
+ userIds: LinkedInUserId[];
29
+ firstName?: string;
30
+ lastName?: string;
31
+ title?: string;
32
+ company?: string;
33
+ country?: string;
34
+ }
35
+ export type LinkedInUserId = {
36
+ idType: 'SHA256_EMAIL';
37
+ idValue: string;
38
+ } | {
39
+ idType: 'GOOGLE_AID';
40
+ idValue: string;
41
+ };
2
42
  export interface RefreshTokenResponse {
3
43
  access_token: string;
4
44
  scope: string;
@@ -11,14 +51,19 @@ export interface ProfileAPIResponse {
11
51
  export interface AdAccountUserResponse {
12
52
  role: string;
13
53
  }
14
- export interface LinkedInAudiencePayload {
15
- action: 'ADD' | 'REMOVE';
16
- userIds: Record<string, string>[];
17
- firstName?: string;
18
- lastName?: string;
19
- title?: string;
20
- company?: string;
21
- country?: string;
54
+ export interface GetDMPSegmentResponse {
55
+ elements: Array<CreateDMPSegmentResponse>;
56
+ }
57
+ export interface CreateDMPSegmentResponse {
58
+ id: string;
59
+ type: 'USER' | 'COMPANY';
60
+ }
61
+ export interface LinkedInBatchUpdateResponse {
62
+ elements: Array<{
63
+ status: number;
64
+ id?: string;
65
+ message?: string;
66
+ }>;
22
67
  }
23
68
  export declare class LinkedInRefreshTokenError extends HTTPError {
24
69
  response: Response & {
@@ -1 +1 @@
1
- {"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/destinations/linkedin-audiences/types.ts"],"names":[],"mappings":";;;AAAA,wDAAiD;AA2BjD,MAAa,yBAA0B,SAAQ,wBAAS;CAOvD;AAPD,8DAOC;AAED,MAAa,+BAAgC,SAAQ,wBAAS;CAM7D;AAND,0EAMC"}
1
+ {"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/destinations/linkedin-audiences/types.ts"],"names":[],"mappings":";;;AAAA,wDAAiD;AAqEjD,MAAa,yBAA0B,SAAQ,wBAAS;CAOvD;AAPD,8DAOC;AAED,MAAa,+BAAgC,SAAQ,wBAAS;CAM7D;AAND,0EAMC"}
@@ -1,10 +1,11 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.fields = void 0;
4
+ const constants_1 = require("../constants");
4
5
  exports.fields = {
5
6
  dmp_segment_name: {
6
- label: 'DMP Segment Display Name',
7
- description: 'The display name of the LinkedIn DMP Segment. This field is set only when Segment creates a new audience. Updating this field after Segment has created an audience will not update the audience name in LinkedIn.',
7
+ label: 'Segment Creation Name',
8
+ description: 'The name of the segment to create. This field is no longer used after the Segment is created in LinkedIn.',
8
9
  type: 'string',
9
10
  default: {
10
11
  '@if': {
@@ -15,8 +16,8 @@ exports.fields = {
15
16
  }
16
17
  },
17
18
  enable_batching: {
18
- label: 'Enable Batching',
19
- description: 'Enable batching of requests to the LinkedIn DMP Segment.',
19
+ label: '[Hidden] Enable Batching',
20
+ description: '[Hidden] Enable batching of requests to the LinkedIn DMP Segment.',
20
21
  type: 'boolean',
21
22
  default: true,
22
23
  unsafe_hidden: true
@@ -29,7 +30,7 @@ exports.fields = {
29
30
  '@if': {
30
31
  exists: { '@path': '$.context.traits.email' },
31
32
  then: { '@path': '$.context.traits.email' },
32
- else: { '@path': '$.traits.email' }
33
+ else: { '@path': '$.properties.email' }
33
34
  }
34
35
  },
35
36
  category: 'hashedPII'
@@ -39,7 +40,7 @@ exports.fields = {
39
40
  description: "The user's first name to send to LinkedIn.",
40
41
  type: 'string',
41
42
  default: {
42
- '@path': '$.traits.firstName'
43
+ '@path': '$.properties.first_name'
43
44
  }
44
45
  },
45
46
  last_name: {
@@ -47,7 +48,7 @@ exports.fields = {
47
48
  description: "The user's last name to send to LinkedIn.",
48
49
  type: 'string',
49
50
  default: {
50
- '@path': '$.traits.lastName'
51
+ '@path': '$.properties.last_name'
51
52
  }
52
53
  },
53
54
  title: {
@@ -55,7 +56,7 @@ exports.fields = {
55
56
  description: "The user's title to send to LinkedIn.",
56
57
  type: 'string',
57
58
  default: {
58
- '@path': '$.traits.title'
59
+ '@path': '$.properties.title'
59
60
  }
60
61
  },
61
62
  company: {
@@ -63,7 +64,7 @@ exports.fields = {
63
64
  description: "The user's company to send to LinkedIn.",
64
65
  type: 'string',
65
66
  default: {
66
- '@path': '$.traits.company'
67
+ '@path': '$.properties.company'
67
68
  }
68
69
  },
69
70
  country: {
@@ -71,21 +72,25 @@ exports.fields = {
71
72
  description: "The user's country to send to LinkedIn. This field accepts an ISO standardized two letter country code e.g. US.",
72
73
  type: 'string',
73
74
  default: {
74
- '@path': '$.traits.country'
75
+ '@path': '$.properties.country'
75
76
  }
76
77
  },
77
78
  google_advertising_id: {
78
79
  label: 'User Google Advertising ID',
79
80
  description: "The user's Google Advertising ID to send to LinkedIn.",
80
81
  type: 'string',
81
- unsafe_hidden: true,
82
+ unsafe_hidden: false,
82
83
  default: {
83
- '@path': '$.context.device.advertisingId'
84
+ '@if': {
85
+ exists: { '@path': '$.properties.android_idfa' },
86
+ then: { '@path': '$.properties.android_idfa' },
87
+ else: { '@path': '$.context.device.advertisingId' }
88
+ }
84
89
  }
85
90
  },
86
91
  source_segment_id: {
87
- label: 'LinkedIn Source Segment ID',
88
- description: "A Segment-specific key associated with the LinkedIn DMP Segment. This is the lookup key Segment uses to fetch the DMP Segment from LinkedIn's API.",
92
+ label: '[Hidden] LinkedIn Source Segment ID',
93
+ description: "[Hidden] A Segment-specific key associated with the LinkedIn DMP Segment. This is the lookup key Segment uses to fetch the DMP Segment from LinkedIn's API.",
89
94
  type: 'string',
90
95
  unsafe_hidden: true,
91
96
  default: {
@@ -97,10 +102,11 @@ exports.fields = {
97
102
  }
98
103
  },
99
104
  personas_audience_key: {
100
- label: 'Segment Engage Audience Key',
101
- description: 'The `audience_key` of the Engage audience you want to sync to LinkedIn. This value must be a hard-coded string variable, e.g. `personas_test_audience`, in order for batching to work properly.',
105
+ label: '[Hidden] Segment Engage Audience Key',
106
+ description: '[Hidden] The `audience_key` of the Engage audience you want to sync to LinkedIn. This value must be a hard-coded string variable, e.g. `personas_test_audience`, in order for batching to work properly.',
102
107
  type: 'string',
103
- required: true
108
+ required: false,
109
+ unsafe_hidden: true
104
110
  },
105
111
  event_name: {
106
112
  label: 'Event Name',
@@ -112,15 +118,24 @@ exports.fields = {
112
118
  }
113
119
  },
114
120
  dmp_user_action: {
115
- label: 'DMP User Action',
116
- description: 'A Segment specific key used to define action type.',
121
+ label: 'User Segment Action',
122
+ description: 'Specifies if the user should be added or removed from the LinkedIn DMP User Segment.',
117
123
  type: 'string',
118
124
  choices: [
119
125
  { label: `Auto Detect`, value: 'AUTO' },
120
- { label: `Add`, value: 'ADD' },
121
- { label: 'Remove', value: 'REMOVE' }
126
+ { label: `Add`, value: constants_1.AUDIENCE_ACTION.ADD },
127
+ { label: 'Remove', value: constants_1.AUDIENCE_ACTION.REMOVE }
122
128
  ],
123
129
  default: 'AUTO'
130
+ },
131
+ batch_keys: {
132
+ label: '[Hidden] Batch Keys',
133
+ description: '[Hidden] Batch key used to ensure a batch contains payloads from a single Audience only.',
134
+ type: 'string',
135
+ unsafe_hidden: true,
136
+ required: false,
137
+ multiple: true,
138
+ default: ['source_segment_id', 'personas_audience_key']
124
139
  }
125
140
  };
126
141
  //# sourceMappingURL=fields.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"fields.js","sourceRoot":"","sources":["../../../../src/destinations/linkedin-audiences/updateAudience/fields.ts"],"names":[],"mappings":";;;AAEa,QAAA,MAAM,GAA+B;IAChD,gBAAgB,EAAE;QAChB,KAAK,EAAE,0BAA0B;QACjC,WAAW,EACT,oNAAoN;QACtN,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE;YACP,KAAK,EAAE;gBACL,MAAM,EAAE,EAAE,OAAO,EAAE,2BAA2B,EAAE;gBAChD,IAAI,EAAE,EAAE,OAAO,EAAE,2BAA2B,EAAE;gBAC9C,IAAI,EAAE,EAAE,OAAO,EAAE,oCAAoC,EAAE;aACxD;SACF;KACF;IACD,eAAe,EAAE;QACf,KAAK,EAAE,iBAAiB;QACxB,WAAW,EAAE,0DAA0D;QACvE,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,IAAI;QACb,aAAa,EAAE,IAAI;KACpB;IACD,KAAK,EAAE;QACL,KAAK,EAAE,YAAY;QACnB,WAAW,EAAE,+CAA+C;QAC5D,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE;YACP,KAAK,EAAE;gBACL,MAAM,EAAE,EAAE,OAAO,EAAE,wBAAwB,EAAE;gBAC7C,IAAI,EAAE,EAAE,OAAO,EAAE,wBAAwB,EAAE;gBAC3C,IAAI,EAAE,EAAE,OAAO,EAAE,gBAAgB,EAAE;aACpC;SACF;QACD,QAAQ,EAAE,WAAW;KACtB;IACD,UAAU,EAAE;QACV,KAAK,EAAE,iBAAiB;QACxB,WAAW,EAAE,4CAA4C;QACzD,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE;YACP,OAAO,EAAE,oBAAoB;SAC9B;KACF;IACD,SAAS,EAAE;QACT,KAAK,EAAE,gBAAgB;QACvB,WAAW,EAAE,2CAA2C;QACxD,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE;YACP,OAAO,EAAE,mBAAmB;SAC7B;KACF;IACD,KAAK,EAAE;QACL,KAAK,EAAE,YAAY;QACnB,WAAW,EAAE,uCAAuC;QACpD,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE;YACP,OAAO,EAAE,gBAAgB;SAC1B;KACF;IACD,OAAO,EAAE;QACP,KAAK,EAAE,cAAc;QACrB,WAAW,EAAE,yCAAyC;QACtD,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE;YACP,OAAO,EAAE,kBAAkB;SAC5B;KACF;IACD,OAAO,EAAE;QACP,KAAK,EAAE,cAAc;QACrB,WAAW,EACT,iHAAiH;QACnH,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE;YACP,OAAO,EAAE,kBAAkB;SAC5B;KACF;IACD,qBAAqB,EAAE;QACrB,KAAK,EAAE,4BAA4B;QACnC,WAAW,EAAE,uDAAuD;QACpE,IAAI,EAAE,QAAQ;QACd,aAAa,EAAE,IAAI;QACnB,OAAO,EAAE;YACP,OAAO,EAAE,gCAAgC;SAC1C;KACF;IACD,iBAAiB,EAAE;QACjB,KAAK,EAAE,4BAA4B;QACnC,WAAW,EACT,oJAAoJ;QACtJ,IAAI,EAAE,QAAQ;QACd,aAAa,EAAE,IAAI;QACnB,OAAO,EAAE;YACP,KAAK,EAAE;gBACL,MAAM,EAAE,EAAE,OAAO,EAAE,2BAA2B,EAAE;gBAChD,IAAI,EAAE,EAAE,OAAO,EAAE,2BAA2B,EAAE;gBAC9C,IAAI,EAAE,EAAE,OAAO,EAAE,oCAAoC,EAAE;aACxD;SACF;KACF;IACD,qBAAqB,EAAE;QACrB,KAAK,EAAE,6BAA6B;QACpC,WAAW,EACT,iMAAiM;QACnM,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,IAAI;KACf;IACD,UAAU,EAAE;QACV,KAAK,EAAE,YAAY;QACnB,WAAW,EAAE,wCAAwC;QACrD,IAAI,EAAE,QAAQ;QACd,aAAa,EAAE,IAAI;QACnB,OAAO,EAAE;YACP,OAAO,EAAE,SAAS;SACnB;KACF;IACD,eAAe,EAAE;QACf,KAAK,EAAE,iBAAiB;QACxB,WAAW,EAAE,oDAAoD;QACjE,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE;YACP,EAAE,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,MAAM,EAAE;YACvC,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE;YAC9B,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,QAAQ,EAAE;SACrC;QACD,OAAO,EAAE,MAAM;KAChB;CACF,CAAA"}
1
+ {"version":3,"file":"fields.js","sourceRoot":"","sources":["../../../../src/destinations/linkedin-audiences/updateAudience/fields.ts"],"names":[],"mappings":";;;AAEA,4CAA8C;AAEjC,QAAA,MAAM,GAA8B;IAC7C,gBAAgB,EAAE;QAChB,KAAK,EAAE,uBAAuB;QAC9B,WAAW,EAAE,2GAA2G;QACxH,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE;YACP,KAAK,EAAE;gBACL,MAAM,EAAE,EAAE,OAAO,EAAE,2BAA2B,EAAE;gBAChD,IAAI,EAAE,EAAE,OAAO,EAAE,2BAA2B,EAAE;gBAC9C,IAAI,EAAE,EAAE,OAAO,EAAE,oCAAoC,EAAE;aACxD;SACF;KACF;IACD,eAAe,EAAE;QACf,KAAK,EAAE,0BAA0B;QACjC,WAAW,EAAE,mEAAmE;QAChF,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,IAAI;QACb,aAAa,EAAE,IAAI;KACpB;IACD,KAAK,EAAE;QACL,KAAK,EAAE,YAAY;QACnB,WAAW,EAAE,+CAA+C;QAC5D,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE;YACP,KAAK,EAAE;gBACL,MAAM,EAAE,EAAE,OAAO,EAAE,wBAAwB,EAAE;gBAC7C,IAAI,EAAE,EAAE,OAAO,EAAE,wBAAwB,EAAE;gBAC3C,IAAI,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE;aACxC;SACF;QACD,QAAQ,EAAE,WAAW;KACtB;IACD,UAAU,EAAE;QACV,KAAK,EAAE,iBAAiB;QACxB,WAAW,EAAE,4CAA4C;QACzD,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE;YACP,OAAO,EAAE,yBAAyB;SACnC;KACF;IACD,SAAS,EAAE;QACT,KAAK,EAAE,gBAAgB;QACvB,WAAW,EAAE,2CAA2C;QACxD,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE;YACP,OAAO,EAAE,wBAAwB;SAClC;KACF;IACD,KAAK,EAAE;QACL,KAAK,EAAE,YAAY;QACnB,WAAW,EAAE,uCAAuC;QACpD,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE;YACP,OAAO,EAAE,oBAAoB;SAC9B;KACF;IACD,OAAO,EAAE;QACP,KAAK,EAAE,cAAc;QACrB,WAAW,EAAE,yCAAyC;QACtD,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE;YACP,OAAO,EAAE,sBAAsB;SAChC;KACF;IACD,OAAO,EAAE;QACP,KAAK,EAAE,cAAc;QACrB,WAAW,EACT,iHAAiH;QACnH,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE;YACP,OAAO,EAAE,sBAAsB;SAChC;KACF;IACD,qBAAqB,EAAE;QACrB,KAAK,EAAE,4BAA4B;QACnC,WAAW,EAAE,uDAAuD;QACpE,IAAI,EAAE,QAAQ;QACd,aAAa,EAAE,KAAK;QACpB,OAAO,EAAE;YACP,KAAK,EAAE;gBACL,MAAM,EAAE,EAAE,OAAO,EAAE,2BAA2B,EAAE;gBAChD,IAAI,EAAE,EAAE,OAAO,EAAE,2BAA2B,EAAE;gBAC9C,IAAI,EAAE,EAAE,OAAO,EAAE,gCAAgC,EAAE;aACpD;SACF;KACF;IACD,iBAAiB,EAAE;QACjB,KAAK,EAAE,qCAAqC;QAC5C,WAAW,EACT,6JAA6J;QAC/J,IAAI,EAAE,QAAQ;QACd,aAAa,EAAE,IAAI;QACnB,OAAO,EAAE;YACP,KAAK,EAAE;gBACL,MAAM,EAAE,EAAE,OAAO,EAAE,2BAA2B,EAAE;gBAChD,IAAI,EAAE,EAAE,OAAO,EAAE,2BAA2B,EAAE;gBAC9C,IAAI,EAAE,EAAE,OAAO,EAAE,oCAAoC,EAAE;aACxD;SACF;KACF;IACD,qBAAqB,EAAE;QAOrB,KAAK,EAAE,sCAAsC;QAC7C,WAAW,EACT,0MAA0M;QAC5M,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,KAAK;QACf,aAAa,EAAE,IAAI;KACpB;IACD,UAAU,EAAE;QACV,KAAK,EAAE,YAAY;QACnB,WAAW,EAAE,wCAAwC;QACrD,IAAI,EAAE,QAAQ;QACd,aAAa,EAAE,IAAI;QACnB,OAAO,EAAE;YACP,OAAO,EAAE,SAAS;SACnB;KACF;IACD,eAAe,EAAE;QACf,KAAK,EAAE,qBAAqB;QAC5B,WAAW,EAAE,sFAAsF;QACnG,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE;YACP,EAAE,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,MAAM,EAAE;YACvC,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,2BAAe,CAAC,GAAG,EAAE;YAC5C,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,2BAAe,CAAC,MAAM,EAAE;SACnD;QACD,OAAO,EAAE,MAAM;KAChB;IACD,UAAU,EAAE;QACV,KAAK,EAAE,qBAAqB;QAC5B,WAAW,EAAE,0FAA0F;QACvG,IAAI,EAAE,QAAQ;QACd,aAAa,EAAE,IAAI;QACnB,QAAQ,EAAE,KAAK;QACf,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,CAAC,mBAAmB,EAAE,uBAAuB,CAAC;KACxD;CACF,CAAA"}
@@ -1,5 +1,10 @@
1
- import type { StatsContext } from '@segment/actions-core';
2
- import { RequestClient } from '@segment/actions-core';
3
- import type { Settings } from '../generated-types';
1
+ import { MultiStatusResponse } from '@segment/actions-core';
4
2
  import type { Payload } from './generated-types';
5
- export declare function processPayload(request: RequestClient, settings: Settings, payloads: Payload[], statsContext: StatsContext | undefined): Promise<import("@segment/actions-core/src").ModifiedResponse<unknown> | undefined>;
3
+ import { AudienceJSON, LinkedInUserAudienceElement, ValidUserPayload } from '../types';
4
+ import type { Settings } from '../generated-types';
5
+ export declare function validate(payloads: Payload[], msResponse: MultiStatusResponse, isBatch: boolean, settings: Settings): ValidUserPayload[];
6
+ export declare function buildJSON(payloads: Payload[], settings: Settings): AudienceJSON<LinkedInUserAudienceElement>;
7
+ export declare function getSegmentSourceIdAndName(payload: Payload): {
8
+ sourceSegmentId: string;
9
+ segmentName: string;
10
+ };