Zum Hauptinhalt springen

Documentation Index

Fetch the complete documentation index at: https://docs.topsort.com/llms.txt

Use this file to discover all available pages before exploring further.

Der Proxy ist eine Zwischenschicht zwischen dem Backend des Marktplatzes und dem Ergebnisserver (z.B. dem Algolia-Server). Er fungiert als Brücke zwischen dem Marktplatz, der Suchmaschine und Topsort. Dies ermöglicht es dem Proxy, Auktionsgewinner, die von Topsort abgerufen werden, in die von der Suchmaschine bereitgestellte Antwort zu integrieren und die endgültige zusammengeführte Antwort an den Marktplatz zurückzugeben. Der Proxy ist mit den meisten Technologie-Stacks kompatibel und wurde mit Plattformen wie VTEX, Algolia und Salesforce getestet.

​
Wie man den Proxy verwendet

Um den Proxy zu verwenden, müssen Sie einfach den Hostnamen in Ihrem bestehenden API-Aufruf von Ihrem Katalog oder Ihrer Suchmaschine zu unserem Proxy ändern. Zum Beispiel ändern Sie von: 
https://api.site.com/catalog/query?taxonomy=clothes
zu: 
https://site.proxy.topsort.com/catalog/query?taxonomy=clothes
Und wir kümmern uns um den Rest. Wir senden die Anfrage an die Auktionsmaschine von Topsort und an den Katalog oder die Suchmaschine. Wenn eines der vom Katalog oder der Suchmaschine zurückgegebenen Produkte beworben wird, werden wir dies in der zusammengeführten Antwort kennzeichnen, die wir erstellen und an den Marktplatz zurückgeben. Derzeit unterstützt der Proxy application/json-Antworten. Unterstützung für XML und GraphQL ist geplant.

​
Wie beworbene Produkte hinzugefügt werden

Betrachten Sie die folgende Anfrage, die Produkte aus der Taxonomie ‘office’ abruft: 
GET https://api.site.com/catalog/query?taxonomy=office
Die Antwort vom Katalog oder Suchserver ohne Topsort Proxy-Integration: 
{
  "products": [
    { "id": "1", "name": "Hochgeschwindigkeits-Farblaserdrucker" },
    { "id": "2", "name": "Höhenverstellbarer Stehschreibtisch" },
    { "id": "3", "name": "Ergonomischer Drehbürostuhl" },
    { "id": "4", "name": "Kabelloses Tastatur- und Maus-Set" },
    { "id": "5", "name": "Magnetisches Whiteboard mit Marker-Set" }
  ]
}
Nach der Zusammenführung beworbener Produkte in die Antwort: 
{
  "products": [
    {
      "id": "3",
      "name": "Ergonomischer Drehbürostuhl",
      "rank": 1,
      "resolvedBidId": "..."
    },
    {
      "id": "6",
      "name": "Mehrstufiger Aktenschrank",
      "rank": 2,
      "resolvedBidId": "..."
    },
    { "id": "1", "name": "Hochgeschwindigkeits-Farblaserdrucker" },
    { "id": "2", "name": "Höhenverstellbarer Stehschreibtisch" },
    { "id": "4", "name": "Kabelloses Tastatur- und Maus-Set" }
  ],
  "topsort": {
    "winners": [
      { "rank": 1, "type": "product", "id": "3", "resolvedBidId": "..." },
      { "rank": 2, "type": "product", "id": "6", "resolvedBidId": "..." }
    ]
  }
}

​
Die neuen Felder verstehen

  • rank: Die Position des beworbenen Produkts in der Auktion.
  • resolvedBidId: Eine eindeutige ID, die zur Verfolgung des Produkts in Analysen verwendet wird.
Ein neues Objekt namens topsort wird nur auf der Root-Ebene hinzugefügt, wenn beworbene Produkte enthalten sind.

​
Wie Ereignisse verfolgt werden

Wenn Sie die analytics.js-Bibliothek von Topsort oder die Events API verwenden, verwenden Sie die Felder product id und resolvedBidId, um Benutzerinteraktionen zu verfolgen: 
<div class="product" data-ts-product="3" data-ts-resolved-bid="resolvedBidId">
  ...
</div>

​
Proxy-Funktionen

  • Antwort-Caching: Reduziert die Latenz durch Caching erfolgreicher Antworten vom Katalog oder der Suchmaschine.
  • Staging-Modus: Ermöglicht Tests vor der Produktionsfreigabe.
  • Katalog-Synchronisierungsunterstützung: Sendet Informationen, um den Katalog von Topsort aktuell zu halten.
  • Integrierte Protokollierung: Sammelt Daten über Produkte, Auktionen und Leistung.