feat: banners events

[agustinespildora]

Note

Ready to review.

Topsort Banner Events

This is a destination so that eCommerce sites that already use Segment (to track actions) can integrate Topsort events for sponsored listings seamlessly. With this PR we now add the events integration for banner ads too.

Intro to Topsort Banners

Topsort allows to monetize through banner auction ads served in your site. To learn more about Topsort you can visit our docs.
This destination already helps you track the 3 main events Topsort needs to serve the most relevant sponsored listing ads: impressions, clicks and purchases. Here is the new events we map for the banner events:

1. Banner Impression: Every time a user sees a Topsort promoted banner.
2. Banner Click: If the user then clicks on the banner, then a topsort click should be triggered with the banner resolvedBidId.
3. Product Impression: If the banner redirects to a PLP: every time a user sees a Topsort promoted product in the landing page of the banner. If the banner redirects to a PDP: every time the user sees the Topsort promoted banner.
4. Product Click: If the banner redirects to a PLP: every time a user clicks or adds to the cart a Topsort promoted product in the landing page of the banner. If the banner redirects to a PDP: every time the user clicks the Topsort promoted banner.
5. Purchase: [Already mapped] 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. For more information on banner attribution with Topsort you can go to https://api.docs.topsort.com/api-reference/examples/sponsored-banners/attribution

Testing

• Added additional attribution required fields
• Added banner impression event mapping
• Added unit tests for new functionality
• Tested end-to-end using the local server

End to end tests

Click event with additional attribution in local Action Tester

Impression event with additional attribution in local Action Tester

Banner Impression event with local Action Tester

Banner Click event with local Action Tester

[github-actions]

New required fields detected

Warning

Your PR adds new required fields to an existing destination. Adding new required settings/mappings for a destination already in production requires updating existing customer destination configuration. Ignore this warning if this PR is for a new destination with no active customers in production.

The following required fields were added in this PR:

• Destination: Topsort, Action Field(s):id,occurredAt,opaqueUserId,resolvedBidId
• Destination: Topsort, Action Field(s):id,occurredAt,opaqueUserId,resolvedBidId

Add these new fields as optional instead and assume default values in perform or performBatch block.

[anonvt]

LGTM