Кратко: автоматизируйте создание и управление правилами валидации в масштабе. API правил валидации позволяет техническим командам программно создавать, обновлять, вносить исправления и удалять правила, обходя ограничения UI по количеству значений и устраняя издержки на ручное управление правилами.
Примечание
API правил валидации доступен клиентам Protect360. Сейчас он находится в закрытой бете, а доступ ограничен и включается для каждой учетной записи отдельно. Чтобы запросить доступ, обратитесь к своему Customer Success Manager (CSM).
Об API правил валидации
До сих пор правилами валидации можно было управлять только через UI AppsFlyer. Из-за этого возникали два ограничения:
- Ограничение примерно в 17 0000 значений на правило. Этого недостаточно для блоклистов корпоративного масштаба.
- Каждое обновление требовало ручной работы в UI. Это занимает много времени и обходится командам дорого в операционном плане при частых изменениях.
API правил валидации снимает оба этих ограничения. Он дает техническим командам полный программный контроль над правилами, поддерживает до 300 000 значений на правило и позволяет автоматизировать частые обновления, не заходя в UI.
Правила, созданные через API, помечаются как управляемые через API и отображаются в UI AppsFlyer только для чтения. Это не влияет на существующие правила, созданные в UI. Правила, управляемые через UI и через API, могут сосуществовать в одной учетной записи.
Это для вас?
API правил валидации предназначен для определенных сценариев использования. Он не предназначен для замены UI для каждого клиента. Рассмотрите API, если:
- Вы управляете чёрным или белым списком, который превышает или приближается к ограничению интерфейса в ~17 000 значений.
- Ваша команда хочет интегрировать управление правилами в собственные системы, скрипты или конвейеры автоматизации.
- Ваша логика фрода или блокировки трафика часто меняется, и ручные обновления в UI стали узким местом.
Если вы управляете небольшим количеством правил, которые редко меняются, интерфейс правил валидации по-прежнему остается самым простым способом работы с ними.
Доступ и соответствие требованиям
API правил валидации доступен клиентам Protect360. Сейчас эта функция находится в закрытой бета-версии, и доступ включается отдельно для каждого аккаунта.
- Требуется подписка Protect360.
- Управляется фичефлагом. Чтобы запросить доступ и активацию, обратитесь к своему менеджеру по работе с клиентами (CSM).
- Для больших правил (до 300 000 значений) требуется дополнительная специальная активация сверх стандартного доступа к API. Обратитесь к своему CSM, чтобы активировать их.
Принцип действия
Аутентифицироваться
API использует аутентификацию с помощью токена Bearer (JWT).
- В аккаунте AppsFlyer перейдите в Центр безопасности > токены API .
- Создайте токен.
- Добавьте токен в заголовок Авторизация ваших API-запросов.
Примечание
Доступ к API должен быть включен отдельно для каждого аккаунта, прежде чем токен начнет работать. Обратитесь к своему CSM, чтобы активировать это.
Что можно сделать
| Действие | Описание |
|---|---|
| Перечислить правила | Получить все активные правила (включенные и отключенные) для вашего аккаунта. |
| Создать правило | Создать новое правило программно. |
| Получить правило | Получить полную информацию о правиле, включая все условия. |
| Обновить правило | Перезаписать существующее правило новой конфигурацией. |
| Включить / отключить правило | Включайте и выключайте правило, не удаляя его. |
| Удалить правило | Удалить правило без возможности восстановления. |
| Патчить правило | Добавляйте, удаляйте или заменяйте значения для одного измерения без переписывания всего правила. |
Эндпоинт patch особенно полезен для частых обновлений. Вы обновляете только то, что изменилось, а не все правило целиком. Это хорошо подходит для таких сценариев, как ежедневные обновления списка блокировки источников фрода.
Область применения и поддерживаемые конфигурации
В настоящее время Validation Rules API поддерживает определенное подмножество возможностей, доступных в конструкторе правил в UI.
- Применяется только к событиям установки. In-app события не поддерживаются в этой версии.
- Поддерживаемые параметры:
- Источник трафика (Population): ID сайта, медиаисточник, агентство, кампания, ID кампании, ID группы объявлений и ID рекламного объявления
- Условия: гео, платформа
- Поддерживаемые операторы: входит в список, не входит в список.
- Логика между измерениями: только AND. OR не поддерживается.
- Типы правил: Match (блокировать совпадающий трафик) или Do not match (блокировать трафик, который не совпадает).
- Типы источников: весь трафик, весь неорганический трафик или неорганический трафик из определенного агентства.
- Поддерживаемые действия по блокировке:
- Заблокировать атрибуцию и скорректировать ее на последний действительный медиаисточник.
- Блокировать атрибуцию и пометить установки как недействительные. Они не будут отображаться в дэшборде Protect360.
Размер правила и ограничения
| Стандартное правило | Большое правило | |
|---|---|---|
| Общее количество значений по всем условиям | Не более 17,000 | Не более 300,000 |
| Требуется специальное включение функции | Да | Да |
| Макс. количество правил на учетную запись | 100 | Не более 5 |
Дополнительные ограничения:
- Максимум 2 000 идентификаторов приложений на правило.
- 2 МБ на вызов API. Запросы, превышающие это значение (примерно 50 000 значений), необходимо разделить на несколько вызовов.
- 300 000 значений на одно большое правило по всем измерениям в совокупности, независимо от типа операции (создание, обновление или исправление).
При превышении любого лимита возвращается ошибка с указанием того, какой именно лимит был превышен.
Доступ к данным о заблокированном трафике
Трафик, заблокированный правилами, управляемыми через API, отображается так же, как и трафик, заблокированный правилами, созданными в UI.
| Отчёт | Местоположение: |
|---|---|
| Экспорт сырых данных | Protect360 & Validation Rules > Installs |
| Отчет Data Locker | Отчеты Protect360 > отчет blocked_installs |
| Pull API | Экспорт сырых данных |
Техническая документация
Полные технические сведения, включая ссылки на эндпоинты, схемы запросов и ответов, а также коды ошибок, см. в справочнике по Validation Rules API.
Спецификации и ограничения
| Специфика | Description(Описание) |
|---|---|
| Поддержка событий | Только события установки. События в приложении не поддерживаются в этой версии. |
| Логика | Между измерениями поддерживается только логика AND. OR не поддерживается. |
| Взаимодействие с UI | Правила, созданные через API, отображаются в UI в режиме только для чтения. Редактируйте их с помощью API. |
| Правила, созданные в интерфейсе пользователя | Недоступны и не могут быть отредактированы через API. |
| Размер вызова | 2MB на один вызов API (примерно 50 000 значений). Более крупные обновления необходимо разбивать на несколько вызовов. |
Часто задаваемые вопросы
Кто может использовать API правил валидации?
API правил валидации доступен клиентам Protect360. Сейчас он находится в закрытой бета-версии, и доступ включается для каждой учетной записи отдельно. Для получения доступа обратитесь к своему менеджеру.
Отображаются ли в UI правила, управляемые через API?
Да Да Правила, созданные через API, видны в интерфейсе AppsFlyer, но помечаются как управляемые через API и отображаются только для чтения.
Можно ли управлять одними правилами через API, а другими — через интерфейс пользователя?
Да Да Правила, управляемые через API, и правила, созданные в интерфейсе пользователя, сосуществуют в одной учетной записи. Правила, управляемые через API, отображаются в интерфейсе пользователя только для чтения. Правила, созданные в интерфейсе пользователя, недоступны через API.
Можно ли редактировать в интерфейсе пользователя правило, управляемое через API?
Нет, правило отображается только для чтения. Вместо этого для обновления необходимо использовать API.
В чем разница между Update и Patch?
Update перезаписывает правило целиком. Patch обновляет только одно измерение: добавляет, удаляет или заменяет значения без перезаписи всего правила. Используйте Patch для частых точечных обновлений.
Что будет, если я превышу лимит?
API возвращает ошибку с указанием, какой лимит был превышен. Разделяйте крупные обновления на несколько вызовов API, чтобы не превышать ограничение 2 МБ на один вызов.
Сколько правил можно иметь?
До 100 стандартных правил на аккаунт и до 5 крупных правил на аккаунт. И стандартные, и крупные правила требуют специального разрешения. Чтобы активировать их, обратитесь к своему CSM.
Поддерживается ли логика OR?
№ № Между измерениями поддерживается только логика AND.
Какие типы событий поддерживаются?
Только события установки. События в приложении не поддерживаются в этой версии.
Смотрите также