-
Notifications
You must be signed in to change notification settings - Fork 393
[TOPSORT] added topsort events destination docs #6952
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
Merged
Merged
Changes from 11 commits
Commits
Show all changes
23 commits
Select commit
Hold shift + click to select a range
3d3b972
feat: added topsort destination docs (#2)
agustinespildora 8167d46
Remove comment
agustinespildora 815e9b5
Syntax and spelling
agustinespildora c9f4bf4
Added description afterwards
agustinespildora 058de97
delete comment
agustinespildora 639fb6c
Syntax and spelling
agustinespildora 5c98cb9
Syntax and spelling
agustinespildora a48c2f8
Syntax and spelling
agustinespildora 2aa03d9
Syntax and spelling
agustinespildora 99be1b6
Syntax and spelling
agustinespildora 47086c8
Syntax and spelling
agustinespildora b41412f
add snippet to populate action tables
agustinespildora 4a9df4d
spelling and redaction
agustinespildora 9adb4f6
spelling and redaction
agustinespildora 93aee71
feat: added topsort destination docs (#3)
agustinespildora f84a529
spelling and redaction fix
agustinespildora d603aef
spelling and redaction fix
agustinespildora 00b7134
spelling and redaction fix
agustinespildora 62242c2
move section
agustinespildora 8c25b29
remove automated status
agustinespildora 71da8aa
move section
agustinespildora 5507716
changed folder name to destination slug (#5)
agustinespildora 85a0e38
lint fix (#6)
agustinespildora File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,58 @@ | ||
--- | ||
title: Topsort Events Destination | ||
id: 66ba237845b93b71bca2713e | ||
beta: true | ||
--- | ||
|
||
[Topsort](https://www.topsort.com){:target="_blank"} is an AI-powered retail media platform enabling retailers and marketplaces to build their own high-performing ad networks, rivaling Google and Amazon. With its advanced auto-bidding algorithm and fast integration, Topsort provides an advertising solution that delivers exceptional returns on ad spend (ROAS) while respecting users privacy by being cookie-less. | ||
|
||
agustinespildora marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
This is a destination for eCommerce sites that want to use Segment or are already using it to Track actions on their site. It helps you seamlessly integrate Topsort events for sponsored listings. | ||
Setting up an events integration is one of the 3 steps to integrate with Topsort (see [Integration Overview](https://docs.topsort.com/reference/integration-overview){:target="_blank"} for more details). It allows marketplaces to have a full metrics report available through Topsort's Reporting API or directly in the [Topsort Manager Platform](https://app.topsort.com){:target="_blank"} dashboards. It also provides the necessary information for the Topsort team to display relevant ads, optimize budget consumption, attribute purchases and accomplish sellers' conversion goals. | ||
|
||
This destination is maintained by Topsort. For any issues with the destination, [contact the Topsort Support team](mailto:[email protected]){:target="_blank"}. | ||
|
||
|
||
## Getting started | ||
|
||
### Intro to Topsort Events | ||
|
||
This destination helps you track the 3 main events Topsort needs to serve the most relevant ads and accomplish attribution for sponsored listings: `impressions`, `clicks` and `purchases`. Here is an explanation of what each one of these means to Topsort: | ||
|
||
1. **Impression**: Every time a user sees a promoted product in a listing page (PLP) or section. | ||
2. **Click**: If the user then clicks or adds the promoted product to a cart, then a `click` should be triggered. | ||
3. **Purchase**: Finally, when an order is completed and confirmed to be successful, a `purchase` event should be reported to Topsort. You can report a purchase whether it has promoted products or not. We will take care of filtering relevant promoted products inside the completed order given the information about promoted clicks. | ||
agustinespildora marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
This destination has 3 default presets that map the Track events `'Product Viewed'`, `'Product Clicked'` and `'Order Completed'` to Topsort's `impression`, `click` and `purchase` events respectively. If you’re not familiar with the Segment Spec, take a look to understand what the [Track method](/docs/connections/spec/track/) does. The mappings in the Topsort destination are built based on the Segment [Ecommerce Spec](/docs/connections/spec/ecommerce/v2/). If you have different Segment Track events mapped to these action definitions then we can adapt this destination to your case. Once the destination is configured make sure to activate only the mappings relevant to your site, see point 5 of the [set up](#set-up-your-topsort-destination). | ||
agustinespildora marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
You don't need to change anything about the way you report Track events to Segment. The only extra field you need to provide, only for the `impression` and `click` events, is the `resolvedBidId` given in the winner promoted product (whether it is from the [Auctions API](https://docs.topsort.com/reference/createauctions){:target="_blank"} or the [proxy](https://docs.topsort.com/reference/listings-low-code){:target="_blank"} response). Please find below an example call to track a product listing page (PLP) click event with the `resolvedBidId` included: | ||
|
||
```js | ||
analytics.track("Product Clicked", { | ||
product_id: product.id, | ||
name: product.name, | ||
resolvedBidId: product.resolvedBidId | ||
}); | ||
``` | ||
agustinespildora marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
### Set up your Topsort destination | ||
|
||
1. From the Segment web app, click **Catalog**, then click **Destinations**. | ||
2. Search for "Topsort" in the Catalog, select it, and choose which of your sources to connect the destination to. | ||
3. In the [Topsort Manager Platform](https://app.topsort.com){:target="_blank"}, go to [Settings > API Integration](https://app.topsort.com/new/es/marketplace/account-settings/api-integration){:target="_blank"} to find or create your **Marketplace API Key** for auctions and events. | ||
4. Return to the Topsort destination in the Segment app and enter the value for your **Marketplace API Key**. | ||
5. Enable only the Track events relevant to your site and so that the events do not get duplicated with a single user action. For example, if you always trigger a `Product Clicked` event together with the `Product Added` event when a user makes a click in the "Add to cart" button, then you should enable only the `Product Clicked` event for the Topsort Destination. | ||
|
||
agustinespildora marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
### Identify | ||
|
||
Topsort recommends that you identify your logged-in users using Segment's [Identify method](/docs/connections/spec/identify/) and that you hash the user ID before sending it to Topsort. | ||
agustinespildora marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
Please find an example Identify call below: | ||
|
||
```js | ||
analytics.identify('361b1fdfbeaa9d64a13c033eb9f970dc6740f6bc', { | ||
email: '[email protected]' | ||
}); | ||
``` | ||
|
||
Once a user is identified, each call to Segment's [Track method](/docs/connections/spec/track/) automatically records the user ID. | ||
Users that are not logged in can be tracked using an [anonymousID](/docs/connections/spec/identify/#anonymous-id). | ||
agustinespildora marked this conversation as resolved.
Show resolved
Hide resolved
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.