Em resumo: automatize a criação e o gerenciamento de Regras de Validação em escala. A API de Regras de Validação permite que equipes técnicas criem, atualizem, apliquem patches e excluam regras de forma programática, indo além dos limites de valores da UI e eliminando a sobrecarga do gerenciamento manual de regras.
Atenção
A API de Regras de Validação está disponível para clientes do Protect360. No momento, ela está em beta fechada, e o acesso é limitado e habilitado por conta. Entre em contato com seu Customer Success Manager (CSM) para solicitar acesso.
Sobre a API de Regras de Validação
Até agora, as Regras de Validação só podiam ser gerenciadas pela UI da AppsFlyer. Isso gerava duas limitações:
- Um limite de aproximadamente 17.000 valores por regra. Não é suficiente para listas de bloqueio em escala empresarial.
- Toda atualização exigia trabalho manual na UI. Isso consome tempo e gera altos custos operacionais para equipes que fazem alterações frequentes.
A API de Regras de Validação remove essas duas limitações. Ela dá às equipes técnicas controle programático total sobre suas regras, oferece suporte a até 300.000 valores por regra em regras grandes e permite automatizar atualizações de alta frequência sem precisar mexer na UI.
As regras criadas via API são sinalizadas como gerenciadas por API e aparecem como somente leitura na UI da AppsFlyer. As regras existentes criadas na UI não são afetadas. As regras gerenciadas pela UI e pela API coexistem na mesma conta.
Isso é para você?
A API de regras de validação foi criada para casos de uso específicos. Ela não foi criada para substituir a UI para todos os clientes. Considere a API se:
- Você gerencia uma blocklist ou allowlist que excede, ou está se aproximando, do limite de ~17.000 valores da UI.
- Sua equipe quer integrar o gerenciamento de regras aos seus próprios sistemas, scripts ou pipelines de automação.
- Sua lógica de fraude ou de bloqueio de tráfego muda com frequência, e as atualizações manuais na UI se tornaram um gargalo.
Se você gerencia um pequeno número de regras que raramente mudam, a IU de Regras de validação continua sendo a maneira mais simples de gerenciá-las.
Acesso e elegibilidade
A API de Regras de validação está disponível para clientes do Protect360. No momento, ela está em beta fechado, e o acesso é habilitado por conta.
- Requer uma assinatura do Protect360.
- Controlado por uma flag de recurso. Entre em contato com seu Customer Success Manager (CSM) para solicitar acesso e ativação.
- Regras grandes (até 300.000 valores) exigem habilitação especial adicional além do acesso padrão à API. Entre em contato com seu CSM para ativá-las.
Como funciona
Autenticar
A API usa autenticação por token Bearer (JWT).
- Na sua conta da AppsFlyer, acesse Security Center > API tokens.
- Gere um token.
- Inclua o token no cabeçalho Authorization das suas solicitações de API.
Atenção
O acesso à API deve ser habilitado por conta antes que um token funcione. Entre em contato com seu CSM para ativá-lo.
O que você pode fazer
| Action | Descrição |
|---|---|
| Listar regras | Recupere todas as regras ativas (habilitadas e desabilitadas) da sua conta. |
| Criar regra | Crie uma nova regra de forma programática. |
| Recuperar uma regra | Obtenha os detalhes completos da regra, incluindo todas as condições. |
| Atualizar regra | Substitua uma regra existente por uma nova configuração. |
| Habilitar/desabilitar uma regra | Ative ou desative uma regra sem excluí-la. |
| Excluir regra | Remova uma regra de forma permanente. |
| Aplicar patch em uma regra | Adicione, remova ou substitua valores de uma única dimensão sem reescrever a regra inteira. |
O endpoint de patch é especialmente útil para atualizações de alta frequência. Você atualiza apenas o que mudou, não a regra inteira. Isso funciona bem para fluxos de trabalho, como atualizações diárias de listas de bloqueio de fontes de fraude.
Escopo e configurações compatíveis
Atualmente, a API de Regras de Validação oferece suporte a um subconjunto definido do que está disponível no construtor de regras da UI.
- Aplica-se apenas a eventos de instalação. Eventos in-app não são compatíveis nesta versão.
- Dimensões compatíveis:
- Fonte de tráfego (população): ID do site, canal de mídia, agência, campanha, ID da campanha, ID do conjunto de anúncios e ID do anúncio
- Condições: Geolocalização, Plataforma
- Operadores com suporte: Está na lista, Não está na lista.
- Lógica entre dimensões: apenas AND. OR não é suportado.
- Tipos de regra: Correspondência (bloquear tráfego correspondente) ou Sem correspondência (bloquear tráfego que não corresponde).
- Tipos de fonte: todo o tráfego, todo o tráfego não orgânico ou tráfego não orgânico de uma agência específica.
- Ações de bloqueio com suporte:
- Bloquear atribuição e corrigi-la para o último canal de mídia válido.
- Bloquear atribuição e marcar instalações como inválidas. Elas não aparecerão no dashboard do Protect360.
Tamanho e limites da regra
| Regra padrão | Regra grande | |
|---|---|---|
| Total de valores em todas as condições | Até 17,000 | Até 300,000 |
| Requer habilitação especial | Yes | Yes |
| Máx. de regras por conta | 100 | Até 5 |
Limites adicionais:
- Máx. de 2.000 IDs de aplicativo por regra.
- 2 MB por chamada de API. Solicitações que excederem isso (aproximadamente 50.000 valores) devem ser divididas em várias chamadas.
- 300.000 valores por regra grande, em todas as dimensões combinadas, independentemente do tipo de operação (criar, atualizar ou aplicar patch).
Exceder qualquer limite retorna um erro que identifica qual limite foi ultrapassado.
Acesso a dados de tráfego bloqueado
O tráfego bloqueado por regras gerenciadas por API é relatado da mesma forma que o tráfego bloqueado por regras criadas na IU.
| Relatório | Localização |
|---|---|
| Exportação de dados brutos | Protect360 & Regras de validação > Instalações |
| Relatório do Data Locker | Relatórios do Protect360 > relatório blocked_installs |
| Extrair API | Exportação de dados brutos |
Documentação técnica
Para ver todos os detalhes técnicos, incluindo referências de endpoints, esquemas de solicitação e resposta e códigos de erro, consulte a referência da API de regras de validação.
Especificações e limitações
| Caraterística | A descrição |
|---|---|
| Suporte a eventos | Somente eventos de instalação. Eventos in-app não são compatíveis com esta versão. |
| Lógica | Somente a lógica AND é suportada entre dimensões. OR não é suportado. |
| Interação na IU | As regras criadas pela API aparecem como somente leitura na IU. Edite-as usando a API. |
| Regras criadas na UI | Não é acessível nem editável via API. |
| Tamanho da chamada | 2MB por chamada à API (aproximadamente 50,000 valores). Atualizações maiores devem ser divididas em várias chamadas. |
Perguntas frequentes
Quem pode usar a API de regras de validação?
A API de regras de validação está disponível para clientes do Protect360. No momento, está em beta fechado, e o acesso é habilitado por conta. Fale com seu CSM para solicitar o acesso.
As regras gerenciadas pela API aparecem na interface?
sim, As regras criadas via API ficam visíveis na interface do AppsFlyer, mas são sinalizadas como gerenciadas pela API e aparecem como somente leitura.
Posso gerenciar algumas regras pela API e outras pela interface?
sim, Regras gerenciadas pela API e regras criadas na interface coexistem na mesma conta. As regras gerenciadas pela API aparecem como somente leitura na interface. As regras criadas na interface não são acessíveis via API.
Posso editar uma regra gerenciada pela API na interface?
Não, a regra aparece como somente leitura. Você deve usar a API para atualizá-la.
Qual é a diferença entre Update e Patch?
Update substitui a regra inteira. Patch atualiza apenas uma única dimensão, adicionando, removendo ou substituindo valores sem reescrever a regra inteira. Use Patch para atualizações frequentes e direcionadas.
O que acontece se eu exceder um limite?
A API retorna um erro informando qual limite foi violado. Divida atualizações grandes em várias chamadas à API para ficar dentro do limite de 2 MB por chamada.
Quantas regras posso ter?
Até 100 regras padrão por conta e até 5 regras grandes por conta. Tanto as regras padrão quanto as grandes exigem uma habilitação especial. Entre em contato com seu CSM para ativá-las.
A lógica OU tem suporte?
Sem. Apenas a lógica E tem suporte entre dimensões.
Quais tipos de evento têm suporte?
Somente eventos de instalação. Eventos in-app não são compatíveis nesta versão.
Consulte também
This article was translated using AI and may contain errors. For the most accurate information, please refer to the English version using the language selector.