Zum Hauptinhalt springen
Die Sponsored Brand Auction API ermöglicht es Ihnen, Auktionen durchzuführen, um Marken mit Assets, Text und zugehörigen Produkten zu bewerben.

​
Bevor Sie beginnen

Um die Sponsored Brand Auction API zu verwenden, stellen Sie sicher, dass Sie die folgenden Schritte abgeschlossen haben:
  1. Einen API-Schlüssel erhalten zur Authentifizierung.
  2. Mehrere Kampagnen erstellen, um Gebote für Auktionen verfügbar zu haben.

​
Anfrage

Der /auctions/sponsored-brand Endpoint ermöglicht es Ihnen, Auktionen für Sponsored Brand-Platzierungen durchzuführen. Die vollständige Spezifikation für diesen Endpoint finden Sie in der API-Dokumentation.

​
Beispielanfrage

{
  "auctions": [
    {
      "winners": 2,
      "placementId": "some-placement",
      "triggers": {
        "products": {
          "ids": ["1", "8"]
        }
      }
    }
  ]
}

​
Beispielanfrage mit Geo-Targeting

{
  "auctions": [
    {
      "winners": 2,
      "placementId": "some-placement",
      "triggers": {
        "searchQuery": "electronics"
      },
      "geoTargeting": "new-york",
      "opaqueUserId": "user-123"
    }
  ]
}

​
Wichtige Felder:

  • auctions: Ein Array mit Auktionsobjekten.
  • winners: Die maximale Anzahl von Gewinnern für die Auktion.
  • placementId: Die ID der Platzierung, wo die Anzeige erscheinen wird.
  • triggers: Targeting-Kriterien einschließlich:
    • products.ids: Ein Array von Produkt-IDs, die mit der Auktion verbunden sind.
    • searchQuery: Suchbegriffe für Keyword-basiertes Targeting.
    • category.id: Produktkategorie für breiteres Targeting.
  • geoTargeting: (Optional) Geografischer Standortidentifikator für standortbasierte Kampagnenfilterung.
  • opaqueUserId: (Optional) Anonymer Benutzeridentifikator für erweiterte Personalisierung und Targeting.

​
Antwort

Diese Antwort nicht cachen oder ihre Ergebnisse. Auktionen müssen pro Seitenaufruf eindeutig bleiben, um eine ordnungsgemäße Funktion zu gewährleisten.Das Caching kann dazu führen, dass wiederholte Ergebnisse für mehrere Benutzer oder Sitzungen angezeigt werden.
Wenn kein Anfragefehler auftritt, gibt der Endpoint die Auktionsergebnisse zurück.

​
Antwort mit Gewinnern

Beispielantwort, wenn Gewinner gefunden werden: 
{
  "results": [
    {
      "winners": [
        {
          "rank": 1,
          "resolvedBidId": "ChAGc-G66Wt7LKQEOcW8VBdIEhABjz_zDXx7db-ZYpxiwJ3DGhABjr4Lt_J0_a7Xv_uIfyOXIgUKATEQATDrrg8",
          "productId": "1",
          "title": "Brand Example Promo 1",
          "assets": [
            {
              "url": "https://assets.hosted.topsort.com/5bcccb92e5eaaa73ce9fcc545e944865bf70e9b60e5a048979769282450343c4/example-banner-1.png",
              "role": "image",
              "contentType": "image/png",
              "contentLength": 33902,
              "width": 920,
              "height": 920
            },
            {
              "url": "https://assets.hosted.topsort.com/c27c9cd94badc90fb50827e144dfacb2f51a601560905b950f525cec725ea85f/example-logo-1.png",
              "role": "logo",
              "contentType": "image/png",
              "contentLength": 80648,
              "width": 264,
              "height": 264
            }
          ],
          "campaignId": "018f3ff3-0d7c-7b75-bf99-629c62c09dc3"
        },
        {
          "rank": 2,
          "resolvedBidId": "ChAGc-G66Wt7LKQEOcW8VBdIEhABk0pue7N5wYmzE04uO_iOGhABjr4Lt_J0_a7Xv_uIfyOXIgUKATgQATDrrg8",
          "productId": "8",
          "title": "Brand Example Promo 2",
          "assets": [
            {
              "url": "https://assets.hosted.topsort.com/c049a46d834ab071cdde63e401d4efcd554e1a124f05c4ba9b3743fed2d43c4b/example-banner-2.jpeg",
              "role": "image",
              "contentType": "image/jpeg",
              "contentLength": 4505,
              "width": 403,
              "height": 125
            },
            {
              "url": "https://assets.hosted.topsort.com/db41a8b8b22c5ed9091f9f154b552b6bc1d1dbeb85059190f1c3b202977938f1/example-logo-2.png",
              "role": "logo",
              "contentType": "image/png",
              "contentLength": 34747,
              "width": 140,
              "height": 160
            }
          ],
          "campaignId": "01934a6e-7bb3-79c1-89b3-134e2e3bf88e"
        }
      ],
      "error": false
    }
  ]
}

​
Antwort ohne Gewinner

Beispielantwort, wenn keine Gewinner gefunden werden: 
{
  "results": [
    {
      "winners": [],
      "error": false
    }
  ]
}

​
Weiterführende Literatur

Für weitere Beispiele und Anwendungsfälle: