Índice
Criteo Resellers Program API V2 - Guia de Referência Completo
Conceitos
Os seguintes conceitos são usados na API do programa de revendedores da Criteo
- Orçamento - um orçamento limita os gastos de um vendedor em uma ou mais campanhas. Tem um valor inicial e também um valor gasto. Ele também tem uma data de início e término. Os cliques em um anúncio vendido por meio de uma campanha do vendedor são cobrados em relação ao orçamento associado de acordo com a taxa negociada. Um orçamento pode ser consumido por várias campanhas de vendedores, desde que pertençam ao mesmo vendedor.
- Campanha - uma campanha é um curso de ação para promover produtos de seus vendedores.
- Anunciante - O anunciante é a entidade que anuncia em nome do Vendedor. Normalmente, o anunciante é um mercado que usa a solução CRP para monetizar o orçamento de publicidade do vendedor. Aliases: Marketplace
- Vendedor - um vendedor vende produtos em seu mercado. Um vendedor se beneficia de uma campanha obtendo mais exposição de produtos na internet por meio da plataforma Criteo. No entanto, um Vendedor não interage financeiramente com a Criteo.
- Campanha do vendedor - uma campanha do vendedor é um recurso que encapsula as regras de negócios acordadas pelo vendedor para usar em uma campanha específica. Por exemplo, contém o lance máximo que o vendedor está disposto a fazer em alguma campanha. Plataformas diferentes (web x móvel) geralmente têm campanhas diferentes.
Os recursos expostos nesta API são os seguintes:
- Anunciantes (anunciantes)
- Vendedor (vendedores)
- Campanha do vendedor (campanhas do vendedor)
- Orçamento (orçamentos)
Além disso, o recurso v1 Campaign (/marketing/v1/campaigns) também é referenciado na API.
Cada um desses recursos tem identificadores exclusivos globalmente, exceto para a campanha do vendedor para a qual o sellerId e o CampaignId servem como um identificador exclusivo.
O recurso vendedor está associado a um anunciante e também possui um nome exclusivo nesse contexto.
Projeto
O design do esquema v2 é baseado no diagrama de relacionamento a seguir para os recursos mais importantes.
Observe que cada campanha do vendedor usa uma chave primária composta que consiste em um único vendedor e uma única campanha. Pode ser associado a vários recursos de Orçamento. Um orçamento pode ser consumido por várias campanhas de vendedores, desde que pertençam ao mesmo vendedor. No entanto, as regras de negócios estipulam que haja no máximo um orçamento diário atual e um orçamento não diário atual. Um orçamento diário pode ser configurado sem um orçamento não diário por trás dele, mas por si só um orçamento diário não é suficiente para ativar uma campanha do vendedor e começar a veicular anúncios; um orçamento não diário (também conhecido como "total") é necessário.
Pontos de extremidade da API
- Este documento de design descreve os serviços encontrados na seguinte raiz de serviço: https://api.criteo.com/marketing/v2/crp
- Uma descrição arrogante da API estará disponível aqui: https://api.criteo.com/marketing/swagger
Esta raiz de serviço será usada exclusivamente para o domínio do Programa de Revenda. No passado, o Programa de Revendedores fazia parte da raiz do serviço https://api.criteo.com/marketing/v1/ no segmento de caminho do URI do vendedor.
O restante desta seção é organizado por endereço URI. Existem quatro subseções principais:
- Anunciantes
- Vendedores (vendedores)
- Campanhas de vendedores (campanhas de vendedores)
- Orçamentos (orçamentos)
Cada subseção começa com uma tabela de endpoints suportados.