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

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,71 @@
---
title: StackAdapt Audience Destination
hide-boilerplate: true
hide-dossier: true
beta: true
id: 66e96b9f4ee97f41caa06487
hidden: true
forstisabella marked this conversation as resolved.
Show resolved Hide resolved
redirect_from: "/connections/destinations/catalog/actions-stackadapt-audiences/"
---

{% 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 Twilio Engage helps you sync user data to optimize targeting and improve your campaign outcomes.
Copy link
Contributor

@joe-ayoub-segment joe-ayoub-segment Nov 28, 2024

Choose a reason for hiding this comment

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

Should it say 'Twilio Engage' or 'Segment Engage' here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This was changed according to this comment from @forstisabella


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

## Getting started

### Getting your StackAdapt GraphQL Token

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

### 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 ?

Copy link
Contributor

Choose a reason for hiding this comment

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

I'd need the id for both actions to add a specific note to the autogenerated Available Actions section of this page. Do you happen to know the id for both actions @joe-ayoub-segment?

Copy link
Contributor

Choose a reason for hiding this comment

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

Hi @forstisabella :

Forward Audience Event = dkwweyGfhoSh7jWwSi9n4D
Forward Profile = 8mmGRhHeA8F2fzwNXVymNF

Copy link
Contributor

Choose a reason for hiding this comment

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

Hi @joe-ayoub-segment & @Vanessa-SSY: I opened a pull request to add in notes for each action. Please approve and merge when you have a minute!

StackAdapt#2

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@forstisabella Thanks! Approved


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 that is Engage Space to connect to the StackAdapt Audience destination.
5. Enter a name for your destination.
6. On the Settings screen, provide your StackAdapt GraphQL API token.
7. Toggle on the destination using the **Enable Destination** toggle.
8. Click **Save Changes**.
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).
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 have a valid email address. Profiles missing an email address are not valid on StackAdapt's platform.
2. Add a condition to the Engage audience to ensure the required email trait is included.
3. Open the previously created StackAdapt Audience destination.
4. On 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`.
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.
![Image showing sample map fields](images/map-fields-example.png)

On StackAdapt platform:

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.

> info "Syncs can take up to 4 hours"
> It can take up to 4 hours from the time you initiate a sync for profiles to show up in StackAdapt.

If you want to create a StackAdapt Audience from your Twilio Engage Audience:

1. Open StackAdapt and navigate to **Audience & Attribution** > **Customer Data** > **Segments**, then click **Create Segment**.
2. Choose **Segment Engage Audience ID** or **Segment Engage Audience Name** as the rule.
3. Select the value for the corresponding filter.
4. Click **Submit** to create the segment.

### 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
Contributor 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"}.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
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"}.
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: '[email protected]',
first_name: 'John',
last_name: 'Smith',
phone: '+180055501000'
email: "[email protected]",
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.
Copy link
Contributor

Choose a reason for hiding this comment

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

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

Loading