-
Notifications
You must be signed in to change notification settings - Fork 393
Setup guide for StackAdapt audience destination #7221
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
Changes from 6 commits
3accf62
1febc97
d564735
16f4240
65a9990
be6e8db
e25ea33
fa279f3
c6c8090
9b59611
19ab7f7
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
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 | ||||||||||
|
# id: 61d8859be4f795335d5c677c | |
id: 66e96b9f4ee97f41caa06487 |
forstisabella marked this conversation as resolved.
Show resolved
Hide resolved
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When you navigate to segment.com/docs/connections/destinations/catalog/actions-stackadapt/, it redirects to the existing StackAdapt destination. Was that behavior intentional?
redirect_from: "/connections/destinations/catalog/actions-stackadapt/" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The slug for this new Stackadapt Audience Destination is separate to the actions-stackadapt Destination.
The Stackadapt Audience Destination slug is: actions-stackadapt-audiences
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
okay great, then we should remove this line!
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[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. | |
[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. |
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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"}. |
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd like to include contact information here - would this link (https://support.stackadapt.com/hc/en-us/requests/new?ticket_form_id=360006572593) be the best way to contact the StackAdapt team? @Vanessa-SSY
If you do not have an API key, reach out to the StackAdapt team for help. | |
If you do not have an existing StackAdapt API key, reach out to the StackAdapt team for help. |
There was a problem hiding this comment.
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.
- Forward Profile - this is basically a Connections Action which sends user profile data to Stackadapt. This Action can be used with Connections Source.
- 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 ?
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@forstisabella Thanks! Approved
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we clarify that the Source should be the Engage Space?
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
5. Give the destination a name. | |
5. Enter a name for your destination. |
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
6. On the Settings screen, provide your StackAdapt Graphql API token. | |
6. On the Settings screen, provide your StackAdapt GraphQL API token. |
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
8. Click **Save Change**. | |
8. Click **Save Changes**. |
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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. | |
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). |
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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. | |
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. |
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
3. Open the previously created StackAdapt destination. | |
3. Open the previously created StackAdapt Audience destination. |
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
4. In the **Mappings** tab, click **New Mapping** and select **Forward Audience Event**. | |
4. On the Mappings tab, click **New Mapping** and select **Forward Audience Event**. |
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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` | |
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`. |
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we need this screenshot?
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. | |
 | |
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. | |
 |
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
2. Click Add Destination and select **StackAdapt Audience**. | |
2. Click **Add Destination** and select **StackAdapt Audience**. |
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
4. Click Save. | |
4. Click **Save**. |
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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. |
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -3,15 +3,14 @@ title: StackAdapt Destination | |||||
hide-boilerplate: true | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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"}. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
## Getting started | ||||||
|
||||||
|
@@ -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**. | ||||||
|
||||||
 | ||||||
 | ||||||
|
||||||
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`. | ||||||
|
||||||
|
@@ -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: | ||||||
|
||||||
|
@@ -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` | | ||||||
|
@@ -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` | | ||||||
|
@@ -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` | | ||||||
|
@@ -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" | ||||||
} | ||||||
}); | ||||||
``` | ||||||
|
@@ -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. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
There was a problem hiding this comment.
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 🤔
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@tcgilbert any insight on what the destination's ID should be?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
hi @forstisabella the ID is 66e96b9f4ee97f41caa06487