@segment/action-destinations 3.480.0 → 3.481.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 (72) hide show
  1. package/dist/destinations/facebook-conversions-api/addToCart/generated-types.d.ts +0 -1
  2. package/dist/destinations/facebook-conversions-api/addToCart/index.js +87 -4
  3. package/dist/destinations/facebook-conversions-api/addToCart/index.js.map +1 -1
  4. package/dist/destinations/facebook-conversions-api/addToCart2/generated-types.d.ts +0 -1
  5. package/dist/destinations/facebook-conversions-api/addToCart2/index.js +86 -4
  6. package/dist/destinations/facebook-conversions-api/addToCart2/index.js.map +1 -1
  7. package/dist/destinations/facebook-conversions-api/constants.d.ts +0 -11
  8. package/dist/destinations/facebook-conversions-api/constants.js +1 -12
  9. package/dist/destinations/facebook-conversions-api/constants.js.map +1 -1
  10. package/dist/destinations/facebook-conversions-api/custom/generated-types.d.ts +0 -9
  11. package/dist/destinations/facebook-conversions-api/custom/index.js +53 -5
  12. package/dist/destinations/facebook-conversions-api/custom/index.js.map +1 -1
  13. package/dist/destinations/facebook-conversions-api/custom2/generated-types.d.ts +0 -9
  14. package/dist/destinations/facebook-conversions-api/custom2/index.js +52 -5
  15. package/dist/destinations/facebook-conversions-api/custom2/index.js.map +1 -1
  16. package/dist/destinations/facebook-conversions-api/fb-capi-app-data.d.ts +11 -0
  17. package/dist/destinations/facebook-conversions-api/fb-capi-app-data.js +188 -0
  18. package/dist/destinations/facebook-conversions-api/fb-capi-app-data.js.map +1 -0
  19. package/dist/destinations/facebook-conversions-api/{fields.d.ts → fb-capi-properties.d.ts} +10 -14
  20. package/dist/destinations/facebook-conversions-api/fb-capi-properties.js +185 -0
  21. package/dist/destinations/facebook-conversions-api/fb-capi-properties.js.map +1 -0
  22. package/dist/destinations/facebook-conversions-api/fb-capi-user-data.d.ts +7 -0
  23. package/dist/destinations/facebook-conversions-api/fb-capi-user-data.js +272 -0
  24. package/dist/destinations/facebook-conversions-api/fb-capi-user-data.js.map +1 -0
  25. package/dist/destinations/facebook-conversions-api/initiateCheckout/generated-types.d.ts +0 -1
  26. package/dist/destinations/facebook-conversions-api/initiateCheckout/index.js +90 -4
  27. package/dist/destinations/facebook-conversions-api/initiateCheckout/index.js.map +1 -1
  28. package/dist/destinations/facebook-conversions-api/initiateCheckout2/generated-types.d.ts +0 -1
  29. package/dist/destinations/facebook-conversions-api/initiateCheckout2/index.js +89 -4
  30. package/dist/destinations/facebook-conversions-api/initiateCheckout2/index.js.map +1 -1
  31. package/dist/destinations/facebook-conversions-api/pageView/generated-types.d.ts +0 -1
  32. package/dist/destinations/facebook-conversions-api/pageView/index.js +46 -5
  33. package/dist/destinations/facebook-conversions-api/pageView/index.js.map +1 -1
  34. package/dist/destinations/facebook-conversions-api/pageView2/generated-types.d.ts +0 -1
  35. package/dist/destinations/facebook-conversions-api/pageView2/index.js +45 -5
  36. package/dist/destinations/facebook-conversions-api/pageView2/index.js.map +1 -1
  37. package/dist/destinations/facebook-conversions-api/purchase/generated-types.d.ts +0 -11
  38. package/dist/destinations/facebook-conversions-api/purchase/index.js +95 -4
  39. package/dist/destinations/facebook-conversions-api/purchase/index.js.map +1 -1
  40. package/dist/destinations/facebook-conversions-api/purchase2/fields.d.ts +2 -0
  41. package/dist/destinations/facebook-conversions-api/purchase2/fields.js +50 -0
  42. package/dist/destinations/facebook-conversions-api/purchase2/fields.js.map +1 -0
  43. package/dist/destinations/facebook-conversions-api/purchase2/functions.d.ts +4 -0
  44. package/dist/destinations/facebook-conversions-api/purchase2/functions.js +59 -0
  45. package/dist/destinations/facebook-conversions-api/purchase2/functions.js.map +1 -0
  46. package/dist/destinations/facebook-conversions-api/purchase2/generated-types.d.ts +0 -11
  47. package/dist/destinations/facebook-conversions-api/purchase2/index.js +4 -5
  48. package/dist/destinations/facebook-conversions-api/purchase2/index.js.map +1 -1
  49. package/dist/destinations/facebook-conversions-api/search/generated-types.d.ts +0 -1
  50. package/dist/destinations/facebook-conversions-api/search/index.js +94 -4
  51. package/dist/destinations/facebook-conversions-api/search/index.js.map +1 -1
  52. package/dist/destinations/facebook-conversions-api/search2/generated-types.d.ts +0 -1
  53. package/dist/destinations/facebook-conversions-api/search2/index.js +93 -4
  54. package/dist/destinations/facebook-conversions-api/search2/index.js.map +1 -1
  55. package/dist/destinations/facebook-conversions-api/utils.d.ts +3 -0
  56. package/dist/destinations/facebook-conversions-api/utils.js +19 -0
  57. package/dist/destinations/facebook-conversions-api/utils.js.map +1 -0
  58. package/dist/destinations/facebook-conversions-api/viewContent/generated-types.d.ts +0 -1
  59. package/dist/destinations/facebook-conversions-api/viewContent/index.js +89 -4
  60. package/dist/destinations/facebook-conversions-api/viewContent/index.js.map +1 -1
  61. package/dist/destinations/facebook-conversions-api/viewContent2/generated-types.d.ts +0 -1
  62. package/dist/destinations/facebook-conversions-api/viewContent2/index.js +88 -4
  63. package/dist/destinations/facebook-conversions-api/viewContent2/index.js.map +1 -1
  64. package/package.json +2 -2
  65. package/dist/destinations/facebook-conversions-api/fields.js +0 -842
  66. package/dist/destinations/facebook-conversions-api/fields.js.map +0 -1
  67. package/dist/destinations/facebook-conversions-api/functions.d.ts +0 -37
  68. package/dist/destinations/facebook-conversions-api/functions.js +0 -425
  69. package/dist/destinations/facebook-conversions-api/functions.js.map +0 -1
  70. package/dist/destinations/facebook-conversions-api/types.d.ts +0 -182
  71. package/dist/destinations/facebook-conversions-api/types.js +0 -3
  72. package/dist/destinations/facebook-conversions-api/types.js.map +0 -1
