Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Setup guide for StackAdapt audience destination #7221

Open
wants to merge 7 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
---
title: StackAdapt Audience Destination
hide-boilerplate: true
hide-dossier: true
beta: true
# id: 61d8859be4f795335d5c677c
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure what this ID should be 🤔

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's OK the Docs team will fix that.

hidden: true
redirect_from: "/connections/destinations/catalog/actions-stackadapt/"
---

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

[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 Segment Engage helps you sync user data to optimize targeting and improve your campaign outcomes.

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"}.

## Getting started

### Getting your StackAdapt GraphQL Token

If you do not have an API key, reach out to the StackAdapt team for help.

### Setting up the StackAdapt Audience destination in Segment Engage
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note for Docs team reviewer.

This Destination has 2 Actions.

  1. Forward Profile - this is basically a Connections Action which sends user profile data to Stackadapt. This Action can be used with Connections Source.
  2. Forward Audience Event - this syncs Engage Audiences to Stackadapt. This Action can only be used with Engage Audiences.

I'm thinking that might need some specific wording to explain that this Destination the different use-cases for each of these Actions, the different Sources for each (Connections Vs Engage Audience), and the different setup steps for each.

Is this something you can edit into this PR? Or would you like assistance from me or @Vanessa-SSY ?


1. From the Segment web app, navigate to **Connections > Catalog > Destinations**.
2. Search for and select the "StackAdapt Audience" destination.
3. Click **Add Destination**.
4. Select an existing source to connect to the StackAdapt Audience destination.
5. Give the destination a name.
6. On the Settings screen, provide your StackAdapt Graphql API token.
7. Toggle on the destination using the **Enable Destination** toggle.
8. Click **Save Change**.
9. Follow the steps in the Destinations Actions documentation to [customize mappings](/docs/connections/destinations/actions/#customize-mappings) or follow the steps below to Sync an Engage Audience.
10. Enable the destination and click **Save Changes**.

### Sync an Engage Audience

To sync an Engage audience with StackAdapt:

1. Each Engage audience should only contain profiles that meet StackAdapt’s targeting criteria. Each profile in the Engage audience must have a valid email address to be considered as a valid profile in the StackAdapt platform. Profiles missing an email address will not be valid on StackAdapt platform.
2. Add a condition to the Engage audience to ensure the required email trait is included.
3. Open the previously created StackAdapt destination.
4. In the **Mappings** tab, click **New Mapping** and select **Forward Audience Event**.
5. Under **Define event trigger**, click **Add Condition** and add this condition: **Event Type** is **Track** or **Identify**. Click **Add Condition** and add this condition: **Event Name** is `Audience Entered` or `Audience Exited`
6. Under **Map fields**, select the advertiser you want to sync the audience under. You can look for the advertiser by its ID on StackAdapt platform.
![Image showing sample map fields](images/map-fields-example.png)

On StackAdapt platform:

1. Under **Audience & Attribution** > **Customer Data** > **Profiles**, you should be able to see a list of profiles being synced to StackAdapt platform.
2. Under **Audience & Attribution** > **Customer Data** > **Segments**, on the top right corner, click **Create Segment**.
3. Set the rules [Check with audience team on this]
4. Under **Audience & Attribution** > **Customer Data** > **Profiles**, you should be able to see a list of profiles being synced to StackAdapt platform. Please note that it can take up to 4 hours for profiles to show in the StackAdapt platform.

### Sending an Audience to StackAdapt

1. In Segment, go to Engage > Audiences and select the audience to sync with StackAdapt.
2. Click Add Destination and select **StackAdapt Audience**.
3. Toggle **Send Track** and **Send Identify** on.
4. Click Save.

## Data and privacy

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.
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,14 @@ title: StackAdapt Destination
hide-boilerplate: true
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All changes in this files are result of auto-linter on save

hide-dossier: true
id: 61d8859be4f795335d5c677c
redirect_from: '/connections/destinations/catalog/actions-stackadapt/'
redirect_from: "/connections/destinations/catalog/actions-stackadapt/"
---

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

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.

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"}.
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.

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"}.

## Getting started

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

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

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`.

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

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:

- [Creating Conversion Events](https://support.stackadapt.com/hc/en-us/articles/360005859214-Creating-Conversion-Events){:target="_blank"}
- [Creating Retargeting Audiences](https://support.stackadapt.com/hc/en-us/articles/360005939153-Creating-Retargeting-Audiences){:target="_blank"}
- [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"}
- [Creating Conversion Events](https://support.stackadapt.com/hc/en-us/articles/360005859214-Creating-Conversion-Events){:target="\_blank"}
- [Creating Retargeting Audiences](https://support.stackadapt.com/hc/en-us/articles/360005939153-Creating-Retargeting-Audiences){:target="\_blank"}
- [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"}

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:

Expand All @@ -64,7 +63,7 @@ A Segment event fired with the code `analytics.track("User Registered")` can be
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:

| Segment Ecommerce Event Property | StackAdapt Event Key |
|----------------------------------|----------------------|
| -------------------------------- | -------------------- |
| `order_id` | `order_id` |
| `revenue` | `revenue` |
| `product_id` | `product_id` |
Expand All @@ -76,7 +75,7 @@ The StackAdapt destination also supports forwarding ecommerce fields for the pur
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:

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

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

```javascript
analytics.track('Order Completed', {
order_id: '50314b8e9bcf000000000000',
analytics.track("Order Completed", {
order_id: "50314b8e9bcf000000000000",
traits: {
email: 'john.smith@example.com',
first_name: 'John',
last_name: 'Smith',
phone: '+180055501000'
email: "john.smith@example.com",
first_name: "John",
last_name: "Smith",
phone: "+180055501000"
}
});
```
Expand Down Expand Up @@ -167,4 +166,4 @@ When forwarding past events using Reverse ETL, only users who have interacted wi

## Data and privacy

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