Skip to content

Add sponsored tracking to the readme #152

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.

Sign up for GitHub

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 2 commits into from
Aug 7, 2025
Merged

Add sponsored tracking to the readme #152

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ac3151b
Add sponsored tracking to the readme
Aug 6, 2025
36d8c74
Small fixes
Aug 6, 2025
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
20 changes: 20 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -542,6 +542,16 @@ ConstructorIo.trackSearchResultClick("Fashionable Toothpicks", "1234567-AB", "to
ConstructorIo.trackSearchResultClick("Fashionable Toothpicks", "1234567-AB", "RED", "tooth", "Products", "179b8a0e-3799-4a31-be87-127b06871de2")
```

### Sponsored Search Events
Sponsored results can be identified by `is_retail_media = true` label
```kotlin
// Track when sponsored search results are loaded into view.
ConstructorIo.trackSearchResultsLoaded(term = "tooth", resultCount = 789, items = arrayOf(TrackingItem("item-1", "variation-1", "campaign-1", "owner-1"))

// Track when a sponsored search result is clicked
ConstructorIo.trackSearchResultClick(itemName = "Fashionable Toothpicks", customerId = "1234567-AB", searchTerm = "tooth", slCampaignId = "campaign-1", slCampaignOwner = "owner-1")
```

### Browse Events

```kotlin
Expand All @@ -560,6 +570,16 @@ ConstructorIo.trackBrowseResultClick("group_id", "Snacks", "7654321-BA", "4", "P
ConstructorIo.trackBrowseResultClick("group_id", "Snacks", "7654321-BA", "RED", "4", "Products", "179b8a0e-3799-4a31-be87-127b06871de2")
```

### Sponsored Browse Events
Sponsored results can be identified by `is_retail_media = true` label
```kotlin
// Track when sponsored browse results are loaded into view
ConstructorIo.trackBrowseResultsLoaded(filterName = "group_id", filterValue = "Snacks", items = arrayOf(TrackingItem("item-1", "variation-1", "campaign-1", "owner-1")), resultCount = 674)

// Track when a sponsored browse result is clicked
ConstructorIo.trackBrowseResultClick(filterName = "group_id", filterValue = "Snacks", customerId = "7654321-BA", "4", slCampaignId = "campaign-1", slCampaignOwner = "owner-1")
```

### Recommendation Events

```kotlin
Expand Down