Auktionen durchführen

Erfahren Sie, wie Sie die Auction API verwenden, um Auktionen für Listings und Banner zu erstellen.

Die Auction API ermöglicht es Ihnen, eine Vielzahl von Auktionen zu erstellen.

Egal, ob Sie gesponserte Listings in Suchergebnisse einbinden oder Banner auf Ihrer Homepage anzeigen möchten, wir haben alles für Sie.

Bevor Sie beginnen

Bevor Sie bereit sind, die Auction API zu verwenden, müssen Sie:

1. Einen API-Schlüssel erhalten zur Authentifizierung.
2. Mehrere Kampagnen erstellen, um Gebote für Auktionen verfügbar zu haben.

Anfrage

Der /auctions Endpoint ermöglicht es Ihnen, bis zu 5 Auktionen in einer einzigen Anfrage durchzuführen.

Die vollständige Spezifikation für diesen Endpoint finden Sie hier.

Das kann zunächst viel sein, also bleiben wir erst einmal bei den Grundlagen.

Jeder Anfrage-Body muss im JSON-Format bereitgestellt werden und ist in der Regel wie folgt strukturiert.

{
  "auctions": [
    {
      "type": "listings",
      "slots": 2
    },
    {
      "type": "banners",
      "slots": 1
    }
  ]
}

Es gibt mehrere interessante Dinge an diesem (unvollständigen) Ausschnitt:

• Auktionen werden als Array im auctions-Feld bereitgestellt. Sie können 1 bis 5 Auktionen in einer einzigen Anfrage bereitstellen.
• Jede Auktion hat einen type, der bestimmt, ob es sich um eine Listings- oder Banner-Auktion handelt.
• Jede Auktion hat ein slots-Feld, das die maximale Anzahl von Auktionsgewinnern bestimmt.

Um den obigen Ausschnitt zu vervollständigen, müssen Sie weitere Felder hinzufügen. Siehe Sponsored Listings-Beispiel oder Sponsored Banners-Beispiel für weitere Informationen.

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 es keine Anfragefehler gibt, gibt der Auktions-Endpoint die Ergebnisse für jede Auktion zurück.

Eine erfolgreiche Antwort bedeutet nicht, dass jede Auktion erfolgreich war oder Gewinner hat. Sie müssen die Ergebnisse überprüfen, um dies festzustellen.

Antwort mit Gewinnern

Angenommen, beide Auktionen aus der vorherigen Anfrage haben Gewinner, könnte die Antwort so aussehen:

{
  "results": [
    {
      "winners": [
        {
          "rank": "1",
          "resolvedBidId": "WyJiX01mazE1IiwiMTJhNTU4MjgtOGVhZC00Mjk5LTgzMjctY2ViYjAwMmEwZmE4IiwibGlzdGluZ3MiLCJkZWZhdWx0IiwiIl0="
        },
        {
          "rank": "2",
          "resolvedBidId": "WyJlX1hKYm5OIiwiMTNiNTU4MjgtOGVhZC00Mjk5LTgzMjctY2ViYjAwMmEwZmE4IiwibGlzdGluZ3MiLCJkZWZhdWx0IiwiIl0=="
        }
      ],
      "error": false
    },
    {
      "winners": [
        {
          "rank": "1",
          "resolvedBidId": "WyJzb21lLXNsb3QiLCIxM2I1NTgyOC04ZWFkLTQyOTktODMyNy1jZWJiMDAyYTBmYTgiLCJiYW5uZXJzIiwiZGVmYXVsdCIsIiJd=="
        }
      ],
      "error": false
    }
  ]
}

Hinweise zu dieser Antwort:

• Die Auktionsergebnisse befinden sich unter einer Top-Level-Eigenschaft results.
• Die Reihenfolge der Ergebnisse entspricht der Reihenfolge der Auktionen.
• Jedes Ergebnis hat ein Array von Gewinnern. Dieses Array kann leer sein und wird nie größer als die slots der Auktion sein.
• Es ist möglich, dass Auktionen unabhängig voneinander fehlschlagen/erfolgreich sind. Das error-Flag zeigt an, ob eine Auktion erfolgreich war.

Die genauen Felder bei den Gewinnern hängen vom Auktionstyp ab, aber sie haben immer:

• rank eine 1-basierte Zahl, die ihrer Position in winners entspricht.
• resolvedBidId identifiziert das Gebot, das diesen Gewinner gewonnen hat. Diese ID wird verwendet, um die Auktion mit Events zu verknüpfen.

Antwort ohne Gewinner

Es ist nicht garantiert, dass eine Auktion Gewinner hat. Wenn es keine aktiven Kampagnen gibt, die ihren Kriterien entsprechen, gibt es keine Gebote zu platzieren.

Wenn unsere vorherige Auktionsanfrage keine Gewinner für eine oder beide Auktionen hätte, würde ihre Antwort so aussehen:

{
  "results": [
    {
      "winners": [],
      "error": false
    },
    {
      "winners": [],
      "error": false
    }
  ]
}

Beachten Sie, dass diese Antwort immer noch Ergebnisse für beide Auktionen enthält.

Weiterführende Literatur

Sehen Sie sich die anderen Seiten in diesem Abschnitt an, um vollständige Beispiele für verschiedene Anwendungsfälle zu sehen.