@walkeros/web-destination-meta 0.4.2 → 0.5.1-next.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.
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  <p align="left">
2
- <a href="https://elbwalker.com">
3
- <img title="elbwalker" src="https://www.elbwalker.com/img/elbwalker_logo.png" width="256px"/>
2
+ <a href="https://www.walkeros.io">
3
+ <img title="elbwalker" src="https://www.walkeros.io/img/elbwalker_logo.png" width="256px"/>
4
4
  </a>
5
5
  </p>
6
6
 
@@ -25,21 +25,46 @@ events, and audience building data to optimize your Meta advertising campaigns.
25
25
  npm install @walkeros/web-destination-meta
26
26
  ```
27
27
 
28
- ## Usage
28
+ ## Quick Start
29
+
30
+ Configure in your Flow JSON:
31
+
32
+ ```json
33
+ {
34
+ "version": 1,
35
+ "flows": {
36
+ "default": {
37
+ "web": {},
38
+ "destinations": {
39
+ "meta": {
40
+ "package": "@walkeros/web-destination-meta",
41
+ "config": {
42
+ "settings": { "pixelId": "1234567890" },
43
+ "loadScript": true
44
+ }
45
+ }
46
+ }
47
+ }
48
+ }
49
+ }
50
+ ```
29
51
 
30
- Here's a basic example of how to use the Meta Pixel destination:
52
+ Or programmatically:
31
53
 
32
54
  ```typescript
33
55
  import { startFlow } from '@walkeros/collector';
34
56
  import { destinationMeta } from '@walkeros/web-destination-meta';
35
57
 
36
- const { elb } = await startFlow();
37
-
38
- elb('walker destination', destinationMeta, {
39
- settings: {
40
- pixelId: '1234567890', // Your Meta Pixel ID
41
- },
42
- loadScript: true, // Load Meta Pixel script automatically
58
+ const { elb } = await startFlow({
59
+ destinations: [
60
+ {
61
+ destination: destinationMeta,
62
+ config: {
63
+ settings: { pixelId: '1234567890' },
64
+ loadScript: true,
65
+ },
66
+ },
67
+ ],
43
68
  });
44
69
  ```
45
70
 
@@ -50,6 +75,15 @@ elb('walker destination', destinationMeta, {
50
75
  | `pixelId` | `string` | Your Meta Pixel ID from Facebook Business Manager | Yes | `'1234567890'` |
51
76
  | `loadScript` | `boolean` | Whether to automatically load the Meta Pixel script (fbevents.js) | No | `true` |
52
77
 
78
+ ## Type Definitions
79
+
80
+ See [src/types/](./src/types/) for TypeScript interfaces.
81
+
82
+ ## Related
83
+
84
+ - [Website Documentation](https://www.walkeros.io/docs/destinations/web/meta/)
85
+ - [Destination Interface](../../../core/src/types/destination.ts)
86
+
53
87
  ## Contribute
54
88
 
55
89
  Feel free to contribute by submitting an