La Segments API de Topsort permet à nos clients de créer et de gérer des groupes d’utilisateurs à des fins de ciblage. Après avoir créé des segments sur notre plateforme, ils peuvent être utilisés comme ciblage dans la création de campagne.
Téléchargement d’utilisateurs vers un segment
Une fois qu’un segment est créé, les utilisateurs peuvent y être téléchargés en utilisant nos API. Topsort prend en charge trois actions :
- Add : Ajouter de nouveaux utilisateurs au segment existant, sans apporter de modifications aux utilisateurs existants.
- Remove : Supprimer des utilisateurs spécifiques du segment.
- Replace : Remplacer entièrement le segment par une nouvelle liste d’utilisateurs
Les listes d’utilisateurs doivent suivre cette spécification :
- Le format de fichier est .txt
- Pas d’en-têtes
- Un Opaque User ID par ligne, sans emails ni informations personnelles.
Restreindre un segment à des vendors spécifiques
Par défaut, un nouveau segment est global : tous les vendors de votre marketplace peuvent le sélectionner comme ciblage. Pour limiter un segment à des vendors spécifiques, gérez sa liste de vendors avec votre Advanced API Key :
- Lister les vendors :
GET /public/v1/segment-service/segments/{segment_id}/vendors renvoie les vendors associés au segment. Une liste vendorIds vide signifie que le segment est global.
- Ajouter des vendors :
PUT /public/v1/segment-service/segments/{segment_id}/vendors ajoute les vendors indiqués. Les vendors déjà associés sont conservés. L’ajout du premier vendor transforme un segment global en segment restreint.
- Retirer des vendors :
DELETE /public/v1/segment-service/segments/{segment_id}/vendors retire les vendors indiqués. Retirer le dernier vendor rend le segment à nouveau global.
Les IDs de segment et de vendor sont vos IDs externes. Chaque requête accepte jusqu’à 100 IDs de vendor, et tous les endpoints renvoient la liste de vendors résultante du segment :
Pour savoir quels segments un vendor peut utiliser, appelez Retrieve a list of segments avec le paramètre de requête vendor_id. La réponse contient les segments globaux ainsi que les segments associés à ce vendor.
Un segment est global dès sa création et jusqu’à l’ajout de son premier vendor. Ajoutez les vendors juste après avoir créé un segment qui ne doit pas être disponible pour tous les vendors.
Utilisation dans les campagnes
Les segments sont utilisés comme options de ciblage dans les campagnes. Le même Opaque User ID téléchargé vers les segments doit être utilisé sur la requête d’enchères, pour garantir que le moteur d’enchères puisse le faire correspondre avec le segment correspondant.
