Skip to content

Commit d0f1e15

Browse files
Merge pull request #7221 from StackAdapt/vs/setup-guide-for-stackadapt-audience-destination
Setup guide for StackAdapt audience destination
2 parents e277b57 + 19ab7f7 commit d0f1e15

File tree

3 files changed

+88
-18
lines changed

3 files changed

+88
-18
lines changed
Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
---
2+
title: StackAdapt Audience Destination
3+
hide-boilerplate: true
4+
hide-dossier: true
5+
beta: true
6+
id: 66e96b9f4ee97f41caa06487
7+
hidden: true
8+
redirect_from: "/connections/destinations/catalog/actions-stackadapt-audiences/"
9+
---
10+
11+
{% include content/plan-grid.md name="actions" %}
12+
13+
[StackAdapt](https://www.stackadapt.com/){:target="_blank"} is a programmatic advertising platform specializing in audience engagement. StackAdapt enables marketers to deliver high-performing advertising campaigns across channels through real-time bidding, detailed audience targeting, and data-driven insights. StackAdapt’s integration with Twilio Engage helps you sync user data to optimize targeting and improve your campaign outcomes.
14+
15+
This destination is maintained by StackAdapt. For any issues with the destination, please [submit a ticket to StackFAdapt's support team](https://support.stackadapt.com/hc/en-us/requests/new?ticket_form_id=360006572593){:target="_blank"}.
16+
17+
## Getting started
18+
19+
### Getting your StackAdapt GraphQL Token
20+
21+
If you do not have an existing StackAdapt API key, [reach out to the StackAdapt team for help](https://support.stackadapt.com/hc/en-us/requests/new?ticket_form_id=360006572593){:target="_blank"}.
22+
23+
### Setting up the StackAdapt Audience destination in Segment Engage
24+
25+
1. From the Segment web app, navigate to **Connections > Catalog > Destinations**.
26+
2. Search for and select the "StackAdapt Audience" destination.
27+
3. Click **Add Destination**.
28+
4. Select an existing source that is Engage Space to connect to the StackAdapt Audience destination.
29+
5. Enter a name for your destination.
30+
6. On the Settings screen, provide your StackAdapt GraphQL API token.
31+
7. Toggle on the destination using the **Enable Destination** toggle.
32+
8. Click **Save Changes**.
33+
9. Follow the steps in the Destinations Actions documentation to [customize mappings](/docs/connections/destinations/actions/#customize-mappings) or use the documentation to [sync an Engage Audience](#sync-an-engage-audience).
34+
10. Enable the destination and click **Save Changes**.
35+
36+
### Sync an Engage Audience
37+
38+
To sync an Engage audience with StackAdapt:
39+
40+
1. Each Engage audience should only contain profiles that have a valid email address. Profiles missing an email address are not valid on StackAdapt's platform.
41+
2. Add a condition to the Engage audience to ensure the required email trait is included.
42+
3. Open the previously created StackAdapt Audience destination.
43+
4. On the Mappings tab, click **New Mapping** and select **Forward Audience Event**.
44+
5. Under Define event trigger, click **Add Condition** and add this condition: Event Type is `Track` or `Identify`.
45+
6. Under **Map fields**, select the advertiser you want to sync the audience with. You can identify a specific advertiser by finding its ID in StackAdapt.
46+
![Image showing sample map fields](images/map-fields-example.png)
47+
48+
On StackAdapt platform:
49+
50+
To verify that your audience is syncing with StackAdapt, open StackAdapt and navigate to **Audience & Attribution** > **Customer Data** > **Profiles**. On the Profiles tab, you should be able to see a list of profiles being synced to StackAdapt platform.
51+
52+
> info "Syncs can take up to 4 hours"
53+
> It can take up to 4 hours from the time you initiate a sync for profiles to show up in StackAdapt.
54+
55+
If you want to create a StackAdapt Audience from your Twilio Engage Audience:
56+
57+
1. Open StackAdapt and navigate to **Audience & Attribution** > **Customer Data** > **Segments**, then click **Create Segment**.
58+
2. Choose **Segment Engage Audience ID** or **Segment Engage Audience Name** as the rule.
59+
3. Select the value for the corresponding filter.
60+
4. Click **Submit** to create the segment.
61+
62+
### Sending an Audience to StackAdapt
63+
64+
1. In Segment, go to Engage > Audiences and select the audience to sync with StackAdapt.
65+
2. Click **Add Destination** and select **StackAdapt Audience**.
66+
3. Toggle **Send Track** and **Send Identify** on.
67+
4. Click **Save**.
68+
69+
## Data and privacy
70+
71+
Review [StackAdapt's Data Processing Agreement](https://www.stackadapt.com/data-processing-agreement){:target="_blank"} to learn more about StackAdapt's privacy and data terms.

src/connections/destinations/catalog/actions-stackadapt-cloud/index.md

Lines changed: 17 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,14 @@ title: StackAdapt Destination
33
hide-boilerplate: true
44
hide-dossier: true
55
id: 61d8859be4f795335d5c677c
6-
redirect_from: '/connections/destinations/catalog/actions-stackadapt/'
6+
redirect_from: "/connections/destinations/catalog/actions-stackadapt/"
77
---
88

99
{% include content/plan-grid.md name="actions" %}
1010

11-
By setting up StackAdapt as a Segment destination, your Segment events will be forwarded to [StackAdapt](https://www.stackadapt.com/){:target="_blank"}. This allows you to generate retargeting and lookalike audiences, track conversions, and measure return on ad spend using your Segment events - bypassing the need to install the StackAdapt pixel on your website and write code to send events to StackAdapt.
12-
13-
This destination is maintained by StackAdapt. For any issues with the destination, please [submit a ticket to StackAdapt's support team](https://support.stackadapt.com/hc/en-us/requests/new?ticket_form_id=360006572593){:target="_blank"}.
11+
By setting up StackAdapt as a Segment destination, your Segment events will be forwarded to [StackAdapt](https://www.stackadapt.com/){:target="\_blank"}. This allows you to generate retargeting and lookalike audiences, track conversions, and measure return on ad spend using your Segment events - bypassing the need to install the StackAdapt pixel on your website and write code to send events to StackAdapt.
1412

13+
This destination is maintained by StackAdapt. For any issues with the destination, please [submit a ticket to StackAdapt's support team](https://support.stackadapt.com/hc/en-us/requests/new?ticket_form_id=360006572593){:target="\_blank"}.
1514

1615
## Getting started
1716

@@ -20,7 +19,7 @@ This destination is maintained by StackAdapt. For any issues with the destinatio
2019
1. Log in to your StackAdapt account and navigate to the Pixels page.
2120
2. Above the list of pixels, click **Install StackAdapt Pixel**.
2221

23-
![Image showing location of link to install Pixel](images/install-pixel-link.png)
22+
![Image showing location of link to install Pixel](images/install-pixel-link.png)
2423

2524
3. In the instructions that appear, copy the universal pixel ID from the code snippet. Below is an example of a code snippet where the universal pixel ID is `sqQHa3Ob1hFi__2EcYYVZg1`.
2625

@@ -41,9 +40,9 @@ This destination is maintained by StackAdapt. For any issues with the destinatio
4140

4241
Segment events that are forwarded to StackAdapt can be used to track ad conversions, and to generate retargeting and lookalike audiences. Please review the StackAdapt documentation for the general setup of these if you are not already familiar:
4342

44-
- [Creating Conversion Events](https://support.stackadapt.com/hc/en-us/articles/360005859214-Creating-Conversion-Events){:target="_blank"}
45-
- [Creating Retargeting Audiences](https://support.stackadapt.com/hc/en-us/articles/360005939153-Creating-Retargeting-Audiences){:target="_blank"}
46-
- [How to Generate and Target a Lookalike Audience](https://support.stackadapt.com/hc/en-us/articles/360023738733-How-to-Generate-and-Target-a-Lookalike-Audience){:target="_blank"}
43+
- [Creating Conversion Events](https://support.stackadapt.com/hc/en-us/articles/360005859214-Creating-Conversion-Events){:target="\_blank"}
44+
- [Creating Retargeting Audiences](https://support.stackadapt.com/hc/en-us/articles/360005939153-Creating-Retargeting-Audiences){:target="\_blank"}
45+
- [How to Generate and Target a Lookalike Audience](https://support.stackadapt.com/hc/en-us/articles/360023738733-How-to-Generate-and-Target-a-Lookalike-Audience){:target="\_blank"}
4746

4847
Setup of conversion events, retargeting audiences, and lookalike audiences that fire on Segment events is largely the same as the setup in the StackAdapt documentation, with a few caveats:
4948

@@ -64,7 +63,7 @@ A Segment event fired with the code `analytics.track("User Registered")` can be
6463
The StackAdapt destination also supports forwarding ecommerce fields for the purpose of creating event rules that match ecommerce events, with default mappings to properties specified in the [Segment V2 Ecommerce Event Spec](/docs/connections/spec/ecommerce/v2/) as described in the below table:
6564

6665
| Segment Ecommerce Event Property | StackAdapt Event Key |
67-
|----------------------------------|----------------------|
66+
| -------------------------------- | -------------------- |
6867
| `order_id` | `order_id` |
6968
| `revenue` | `revenue` |
7069
| `product_id` | `product_id` |
@@ -76,7 +75,7 @@ The StackAdapt destination also supports forwarding ecommerce fields for the pur
7675
For events that can involve multiple products, such as checkout events, StackAdapt forwards a JSON array of product objects with a `products` key and fields that map by default to following Segment product array fields:
7776

7877
| Segment Ecommerce Event Property | StackAdapt Product Object Key |
79-
|----------------------------------|-------------------------------|
78+
| -------------------------------- | ----------------------------- |
8079
| `products.$.product_id` | `product_id` |
8180
| `products.$.category` | `product_category` |
8281
| `products.$.name` | `product_name` |
@@ -110,7 +109,7 @@ analytics.track('Order Completed', {
110109
Although trait fields are not frequently used in event rules, the StackAdapt destination forwards them and they can be used if desired.
111110

112111
| Segment Trait Property | StackAdapt Event Key |
113-
|------------------------|----------------------|
112+
| ---------------------- | -------------------- |
114113
| `traits.email` | `email` |
115114
| `traits.first_name` | `first_name` |
116115
| `traits.last_name` | `last_name` |
@@ -123,13 +122,13 @@ For example, to create a conversion event when a user with the domain `example.c
123122
This rule would match a Segment event fired with code such as:
124123

125124
```javascript
126-
analytics.track('Order Completed', {
127-
order_id: '50314b8e9bcf000000000000',
125+
analytics.track("Order Completed", {
126+
order_id: "50314b8e9bcf000000000000",
128127
traits: {
129-
email: 'john.smith@example.com',
130-
first_name: 'John',
131-
last_name: 'Smith',
132-
phone: '+180055501000'
128+
email: "john.smith@example.com",
129+
first_name: "John",
130+
last_name: "Smith",
131+
phone: "+180055501000"
133132
}
134133
});
135134
```
@@ -167,4 +166,4 @@ When forwarding past events using Reverse ETL, only users who have interacted wi
167166

168167
## Data and privacy
169168

170-
Review [StackAdapt's Data Processing Agreement](https://www.stackadapt.com/data-processing-agreement){:target="_blank"} to learn more about StackAdapt's privacy and data terms.
169+
Review [StackAdapt's Data Processing Agreement](https://www.stackadapt.com/data-processing-agreement){:target="\_blank"} to learn more about StackAdapt's privacy and data terms.

0 commit comments

Comments
 (0)