概要: 検証ルールの作成と管理を大規模に自動化します。 検証ルールAPIを使用すると、技術チームはルールをプログラムで作成、更新、パッチ適用、削除でき、UIの値の上限を超えて、手動でのルール管理にかかるオーバーヘッドを削減できます。
注
検証ルールAPIは、Protect360の顧客に提供されています。 現在はクローズドベータ版で、アクセスは限定されており、アカウントごとに有効化されます。 アクセスをリクエストするには、Customer Success Manager（CSM）にご連絡ください。
検証ルールAPIについて
これまで、検証ルールはAppsFlyer UIでのみ管理できました。 これにより、次の制限が生じました：
- ルールごとに設定できる値の上限は約17,000件です。 エンタープライズ規模のブロックリストには不十分です。
- 更新のたびに、UIで手動作業が必要でした。 これは、頻繁に変更を行うチームにとって時間がかかり、運用コストも高くなります。
検証ルールAPIは、これら両方の制約を解消します。 技術チームはルールをプログラムで完全にコントロールできるようになり、大規模なルールではルールあたり最大300,000件の値をサポートし、UIにタッチすることなく高頻度の更新をオートメーション化できます。
API経由で作成されたルールにはAPI管理のフラグが付き、AppsFlyer UIでは読み取り専用として表示されます。 既存のUIで作成されたルールには影響しません。 UI管理のルールとAPI管理のルールは、同じアカウント内で共存できます。
この機能は適していますか？
検証ルールAPIは、特定のユースケース向けに設計されています。 すべての顧客にとって、UIの代替となることを目的としたものではありません。 次の場合はAPIをご検討ください：
- 管理しているブロックリストまたは許可リストが、UIの約17,000件の値の上限を超えている、またはその上限に近づいている場合。
- チームでルール管理を自社のシステム、スクリプト、またはオートメーションパイプラインに統合したい場合。
- 不正対策やトラフィックのブロックロジックが頻繁に変わり、UIでの手動更新がボトルネックになっている場合。
管理するルール数が少なく、変更もほとんどない場合は、引き続き［検証ルール］UIが最もシンプルな管理方法です。
アクセスと利用条件
検証ルールAPIは、Protect360の顧客が利用できます。 現在はクローズドベータ版で、アクセスはアカウントごとに有効化されます。
- Protect360のご契約が必要です。
- フィーチャーフラグで制御されます。 アクセスと有効化をリクエストするには、担当のカスタマーサクセスマネージャー（CSM）にお問い合わせください。
- 大規模なルール（最大300,000件の値）には、標準のAPIアクセスに加えて追加の特別な有効化が必要です。 有効化するには、担当のCSMにお問い合わせください。
利用方法
認証
このAPIでは、Bearerトークン（JWT）認証を使用します。
- AppsFlyerアカウントで、Security Center > API tokens に移動します。
- トークンを生成します。
- APIリクエストのAuthorizationヘッダーにトークンを含めます。
注
トークンを機能させるには、事前にアカウントごとにAPIアクセスを有効にしておく必要があります。 有効化するには、担当のCSMにお問い合わせください。
できること
| 対応事項 | 概要 |
|---|---|
| ルールを一覧表示 | アカウントのすべてのアクティブなルール（有効・無効を含む）を取得します。 |
| ルールの作成 | プログラムで新しいルールを作成します。 |
| ルールの取得 | すべての条件を含む、ルールの詳細情報を取得します。 |
| ルールの更新 | 既存のルールを新しい設定で上書きします。 |
| ルールの有効化 / 無効化 | ルールを削除せずにオンまたはオフに切り替えます。 |
| ルールを削除 | ルールを完全に削除します。 |
| ルールにパッチを適用 | ルール全体を書き直すことなく、単一のディメンションの値を追加、削除、または置換できます。 |
パッチエンドポイントは、特に高頻度の更新に便利です。 ルール全体ではなく、変更された部分だけを更新します。 これは、日次の不正ソースのブロックリスト更新のようなワークフローに適しています。
適用範囲とサポートされる設定
Validation Rules API は現在、UI のルールビルダーで利用できる機能のうち、定義された一部のみをサポートしています。
- インストールイベントにのみ適用されます。 このバージョンではアプリ内イベントはサポートされていません。
- サポートされているディメンション：
- トラフィックソース（母集団）: Site ID、メディアソース、代理店、キャンペーン、キャンペーン ID、広告セット ID、広告 ID
- 条件: 地域、プラットフォーム
- サポートされている演算子: リストに含まれる、リストに含まれない。
- ディメンション間のロジック: AND のみ。 OR はサポートされていません。
- ルールタイプ: Match（一致するトラフィックをブロックする）または Do not match（一致しないトラフィックをブロックする）。
- ソースタイプ: すべてのトラフィック、すべての非オーガニックトラフィック、または特定の代理店からの非オーガニックトラフィック。
- サポートされているブロックのアクション：
- アトリビューションをブロックし、最後の有効なメディアソースに成果の紐付けを修正する。
- アトリビューションをブロックし、インストールを無効としてマークする。 これらはProtect360ダッシュボードには表示されません。
ルールサイズと制限
| 標準ルール | 大規模ルール | |
|---|---|---|
| すべての条件にまたがる値の合計 | 最大17,000件 | 最大300,000件 |
| 特別な有効化が必要 | はい | はい |
| アカウントあたりのルールの最大数 | 100 | 最大5件 |
追加の制限：
- ルールあたりのアプリ ID は最大 2,000 件です。
- APIコールあたり2MB。 これを超えるリクエスト（約50,000値）は、複数のコールに分割する必要があります。
- 大規模ルールあたり、すべてのディメンションを合算して最大 300,000 値。操作タイプ（作成、更新、またはパッチ）に関係なく。
いずれかの制限を超えると、どの制限に違反したかを示すエラーが返されます。
ブロックされたトラフィックデータへのアクセス
APIで管理されるルールによってブロックされたトラフィックは、UIで作成されたルールによってブロックされたトラフィックと同じ方法でレポートされます。
| レポート | ロケーション |
|---|---|
| ローデータエクスポート | Protect360 & 検証ルール > インストール |
| Data Locker | Protect360レポート > blocked_installsレポート |
| プルAPI | ローデータエクスポート |
技術ドキュメンテーション
エンドポイントのリファレンス、リクエストおよびレスポンスのスキーマ、エラーコードなどの技術的な詳細については、検証ルールAPIリファレンスを参照してください。
特性と制限事項
| 特性 | 説明 |
|---|---|
| イベントのサポート | インストールイベントのみ。 このバージョンではアプリ内イベントはサポートされていません。 |
| ロジック | ディメンション間ではANDロジックのみがサポートされています。 ORはサポートされていません。 |
| UIインタラクション | API経由で作成されたルールは、UIでは読み取り専用として表示されます。 APIを使用して編集してください。 |
| UIで作成されたルール | API経由ではアクセスも編集もできません。 |
| コールサイズ | APIコールあたり2MB（約50,000件の値）。 大きな更新は複数回のコールに分割する必要があります。 |
FAQ
Validation Rules APIを使用できるのは誰ですか？
Validation Rules APIはProtect360の顧客が利用できます。 現在はクローズドベータ版で、アクセスはアカウントごとに有効化されます。 アクセスをリクエストするには、担当のCSMにお問い合わせください。
APIで管理されるルールはUIに表示されますか？
はい。 API経由で作成されたルールはAppsFlyerのUIに表示されますが、API管理としてマークされ、読み取り専用として表示されます。
一部のルールはAPIで管理し、他のルールはUIで管理できますか？
はい。 APIで管理されるルールとUIで作成されたルールは、同じアカウント内で共存します。 APIで管理されるルールは、UIでは読み取り専用として表示されます。 UIで作成されたルールにはAPIからアクセスできません。
APIで管理されるルールはUIで編集できますか？
いいえ、そのルールは読み取り専用として表示されます。 代わりに、更新にはAPIを利用する必要があります。
UpdateとPatchの違いは何ですか？
Updateはルール全体を上書きします。 Patchは単一のディメンションのみを更新し、ルール全体を書き換えることなく、値の追加、削除、または置換を行います。 頻繁に行う、ターゲットを絞った更新にはPatchを利用してください。
制限を超えるとどうなりますか？
APIは、どの制限に違反したかを示すエラーを返します。 1回あたり2MBの制限内に収めるため、大きな更新は複数回のAPIコールに分割してください。
ルールはいくつまで作成できますか？
アカウントごとに、標準ルールは最大100件、大規模ルールは最大5件までです。 標準ルールと大規模ルールはいずれも、特別な有効化が必要です。 有効にするには、担当のCSMにお問い合わせください。
ORロジックはサポートされていますか？
いいえ。 ディメンション間では、ANDロジックのみがサポートされています。
どのイベントタイプがサポートされていますか？
インストールイベントのみです。 このバージョンでは、アプリ内イベントはサポートされていません。
こちらもご参照ください