Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 3ae14aa

Browse files
authored
Merge pull request segmentio#4006 from segmentio/4003-fix-link
Update Facebook Conversions API link
2 parents 2ab9f88 + 8daada5 commit 3ae14aa

File tree

1 file changed

+24
-24
lines changed
  • src/connections/destinations/catalog/facebook-pixel-server-side

1 file changed

+24
-24
lines changed

src/connections/destinations/catalog/facebook-pixel-server-side/index.md

+24-24
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ hide-dossier: true
2121
> info "Destination name change"
2222
> Facebook Conversions API was renamed from Facebook Pixel Server-Side.
2323
24-
### Other Facebook Destinations Supported by Segment
24+
### Other Facebook destinations supported by Segment
2525

2626
This page is about the **Facebook Conversions API** destination. For documentation on other Facebook destinations, including Facebook Pixel, see the pages linked below.
2727

@@ -32,15 +32,15 @@ This page is about the **Facebook Conversions API** destination. For documentati
3232
| **[Facebook Offline Conversions](/docs/connections/destinations/catalog/facebook-offline-conversions/)** | Yes |
3333
| **[Facebook Pixel](/docs/connections/destinations/catalog/facebook-pixel/)** | No |
3434

35-
## Getting Started
35+
## Getting started
3636

3737
{% include content/connection-modes.md %}
3838

3939
Next, set up your Pixel to work with the Facebook Conversions API destination. You can use an existing Facebook Pixel that you already have set up, or create a new one. If you don't already have a Facebook Pixel configured, follow the "New Pixel" instructions below to create one.
4040

4141
### Option 1 - Create a new pixel
4242