@@ -1,9 +1,10 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  const actions_core_1 = require("@segment/actions-core");
4
- const functions_1 = require("../functions");
5
- const fields_1 = require("../fields");
6
- const constants_1 = require("../constants");
4
+ const fb_capi_properties_1 = require("../fb-capi-properties");
5
+ const fb_capi_user_data_1 = require("../fb-capi-user-data");
6
+ const utils_1 = require("../utils");
7
+ const fb_capi_app_data_1 = require("../fb-capi-app-data");
7
8
  const action = {
8
9
  title: 'Page View V2',
9
10
  description: 'Send a page view event when a user lands on a page',
@@ -14,10 +15,49 @@ const action = {
14
15
  default: 'add',
15
16
  choices: [{ label: 'Insert Records', value: 'add' }]
16
17
  },
17
- fields: fields_1.pageFields,
18
+ fields: {
19
+ action_source: { ...fb_capi_properties_1.action_source, required: true },
20
+ event_time: { ...fb_capi_properties_1.event_time, required: true },
21
+ user_data: fb_capi_user_data_1.user_data_field,
22
+ app_data_field: fb_capi_app_data_1.app_data_field,
23
+ event_id: fb_capi_properties_1.event_id,
24
+ event_source_url: fb_capi_properties_1.event_source_url,
25
+ custom_data: fb_capi_properties_1.custom_data,
26
+ data_processing_options: fb_capi_properties_1.data_processing_options,
27
+ data_processing_options_country: fb_capi_properties_1.data_processing_options_country,
28
+ data_processing_options_state: fb_capi_properties_1.data_processing_options_state,
29
+ test_event_code: fb_capi_properties_1.test_event_code
30
+ },
18
31
  perform: (request, { payload, settings, features, statsContext, syncMode }) => {
19
32
  if (syncMode === 'add') {
20
- return (0, functions_1.send)(request, payload, settings, constants_1.EventType.PageView, features, statsContext);
33
+ if (!payload.user_data) {
34
+ throw new actions_core_1.IntegrationError('Must include at least one user data property', 'Misconfigured required field', 400);
35
+ }
36
+ if (payload.action_source === 'website' && payload.user_data.client_user_agent === undefined) {
37
+ throw new actions_core_1.IntegrationError('If action source is "Website" then client_user_agent must be defined', 'Misconfigured required field', 400);
38
+ }
39
+ const [data_options, country_code, state_code] = (0, fb_capi_properties_1.dataProcessingOptions)(payload.data_processing_options, payload.data_processing_options_country, payload.data_processing_options_state);
40
+ const testEventCode = payload.test_event_code || settings.testEventCode;
41
+ return request(`https://graph.facebook.com/v${(0, utils_1.get_api_version)(features, statsContext)}/${settings.pixelId}/events`, {
42
+ method: 'POST',
43
+ json: {
44
+ data: [
45
+ {
46
+ event_name: 'PageView',
47
+ event_time: payload.event_time,
48
+ action_source: payload.action_source,
49
+ event_source_url: payload.event_source_url,
50
+ event_id: payload.event_id,
51
+ user_data: (0, fb_capi_user_data_1.hash_user_data)({ user_data: payload.user_data }),
52
+ app_data: (0, fb_capi_app_data_1.generate_app_data)(payload.app_data_field),
53
+ data_processing_options: data_options,
54
+ data_processing_options_country: country_code,
55
+ data_processing_options_state: state_code
56
+ }
57
+ ],
58
+ ...(testEventCode && { test_event_code: testEventCode })
59
+ }
60
+ });
21
61
  }
22
62
  else {
23
63
  throw new actions_core_1.IntegrationError(`Sync mode ${syncMode} is not supported`, 'Misconfigured sync mode', 400);
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/destinations/facebook-conversions-api/pageView2/index.ts"],"names":[],"mappings":";;AAAA,wDAA0E;AAG1E,4CAAmC;AACnC,sCAAsC;AACtC,4CAAwC;AAExC,MAAM,MAAM,GAAwC;IAClD,KAAK,EAAE,cAAc;IACrB,WAAW,EAAE,oDAAoD;IACjE,mBAAmB,EAAE,eAAe;IACpC,QAAQ,EAAE;QACR,WAAW,EAAE,8DAA8D;QAC3E,KAAK,EAAE,qBAAqB;QAC5B,OAAO,EAAE,KAAK;QACd,OAAO,EAAE,CAAC,EAAE,KAAK,EAAE,gBAAgB,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;KACrD;IACD,MAAM,EAAE,mBAAU;IAClB,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,YAAY,EAAE,QAAQ,EAAE,EAAE,EAAE;QAC5E,IAAI,QAAQ,KAAK,KAAK,EAAE,CAAC;YACvB,OAAO,IAAA,gBAAI,EAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,qBAAS,CAAC,QAAQ,EAAE,QAAQ,EAAE,YAAY,CAAC,CAAA;QACrF,CAAC;aACI,CAAC;YACJ,MAAM,IAAI,+BAAgB,CAAC,aAAa,QAAQ,mBAAmB,EAAE,yBAAyB,EAAE,GAAG,CAAC,CAAA;QACtG,CAAC;IACH,CAAC;CACF,CAAA;AAED,kBAAe,MAAM,CAAA"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/destinations/facebook-conversions-api/pageView2/index.ts"],"names":[],"mappings":";;AAAA,wDAA0E;AAC1E,8DAW8B;AAC9B,4DAAsE;AAGtE,oCAA0C;AAC1C,0DAAuE;AAEvE,MAAM,MAAM,GAAwC;IAClD,KAAK,EAAE,cAAc;IACrB,WAAW,EAAE,oDAAoD;IACjE,mBAAmB,EAAE,eAAe;IACpC,QAAQ,EAAE;QACR,WAAW,EAAE,8DAA8D;QAC3E,KAAK,EAAE,qBAAqB;QAC5B,OAAO,EAAE,KAAK;QACd,OAAO,EAAE,CAAC,EAAE,KAAK,EAAE,gBAAgB,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;KACrD;IACD,MAAM,EAAE;QACN,aAAa,EAAE,EAAE,GAAG,kCAAa,EAAE,QAAQ,EAAE,IAAI,EAAE;QACnD,UAAU,EAAE,EAAE,GAAG,+BAAU,EAAE,QAAQ,EAAE,IAAI,EAAE;QAC7C,SAAS,EAAE,mCAAe;QAC1B,cAAc,EAAE,iCAAc;QAC9B,QAAQ,EAAE,6BAAQ;QAClB,gBAAgB,EAAE,qCAAgB;QAClC,WAAW,EAAE,gCAAW;QACxB,uBAAuB,EAAE,4CAAuB;QAChD,+BAA+B,EAAE,oDAA+B;QAChE,6BAA6B,EAAE,kDAA6B;QAC5D,eAAe,EAAE,oCAAe;KACjC;IACD,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,YAAY,EAAE,QAAQ,EAAE,EAAE,EAAE;QAC5E,IAAI,QAAQ,KAAK,KAAK,EAAE,CAAC;YACvB,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC;gBACvB,MAAM,IAAI,+BAAgB,CAAC,8CAA8C,EAAE,8BAA8B,EAAE,GAAG,CAAC,CAAA;YACjH,CAAC;YAED,IAAI,OAAO,CAAC,aAAa,KAAK,SAAS,IAAI,OAAO,CAAC,SAAS,CAAC,iBAAiB,KAAK,SAAS,EAAE,CAAC;gBAC7F,MAAM,IAAI,+BAAgB,CACxB,sEAAsE,EACtE,8BAA8B,EAC9B,GAAG,CACJ,CAAA;YACH,CAAC;YAED,MAAM,CAAC,YAAY,EAAE,YAAY,EAAE,UAAU,CAAC,GAAG,IAAA,0CAAqB,EACpE,OAAO,CAAC,uBAAuB,EAC/B,OAAO,CAAC,+BAA+B,EACvC,OAAO,CAAC,6BAA6B,CACtC,CAAA;YAED,MAAM,aAAa,GAAG,OAAO,CAAC,eAAe,IAAI,QAAQ,CAAC,aAAa,CAAA;YAEvE,OAAO,OAAO,CACZ,+BAA+B,IAAA,uBAAe,EAAC,QAAQ,EAAE,YAAY,CAAC,IAAI,QAAQ,CAAC,OAAO,SAAS,EACnG;gBACE,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE;oBACJ,IAAI,EAAE;wBACJ;4BACE,UAAU,EAAE,UAAU;4BACtB,UAAU,EAAE,OAAO,CAAC,UAAU;4BAC9B,aAAa,EAAE,OAAO,CAAC,aAAa;4BACpC,gBAAgB,EAAE,OAAO,CAAC,gBAAgB;4BAC1C,QAAQ,EAAE,OAAO,CAAC,QAAQ;4BAC1B,SAAS,EAAE,IAAA,kCAAc,EAAC,EAAE,SAAS,EAAE,OAAO,CAAC,SAAS,EAAE,CAAC;4BAC3D,QAAQ,EAAE,IAAA,oCAAiB,EAAC,OAAO,CAAC,cAAc,CAAC;4BACnD,uBAAuB,EAAE,YAAY;4BACrC,+BAA+B,EAAE,YAAY;4BAC7C,6BAA6B,EAAE,UAAU;yBAC1C;qBACF;oBACD,GAAG,CAAC,aAAa,IAAI,EAAE,eAAe,EAAE,aAAa,EAAE,CAAC;iBACzD;aACF,CACF,CAAA;QACH,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,+BAAgB,CAAC,aAAa,QAAQ,mBAAmB,EAAE,yBAAyB,EAAE,GAAG,CAAC,CAAA;QACtG,CAAC;IACH,CAAC;CACF,CAAA;AAED,kBAAe,MAAM,CAAA"}
@@ -1,12 +1,4 @@
1
1
  export interface Payload {
2
- is_append_event?: boolean;
3
- append_event_details?: {
4
- original_event_time?: string;
5
- original_event_order_id?: string;
6
- original_event_id?: string;
7
- net_revenue_to_append?: number;
8
- predicted_ltv_to_append?: number;
9
- };
10
2
  action_source: string;
11
3
  currency: string;
12
4
  event_time: string;
@@ -33,7 +25,6 @@ export interface Payload {
33
25
  madId?: string;
34
26
  partner_id?: string;
35
27
  partner_name?: string;
36
- ctwa_clid?: string;
37
28
  };
38
29
  app_data_field?: {
39
30
  use_app_data?: boolean;
@@ -59,7 +50,6 @@ export interface Payload {
59
50
  };
60
51
  value: number;
61
52
  net_revenue?: number;
62
- predicted_ltv?: number;
63
53
  content_ids?: string[];
64
54
  content_name?: string;
65
55
  content_type?: string;
@@ -70,7 +60,6 @@ export interface Payload {
70
60
  delivery_category?: string;
71
61
  }[];
72
62
  event_id?: string;
73
- order_id?: string;
74
63
  event_source_url?: string;
75
64
  num_items?: number;
76
65
  custom_data?: {
@@ -1,15 +1,106 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- const fields_1 = require("../fields");
4
- const functions_1 = require("../functions");
3
+ const actions_core_1 = require("@segment/actions-core");
5
4
  const constants_1 = require("../constants");
5
+ const utils_1 = require("../utils");
6
+ const fb_capi_properties_1 = require("../fb-capi-properties");
7
+ const fb_capi_user_data_1 = require("../fb-capi-user-data");
8
+ const fb_capi_app_data_1 = require("../fb-capi-app-data");
6
9
  const action = {
7
10
  title: 'Purchase',
8
11
  description: 'Send event when a user completes a purchase',
9
12
  defaultSubscription: 'type = "track" and event = "Order Completed"',
10
- fields: fields_1.purchaseFields,
13
+ fields: {
14
+ action_source: { ...fb_capi_properties_1.action_source, required: true },
15
+ currency: { ...fb_capi_properties_1.currency, required: true },
16
+ event_time: { ...fb_capi_properties_1.event_time, required: true },
17
+ user_data: fb_capi_user_data_1.user_data_field,
18
+ app_data_field: fb_capi_app_data_1.app_data_field,
19
+ value: {
20
+ ...fb_capi_properties_1.value,
21
+ required: true,
22
+ default: { '@path': '$.properties.revenue' }
23
+ },
24
+ net_revenue: fb_capi_properties_1.net_revenue,
25
+ content_ids: fb_capi_properties_1.content_ids,
26
+ content_name: fb_capi_properties_1.content_name,
27
+ content_type: fb_capi_properties_1.content_type,
28
+ contents: {
29
+ ...fb_capi_properties_1.contents,
30
+ default: {
31
+ '@arrayPath': [
32
+ '$.properties.products',
33
+ {
34
+ id: {
35
+ '@path': '$.product_id'
36
+ },
37
+ quantity: {
38
+ '@path': '$.quantity'
39
+ },
40
+ item_price: {
41
+ '@path': '$.price'
42
+ }
43
+ }
44
+ ]
45
+ }
46
+ },
47
+ event_id: fb_capi_properties_1.event_id,
48
+ event_source_url: fb_capi_properties_1.event_source_url,
49
+ num_items: fb_capi_properties_1.num_items,
50
+ custom_data: fb_capi_properties_1.custom_data,
51
+ data_processing_options: fb_capi_properties_1.data_processing_options,
52
+ data_processing_options_country: fb_capi_properties_1.data_processing_options_country,
53
+ data_processing_options_state: fb_capi_properties_1.data_processing_options_state,
54
+ test_event_code: fb_capi_properties_1.test_event_code
55
+ },
11
56
  perform: (request, { payload, settings, features, statsContext }) => {
12
- return (0, functions_1.send)(request, payload, settings, constants_1.EventType.Purchase, features, statsContext);
57
+ if (!constants_1.CURRENCY_ISO_CODES.has(payload.currency)) {
58
+ throw new actions_core_1.IntegrationError(`${payload.currency} is not a valid currency code.`, actions_core_1.ErrorCodes.INVALID_CURRENCY_CODE, 400);
59
+ }
60
+ if (!payload.user_data) {
61
+ throw new actions_core_1.PayloadValidationError('Must include at least one user data property');
62
+ }
63
+ if (payload.action_source === 'website' && payload.user_data.client_user_agent === undefined) {
64
+ throw new actions_core_1.PayloadValidationError('If action source is "Website" then client_user_agent must be defined');
65
+ }
66
+ if (payload.contents) {
67
+ const err = (0, fb_capi_properties_1.validateContents)(payload.contents);
68
+ if (err)
69
+ throw err;
70
+ }
71
+ const [data_options, country_code, state_code] = (0, fb_capi_properties_1.dataProcessingOptions)(payload.data_processing_options, payload.data_processing_options_country, payload.data_processing_options_state);
72
+ const testEventCode = payload.test_event_code || settings.testEventCode;
73
+ return request(`https://graph.facebook.com/v${(0, utils_1.get_api_version)(features, statsContext)}/${settings.pixelId}/events`, {
74
+ method: 'POST',
75
+ json: {
76
+ data: [
77
+ {
78
+ event_name: 'Purchase',
79
+ event_time: payload.event_time,
80
+ action_source: payload.action_source,
81
+ event_source_url: payload.event_source_url,
82
+ event_id: payload.event_id,
83
+ user_data: (0, fb_capi_user_data_1.hash_user_data)({ user_data: payload.user_data }),
84
+ custom_data: {
85
+ ...payload.custom_data,
86
+ currency: payload.currency,
87
+ value: payload.value,
88
+ net_revenue: payload.net_revenue,
89
+ content_ids: payload.content_ids,
90
+ content_name: payload.content_name,
91
+ content_type: payload.content_type,
92
+ contents: payload.contents,
93
+ num_items: payload.num_items
94
+ },
95
+ app_data: (0, fb_capi_app_data_1.generate_app_data)(payload.app_data_field),
96
+ data_processing_options: data_options,
97
+ data_processing_options_country: country_code,
98
+ data_processing_options_state: state_code
99
+ }
100
+ ],
101
+ ...(testEventCode && { test_event_code: testEventCode })
102
+ }
103
+ });
13
104
  }
14
105
  };
15
106
  exports.default = action;
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/destinations/facebook-conversions-api/purchase/index.ts"],"names":[],"mappings":";;AAGA,sCAA0C;AAC1C,4CAAmC;AACnC,4CAAwC;AAExC,MAAM,MAAM,GAAwC;IAClD,KAAK,EAAE,UAAU;IACjB,WAAW,EAAE,6CAA6C;IAC1D,mBAAmB,EAAE,8CAA8C;IACnE,MAAM,EAAE,uBAAc;IACtB,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,YAAY,EAAE,EAAE,EAAE;QAClE,OAAO,IAAA,gBAAI,EAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,qBAAS,CAAC,QAAQ,EAAE,QAAQ,EAAE,YAAY,CAAC,CAAA;IACrF,CAAC;CACF,CAAA;AAED,kBAAe,MAAM,CAAA"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/destinations/facebook-conversions-api/purchase/index.ts"],"names":[],"mappings":";;AAAA,wDAA8G;AAG9G,4CAAiD;AACjD,oCAA0C;AAC1C,8DAoB8B;AAC9B,4DAAsE;AACtE,0DAAuE;AAEvE,MAAM,MAAM,GAAwC;IAClD,KAAK,EAAE,UAAU;IACjB,WAAW,EAAE,6CAA6C;IAC1D,mBAAmB,EAAE,8CAA8C;IACnE,MAAM,EAAE;QACN,aAAa,EAAE,EAAE,GAAG,kCAAa,EAAE,QAAQ,EAAE,IAAI,EAAE;QACnD,QAAQ,EAAE,EAAE,GAAG,6BAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE;QACzC,UAAU,EAAE,EAAE,GAAG,+BAAU,EAAE,QAAQ,EAAE,IAAI,EAAE;QAC7C,SAAS,EAAE,mCAAe;QAC1B,cAAc,EAAE,iCAAc;QAC9B,KAAK,EAAE;YACL,GAAG,0BAAK;YACR,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,EAAE,OAAO,EAAE,sBAAsB,EAAE;SAC7C;QACD,WAAW,EAAE,gCAAW;QACxB,WAAW,EAAE,gCAAW;QACxB,YAAY,EAAE,iCAAY;QAC1B,YAAY,EAAE,iCAAY;QAC1B,QAAQ,EAAE;YAER,GAAG,6BAAQ;YACX,OAAO,EAAE;gBACP,YAAY,EAAE;oBACZ,uBAAuB;oBACvB;wBACE,EAAE,EAAE;4BACF,OAAO,EAAE,cAAc;yBACxB;wBACD,QAAQ,EAAE;4BACR,OAAO,EAAE,YAAY;yBACtB;wBACD,UAAU,EAAE;4BACV,OAAO,EAAE,SAAS;yBACnB;qBACF;iBACF;aACF;SACF;QACD,QAAQ,EAAE,6BAAQ;QAClB,gBAAgB,EAAE,qCAAgB;QAClC,SAAS,EAAE,8BAAS;QACpB,WAAW,EAAE,gCAAW;QACxB,uBAAuB,EAAE,4CAAuB;QAChD,+BAA+B,EAAE,oDAA+B;QAChE,6BAA6B,EAAE,kDAA6B;QAC5D,eAAe,EAAE,oCAAe;KACjC;IACD,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,YAAY,EAAE,EAAE,EAAE;QAClE,IAAI,CAAC,8BAAkB,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC9C,MAAM,IAAI,+BAAgB,CACxB,GAAG,OAAO,CAAC,QAAQ,gCAAgC,EACnD,yBAAU,CAAC,qBAAqB,EAChC,GAAG,CACJ,CAAA;QACH,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC;YACvB,MAAM,IAAI,qCAAsB,CAAC,8CAA8C,CAAC,CAAA;QAClF,CAAC;QAED,IAAI,OAAO,CAAC,aAAa,KAAK,SAAS,IAAI,OAAO,CAAC,SAAS,CAAC,iBAAiB,KAAK,SAAS,EAAE,CAAC;YAC7F,MAAM,IAAI,qCAAsB,CAAC,sEAAsE,CAAC,CAAA;QAC1G,CAAC;QAED,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;YACrB,MAAM,GAAG,GAAG,IAAA,qCAAgB,EAAC,OAAO,CAAC,QAAQ,CAAC,CAAA;YAC9C,IAAI,GAAG;gBAAE,MAAM,GAAG,CAAA;QACpB,CAAC;QAED,MAAM,CAAC,YAAY,EAAE,YAAY,EAAE,UAAU,CAAC,GAAG,IAAA,0CAAqB,EACpE,OAAO,CAAC,uBAAuB,EAC/B,OAAO,CAAC,+BAA+B,EACvC,OAAO,CAAC,6BAA6B,CACtC,CAAA;QAED,MAAM,aAAa,GAAG,OAAO,CAAC,eAAe,IAAI,QAAQ,CAAC,aAAa,CAAA;QAEvE,OAAO,OAAO,CACZ,+BAA+B,IAAA,uBAAe,EAAC,QAAQ,EAAE,YAAY,CAAC,IAAI,QAAQ,CAAC,OAAO,SAAS,EACnG;YACE,MAAM,EAAE,MAAM;YACd,IAAI,EAAE;gBACJ,IAAI,EAAE;oBACJ;wBACE,UAAU,EAAE,UAAU;wBACtB,UAAU,EAAE,OAAO,CAAC,UAAU;wBAC9B,aAAa,EAAE,OAAO,CAAC,aAAa;wBACpC,gBAAgB,EAAE,OAAO,CAAC,gBAAgB;wBAC1C,QAAQ,EAAE,OAAO,CAAC,QAAQ;wBAC1B,SAAS,EAAE,IAAA,kCAAc,EAAC,EAAE,SAAS,EAAE,OAAO,CAAC,SAAS,EAAE,CAAC;wBAC3D,WAAW,EAAE;4BACX,GAAG,OAAO,CAAC,WAAW;4BACtB,QAAQ,EAAE,OAAO,CAAC,QAAQ;4BAC1B,KAAK,EAAE,OAAO,CAAC,KAAK;4BACpB,WAAW,EAAE,OAAO,CAAC,WAAW;4BAChC,WAAW,EAAE,OAAO,CAAC,WAAW;4BAChC,YAAY,EAAE,OAAO,CAAC,YAAY;4BAClC,YAAY,EAAE,OAAO,CAAC,YAAY;4BAClC,QAAQ,EAAE,OAAO,CAAC,QAAQ;4BAC1B,SAAS,EAAE,OAAO,CAAC,SAAS;yBAC7B;wBACD,QAAQ,EAAE,IAAA,oCAAiB,EAAC,OAAO,CAAC,cAAc,CAAC;wBACnD,uBAAuB,EAAE,YAAY;wBACrC,+BAA+B,EAAE,YAAY;wBAC7C,6BAA6B,EAAE,UAAU;qBAC1C;iBACF;gBACD,GAAG,CAAC,aAAa,IAAI,EAAE,eAAe,EAAE,aAAa,EAAE,CAAC;aACzD;SACF,CACF,CAAA;IACH,CAAC;CACF,CAAA;AAED,kBAAe,MAAM,CAAA"}
@@ -0,0 +1,2 @@
1
+ import { InputField } from '@segment/actions-core';
2
+ export declare const fields: Record<string, InputField>;
@@ -0,0 +1,50 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.fields = void 0;
4
+ const fb_capi_properties_1 = require("../fb-capi-properties");
5
+ const fb_capi_user_data_1 = require("../fb-capi-user-data");
6
+ const fb_capi_app_data_1 = require("../fb-capi-app-data");
7
+ exports.fields = {
8
+ action_source: { ...fb_capi_properties_1.action_source, required: true },
9
+ currency: { ...fb_capi_properties_1.currency, required: true },
10
+ event_time: { ...fb_capi_properties_1.event_time, required: true },
11
+ user_data: fb_capi_user_data_1.user_data_field,
12
+ app_data_field: fb_capi_app_data_1.app_data_field,
13
+ value: {
14
+ ...fb_capi_properties_1.value,
15
+ required: true,
16
+ default: { '@path': '$.properties.revenue' }
17
+ },
18
+ net_revenue: fb_capi_properties_1.net_revenue,
19
+ content_ids: fb_capi_properties_1.content_ids,
20
+ content_name: fb_capi_properties_1.content_name,
21
+ content_type: fb_capi_properties_1.content_type,
22
+ contents: {
23
+ ...fb_capi_properties_1.contents,
24
+ default: {
25
+ '@arrayPath': [
26
+ '$.properties.products',
27
+ {
28
+ id: {
29
+ '@path': '$.product_id'
30
+ },
31
+ quantity: {
32
+ '@path': '$.quantity'
33
+ },
34
+ item_price: {
35
+ '@path': '$.price'
36
+ }
37
+ }
38
+ ]
39
+ }
40
+ },
41
+ event_id: fb_capi_properties_1.event_id,
42
+ event_source_url: fb_capi_properties_1.event_source_url,
43
+ num_items: fb_capi_properties_1.num_items,
44
+ custom_data: fb_capi_properties_1.custom_data,
45
+ data_processing_options: fb_capi_properties_1.data_processing_options,
46
+ data_processing_options_country: fb_capi_properties_1.data_processing_options_country,
47
+ data_processing_options_state: fb_capi_properties_1.data_processing_options_state,
48
+ test_event_code: fb_capi_properties_1.test_event_code
49
+ };
50
+ //# sourceMappingURL=fields.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"fields.js","sourceRoot":"","sources":["../../../../src/destinations/facebook-conversions-api/purchase2/fields.ts"],"names":[],"mappings":";;;AACA,8DAkB8B;AAC9B,4DAAsD;AACtD,0DAAoD;AAEvC,QAAA,MAAM,GAAgC;IAC/C,aAAa,EAAE,EAAE,GAAG,kCAAa,EAAE,QAAQ,EAAE,IAAI,EAAE;IACnD,QAAQ,EAAE,EAAE,GAAG,6BAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE;IACzC,UAAU,EAAE,EAAE,GAAG,+BAAU,EAAE,QAAQ,EAAE,IAAI,EAAE;IAC7C,SAAS,EAAE,mCAAe;IAC1B,cAAc,EAAE,iCAAc;IAC9B,KAAK,EAAE;QACL,GAAG,0BAAK;QACR,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,EAAE,OAAO,EAAE,sBAAsB,EAAE;KAC7C;IACD,WAAW,EAAE,gCAAW;IACxB,WAAW,EAAE,gCAAW;IACxB,YAAY,EAAE,iCAAY;IAC1B,YAAY,EAAE,iCAAY;IAC1B,QAAQ,EAAE;QAER,GAAG,6BAAQ;QACX,OAAO,EAAE;YACP,YAAY,EAAE;gBACZ,uBAAuB;gBACvB;oBACE,EAAE,EAAE;wBACF,OAAO,EAAE,cAAc;qBACxB;oBACD,QAAQ,EAAE;wBACR,OAAO,EAAE,YAAY;qBACtB;oBACD,UAAU,EAAE;wBACV,OAAO,EAAE,SAAS;qBACnB;iBACF;aACF;SACF;KACF;IACD,QAAQ,EAAE,6BAAQ;IAClB,gBAAgB,EAAE,qCAAgB;IAClC,SAAS,EAAE,8BAAS;IACpB,WAAW,EAAE,gCAAW;IACxB,uBAAuB,EAAE,4CAAuB;IAChD,+BAA+B,EAAE,oDAA+B;IAChE,6BAA6B,EAAE,kDAA6B;IAC5D,eAAe,EAAE,oCAAe;CACnC,CAAA"}
@@ -0,0 +1,4 @@
1
+ import { RequestClient, Features, StatsContext } from '@segment/actions-core';
2
+ import type { Settings } from '../generated-types';
3
+ import type { Payload } from './generated-types';
4
+ export declare function send(request: RequestClient, payload: Payload, settings: Settings, features?: Features, statsContext?: StatsContext): Promise<import("@segment/actions-core/src").ModifiedResponse<unknown>>;
@@ -0,0 +1,59 @@
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 constants_1 = require("../constants");
6
+ const utils_1 = require("../utils");
7
+ const fb_capi_properties_1 = require("../fb-capi-properties");
8
+ const fb_capi_user_data_1 = require("../fb-capi-user-data");
9
+ const fb_capi_app_data_1 = require("../fb-capi-app-data");
10
+ function send(request, payload, settings, features, statsContext) {
11
+ if (!constants_1.CURRENCY_ISO_CODES.has(payload.currency)) {
12
+ throw new actions_core_1.IntegrationError(`${payload.currency} is not a valid currency code.`, actions_core_1.ErrorCodes.INVALID_CURRENCY_CODE, 400);
13
+ }
14
+ if (!payload.user_data) {
15
+ throw new actions_core_1.PayloadValidationError('Must include at least one user data property');
16
+ }
17
+ if (payload.action_source === 'website' && payload.user_data.client_user_agent === undefined) {
18
+ throw new actions_core_1.PayloadValidationError('If action source is "Website" then client_user_agent must be defined');
19
+ }
20
+ if (payload.contents) {
21
+ const err = (0, fb_capi_properties_1.validateContents)(payload.contents);
22
+ if (err)
23
+ throw err;
24
+ }
25
+ const [data_options, country_code, state_code] = (0, fb_capi_properties_1.dataProcessingOptions)(payload.data_processing_options, payload.data_processing_options_country, payload.data_processing_options_state);
26
+ const testEventCode = payload.test_event_code || settings.testEventCode;
27
+ return request(`https://graph.facebook.com/v${(0, utils_1.get_api_version)(features, statsContext)}/${settings.pixelId}/events`, {
28
+ method: 'POST',
29
+ json: {
30
+ data: [
31
+ {
32
+ event_name: 'Purchase',
33
+ event_time: payload.event_time,
34
+ action_source: payload.action_source,
35
+ event_source_url: payload.event_source_url,
36
+ event_id: payload.event_id,
37
+ user_data: (0, fb_capi_user_data_1.hash_user_data)({ user_data: payload.user_data }),
38
+ custom_data: {
39
+ ...payload.custom_data,
40
+ currency: payload.currency,
41
+ value: payload.value,
42
+ net_revenue: payload.net_revenue,
43
+ content_ids: payload.content_ids,
44
+ content_name: payload.content_name,
45
+ content_type: payload.content_type,
46
+ contents: payload.contents,
47
+ num_items: payload.num_items
48
+ },
49
+ app_data: (0, fb_capi_app_data_1.generate_app_data)(payload.app_data_field),
50
+ data_processing_options: data_options,
51
+ data_processing_options_country: country_code,
52
+ data_processing_options_state: state_code
53
+ }
54
+ ],
55
+ ...(testEventCode && { test_event_code: testEventCode })
56
+ }
57
+ });
58
+ }
59
+ //# sourceMappingURL=functions.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"functions.js","sourceRoot":"","sources":["../../../../src/destinations/facebook-conversions-api/purchase2/functions.ts"],"names":[],"mappings":";;AASA,oBAgEC;AAzED,wDAAoI;AAGpI,4CAAiD;AACjD,oCAA0C;AAC1C,8DAA+E;AAC/E,4DAAqD;AACrD,0DAAuD;AAEvD,SAAgB,IAAI,CAAC,OAAsB,EAAE,OAAgB,EAAE,QAAkB,EAAE,QAAmB,EAAE,YAA2B;IAC/H,IAAI,CAAC,8BAAkB,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC5C,MAAM,IAAI,+BAAgB,CACtB,GAAG,OAAO,CAAC,QAAQ,gCAAgC,EACnD,yBAAU,CAAC,qBAAqB,EAChC,GAAG,CACN,CAAA;IACL,CAAC;IAED,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC;QACrB,MAAM,IAAI,qCAAsB,CAAC,8CAA8C,CAAC,CAAA;IACpF,CAAC;IAED,IAAI,OAAO,CAAC,aAAa,KAAK,SAAS,IAAI,OAAO,CAAC,SAAS,CAAC,iBAAiB,KAAK,SAAS,EAAE,CAAC;QAC3F,MAAM,IAAI,qCAAsB,CAAC,sEAAsE,CAAC,CAAA;IAC5G,CAAC;IAED,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;QACnB,MAAM,GAAG,GAAG,IAAA,qCAAgB,EAAC,OAAO,CAAC,QAAQ,CAAC,CAAA;QAC9C,IAAI,GAAG;YAAE,MAAM,GAAG,CAAA;IACtB,CAAC;IAED,MAAM,CAAC,YAAY,EAAE,YAAY,EAAE,UAAU,CAAC,GAAG,IAAA,0CAAqB,EAClE,OAAO,CAAC,uBAAuB,EAC/B,OAAO,CAAC,+BAA+B,EACvC,OAAO,CAAC,6BAA6B,CACxC,CAAA;IAED,MAAM,aAAa,GAAG,OAAO,CAAC,eAAe,IAAI,QAAQ,CAAC,aAAa,CAAA;IAEvE,OAAO,OAAO,CACV,+BAA+B,IAAA,uBAAe,EAAC,QAAQ,EAAE,YAAY,CAAC,IAAI,QAAQ,CAAC,OAAO,SAAS,EACnG;QACI,MAAM,EAAE,MAAM;QACd,IAAI,EAAE;YACN,IAAI,EAAE;gBACF;oBACA,UAAU,EAAE,UAAU;oBACtB,UAAU,EAAE,OAAO,CAAC,UAAU;oBAC9B,aAAa,EAAE,OAAO,CAAC,aAAa;oBACpC,gBAAgB,EAAE,OAAO,CAAC,gBAAgB;oBAC1C,QAAQ,EAAE,OAAO,CAAC,QAAQ;oBAC1B,SAAS,EAAE,IAAA,kCAAc,EAAC,EAAE,SAAS,EAAE,OAAO,CAAC,SAAS,EAAE,CAAC;oBAC3D,WAAW,EAAE;wBACT,GAAG,OAAO,CAAC,WAAW;wBACtB,QAAQ,EAAE,OAAO,CAAC,QAAQ;wBAC1B,KAAK,EAAE,OAAO,CAAC,KAAK;wBACpB,WAAW,EAAE,OAAO,CAAC,WAAW;wBAChC,WAAW,EAAE,OAAO,CAAC,WAAW;wBAChC,YAAY,EAAE,OAAO,CAAC,YAAY;wBAClC,YAAY,EAAE,OAAO,CAAC,YAAY;wBAClC,QAAQ,EAAE,OAAO,CAAC,QAAQ;wBAC1B,SAAS,EAAE,OAAO,CAAC,SAAS;qBAC/B;oBACD,QAAQ,EAAE,IAAA,oCAAiB,EAAC,OAAO,CAAC,cAAc,CAAC;oBACnD,uBAAuB,EAAE,YAAY;oBACrC,+BAA+B,EAAE,YAAY;oBAC7C,6BAA6B,EAAE,UAAU;iBACxC;aACJ;YACD,GAAG,CAAC,aAAa,IAAI,EAAE,eAAe,EAAE,aAAa,EAAE,CAAC;SACvD;KACJ,CACJ,CAAA;AACL,CAAC"}
@@ -1,12 +1,4 @@
1
1
  export interface Payload {
2
- is_append_event?: boolean;
3
- append_event_details?: {
4
- original_event_time?: string;
5
- original_event_order_id?: string;
6
- original_event_id?: string;
7
- net_revenue_to_append?: number;
8
- predicted_ltv_to_append?: number;
9
- };
10
2
  action_source: string;
11
3
  currency: string;
12
4
  event_time: string;
@@ -33,7 +25,6 @@ export interface Payload {
33
25
  madId?: string;
34
26
  partner_id?: string;
35
27
  partner_name?: string;
36
- ctwa_clid?: string;
37
28
  };
38
29
  app_data_field?: {
39
30
  use_app_data?: boolean;
@@ -59,7 +50,6 @@ export interface Payload {
59
50
  };
60
51
  value: number;
61
52
  net_revenue?: number;
62
- predicted_ltv?: number;
63
53
  content_ids?: string[];
64
54
  content_name?: string;
65
55
  content_type?: string;
@@ -70,7 +60,6 @@ export interface Payload {
70
60
  delivery_category?: string;
71
61
  }[];
72
62
  event_id?: string;
73
- order_id?: string;
74
63
  event_source_url?: string;
75
64
  num_items?: number;
76
65
  custom_data?: {
@@ -1,9 +1,8 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  const actions_core_1 = require("@segment/actions-core");
4
- const fields_1 = require("../fields");
5
- const functions_1 = require("../functions");
6
- const constants_1 = require("../constants");
4
+ const fields_1 = require("./fields");
5
+ const functions_1 = require("./functions");
7
6
  const action = {
8
7
  title: 'Purchase V2',
9
8
  description: 'Send event when a user completes a purchase',
@@ -14,10 +13,10 @@ const action = {
14
13
  default: 'add',
15
14
  choices: [{ label: 'Insert Records', value: 'add' }]
16
15
  },
17
- fields: fields_1.purchaseFields,
16
+ fields: fields_1.fields,
18
17
  perform: (request, { payload, settings, features, statsContext, syncMode }) => {
19
18
  if (syncMode === 'add') {
20
- return (0, functions_1.send)(request, payload, settings, constants_1.EventType.Purchase, features, statsContext);
19
+ return (0, functions_1.send)(request, payload, settings, features, statsContext);
21
20
  }
22
21
  else {
23
22
  throw new actions_core_1.IntegrationError(`Sync mode ${syncMode} is not supported`, 'Misconfigured sync mode', 400);
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/destinations/facebook-conversions-api/purchase2/index.ts"],"names":[],"mappings":";;AAAA,wDAA0E;AAG1E,sCAA0C;AAC1C,4CAAmC;AACnC,4CAAwC;AAExC,MAAM,MAAM,GAAwC;IAClD,KAAK,EAAE,aAAa;IACpB,WAAW,EAAE,6CAA6C;IAC1D,mBAAmB,EAAE,8CAA8C;IACnE,QAAQ,EAAE;QACR,WAAW,EAAE,8DAA8D;QAC3E,KAAK,EAAE,qBAAqB;QAC5B,OAAO,EAAE,KAAK;QACd,OAAO,EAAE,CAAC,EAAE,KAAK,EAAE,gBAAgB,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;KACrD;IACD,MAAM,EAAE,uBAAc;IACtB,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,YAAY,EAAE,QAAQ,EAAE,EAAE,EAAE;QAC5E,IAAI,QAAQ,KAAK,KAAK,EAAE,CAAC;YACvB,OAAO,IAAA,gBAAI,EAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,qBAAS,CAAC,QAAQ,EAAE,QAAQ,EAAE,YAAY,CAAC,CAAA;QACrF,CAAC;aACI,CAAC;YACJ,MAAM,IAAI,+BAAgB,CAAC,aAAa,QAAQ,mBAAmB,EAAE,yBAAyB,EAAE,GAAG,CAAC,CAAA;QACtG,CAAC;IACH,CAAC;CACF,CAAA;AAED,kBAAe,MAAM,CAAA"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/destinations/facebook-conversions-api/purchase2/index.ts"],"names":[],"mappings":";;AAAA,wDAA0E;AAG1E,qCAAiC;AACjC,2CAAkC;AAElC,MAAM,MAAM,GAAwC;IAClD,KAAK,EAAE,aAAa;IACpB,WAAW,EAAE,6CAA6C;IAC1D,mBAAmB,EAAE,8CAA8C;IACnE,QAAQ,EAAE;QACR,WAAW,EAAE,8DAA8D;QAC3E,KAAK,EAAE,qBAAqB;QAC5B,OAAO,EAAE,KAAK;QACd,OAAO,EAAE,CAAC,EAAE,KAAK,EAAE,gBAAgB,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;KACrD;IACD,MAAM,EAAN,eAAM;IACN,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,YAAY,EAAE,QAAQ,EAAE,EAAE,EAAE;QAC5E,IAAI,QAAQ,KAAK,KAAK,EAAE,CAAC;YACvB,OAAO,IAAA,gBAAI,EAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,YAAY,CAAC,CAAA;QACjE,CAAC;aACI,CAAC;YACJ,MAAM,IAAI,+BAAgB,CAAC,aAAa,QAAQ,mBAAmB,EAAE,yBAAyB,EAAE,GAAG,CAAC,CAAA;QACtG,CAAC;IACH,CAAC;CACF,CAAA;AAED,kBAAe,MAAM,CAAA"}
@@ -24,7 +24,6 @@ export interface Payload {
24
24
  madId?: string;
25
25
  partner_id?: string;
26
26
  partner_name?: string;
27
- ctwa_clid?: string;
28
27
  };
29
28
  app_data_field?: {
30
29
  use_app_data?: boolean;
@@ -1,15 +1,105 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- const fields_1 = require("../fields");
4
- const functions_1 = require("../functions");
3
+ const actions_core_1 = require("@segment/actions-core");
5
4
  const constants_1 = require("../constants");
5
+ const utils_1 = require("../utils");
6
+ const fb_capi_properties_1 = require("../fb-capi-properties");
7
+ const fb_capi_user_data_1 = require("../fb-capi-user-data");
8
+ const fb_capi_app_data_1 = require("../fb-capi-app-data");
6
9
  const action = {
7
10
  title: 'Search',
8
11
  description: 'Send event when a user searches content or products',
9
12
  defaultSubscription: 'type = "track" and event = "Products Searched"',
10
- fields: fields_1.searchFields,
13
+ fields: {
14
+ action_source: { ...fb_capi_properties_1.action_source, required: true },
15
+ event_time: { ...fb_capi_properties_1.event_time, required: true },
16
+ user_data: fb_capi_user_data_1.user_data_field,
17
+ app_data_field: fb_capi_app_data_1.app_data_field,
18
+ content_category: fb_capi_properties_1.content_category,
19
+ content_ids: fb_capi_properties_1.content_ids,
20
+ contents: {
21
+ ...fb_capi_properties_1.contents,
22
+ default: {
23
+ '@arrayPath': [
24
+ '$.properties',
25
+ {
26
+ id: {
27
+ '@path': '$.product_id'
28
+ },
29
+ quantity: {
30
+ '@path': '$.quantity'
31
+ },
32
+ item_price: {
33
+ '@path': '$.price'
34
+ }
35
+ }
36
+ ]
37
+ }
38
+ },
39
+ currency: fb_capi_properties_1.currency,
40
+ event_id: fb_capi_properties_1.event_id,
41
+ event_source_url: fb_capi_properties_1.event_source_url,
42
+ search_string: {
43
+ label: 'Search String',
44
+ description: 'A search query made by a user. This must be a string.',
45
+ type: 'string',
46
+ default: {
47
+ '@path': '$.properties.query'
48
+ }
49
+ },
50
+ value: fb_capi_properties_1.value,
51
+ custom_data: fb_capi_properties_1.custom_data,
52
+ data_processing_options: fb_capi_properties_1.data_processing_options,
53
+ data_processing_options_country: fb_capi_properties_1.data_processing_options_country,
54
+ data_processing_options_state: fb_capi_properties_1.data_processing_options_state,
55
+ test_event_code: fb_capi_properties_1.test_event_code
56
+ },
11
57
  perform: (request, { payload, settings, features, statsContext }) => {
12
- return (0, functions_1.send)(request, payload, settings, constants_1.EventType.Search, features, statsContext);
58
+ if (payload.currency && !constants_1.CURRENCY_ISO_CODES.has(payload.currency)) {
59
+ throw new actions_core_1.IntegrationError(`${payload.currency} is not a valid currency code.`, 'Misconfigured required field', 400);
60
+ }
61
+ if (!payload.user_data) {
62
+ throw new actions_core_1.IntegrationError('Must include at least one user data property', 'Misconfigured required field', 400);
63
+ }
64
+ if (payload.action_source === 'website' && payload.user_data.client_user_agent === undefined) {
65
+ throw new actions_core_1.IntegrationError('If action source is "Website" then client_user_agent must be defined', 'Misconfigured required field', 400);
66
+ }
67
+ if (payload.contents) {
68
+ const err = (0, fb_capi_properties_1.validateContents)(payload.contents);
69
+ if (err)
70
+ throw err;
71
+ }
72
+ const [data_options, country_code, state_code] = (0, fb_capi_properties_1.dataProcessingOptions)(payload.data_processing_options, payload.data_processing_options_country, payload.data_processing_options_state);
73
+ const testEventCode = payload.test_event_code || settings.testEventCode;
74
+ return request(`https://graph.facebook.com/v${(0, utils_1.get_api_version)(features, statsContext)}/${settings.pixelId}/events`, {
75
+ method: 'POST',
76
+ json: {
77
+ data: [
78
+ {
79
+ event_name: 'Search',
80
+ event_time: payload.event_time,
81
+ action_source: payload.action_source,
82
+ event_id: payload.event_id,
83
+ event_source_url: payload.event_source_url,
84
+ user_data: (0, fb_capi_user_data_1.hash_user_data)({ user_data: payload.user_data }),
85
+ custom_data: {
86
+ ...payload.custom_data,
87
+ currency: payload.currency,
88
+ content_ids: payload.content_ids,
89
+ contents: payload.contents,
90
+ content_category: payload.content_category,
91
+ value: payload.value,
92
+ search_string: payload.search_string
93
+ },
94
+ app_data: (0, fb_capi_app_data_1.generate_app_data)(payload.app_data_field),
95
+ data_processing_options: data_options,
96
+ data_processing_options_country: country_code,
97
+ data_processing_options_state: state_code
98
+ }
99
+ ],
100
+ ...(testEventCode && { test_event_code: testEventCode })
101
+ }
102
+ });
13
103
  }
14
104
  };
15
105
  exports.default = action;
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/destinations/facebook-conversions-api/search/index.ts"],"names":[],"mappings":";;AAGA,sCAAwC;AACxC,4CAAmC;AACnC,4CAAwC;AAExC,MAAM,MAAM,GAAwC;IAClD,KAAK,EAAE,QAAQ;IACf,WAAW,EAAE,qDAAqD;IAClE,mBAAmB,EAAE,gDAAgD;IACrE,MAAM,EAAE,qBAAY;IACpB,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,YAAY,EAAE,EAAE,EAAE;QAClE,OAAO,IAAA,gBAAI,EAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,qBAAS,CAAC,MAAM,EAAE,QAAQ,EAAE,YAAY,CAAC,CAAA;IACnF,CAAC;CACF,CAAA;AAED,kBAAe,MAAM,CAAA"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/destinations/facebook-conversions-api/search/index.ts"],"names":[],"mappings":";;AAAA,wDAA0E;AAG1E,4CAAiD;AACjD,oCAA0C;AAC1C,8DAiB8B;AAC9B,4DAAsE;AACtE,0DAAuE;AAEvE,MAAM,MAAM,GAAwC;IAClD,KAAK,EAAE,QAAQ;IACf,WAAW,EAAE,qDAAqD;IAClE,mBAAmB,EAAE,gDAAgD;IACrE,MAAM,EAAE;QACN,aAAa,EAAE,EAAE,GAAG,kCAAa,EAAE,QAAQ,EAAE,IAAI,EAAE;QACnD,UAAU,EAAE,EAAE,GAAG,+BAAU,EAAE,QAAQ,EAAE,IAAI,EAAE;QAC7C,SAAS,EAAE,mCAAe;QAC1B,cAAc,EAAE,iCAAc;QAC9B,gBAAgB,EAAE,qCAAgB;QAClC,WAAW,EAAE,gCAAW;QACxB,QAAQ,EAAE;YACR,GAAG,6BAAQ;YACX,OAAO,EAAE;gBAEP,YAAY,EAAE;oBACZ,cAAc;oBACd;wBACE,EAAE,EAAE;4BACF,OAAO,EAAE,cAAc;yBACxB;wBACD,QAAQ,EAAE;4BACR,OAAO,EAAE,YAAY;yBACtB;wBACD,UAAU,EAAE;4BACV,OAAO,EAAE,SAAS;yBACnB;qBACF;iBACF;aACF;SACF;QACD,QAAQ,EAAE,6BAAQ;QAClB,QAAQ,EAAE,6BAAQ;QAClB,gBAAgB,EAAE,qCAAgB;QAClC,aAAa,EAAE;YACb,KAAK,EAAE,eAAe;YACtB,WAAW,EAAE,uDAAuD;YACpE,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE;gBACP,OAAO,EAAE,oBAAoB;aAC9B;SACF;QACD,KAAK,EAAE,0BAAK;QACZ,WAAW,EAAE,gCAAW;QACxB,uBAAuB,EAAE,4CAAuB;QAChD,+BAA+B,EAAE,oDAA+B;QAChE,6BAA6B,EAAE,kDAA6B;QAC5D,eAAe,EAAE,oCAAe;KACjC;IACD,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,YAAY,EAAE,EAAE,EAAE;QAClE,IAAI,OAAO,CAAC,QAAQ,IAAI,CAAC,8BAAkB,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;YAClE,MAAM,IAAI,+BAAgB,CACxB,GAAG,OAAO,CAAC,QAAQ,gCAAgC,EACnD,8BAA8B,EAC9B,GAAG,CACJ,CAAA;QACH,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC;YACvB,MAAM,IAAI,+BAAgB,CAAC,8CAA8C,EAAE,8BAA8B,EAAE,GAAG,CAAC,CAAA;QACjH,CAAC;QAED,IAAI,OAAO,CAAC,aAAa,KAAK,SAAS,IAAI,OAAO,CAAC,SAAS,CAAC,iBAAiB,KAAK,SAAS,EAAE,CAAC;YAC7F,MAAM,IAAI,+BAAgB,CACxB,sEAAsE,EACtE,8BAA8B,EAC9B,GAAG,CACJ,CAAA;QACH,CAAC;QAED,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;YACrB,MAAM,GAAG,GAAG,IAAA,qCAAgB,EAAC,OAAO,CAAC,QAAQ,CAAC,CAAA;YAC9C,IAAI,GAAG;gBAAE,MAAM,GAAG,CAAA;QACpB,CAAC;QAED,MAAM,CAAC,YAAY,EAAE,YAAY,EAAE,UAAU,CAAC,GAAG,IAAA,0CAAqB,EACpE,OAAO,CAAC,uBAAuB,EAC/B,OAAO,CAAC,+BAA+B,EACvC,OAAO,CAAC,6BAA6B,CACtC,CAAA;QAED,MAAM,aAAa,GAAG,OAAO,CAAC,eAAe,IAAI,QAAQ,CAAC,aAAa,CAAA;QAEvE,OAAO,OAAO,CACZ,+BAA+B,IAAA,uBAAe,EAAC,QAAQ,EAAE,YAAY,CAAC,IAAI,QAAQ,CAAC,OAAO,SAAS,EACnG;YACE,MAAM,EAAE,MAAM;YACd,IAAI,EAAE;gBACJ,IAAI,EAAE;oBACJ;wBACE,UAAU,EAAE,QAAQ;wBACpB,UAAU,EAAE,OAAO,CAAC,UAAU;wBAC9B,aAAa,EAAE,OAAO,CAAC,aAAa;wBACpC,QAAQ,EAAE,OAAO,CAAC,QAAQ;wBAC1B,gBAAgB,EAAE,OAAO,CAAC,gBAAgB;wBAC1C,SAAS,EAAE,IAAA,kCAAc,EAAC,EAAE,SAAS,EAAE,OAAO,CAAC,SAAS,EAAE,CAAC;wBAC3D,WAAW,EAAE;4BACX,GAAG,OAAO,CAAC,WAAW;4BACtB,QAAQ,EAAE,OAAO,CAAC,QAAQ;4BAC1B,WAAW,EAAE,OAAO,CAAC,WAAW;4BAChC,QAAQ,EAAE,OAAO,CAAC,QAAQ;4BAC1B,gBAAgB,EAAE,OAAO,CAAC,gBAAgB;4BAC1C,KAAK,EAAE,OAAO,CAAC,KAAK;4BACpB,aAAa,EAAE,OAAO,CAAC,aAAa;yBACrC;wBACD,QAAQ,EAAE,IAAA,oCAAiB,EAAC,OAAO,CAAC,cAAc,CAAC;wBACnD,uBAAuB,EAAE,YAAY;wBACrC,+BAA+B,EAAE,YAAY;wBAC7C,6BAA6B,EAAE,UAAU;qBAC1C;iBACF;gBACD,GAAG,CAAC,aAAa,IAAI,EAAE,eAAe,EAAE,aAAa,EAAE,CAAC;aACzD;SACF,CACF,CAAA;IACH,CAAC;CACF,CAAA;AAED,kBAAe,MAAM,CAAA"}
@@ -24,7 +24,6 @@ export interface Payload {
24
24
  madId?: string;
25
25
  partner_id?: string;
26
26
  partner_name?: string;
27
- ctwa_clid?: string;
28
27
  };
29
28
  app_data_field?: {
30
29
  use_app_data?: boolean;