SDK JavaScript

npm install @topsort/sdk

import { TopsortClient } from "@topsort/sdk";

<script type="module">
  import { TopsortClient } from "https://unpkg.com/@topsort/sdk@0.5.0/dist/index.js";

  // The examples below go here.
</script>

const topsortClient = new TopsortClient({ apiKey: "TSE_XXXXXXXXXXXX" }); // Replace with your Topsort API key

const auctionDetails = {
  auctions: [
    {
      type: "listings",
      slots: 3,
      searchQuery: "winter",
    },
    {
      type: "banners",
      slots: 1,
      device: "desktop",
      slotId: "slot123",
    },
  ],
};

let auctionResult;
try {
  auctionResult = await topsortClient.createAuction(auctionDetails);
} catch (error) {
  console.error("Auction Error", error);
}

const opaqueUserId = "<YOUR_OPAQUE_USER_ID>"; // The same persistent id for this shopper
const placement = { path: "/search/winter" };
const winners = auctionResult?.results.flatMap((result) => result.winners || []) ?? [];

function toEvent(winner) {
  return {
    resolvedBidId: winner.resolvedBidId,
    id: crypto.randomUUID(),
    occurredAt: new Date().toISOString(),
    opaqueUserId,
    placement,
  };
}

// Right after inserting the winners into the page
topsortClient
  .reportEvent({ renders: winners.map(toEvent) })
  .then((result) => console.log("Event Result", result))
  .catch((error) => console.error("Event Error", error));

// When a winner becomes visible, for example from an IntersectionObserver callback
function reportImpression(winner) {
  topsortClient
    .reportEvent({ impressions: [toEvent(winner)] })
    .then((result) => console.log("Event Result", result))
    .catch((error) => console.error("Event Error", error));
}

// From the click handler of a winner's element
function reportClick(winner) {
  topsortClient
    .reportEvent({ clicks: [toEvent(winner)] })
    .then((result) => console.log("Event Result", result))
    .catch((error) => console.error("Event Error", error));
}

topsortClient
  .reportEvent({
    purchases: [
      {
        id: "<Marketplace id for the purchase>",
        occurredAt: new Date().toISOString(),
        opaqueUserId,
        items: [{ productId: "p_Mfk11", quantity: 1, unitPrice: 49.99 }],
      },
    ],
  })
  .then((result) => console.log("Event Result", result))
  .catch((error) => console.error("Event Error", error));

function reportWithRetry(event) {
  return topsortClient
    .reportEvent(event)
    .then((result) => {
      if (result.retry) {
        console.warn("Transient error. Retry the call.");
      }
      return result;
    })
    .catch((error) => console.error("Event Error", error));
}