Zum Hauptinhalt springen
In diesem Beispiel verwenden wir die API, um eine Auktion für ein Set von Produkten durchzuführen. Nur Gebote, die auf die Produkte in diesem Set abzielen, haben eine Chance, diese Auktion zu gewinnen. Gebote, die auf andere Produkte abzielen, werden nicht teilnehmen. Dies gibt Ihnen volle Kontrolle darüber, welche Produkte wo angezeigt werden, während Sie Ihren Verkäufern ermöglichen, Produkte zu bewerben.

Anwendungsfall

Wir schreiben nicht vor, wie Sie Ihr Produktset erstellen - Sie können jeden gewünschten Algorithmus verwenden. Alles, was wir brauchen, ist eine Liste von Produkt-IDs. Verwenden Sie zum Beispiel Ihren eigenen Algorithmus, um Folgendes zu generieren:
  • Cross-Sells.
  • Verwandte Produkte.
  • Upsells an der Kasse.
Sammeln Sie die resultierenden IDs und übergeben Sie sie an eine Auktion. Ihre Verkäufer können dann bieten, um an wertvollen Positionen auf dem Marketplace zu erscheinen.

API-Aufruf-Beispiel

Anfrage

Angenommen, wir verwenden eine Art Algorithmus, um ein Set von Produkt-IDs zu erstellen. Wir können diese dann an eine Auktionsanfrage übergeben:
{
  "auctions": [
    {
      "type": "listings",
      "slots": 2,
      "products": {
        "ids": ["p_PJbnN", "p_ojng4", "p_8VKDt", "p_Mfk15"]
      }
    }
  ]
}
Die obige Anfrage erstellt eine einzelne Listings-Auktion:
  • Sie hat aufgrund des slots-Feldes maximal zwei Gewinner.
  • Das products.ids ist das Produktset. Diese müssen in Ihrem Katalog existieren.
Wie bereits erwähnt, werden nur Gebote, die auf diese Produkte abzielen, an der Auktion teilnehmen. Der Auktions-Endpoint unterstützt bis zu 10.000 Produkt-IDs pro Auktion, aber wir empfehlen, nicht mehr als 500 der relevantesten zu senden.

Hinzufügen benutzerdefinierter Quality Scores

Manchmal möchten Sie möglicherweise benutzerdefinierte Quality Scores für jedes Produkt einbeziehen. Der Quality Score ist eine Zahl zwischen 0 und 1, die die Relevanz der teilnehmenden Produkte codiert. Die Verwendung von Quality Scores hilft, Risiken und Verluste durch irrelevante Produkte, die Auktionen gewinnen, zu mindern. Um benutzerdefinierte Quality Scores in die Anfrage aufzunehmen, ändern Sie das products-Feld wie unten gezeigt:
{
  "auctions": [
    {
      "type": "listings",
      "slots": 2,
      "products": {
        "ids": ["p_PJbnN", "p_ojng4", "p_8VKDt", "p_Mfk15"],
        "qualityScores": [0.5, 0.4, 0.7, 0.6]
      }
    }
  ]
}
In diesem Beispiel:
  • Produkt p_PJbnN hat einen Quality Score von 0.5.
  • Produkt p_ojng4 hat einen Quality Score von 0.4.
  • Produkt p_8VKDt hat einen Quality Score von 0.7.
  • Produkt p_Mfk15 hat einen Quality Score von 0.6.
Wichtig: Die Anzahl der Quality Scores muss mit der Anzahl der Produkt-IDs übereinstimmen. Wenn sie nicht übereinstimmen, schlägt die Anfrage fehl. Warnung: Sie können nicht Quality Scores und eine Suchanfrage einbeziehen. Obwohl die Durchführung einer Auktion mit einer Suchanfrage und einem Produktset erlaubt ist, kann die Anfrage keine benutzerdefinierten Quality Scores enthalten.

Antwort

Diese Antwort nicht cachen oder ihre Ergebnisse. Auktionen müssen pro Seitenaufruf eindeutig sein, das ist es, was das System zum Funktionieren bringt.Wenn Auktionsergebnisse gecacht werden, könnten dieselben Ergebnisse mehreren Benutzern oder demselben Benutzer mehrmals angezeigt werden.
Wenn Gebote existieren, die auf die Produkte abzielen, könnten sie diese Auktion gewinnen. Die resultierende Antwort würde etwa so aussehen:
{
  "results": [
    {
      "winners": [
        {
          "rank": 1,
          "type": "product",
          "id": "p_Mfk15",
          "resolvedBidId": "WyJiX01mazE1IiwiMTJhNTU4MjgtOGVhZC00Mjk5LTgzMjctY2ViYjAwMmEwZmE4IiwibGlzdGluZ3MiLCJkZWZhdWx0IiwiIl0="
        },
        {
          "rank": 2,
          "type": "product",
          "id": "p_PJbnN",
          "resolvedBidId": "WyJlX1BKYm5OIiwiMTJhNTU4MjgtOGVhZC00Mjk5LTgzMjctY2ViYjAwMmEwZmE4IiwibGlzdGluZ3MiLCJkZWZhdWx0IiwiIl0="
        }
      ],
      "error": false
    }
  ]
}
Beachten Sie hier:
  • Der Typ der Gewinner ist product, da wir eine Listings-Auktion durchführen.
  • Beide Gewinner-ids entsprechen einer Produkt-ID in der Anfrage.
  • Es gibt zwei Gewinner, das Maximum, das durch das slots-Feld in der Anfrage erlaubt ist.

Nächste Schritte

Die Gewinner müssen mit Produktdaten kombiniert werden, um ein Ergebnis zu erstellen, das dem Endbenutzer angezeigt werden kann. Siehe diese Seite für ein Beispiel.