43-
1. Go to the Facebook Business [Events Manager](https://www.facebook.com/events_manager/) and click **Connect Data Sources**.
43+
1. Go to the Facebook Business [Events Manager](https://www.facebook.com/events_manager/){:target="_blank"} and click **Connect Data Sources**.
4444
2. Choose Web, App, or Offline and then click **Get Started**.
4545
3. Select "Conversions API" and then click **Connect**.
4646
4. Choose "Segment" from the list of partners.
@@ -58,12 +58,12 @@ Next, set up your Pixel to work with the Facebook Conversions API destination. Y
5858
1. From the Destinations catalog page in the Segment App, click **Add Destination**.
5959
2. Search for "Facebook Conversions API" in the Destinations Catalog, and select the "Facebook Conversions API" destination.
6060
3. Choose which Source should send data to the "Facebook Conversions API" destination.
61-
4. Go to the Facebook Business [Event Manager Pixel Settings](https://business.facebook.com/events_manager/pixel/settings), find and copy the "Pixel ID".
61+
4. Go to the Facebook Business [Event Manager Pixel Settings](https://business.facebook.com/events_manager/pixel/settings){:target="_blank"}, find and copy the "Pixel ID".
6262
5. Enter the "Pixel ID" in the "Facebook Conversions API" destination settings in Segment.
6363

6464

6565
> info ""
66-
> See the [Configuration options](#configuration-options) section below for additional implementation steps
66+
> See the [Configuration options](#configuration-options) section below for additional implementation steps.
6767
6868
## Configuration options
6969

@@ -82,7 +82,7 @@ This approach provides a redundancy that ensures maximum signal reliability. Eve
8282

8383
For this option to work best, pass the same `external_id` from the browser and the server. To achieve this, go to the Facebook Pixel destination settings in Segment and enable the **Enable Advanced Matching** and **Use User ID or Anonymous ID as External ID** settings. By default, the Facebook Conversions API destination uses the `userId` (or `anonymousId` if not present) to set the `external_id`, so when you configure Facebook Pixel to use the same settings, Facebook matches users by those IDs.
8484

85-
You can also increase the match rate for events from a server source by sending [user traits in the context object of the track events](#default-mappings-to-facebook-properties). You can also collect other fields from the browser, such as `userAgent`, `ip` address, and [Facebook's parameters (fbp, fbc)](https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/fbp-and-fbc) and pass them to the server, and manually add them to the events.
85+
You can also increase the match rate for events from a server source by sending [user traits in the context object of the track events](#default-mappings-to-facebook-properties). Collect other fields from the browser, such as `userAgent`, `ip` address, and [Facebook's parameters (fbp, fbc)](https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/fbp-and-fbc){:target="_blank"}, pass them to the server, and manually add them to the events.
8686

8787
#### Deduplication considerations
8888

@@ -110,7 +110,7 @@ Use this approach if you don't want to track users from the browser with Faceboo
110110

111111
If you use Facebook Conversions API as a stand-alone without certain data fields collected from the browser, the match rate might not be as high as if you included them.
112112

113-
You can also increase the match rate for events from a server source by sending [user traits in the context object of the track events](#default-mappings-to-facebook-properties). You can also collect other fields from the browser, such as `userAgent`, `ip` address, and [Facebook's parameters (fbp, fbc)](https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/fbp-and-fbc) and pass them to the server, and manually add them to the events.
113+
You can also increase the match rate for events from a server source by sending [user traits in the context object of the track events](#default-mappings-to-facebook-properties). Collect other fields from the browser, such as `userAgent`, `ip` address, and [Facebook's parameters (fbp, fbc)](https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/fbp-and-fbc){:target="_blank"}, pass them to the server, and manually add them to the events.
114114

115115

116116
#### Deduplication considerations
@@ -123,9 +123,9 @@ Currently, Facebook Conversions only supports Track calls.
123123

124124
For more information about Track calls, see the [Track method](/docs/connections/spec/track/) in the Segment Spec.
125125

126-
## Server Event Parameter Requirements
126+
## Server event parameter requirements
127127

128-
Beginning February 15th 2021, Facebook requires the `action_source` server event parameter for all events sent to the Conversions API. This parameter is used to specify where the conversions occurred. If `action_source` is set to 'website' then the `client_user_agent` and the `event_source_url` parameters are also required. Events sent to the Conversions API after February 15th that do not meet the requirements may not be available for optimization, targeting, or measurement.
128+
Beginning February 15th, 2021, Facebook requires the `action_source` server event parameter for all events sent to the Conversions API. This parameter is used to specify where the conversions occurred. If `action_source` is set to 'website' then the `client_user_agent` and the `event_source_url` parameters are also required. Events sent to the Conversions API after February 15th that do not meet the requirements may not be available for optimization, targeting, or measurement.
129129

130130
| Server Event Parameter | Requirement | Implementation p |
131131
| ---------------------- | -------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
@@ -159,7 +159,7 @@ You can set `action_source` manually by passing it as a property of a Track even
159159

160160
`event_source_url` is set by including `context.page.url` in the track event. The value used should be the browser URL where the conversion event occurred. If you're using a server library, set `event_source_url` manually. If you're using the Segment web library, `event_source_url` is set automatically.
161161

162-
### Implementing Server Event Parameter Requirements
162+
### Implementing server event parameter requirements
163163

164164
If `action_source` is set to 'website', the `context.userAgent` and the `context.page.url` fields are required. Segment server-side libraries do not collect `context.userAgent` or `context.page.url` by default. This data must be retrieved manually from the client and passed to the server.
165165

@@ -193,9 +193,9 @@ analytics.track({
193193
});
194194
```
195195

196-
### Default Mappings to Facebook Standard Events
196+
### Default mappings to Facebook standard events
197197

198-
The following mappings are automatic and require no additional set up. Any of the Segment Ecommerce Events in the table below will be sent as the corresponding Facebook Standard Event. You learn more about these in the Facebook pixel [standard events documentation](https://developers.facebook.com/docs/facebook-pixel/implementation/conversion-tracking#standard-events).
198+
The following mappings are automatic and require no additional set up. Any of the Segment Ecommerce Events in the table below will be sent as the corresponding Facebook Standard Event. You learn more about these in the Facebook pixel [standard events documentation](https://developers.facebook.com/docs/facebook-pixel/implementation/conversion-tracking#standard-events){:target="_blank"}.
199199

200200
| Segment E-commerce Event | Facebook Standard Event |
201201
| ------------------------ | ----------------------- |
@@ -209,20 +209,20 @@ The following mappings are automatic and require no additional set up. Any of th
209209
> info ""
210210
> Facebook requires a currency for "Purchase" events -- if you leave it out, Segment will set a default value of "USD".
211211
212-
### Custom Mappings to Facebook Standard Events
212+
### Custom mappings to Facebook standard events
213213

214214
To map any of your Segment Events (not listed in the table above) to a Facebook _Standard event_, use the Segment destination setting labeled **Map Your Events to Standard FB Events**. Then, when Segment receives an event that appears in that mapping, the event is sent to Facebook as the standard event you specified. All properties included in the event are sent as event properties.
215215

216216

217-
### Facebook Custom Events
218-
Any unmapped events are automatically sent to Facebook Conversions as a _custom_ event. If Facebook's predefined standard events aren't suitable for your needs, you can track your own custom events, which also can be used to define [custom audiences](https://developers.facebook.com/docs/facebook-pixel/implementation/custom-audiences) for ad optimization. Custom events also support parameters, which you can include to provide additional information about each custom event.
217+
### Facebook custom events
218+
Any unmapped events are automatically sent to Facebook Conversions as a _custom_ event. If Facebook's predefined standard events aren't suitable for your needs, you can track your own custom events, which also can be used to define [custom audiences](https://developers.facebook.com/docs/facebook-pixel/implementation/custom-audiences){:target="_blank"} for ad optimization. Custom events also support parameters, which you can include to provide additional information about each custom event.
219219

220220
> warning ""
221221
> Custom event names cannot exceed 50 characters in length.
222222
223-
### Default Mappings to Facebook Properties
223+
### Default mappings to Facebook properties
224224

225-
Segment maps the following Segment traits to [Facebook properties](https://developers.facebook.com/docs/marketing-api/server-side-api/parameters):
225+
Segment maps the following Segment traits to [Facebook properties](https://developers.facebook.com/docs/marketing-api/server-side-api/parameters){:target="_blank"}:
226226

227227
| **Segment Property** | **Pixel Property** | **Notes** |
228228
| ----------------------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------- |
@@ -256,7 +256,7 @@ Segment maps the following Segment traits to [Facebook properties](https://devel
256256
> info "About hashing"
257257
> For each of the hashed properties above, Segment's integration code hashes the values before they're sent to the destination.
258258
259-
To access the `contexts` and `context.traits` objects in a Track call, you can use the [context-traits format](/docs/connections/sources/catalog/libraries/website/javascript/#context--traits) as in the example below.
259+
To access the `contexts` and `context.traits` objects in a Track call, you can use the [context-traits format](/docs/connections/sources/catalog/libraries/website/javascript/identity/#saving-traits-to-the-context-object) as in the example below.
260260

261261
```javascript
262262
analytics.track("Clicked Email", {
@@ -269,22 +269,22 @@ analytics.track("Clicked Email", {
269269
});
270270
```
271271

272-
### Custom Mappings to Facebook Properties
272+
### Custom mappings to Facebook properties
273273
Any properties you send that aren't listed above are sent in the `custom_data` part of the Segment payload to Facebook.
274274

275-
### Alternative External IDs
275+
### Alternative external IDs
276276

277277
By default, Segment sends the `userId` as `external_id`, and if `userId` is absent falls back to `anonymousId`. To use a different field in your payload as the `external_id`, use the **Alternative External ID Field** setting. An example value for this setting would be `properties.externalId`.
278278

279-
### Alternative Value Properties
279+
### Alternative value properties
280280

281281
For most events Segment sends revenue for the Pixel value field, but for
282282
the pre-purchase events `Product Viewed` and `Product Added`, Segment
283283
uses the value of the **Value Field Identifier** setting to determine which
284284
property to use for the `value` field. This field defaults to
285285
`price`.
286286

287-
## Limited Data Use
287+
## Limited data use
288288

289289
{% include content/facebook-ldu-intro.md %}
290290

@@ -311,7 +311,7 @@ analytics.track({
311311
})
312312
```
313313

314-
## Verify Events in Facebook
314+
## Verify events in Facebook
315315

316316
After you start sending events, you should start seeing them in twenty
317317
minutes. You can confirm that Facebook received them:
@@ -323,4 +323,4 @@ minutes. You can confirm that Facebook received them:
323323
> info ""
324324
> **Note**: It might take a few minutes before events appear in the Events Manager.
325325
326-
![](images/image2.png)
326+
![Verify events in the Overview tab of the Events Manager](images/image2.png)

0 commit comments

Comments
 (0)