Skip to content

Commit 31eee70

Browse files
authored
Merge branch 'master' into update_docs_for_snippet_5.2.1
2 parents f54c122 + ed0ee57 commit 31eee70

File tree

24 files changed

+1130
-167
lines changed

24 files changed

+1130
-167
lines changed

src/_data/sidenav/main.yml

Lines changed: 9 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -260,6 +260,8 @@ sections:
260260
title: Speeding Up Redshift Queries
261261
- path: /connections/storage/warehouses/redshift-useful-sql
262262
title: Useful SQL Queries for Redshift
263+
- path: /connections/regional-segment
264+
title: Regional Segment
263265
- path: /connections/test-connections
264266
title: Event Tester
265267
- path: /connections/data-export-options
@@ -276,18 +278,6 @@ sections:
276278
title: Integration Error Codes
277279
- path: /connections/rate-limits
278280
title: Rate Limits
279-
- path: /connections/regional-segment
280-
title: Regional Segment
281-
# - section_title: Reverse ETL
282-
# section:
283-
# - path: /reverse-etl
284-
# title: Reverse ETL Overview
285-
# - path: /reverse-etl/bigquery-setup
286-
# title: BigQuery Reverse ETL Setup
287-
# - path: /reverse-etl/redshift-setup
288-
# title: Redshift Reverse ETL Setup
289-
# - path: /reverse-etl/snowflake-setup
290-
# title: Snowflake Reverse ETL Setup
291281
- section_title: Unify
292282
section:
293283
- path: /unify
@@ -324,9 +314,7 @@ sections:
324314
title: Tables & Materialized Views
325315
- section_title: Linked Profiles
326316
slug: unify/linked-profiles
327-
section:
328-
- path: /unify/linked-profiles/linked-events
329-
title: Linked Events
317+
section:
330318
- section_title: Setup Guides
331319
slug: unify/linked-profiles/setup-guides
332320
section:
@@ -336,6 +324,9 @@ sections:
336324
title: Snowflake Setup
337325
- path: /unify/linked-profiles/setup-guides/redshift-setup
338326
title: Redshift Setup
327+
- path: /unify/linked-profiles/linked-events
328+
title: Linked Events
329+
339330
- section_title: Traits
340331
slug: unify/traits
341332
section:
@@ -364,7 +355,7 @@ sections:
364355
title: Unify FAQs
365356
- path: /unify/product-limits
366357
title: Unify Limits
367-
358+
368359
- section_title: Engage
369360
section:
370361
- path: '/engage'
@@ -400,6 +391,8 @@ sections:
400391
title: Audiences Overview
401392
- path: '/engage/audiences/account-audiences'
402393
title: Account-level Audiences
394+
- path: '/engage/audiences/generative-audiences'
395+
title: Generative Audiences
403396
- path: '/engage/audiences/organization'
404397
title: Organize Audiences
405398

