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

Conversation

Vanessa-SSY
Copy link
Contributor

Proposed changes

Adding setup guide for StackAdapt audience destination

Merge timing

Related issues (optional)

@Vanessa-SSY Vanessa-SSY requested a review from a team as a code owner November 13, 2024 07:23
@Vanessa-SSY Vanessa-SSY requested a review from pwseg November 13, 2024 07:23
@seg-atlantis-prod
Copy link

Atlantis commands can't be run on fork pull requests. To enable, set --allow-fork-prs or, to disable this message, set --silence-fork-pr-errors

@seg-atlantis-prod
Copy link

Error parsing command: EOF found when expecting closing quote

@seg-atlantis-prod
Copy link

Atlantis commands can't be run on fork pull requests. To enable, set --allow-fork-prs or, to disable this message, set --silence-fork-pr-errors

@seg-atlantis-prod
Copy link

Error parsing command: EOF found when expecting closing quote

Copy link

netlify bot commented Nov 13, 2024

Deploy Preview for segment-docs ready!

Name Link
🔨 Latest commit 1febc97
🔍 Latest deploy log https://app.netlify.com/sites/segment-docs/deploys/67345400f64a1b0008310405
😎 Deploy Preview https://deploy-preview-7221--segment-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@pwseg pwseg requested a review from tcgilbert November 13, 2024 15:24
@seg-atlantis-prod
Copy link

Atlantis commands can't be run on fork pull requests. To enable, set --allow-fork-prs or, to disable this message, set --silence-fork-pr-errors

@seg-atlantis-prod
Copy link

Error parsing command: EOF found when expecting closing quote

@seg-atlantis-prod
Copy link

Atlantis commands can't be run on fork pull requests. To enable, set --allow-fork-prs or, to disable this message, set --silence-fork-pr-errors

@seg-atlantis-prod
Copy link

Error parsing command: EOF found when expecting closing quote

@seg-atlantis-prod
Copy link

Atlantis commands can't be run on fork pull requests. To enable, set --allow-fork-prs or, to disable this message, set --silence-fork-pr-errors

@seg-atlantis-prod
Copy link

Error parsing command: EOF found when expecting closing quote

@@ -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-boilerplate: true
hide-dossier: true
beta: true
# id: 61d8859be4f795335d5c677c
Copy link
Contributor 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.

Copy link
Contributor

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?

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 the ID is 66e96b9f4ee97f41caa06487


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 ?

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

@seg-atlantis-prod
Copy link

Atlantis commands can't be run on fork pull requests. To enable, set --allow-fork-prs or, to disable this message, set --silence-fork-pr-errors

@seg-atlantis-prod
Copy link

Error parsing command: EOF found when expecting closing quote

hide-boilerplate: true
hide-dossier: true
beta: true
# id: 61d8859be4f795335d5c677c
Copy link
Contributor

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?

beta: true
# id: 61d8859be4f795335d5c677c
hidden: true
redirect_from: "/connections/destinations/catalog/actions-stackadapt/"
Copy link
Contributor

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?

Suggested change
redirect_from: "/connections/destinations/catalog/actions-stackadapt/"

Copy link
Contributor

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

Copy link
Contributor

@forstisabella forstisabella Nov 21, 2024

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!


{% 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.
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
[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.


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

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.
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
4. Click Save.
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.
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.


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

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


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.

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?

hide-boilerplate: true
hide-dossier: true
beta: true
# id: 61d8859be4f795335d5c677c
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
# id: 61d8859be4f795335d5c677c
id: 66e96b9f4ee97f41caa06487

@tcgilbert
Copy link
Contributor

@Vanessa-SSY if you could merge this PR: StackAdapt#2

Then I can approve, and we can proceed with merging on our side.

tcgilbert
tcgilbert previously approved these changes Nov 27, 2024

{% 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

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

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?

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`. Click **Add Condition** and add this condition: Event Name is `Audience Entered` or `Audience Exited`.
Copy link
Contributor

Choose a reason for hiding this comment

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

Technically there is no need to mention anything about Audience Entered or Audience Exited. I think it will just confuse the customer.

You could just saw that the Event Name for track() events is irrelevant.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

removed

@Vanessa-SSY Vanessa-SSY force-pushed the vs/setup-guide-for-stackadapt-audience-destination branch from 2882542 to c6c8090 Compare November 28, 2024 16:15
@seg-atlantis-prod
Copy link

Atlantis commands can't be run on fork pull requests. To enable, set --allow-fork-prs or, to disable this message, set --silence-fork-pr-errors

@seg-atlantis-prod
Copy link

Error parsing command: EOF found when expecting closing quote

@joe-ayoub-segment
Copy link
Contributor

hi @forstisabella could you take another look at this PR? It is looking OK to publish?

@forstisabella
Copy link
Contributor

hi @forstisabella could you take another look at this PR? It is looking OK to publish?

two small changes and we'll be g2g!

@seg-atlantis-prod
Copy link

Atlantis commands can't be run on fork pull requests. To enable, set --allow-fork-prs or, to disable this message, set --silence-fork-pr-errors

@seg-atlantis-prod
Copy link

Error parsing command: EOF found when expecting closing quote

@seg-atlantis-prod
Copy link

Atlantis commands can't be run on fork pull requests. To enable, set --allow-fork-prs or, to disable this message, set --silence-fork-pr-errors

@seg-atlantis-prod
Copy link

Error parsing command: EOF found when expecting closing quote

@Vanessa-SSY
Copy link
Contributor Author

@forstisabella updated!

@Vanessa-SSY
Copy link
Contributor Author

Can someone help merge and deploy this PR?

@forstisabella forstisabella merged commit d0f1e15 into segmentio:develop Dec 3, 2024
4 checks passed
Copy link
Contributor

github-actions bot commented Dec 3, 2024

Thank you for your contribution! Your pull request is merged, but may take a day or two to appear on the site.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants