You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/connections/destinations/catalog/actions-facebook-conversions-api/index.md
+19-18Lines changed: 19 additions & 18 deletions
Original file line number
Diff line number
Diff line change
@@ -7,12 +7,6 @@ hide-dossier: false
7
7
8
8
Facebook Conversions API (Actions) enables advertisers to send events from their servers directly to Facebook. Server-side events link to Facebook Pixel events, and process like browser pixel events. This means that server-side events are used in measurement, reporting, and optimization, just like browser pixel events.
9
9
10
-
> info ""
11
-
> This document is about a feature which is in beta. This means that the Facebook Conversions API (Actions) destination is in active development, and some functionality may change before it becomes generally available.
12
-
13
-
> success ""
14
-
> **Good to know**: This page is about the [Actions-framework](/docs/connections/destinations/actions/) Facebook Conversions API Segment destination. There's also a page about the [non-Actions Facebook Conversions API destination](/docs/connections/destinations/catalog/facebook-pixel-server-side/). Both of these destinations receive data _from_ Segment.
15
-
16
10
## Benefits of Facebook Conversions API (Actions) vs Facebook Conversions API Classic
17
11
18
12
The Facebook Conversions API (Actions) destination provides the following benefits over the classic Facebook Conversions API destination:
@@ -24,6 +18,18 @@ The Facebook Conversions API (Actions) destination provides the following benefi
24
18
-**Support for multi-product arrays**. Product data nested within arrays, like the `products` array in the [Order Completed](/docs/connections/spec/ecommerce/v2/#order-completed) event, can be sent to Facebook.
25
19
-**Data normalization**. Data is normalized before it is hashed to ensure the hashed value matches Facebook Pixel (browser).
26
20
21
+
## Other Facebook Destinations Supported by Segment
22
+
This page is about the **Facebook Conversions API**. For documentation on other Facebook destinations, see the pages linked below.
23
+
24
+
|**Facebook Destination**| Supported by Personas |
Set up your Pixel to work with the Facebook Conversions API (Actions) destination. You can use an existing Facebook Pixel that you already have set up, or create a new one.
@@ -55,15 +61,6 @@ Set up your Pixel to work with the Facebook Conversions API (Actions) destinatio
55
61
56
62
{% include components/actions-fields.html %}
57
63
58
-
## Server Event Parameter Requirements
59
-
60
-
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 that do not meet the requirements may not be available for optimization, targeting, or measurement.
61
-
62
-
| Server Event Parameter | Requirement | Implementation p |
|`action_source`| Always required | It is set automatically but it can be set manually. |
65
-
|`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. |
66
-
|`event_source_url`| 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. |
67
64
## Configuration options
68
65
69
66
The Facebook Conversions API (Actions) destination gives you several ways to implement your conversion tracking. You can use it with [Facebook Pixel](/docs/connections/destinations/catalog/facebook-pixel/), or as a stand-alone alternative. You can read more about implementation options below and in [Facebook documentation](https://developers.facebook.com/docs/marketing-api/conversions-api/guides/end-to-end-implementation#pick-your-integration-type){:target="_blank"}.
@@ -81,7 +78,7 @@ With the Facebook Conversions API (Actions) destination, you can choose any fiel
81
78
82
79
83
80
84
-
You can send additional User Data to increase the match rate for events from a server source. Collect other fields from the browser, like User Agent, IP Address, and [Facebook's cookie parameters (fbp, fbc)](https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/fbp-and-fbc){:target="_blank"}, pass them to the server, and map them in the User Data object. See [Facebook's Customer Information Parameters](https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/customer-information-parameters) for more information on User Data fields.
81
+
You can send additional User Data to increase the match rate for events from a server source. Collect other fields from the browser, like User Agent, IP Address, and [Facebook's cookie parameters (fbp, fbc)](https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/fbp-and-fbc){:target="_blank"}, pass them to the server, and map them in the User Data object. See [Facebook's Customer Information Parameters](https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/customer-information-parameters){:target="_blank"} for more information on User Data fields, and [Facebook’s Best Practices for Conversions API](https://www.facebook.com/business/help/308855623839366?id=818859032317965){:target="_blank"} for match rate best practices.
85
82
86
83
87
84
@@ -105,7 +102,7 @@ With the Facebook Conversions API (Actions) destination, you can choose any fiel
105
102
106
103
107
104
108
-
You can send additional User Data to increase the match rate for events from a server source. Collect other fields from the browser, like User Agent, IP Address, and [Facebook's cookie parameters (fbp, fbc)](https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/fbp-and-fbc){:target="_blank"}, pass them to the server, and map them in the User Data object. See [Facebook's Customer Information Parameters](https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/customer-information-parameters) for more information on User Data fields.
105
+
You can send additional User Data to increase the match rate for events from a server source. Collect other fields from the browser, like User Agent, IP Address, and [Facebook's cookie parameters (fbp, fbc)](https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/fbp-and-fbc){:target="_blank"}, pass them to the server, and map them in the User Data object. See [Facebook's Customer Information Parameters](https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/customer-information-parameters){:target="_blank"} for more information on User Data fields, and [Facebook’s Best Practices for Conversions API](https://www.facebook.com/business/help/308855623839366?id=818859032317965){:target="_blank"} for match rate best practices.
109
106
110
107
111
108
@@ -135,7 +132,7 @@ If you want to send a [Facebook standard event](https://developers.facebook.com/
135
132
136
133
### PII Hashing
137
134
138
-
Segment creates a SHA-256 hash of the following fields:
135
+
Segment creates a SHA-256 hash of the following fields before sending to Facebook:
139
136
- External ID
140
137
- Email
141
138
- Phone
@@ -150,6 +147,10 @@ Segment creates a SHA-256 hash of the following fields:
150
147
151
148
If you use Facebook Pixel, the Pixel library also hashes the External ID. This means External IDs will match across Facebook Pixel and Facebook Conversions API if they use the External ID for [deduplication](https://developers.facebook.com/docs/marketing-api/conversions-api/deduplicate-pixel-and-server-events/#fbp-or-external-id){:target="_blank"}.
152
149
150
+
### Server Event Parameter Requirements
151
+
152
+
Facebook requires the `action_source` server event parameter for all events sent to the Facebook Conversions API. This parameter specifies where the conversions occur. 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 that don't meet the requirements may not be available for optimization, targeting, or measurement.
153
+
153
154
### Verify Events in Facebook
154
155
155
156
After you start sending events, you should start seeing them in twenty minutes. You can confirm that Facebook received them:
Copy file name to clipboardExpand all lines: src/connections/destinations/catalog/actions-google-analytics-4/index.md
-4Lines changed: 0 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -9,10 +9,6 @@ hide-dossier: false
9
9
10
10
When you have Segment installed, you can use your existing tracking implementation to fulfill your data collection needs with Google Analytics 4. Segment will send your data server-side to [Google's Measurement Protocol API](https://developers.google.com/analytics/devguides/collection/protocol/ga4).
11
11
12
-
> info ""
13
-
> This document is about a feature which is in beta. This means that the Destination Actions are in active development, and some functionality may change before it becomes generally available
14
-
15
-
16
12
> success ""
17
13
> **Good to know**: This page is about the [Actions-framework](/docs/connections/destinations/actions/) Google Analytics 4 destination. There's also a page about the [non-Actions Google Universal Analytics destination](/docs/connections/destinations/catalog/google-analytics/). Both of these destinations receive data _from_ Segment.
Copy file name to clipboardExpand all lines: src/connections/destinations/catalog/actions-google-enhanced-conversions/index.md
+4-50Lines changed: 4 additions & 50 deletions
Original file line number
Diff line number
Diff line change
@@ -5,18 +5,12 @@ hide-boilerplate: true
5
5
hide-dossier: false
6
6
---
7
7
8
-
> info ""
9
-
> This document is about a feature that is in beta. This means that the destination is in active development, and some functionality may change before it becomes generally available.
10
-
11
-
> success ""
12
-
> **Good to know**: This page is about the [Actions-framework](/docs/connections/destinations/actions/) Google Enhanced Conversions Segment destination.
13
-
14
8
The Google Enhanced Conversions destination enables you to improve the accuracy of your conversion measurement. You can supplement existing conversion tags by sending first-party customer conversion data from your website, such as email address, to Google Ads. Segment hashes this data and sends it in a privacy-safe way. Google matches hashed data with signed-in Google accounts to attribute the conversion to ad events, such as clicks or views. To learn more about Google Enhanced Conversions, see Google's documentation [About enhanced conversions](https://support.google.com/google-ads/answer/9888656?hl=en-GB){:target="_blank"}.
15
9
16
10
> warning "Before you begin"
17
11
> Enable Enhanced Conversions in your Google Ads account. For each Conversion, specify in the settings that you will use the Enhanced Conversions API:
18
12
> 1. When you log in to Google Ads, make sure you are in [Expert Mode](https://support.google.com/google-ads/answer/9520605?hl=en){:target="_blank"}.
19
-
> 2. Click **Tools & Settings** in the top bar, and select **Conversions** from the dropdown. Select the **Conversion Action** you want Segment to log to.
13
+
> 2. Click **Tools & Settings** in the top bar, and select **Conversions** from the dropdown. Select the website **Conversion Action** you want Segment to log to.
20
14
> 3. Expand the tab for **Enhanced conversions**. Enable **Turn on enhanced conversions**. Under "To start, select how you want to set up enhanced conversions", select **API**.
21
15
>
22
16
> When you authenticate your Segment workspace with your Google Account, use a Google Account that is a member of your Google Ads account.
@@ -26,52 +20,12 @@ The Google Enhanced Conversions destination enables you to improve the accuracy
26
20
2. Search for “Google Enhanced Conversions” in the Destinations Catalog, and select the destination.
27
21
3. Click **Configure Google Enhanced Conversions** in the top-right corner of the screen.
28
22
4. Select the source that will send data to Google Enhanced Conversions and follow the steps to name your destination.
29
-
5. On the **Settings** tab, enter the Conversion ID and click **Save**. Find the Conversion ID in your Google Ads account using the instructions in the article [Google Ads conversions](https://support.google.com/tagmanager/answer/6105160?hl=en){:target="_blank"}. When you log in to Google Ads, enable [Expert Mode](https://support.google.com/google-ads/answer/9520605?hl=en){:target="_blank"}. You'll follow these same instructions to get the Conversion Label, which you'll need when you set up your first Mapping, below.
23
+
5. On the **Settings** tab, enter the Conversion ID and click **Save**. Find the Conversion ID in your Google Ads account using the instructions in the article [Google Ads conversions](https://support.google.com/tagmanager/answer/6105160?hl=en){:target="_blank"}. You'll follow these same instructions to get the Conversion Label, which you'll need when you set up your first Mapping.
30
24
6. On the **Settings** tab, authenticate with Google using OAuth. Click **Connect to Google Enhanced Conversions**. Follow the prompts to authenticate using OAuth, with a Google login that is a member of the Google Ads account with Enhanced Conversions enabled.
31
25
7. Follow the steps in the Destinations Actions documentation on [Customizing mappings](/docs/connections/destinations/actions/#customizing-mappings).
32
26
33
-
34
-
{% capture conv_label %}
35
-
#### Find the Conversions Label
36
-
Enter the Conversion Label. Find the Conversion Label using the instructions in the article [Google Ads conversions](https://support.google.com/tagmanager/answer/6105160?hl=en){:target="_blank"}.
37
-
{% endcapture %}
38
-
39
-
{% capture test_mapping %}
40
-
#### Test the Mapping
41
-
To test your mapping:
42
-
1. Expand the **Test event trigger** section. Segment searches for recent events that match the trigger conditions. If there are no recent events that match the criteria, click **manually enter an event**, and replace the default event data with the following:
43
-
```json
44
-
{
45
-
"messageId": "segment-test-message-hkz2b",
46
-
"timestamp": "2021-08-27T17:32:12.781Z",
47
-
"context" : {
48
-
"userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 9_1 like Mac OS X) AppleWebKit/601.1.46 (KHTML, like Gecko) Version/9.0 Mobile/13B143 Safari/601.1"
9. Scroll down and expand the **Send a test event** section, and click **Test Action**.
71
-
10. The section displays the test result and the payload that Google Enhanced Conversions returns to Segment.
72
-
11. Click **Save**.
73
-
12. Enable the Mapping with the toggle under the **Status** column.
74
-
{% endcapture %}
27
+
> info
28
+
> The Conversion ID is a global setting because it's an account-level ID that's the same for all conversion actions in your Google Ads account. The Conversion Label is unique to each conversion action and is therefore configured per Mapping.
75
29
76
30
{% include components/actions-fields.html content1=conv_label section1="postConversion" content2=test_mapping section2="postConversion" %}
0 commit comments