src/api/public-api/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Learn more about [GitHub's secret scanning program](https://docs.github.com/en/d
4242
## OAuth 2.0
4343

4444
> info ""
45-
> This feature is currently in pilot and is governed by Segment’s [First Access and Beta Preview Terms](https://www.twilio.com/en-us/legal/tos){:target="_blank"}.
45+
> OAuth 2.0 is currently in private beta and is governed by Segment’s [First Access and Beta Preview Terms](https://www.twilio.com/en-us/legal/tos){:target="_blank"}.
4646
4747
## FAQs
4848
#### What should I do if I see a notification that my token was exposed?

src/connections/destinations/actions.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,55 @@ Moving from a classic destination to an actions-based destination is a manual pr
7575
5. Verify that data is flowing from the development or test source to the partner tool.
7676
6. Repeat the steps above with your production source.
7777

78+
### Migrate to an actions-based destination using Destination Filters
79+
For a more comprehensive migration from a classic destination to an actions-based destination, follow the steps outlined below. This implementation strategy is only available for customers on a Segment Business Tier plan with access to [Destination Filters](/docs/connections/destinations/destination-filters/). By adding additional line of defense with Destination Filters, you remove the possibility of duplicate events or dropped events and ensure that events sent before/after a specified `received_at` timestamp are sent to each destination.
80+
81+
This migration strategy involves configuring a destination filter on both the Classic destination and the Actions destination. Configure the classic destination filter to block events by the `received_at` field with a certain value, and the Actions destination to drop events until the `received_at` timestamp field reaches that same value. Destination Filters within the UI have a limitation where they cannot access any top-level fields, but this is not a limitation for [Destination Filters](https://docs.segmentapis.com/tag/Destination-Filters/){:target="_blank”} created by the [Public API](https://segment.com/docs/api/public-api/){:target="_blank”} using [FQL](https://segment.com/docs/api/public-api/fql/){:target="_blank”}. Because the `received_at` is a top-level field in the payload, you'll need to create a destination filter with the Public API and submit the request with that FQL information described below.
82+
83+
By combining these Filters, Segment sends events through the Classic integration up until a specified time and then blocks events after that time. Then the Actions integration blocks events until that specified time, and only allows events beginning at that specified time.
84+
85+
The following code samples show you how you can create filters for your destinations using the [Create Filter for Destination](https://docs.segmentapis.com/tag/Destination-Filters#operation/createFilterForDestination){:target="_blank”} Public API operation.
86+
87+
#### Classic destination
88+
_Endpoint_: `POST` `https://api.segmentapis.com/destination/classic_destination_id_from_url/filters`
89+
```
90+
// JSON BODY :
91+
{
92+
"sourceId": "add_source_id_here",
93+
"destinationId": "classic_destination_id_from_url",
94+
"title": "drop event after (timestamp) received_at > value April 4, 2023 19:55pm",
95+
"description": "drop event after (timestamp) received_at > value April 4, 2023 19:55pm",
96+
"if": "(received_at >= '2023-04-21T19:55:00.933Z')",
97+
"actions": [
98+
{
99+
"type":"DROP"
100+
}
101+
],
102+
"enabled": true
103+
}
104+
```
105+
106+
#### Actions destination
107+
_Endpoint_: `POST` `https://api.segmentapis.com/destination/actions_destination_id_from_url/filters`
108+
```
109+
// JSON BODY :
110+
{
111+
"sourceId": "add_source_id_here",
112+
"destinationId": "actions_destination_id_from_url",
113+
"title": "drop event before (timestamp) received_at < value April 4, 2023 19:55pm",
114+
"description": "drop event before (timestamp) received_at < value April 4, 2023 19:55pm",
115+
"if": "(received_at < '2023-04-21T19:55:00.933Z')",
116+
"actions": [
117+
{
118+
"type":"DROP"
119+
}
120+
],
121+
"enabled": true
122+
}
123+
```
124+
125+
After configuring the Destination Filter on both the Classic and Actions destination, see each destination's Filters tab and enable the filters. After completing the migration, you can disable the Classic destination on the Settings page, and remove each of the filters from both destinations.
126+
78127
## Edit a destination action
79128
You can add or remove, disable and re-enable, and rename individual actions from the Actions tab on the destination's information page in the Segment app. Click an individual action to edit it.
80129

src/connections/destinations/catalog/actions-amplitude/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ To manually add the Log Purchases Action:
5454
The Amplitude (actions) destination does not offer a device-mode connection mode. If you're using one of Segment's new libraries ([Analytics.js 2.0](/docs/connections/sources/catalog/libraries/website/javascript/), [Swift](https://github.com/segmentio/analytics-swift){:target="_blank”} or [Kotlin](https://github.com/segmentio/analytics-kotlin){:target="_blank”}) with the Actions-framework version of the destination, you do not need the device-mode connection.
5555

5656

57-
Most previous deployments of the Amplitude Segment destination used the device-mode connection to use the `session_id` tracking feature. The new Actions-framework Amplitude destination, includes session ID tracking by default. When connected to the Analytics.js 2.0 source, Segment automatically loads a plugin on your website for session tracking and enrichment as an alternative to the Amplitude SDK. This means you don't need to bundle any software to run on the user's device, or write any code. It also means that you can use more of the Segment platform features on data going to Amplitude, such as Protocols filtering and transformations, and Profiles Identity Resolution.
57+
Most previous deployments of the Amplitude Segment destination used the device-mode connection to use the `session_id` tracking feature. The new Actions-framework Amplitude destination includes session ID tracking by default. When connected to the Analytics.js 2.0 source, Segment automatically loads a plugin on your website for session tracking and enrichment as an alternative to the Amplitude SDK. This means you don't need to bundle any software to run on the user's device, or write any code. It also means that you can use more of the Segment platform features on data going to Amplitude, such as Protocols filtering and transformations, and Profiles Identity Resolution.
5858

5959
Session tracking is available with Segment's new libraries: [Analytics.js 2.0](/docs/connections/sources/catalog/libraries/website/javascript/), [Swift](https://github.com/segmentio/analytics-swift){:target="_blank”} or [Kotlin](https://github.com/segmentio/analytics-kotlin){:target="_blank”}.
6060

src/connections/destinations/catalog/actions-google-enhanced-conversions/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ Conversions tracked by other means, such as importing goals from Google Analytic
8181
8282
### Enhanced conversions for leads
8383

84-
[Enhanced conversions for leads](https://developers.google.com/google-ads/api/docs/conversions/upload-identifiers){:target="_blank"} allows you to use hashed, first-party user-provided data from your website lead forms for offline lead measurement. When you upload your leads, the provided hashed information is used to attribute back to the Google Ad campaign. In order to send enhanced conversions for leads, you can use the "Upload Click Conversion" action. Instead of sending GCLID, send an email address or phone number of the user for Segment to hash and send to Google Ads.
84+
[Enhanced conversions for leads](https://developers.google.com/google-ads/api/docs/conversions/upload-identifiers){:target="_blank"} allows you to use hashed, first-party user-provided data from your website lead forms for offline lead measurement. When you upload your leads, the provided hashed information is used to attribute back to the Google Ad campaign. In order to send enhanced conversions for leads, you can use the "Upload Click Conversion" action. If available, include both GCLID and send an email address and phone number of the user for Segment to hash and send to Google Ads.
8585

8686
### Refreshing access tokens
8787

src/connections/destinations/catalog/actions-insider-audiences/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This destination is maintained by Insider. For any issues with the destination,
1414
## Getting started
1515

1616
> info "Prerequisites"
17-
> Before connecting to the Insider Audiences (Actions) destination, you must have an Insider Account, Account Name, and a [Unified Customer Database API Key](https://academy.useinsider.com/docs/api-authentication-tokens){:target="_blank"}.
17+
> Before connecting to the [Insider Audiences (Actions) destination](/docs/connections/destinations/catalog/actions-insider-audiences/), you must have an Insider Account, Account Name, and a [Unified Customer Database API Key](https://academy.useinsider.com/docs/api-authentication-tokens){:target="_blank"}.
1818
1919
To add the Insider Audiences Destination:
2020

src/connections/destinations/catalog/bing-ads/index.md

Lines changed: 51 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,24 +3,26 @@ title: Bing Ads Destination
33
rewrite: true
44
id: 54521fd525e721e32a72ee97
55
---
6-
[Bing Ads](https://bingads.microsoft.com){:target="_blank"} enables marketers to track and monitor campaigns, clicks, CTRs, spend, and budget. Bing Ads lets you place cross-device product ads in front of Bing, Yahoo, and MSN customers and support imported pay-per-click ad campaigns from third-party platforms like Google AdWords. With Bing Ads you can also re-target ads to customers after they complete an action like leaving a shopping cart or viewing a product without purchasing. Learn more about all you can do with [Bing Ads](https://advertise.bingads.microsoft.com/en-us/resources/training/what-is-bing-ads){:target="_blank"}. You can also [browse the code on GitHub](https://github.com/segment-integrations/analytics.js-integration-bing-ads){:target="_blank"}.
6+
7+
[Bing Ads](https://bingads.microsoft.com){:target="_blank"} enables Marketers to track and monitor campaigns, clicks, CTRs, spend and budget. Bing Ads lets you place cross-device product ads in front of Bing, Yahoo, and MSN customers and support imported pay-per-click ad campaigns from third-party platforms like Google AdWords. With Bing Ads you can also retarget ads to customers after they complete an action like leaving a shopping cart or viewing a product without purchasing. To learn more, see [Bing Ads](https://advertise.bingads.microsoft.com/en-us/resources/training/what-is-bing-ads){:target="_blank"}. You can also browse the code [on GitHub](https://github.com/segment-integrations/analytics.js-integration-bing-ads){:target="_blank"}.
78

89
## Getting started
910

10-
Before you can track conversions or target audiences, you need to create a UET tag in Bing Ads and then add it to the destination settings. Follow the steps within [the Bing Ads documentation to create a UET tag](https://advertise.bingads.microsoft.com/en-us/resources/training/universal-event-tracking){:target="_blank"}.
11+
Before you can track conversions or target audiences, create a UET tag in Bing Ads and then add it to the destination settings. Follow the steps within [the Bing Ads documentation to create a UET tag](https://advertise.bingads.microsoft.com/en-us/resources/training/universal-event-tracking){:target="_blank"}.
1112

12-
Once you have created the Tag ID, you can follow the steps below:
13+
After you have created the Tag ID, follow the steps below:
1314

1415
1. From the Segment web app, click **Catalog**.
15-
2. Search for "Bing Ads" in the Catalog, select it, and choose which of your sources to connect the destination to. Note the source must be sending events using Segment's JavaScript library Analytics.js.
16-
3. In the destination settings, enter your Tag Id
16+
2. Search for "Bing Ads" in the Catalog, select it, and choose which of your sources to connect to the destination. Note that the source must be sending events using Segment's JavaScript library Analytics.js.
17+
3. In the destination settings, enter your Tag Id.
18+
19+
Your changes will appear in the Segment CDN in about 45 minutes, and then Analytics.js starts asynchronously loading Bing Ads snippets on your page and sending data.
1720

18-
> info ""
19-
> Bing Ads supports one Tag ID per source. Be sure to associate conversion goals to the correct Tag ID in settings.
21+
_**Note:** You'll only be able to include one Tag ID per source so make sure to associate the conversion goals to the correct Tag ID that is included in your settings._
2022

2123
## Page
2224

23-
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:
25+
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 looks like:
2426

2527
```javascript
2628
// name and properties are optional
@@ -33,6 +35,47 @@ Page events will be sent to Bing Ads as a `Page Load` event where name and prope
3335

3436
If you're not familiar with the Segment Specs, take a look to understand what the [Track method](/docs/connections/spec/track/) does.
3537

38+
For Segment to map your track events to a Conversion Goal, first create the goal on your Bing Ads account:
39+
40+
1. Click the **Campaigns** tab, and then on the left pane, click **Conversion Tracking**.
41+
2. Under **Conversion Tracking**, click **Conversion Goals**.
42+
3. On the conversion goals page, click **Create conversion goal**.
43+
4. Enter a name for your goal in the **Goal name** box. When naming your goal, use a descriptive name that makes sense to you. (For example, "Checkout page")
44+
5. Choose the `Event` type of conversion and click **Next**.
45+
6. Fill in the appropriate values. Make sure to add the Segment event name as the **label** field and to associate the goal to the correct Tag (**UET Tag**) that is set up in your Segment source.
46+
47+
## Setting up Custom Events:
48+
49+
### Step 1: Add the UET Tag Tracking Code to Your Website
50+
51+
1. Copy the UET tag from Microsoft Advertising.
52+
2. Paste the tag into the head or body section of your website's code.
53+
54+
### Step 2: Create a Conversion Goal or Remarketing List
55+
56+
Creating a conversion goal for a custom event:
57+
58+
1. From the top menu, select **Tools > Conversion goals.**
59+
2. Select the type of conversion you want to track.
60+
3. Enter a descriptive name for your goal.
61+
4. Fill in the appropriate values for your selected goal type.
62+
5. Fine-tune your conversion goal with advanced settings.
63+
6. Associate the UET tag with the conversion goal.
64+
65+
Creating a remarketing list for a custom event:
66+
67+
In Microsoft Advertising, click **Shared Library > Audiences.**
68+
Click **Create audience > Remarketing list.**
69+
For Whom to add to your audience, select **Custom events.**
70+
Choose the parameters to report when logging custom events.
71+
Set the membership duration.
72+
Associate the UET tag with the remarketing list.
73+
74+
### Step 3: Modify the UET Tag Tracking Code in Your Website
75+
76+
1. Add the code for the custom event to the UET tag tracking code.
77+
2. Follow the instructions provided to set up the event tag on your website.
78+
3679
For Segment to map your track events to a Conversion Goal, create the goal in your Bing Ads account:
3780

3881
For information about tracking custom events, see Microsoft's article [How to track custom events with UET](https://help.ads.microsoft.com/#apex/ads/en/56684/2-500){:target="_blank"}
@@ -56,7 +99,6 @@ analytics.track('Order Completed', {
5699
| Action | Always set to `track` |
57100

58101

59-
60102
## Troubleshooting
61103

62104
{% include content/client-side-script-unverified.md %}

src/connections/destinations/destination-filters.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,9 @@ Keep the following limitations in mind when you use destination filters:
3131
- *(For device-mode)* Destination filters don't filter some fields that are collected by the destination SDK outside of Segment such as `page.url` and `page.referrer`.
3232
- *(For web device-mode)* Destination filters for web device-mode only supports the Analytics.js 2.0 source. You need to enable device mode destination filters for your Analytics.js source. To do this, go to your Javascript source and navigate to **Settings > Analytics.js** and turn the toggle on for **Destination Filters**.
3333
- *(For web device-mode)* Destination filters for device-mode only supports the Analytics.js 2.0 source.
34-
- *(For mobile device-mode)* Destination filters for mobile device-mode doesn't support iOS and Android libraries.
34+
- *(For mobile device-mode)* Destination filters for mobile device-mode is currenlty not supported.
35+
- Destination Filters don't apply to events that send through the destination Event Tester.
36+
- Destination Filters within the UI and [FQL]([url](https://segment.com/docs/api/public-api/fql/)) do not currently support matching on event fields containing '.$' or '.$.', which references fields with an array type.
3537

3638
[Contact Segment](https://segment.com/help/contact/){:target="_blank"} if these limitations impact your use case.
3739

src/connections/functions/source-functions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -390,7 +390,7 @@ Copy and paste this URL into the upstream tool or service to send data to this s
390390
## OAuth 2.0
391391

392392
> info ""
393-
> OAuth 2.0 is currently in pilot and is governed by Segment’s [First Access and Beta Preview Terms](https://www.twilio.com/en-us/legal/tos){:target="_blank"}.
393+
> OAuth 2.0 is currently in private beta and is governed by Segment’s [First Access and Beta Preview Terms](https://www.twilio.com/en-us/legal/tos){:target="_blank"}.
394394
395395
## Source function FAQs
396396

0 commit comments

Comments
 (0)