Skip to content

Commit 0650bc5

Browse files
author
markzegarelli
committed
made the catalog, edited some text
1 parent 102c2c3 commit 0650bc5

File tree

7 files changed

+34
-30
lines changed

7 files changed

+34
-30
lines changed

src/_data/catalog/destination_categories.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# AUTOGENERATED FROM PUBLIC API. DO NOT EDIT
2-
# destination categories last updated 2021-10-08
2+
# destination categories last updated 2021-10-11
33
items:
44
- display_name: A/B Testing
55
slug: a-b-testing

src/_data/catalog/destinations.yml

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# AUTOGENERATED FROM PUBLIC API. DO NOT EDIT
2-
# destination data last updated 2021-10-08
2+
# destination data last updated 2021-10-11
33
items:
44
- display_name: 2mee
55
name: 2mee
@@ -7812,7 +7812,7 @@ items:
78127812
type: string
78137813
defaultValue: ''
78147814
description: >-
7815-
Your Pixel ID, from the snippet created on the [Facebook Pixel creation
7815+
Your Pixel ID from the snippet created on the [Facebook Pixel creation
78167816
page](https://www.facebook.com/ads/manager/pixel/facebook_pixel/).
78177817
required: true
78187818
label: Pixel ID
@@ -8014,20 +8014,22 @@ items:
80148014
type: boolean
80158015
defaultValue: false
80168016
description: >-
8017-
If true, we will initialize Facebook Pixel with any user traits that's
8018-
been cached in the Segment cookies from your previous `.identify()` calls.
8017+
If enabled, we will initialize Facebook Pixel with any user traits that
8018+
have been cached in the Segment cookies from your previous `.identify()`
8019+
calls.
80198020
required: false
80208021
label: Enable Advanced Matching
80218022
- name: keyForExternalId
80228023
type: string
80238024
defaultValue: ''
80248025
description: >-
8025-
Please indicated a user trait key which you would like Segment to use to
8026+
Please indicate a user trait key which you would like Segment to use to
80268027
send an `external_id` to Facebook Pixel using advanced matching. Segment
80278028
will use the value of this trait to map it to Facebook Pixel's
8028-
`external_id`.
8029+
`external_id`. Note: **Enable Advanced Matching** must be enabled to use
8030+
this setting.
80298031
required: false
8030-
label: 'Client-Side Only: Advanced Match Trait Key for External ID'
8032+
label: Advanced Match Trait Key for External ID
80318033
- name: legacyEvents
80328034
type: text-map
80338035
defaultValue: {}
@@ -8056,7 +8058,7 @@ items:
80568058
type: string
80578059
defaultValue: ''
80588060
description: >-
8059-
Your Pixel ID, from the snippet created on the [Facebook Pixel creation
8061+
Your Pixel ID from the snippet created on the [Facebook Pixel creation
80608062
page](https://www.facebook.com/ads/manager/pixel/facebook_pixel/).
80618063
required: true
80628064
label: Pixel ID
@@ -8086,10 +8088,11 @@ items:
80868088
type: boolean
80878089
defaultValue: false
80888090
description: >-
8089-
Enable this setting if you want to send, `userId` (or `anonymousId` if not
8090-
present) as external Id to Facebook.
8091+
Enable this setting if you want to send `userId` (or `anonymousId` if not
8092+
present) as `external_id` to Facebook when using advanced matching. Note:
8093+
**Enable Advanced Matching** must be enabled to use this setting.
80918094
required: false
8092-
label: Use UserId or Anonymous Id as External Id
8095+
label: Use User ID or Anonymous ID as External ID
80938096
- name: valueIdentifier
80948097
type: select
80958098
defaultValue: value
@@ -14968,10 +14971,10 @@ items:
1496814971
- Personalization
1496914972
logo:
1497014973
url: >-
14971-
https://public-segment-devcenter-production.s3.amazonaws.com/de56ef24-11ea-4cc6-8df2-19db90ff5c1c.svg
14974+
https://public-segment-devcenter-production.s3.amazonaws.com/8bef9c9a-f29b-4019-8a93-687a77d538a9.svg
1497214975
mark:
1497314976
url: >-
14974-
https://public-segment-devcenter-production.s3.amazonaws.com/6aeb55d8-ffc0-468b-a5f7-21f8b2aa18e0.svg
14977+
https://public-segment-devcenter-production.s3.amazonaws.com/b77aa858-b09d-444a-94cc-39d6c7115283.svg
1497514978
methods:
1497614979
track: false
1497714980
identify: true

src/_data/catalog/source_categories.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# AUTOGENERATED FROM PUBLIC API. DO NOT EDIT
2-
# source cateogries last updated 2021-10-08
2+
# source cateogries last updated 2021-10-11
33
items:
44
- display_name: A/B Testing
55
slug: a-b-testing

src/_data/catalog/sources.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# AUTOGENERATED FROM PUBLIC API. DO NOT EDIT
2-
# sources last updated 2021-10-08
2+
# sources last updated 2021-10-11
33
items:
44
- display_name: .NET
55
slug: net

src/_data/catalog/warehouse_papi.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# AUTOGENERATED FROM PUBLIC API. DO NOT EDIT
2-
# warehouse data last updated 2021-10-08
2+
# warehouse data last updated 2021-10-11
33
items:
44
- display_name: Azure SQL Data Warehouse
55
slug: azuresqldw

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ This approach provides a redundancy that ensures maximum signal reliability. Eve
7676

7777
#### Match rate considerations
7878

79-
For this option to work best, the same `external_id` needs to be passed from the browser and the server. To achieve this, go to your 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 set up Facebook Pixel to use the same settings, Facebook can then match the users.
79+
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.
8080

8181
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.
8282

@@ -92,7 +92,7 @@ Use this approach if you want to separate tracking events completed on a user's
9292

9393
For this option to work best, the same `external_id` needs to be passed from the browser and the server. To achieve this, go to your 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 set up Facebook Pixel to use the same settings, Facebook can then match the users.
9494

95-
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.
95+
You can also send [user traits in the context object of the track events](#default-mappings-to-facebook-properties)to increase the match rate for events from a server source. Collect other fields from the browser, like `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.
9696

9797
#### Deduplication considerations
9898

@@ -123,7 +123,7 @@ For more information about Track calls, see the [Track method](/docs/connections
123123

124124
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.
125125

126-
| Server Event Parameter | Requirement | Implementation |
126+
| Server Event Parameter | Requirement | Implementation p |
127127
| ---------------------- | ------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
128128
| `action_source` | Always required | It is set automatically but it can be set manually. |
129129
| `client_user_agent` | Only required if `action_source` = "website" | It must be set manually if using a server library. It is set automatically if using the Segment web library. |
@@ -138,7 +138,7 @@ You can set `action_source` manually by passing it as a property of a Track even
138138

139139
| Action Source Values | Description |
140140
| -------------------- | --------------------------------------------------------------------------------------------------------- |
141-
| `chat` | Conversion was made via a messaging app, SMS, or online messaging feature. |
141+
| `chat` | Conversion was made through a messaging app, SMS, or online messaging feature. |
142142
| `email` | Conversion happened over email. |
143143
| `other` | Conversion happened in a way that is not listed. |
144144
| `phone_call` | Conversion was made over the phone. |

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

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,10 @@ strat: facebook
66

77
[Facebook Pixel](https://developers.facebook.com/docs/facebook-pixel) lets you measure and optimize the performance of your Facebook Ads. It makes conversion tracking, optimization and remarketing easier than ever. The Facebook Pixel Destination is open-source. You can browse the code [on GitHub](https://github.com/segment-integrations/analytics.js-integration-facebook-pixel).
88

9-
_**NOTE:** Facebook has deprecated their modular "Ads For Websites" suite, which previously comprised Facebook Custom Audiences and Facebook Conversion Tracking. We've consolidated those two destinations into this new and improved "Facebook Pixel" destination._
9+
> warning ""
10+
> Facebook has deprecated the modular "Ads For Websites" suite, which previously comprised Facebook Custom Audiences and Facebook Conversion Tracking. We've consolidated those two destinations into this new and improved "Facebook Pixel" destination.
11+
1012

11-
This document was last updated on 31st October, 2018. If you notice any gaps, out-dated information or simply want to leave some feedback to help us improve our documentation, [let us know](https://segment.com/help/contact)!
1213

1314
**Use Cases**
1415

@@ -39,7 +40,7 @@ Segment automatically initializes Facebook's pixel with your `pixelId` upon load
3940

4041
## Page
4142

42-
If you're not familiar with the Segment Specs, take a look to understand what the [Page method](https://segment.com/docs/connections/spec/page/) does. An example call would look like:
43+
If you're not familiar with the Segment Specs, take a look to understand what the [Page method](/docs/connections/spec/page/) does. An example call would look like:
4344

4445
```javascript
4546
analytics.page();
@@ -49,7 +50,7 @@ We've mapped `analytics.page()` to [Facebook's `fbq('track', "PageView")`](https
4950

5051
## Identify
5152

52-
If you're not familiar with the Segment Specs, take a look to understand what the [Identify method](https://segment.com/docs/connections/spec/identify/) does. An example call would look like:
53+
If you're not familiar with the Segment Specs, take a look to understand what the [Identify method](/docs/connections/spec/identify/) does. An example call would look like:
5354

5455
```javascript
5556
analytics.identify('ze8rt1u89', {
@@ -69,7 +70,7 @@ When you make an Identify call with Segment, it will update Facebook Pixel the n
6970

7071
## Track
7172

72-
If you're not familiar with the Segment Specs, take a look to understand what the [Track method](https://segment.com/docs/connections/spec/track/) does. An example call would look like:
73+
If you're not familiar with the Segment Specs, take a look to understand what the [Track method](/docs/connections/spec/track/) does. An example call would look like:
7374

7475
```javascript
7576
analytics.track("My Custom Event", {
@@ -159,9 +160,9 @@ Facebook accepts the following properties:
159160
- State
160161
- Zip code
161162

162-
If you follow Segment's [spec](/docs/connections/spec/identify/#traits), these would automatically be sent correctly.
163+
If you follow Segment's [spec](/docs/connections/spec/identify/#traits), these properties send in the correct format.
163164

164-
Facebook also accepts an External ID when using Advanced Matching. This can be any unique ID from the advertiser, such as loyalty membership IDs, user IDs, and external cookie IDs. In order to send an `external_id` to Facebook you can either:
165+
When you use Advanced Matching, Facebook also accepts an External ID. This can be any unique ID from the advertiser, like loyalty membership IDs, user IDs, and external cookie IDs. To send an `external_id` to Facebook you can either:
165166

166167
- Send the Segment `userId` or `anonymousId` as `external_id` using the **Use User ID or Anonymous ID as External ID** setting
167168
- Indicate which user trait you would like Segment to map to `external_id` using the **Advanced Match Trait Key for External ID** setting
@@ -177,7 +178,7 @@ Facebook also accepts an External ID when using Advanced Matching. This can be a
177178

178179
Facebook uses the `context.ip` to determine the geolocation of the event.
179180

180-
You can manually change the Data Processing parameters by adding settings to the `integrations` object. For Facebook Pixel, you must store these settings in the [Load object](https://segment.com/docs/connections/sources/catalog/libraries/website/javascript/#load-options) so that Segment can set them *before* it calls `init`. The example below shows how you might set custom Data Processing parameters in Analytics.js.
181+
You can manually change the Data Processing parameters by adding settings to the `integrations` object. For Facebook Pixel, you must store these settings in the [Load object](/docs/connections/sources/catalog/libraries/website/javascript/#load-options) so that Segment can set them *before* it calls `init`. The example below shows how you might set custom Data Processing parameters in Analytics.js.
181182

182183
```javascript
183184
analytics.load("replace_with_your_write_key", {
@@ -216,7 +217,7 @@ Facebook enforces strict guidelines around sending Personally Identifiable Infor
216217

217218
Any `track` events with properties containing those keys will be sent to Facebook with those properties omitted.
218219

219-
If you have events that use any of those keys for non-PII properties, you can manually whitelist them using the **Allowlist PII Properties** setting. You may also add to this list and/or optionally hash blocklisted properties with the **Blocklist PII Properties** setting.
220+
If you have events that use any of those keys for non-PII properties, you can manually allowlist them using the **Allowlist PII Properties** setting. You may also add to this list and/or optionally hash blocklisted properties with the **Blocklist PII Properties** setting.
220221

221222
### Inconsistent or Missing Conversions
222223

0 commit comments

Comments
 (0)