A API de Segmentos do Topsort permite que nossos clientes criem e gerenciem grupos de usuários para fins de segmentação. Após criar segmentos em nossa plataforma, eles podem ser usados como segmentação na criação de campanhas.
Fazendo Upload de Usuários para um Segmento
Uma vez que um segmento é criado, os usuários podem ser carregados nele usando nossas APIs. O Topsort suporta três ações:
- Adicionar: Anexar novos usuários ao segmento existente, sem fazer alterações nos existentes.
- Remover: Excluir usuários específicos do segmento.
- Substituir: Sobrescrever todo o segmento com uma nova lista de usuários
As listas de usuários devem seguir esta especificação:
- Formato de arquivo é .txt
- Sem cabeçalhos
- Um ID de Usuário Opaco por linha, sem e-mails ou informações pessoais.
Restringindo um Segmento a Vendors Específicos
Por padrão, um segmento novo é global: qualquer vendor do seu marketplace pode selecioná-lo como segmentação. Para limitar um segmento a vendors específicos, gerencie a lista de vendors dele com sua Advanced API Key:
- Listar vendors:
GET /public/v1/segment-service/segments/{segment_id}/vendors retorna os vendors associados ao segmento. Uma lista vendorIds vazia significa que o segmento é global.
- Adicionar vendors:
PUT /public/v1/segment-service/segments/{segment_id}/vendors adiciona os vendors informados. Os vendors já associados permanecem. Adicionar o primeiro vendor transforma um segmento global em restrito.
- Remover vendors:
DELETE /public/v1/segment-service/segments/{segment_id}/vendors remove os vendors informados. Remover o último vendor torna o segmento global novamente.
Os IDs de segmento e de vendor são os seus IDs externos. Cada requisição aceita até 100 IDs de vendor, e todos os endpoints retornam a lista de vendors resultante do segmento:
Para saber quais segmentos um vendor pode usar, chame Retrieve a list of segments com o parâmetro de consulta vendor_id. A resposta contém os segmentos globais mais os segmentos associados a esse vendor.
Um segmento é global desde o momento em que é criado até que o primeiro vendor seja adicionado. Adicione vendors logo após criar um segmento que não deva ficar disponível para todos os vendors.
Uso em Campanhas
Segmentos são usados como opções de segmentação em campanhas. O mesmo ID de Usuário Opaco carregado nos segmentos deve ser usado na solicitação de leilão, para garantir que o motor de leilão possa combiná-lo com o segmento correspondente.
