Die Segments API von Topsort ermöglicht es unseren Kunden, Benutzergruppen für Targeting-Zwecke zu erstellen und zu verwalten. Nach dem Erstellen von Segmenten auf unserer Plattform können diese als Targeting bei der Kampagnenerstellung verwendet werden.
Benutzer zu einem Segment hochladen
Sobald ein Segment erstellt ist, können Benutzer über unsere APIs hinzugefügt werden. Topsort unterstützt drei Aktionen:
- Hinzufügen: Neue Benutzer an das bestehende Segment anhängen, ohne Änderungen an bestehenden vorzunehmen.
- Entfernen: Bestimmte Benutzer aus dem Segment löschen.
- Ersetzen: Das gesamte Segment mit einer neuen Benutzerliste überschreiben.
Benutzerlisten müssen dieser Spezifikation folgen:
- Dateiformat ist .txt
- Keine Kopfzeilen
- Eine Opaque User ID pro Zeile, ohne E-Mails oder persönliche Informationen.
Ein Segment auf bestimmte Vendors beschränken
Standardmäßig ist ein neues Segment global: Jeder Vendor Ihres Marktplatzes kann es als Targeting auswählen. Um ein Segment auf bestimmte Vendors zu beschränken, verwalten Sie seine Vendor-Liste mit Ihrem Advanced API Key:
- Vendors auflisten:
GET /public/v1/segment-service/segments/{segment_id}/vendors gibt die dem Segment zugewiesenen Vendors zurück. Eine leere vendorIds-Liste bedeutet, dass das Segment global ist.
- Vendors hinzufügen:
PUT /public/v1/segment-service/segments/{segment_id}/vendors fügt die angegebenen Vendors hinzu. Bereits zugewiesene Vendors bleiben erhalten. Das Hinzufügen des ersten Vendors macht aus einem globalen Segment ein beschränktes.
- Vendors entfernen:
DELETE /public/v1/segment-service/segments/{segment_id}/vendors entfernt die angegebenen Vendors. Wird der letzte Vendor entfernt, ist das Segment wieder global.
Segment- und Vendor-IDs sind Ihre externen IDs. Jede Anfrage akzeptiert bis zu 100 Vendor-IDs, und alle Endpunkte geben die resultierende Vendor-Liste des Segments zurück:
Um zu prüfen, welche Segmente ein Vendor verwenden kann, rufen Sie Retrieve a list of segments mit dem Query-Parameter vendor_id auf. Die Antwort enthält die globalen Segmente sowie die diesem Vendor zugewiesenen Segmente.
Ein Segment ist ab seiner Erstellung global, bis der erste Vendor hinzugefügt wird. Fügen Sie Vendors direkt nach dem Erstellen eines Segments hinzu, das nicht allen Vendors zur Verfügung stehen soll.
Verwendung in Kampagnen
Segmente werden als Targeting-Optionen in Kampagnen verwendet. Die gleiche Opaque User ID, die zu den Segmenten hochgeladen wurde, sollte in der Auktionsanfrage verwendet werden, um sicherzustellen, dass die Auktions-Engine sie mit dem entsprechenden Segment abgleichen kann.
