La Segments API de Topsort permite a nuestros clientes crear y gestionar grupos de usuarios para propósitos de segmentación. Después de crear segmentos en nuestra plataforma, pueden usarse como segmentación en la creación de campañas.
Cargar Usuarios a un Segmento
Una vez que se crea un segmento, los usuarios pueden cargarse usando nuestras APIs. Topsort soporta tres acciones:
- Add: Agregar nuevos usuarios al segmento existente, sin realizar cambios a los existentes.
- Remove: Eliminar usuarios específicos del segmento.
- Replace: Sobrescribir el segmento completo con una nueva lista de usuarios
Las listas de usuarios deben seguir esta especificación:
- El formato del archivo es .txt
- Sin encabezados
- Un Opaque User ID por fila, sin correos electrónicos ni información personal.
Restringir un Segmento a Vendors Específicos
Por defecto, un segmento nuevo es global: cualquier vendor de tu marketplace puede seleccionarlo como segmentación. Para limitar un segmento a vendors específicos, gestiona su lista de vendors con tu Advanced API Key:
- Listar vendors:
GET /public/v1/segment-service/segments/{segment_id}/vendors devuelve los vendors asignados al segmento. Una lista vendorIds vacía significa que el segmento es global.
- Agregar vendors:
PUT /public/v1/segment-service/segments/{segment_id}/vendors agrega los vendors indicados. Los vendors ya asignados se mantienen. Agregar el primer vendor convierte un segmento global en uno restringido.
- Eliminar vendors:
DELETE /public/v1/segment-service/segments/{segment_id}/vendors elimina los vendors indicados. Eliminar el último vendor vuelve a hacer global el segmento.
Los IDs de segmento y de vendor son tus IDs externos. Cada solicitud acepta hasta 100 IDs de vendor, y todos los endpoints devuelven la lista de vendors resultante del segmento:
Para saber qué segmentos puede usar un vendor, llama a Retrieve a list of segments con el parámetro de consulta vendor_id. La respuesta contiene los segmentos globales más los segmentos asignados a ese vendor.
Un segmento es global desde el momento en que se crea hasta que se agrega su primer vendor. Agrega vendors justo después de crear un segmento que no deba estar disponible para todos los vendors.
Uso en Campañas
Los segmentos se usan como opciones de segmentación en campañas. El mismo Opaque User ID cargado a los segmentos debe usarse en la solicitud de subasta, para garantizar que el motor de subastas pueda emparejarlo con el segmento correspondiente.
