大量の検証ルールの作成・管理を自動化できます。検証ルールAPIを使用すると、技術担当チームがプログラムからルールの作成、全体更新、部分更新、削除を行えます。管理画面で登録できる値の上限を超えてルールを設定でき、手作業によるルール管理の負担を削減できます。
注意
検証ルールAPIは、Protect360をご契約のお客様が利用できます。現在は限定ベータ版として提供されており、利用できるアカウントは限られています。利用はアカウントごとに有効化されます。利用を希望する場合は、担当カスタマーサクセスマネージャー（CSM）にお問い合わせください。
検証ルールAPIとは
これまで、検証ルールはAppsFlyerの管理画面からのみ管理できました。そのため、以下の2つの制約がありました。
- 1つのルールに登録できる値は約17,000件までです。この上限では、大企業で使用する大規模なブロックリストに対応しきれません。
- 更新のたびに、管理画面での手作業が必要でした。頻繁に変更を行うチームにとっては、時間と運用コストがかかります。
検証ルールAPIは、この両方の制約を解消します。技術担当チームは、プログラムからルールを全面的に管理できます。大規模ルールでは1つのルールに最大300,000件の値を登録でき、管理画面を操作せずに、頻繁な更新を自動化できます。
APIで作成したルールには「API管理」の区分が付き、AppsFlyerの管理画面では読み取り専用として表示されます。管理画面で作成済みのルールには影響しません。同じアカウント内で、管理画面で管理するルールとAPIで管理するルールを併用できます。
APIの利用が適しているケース
検証ルールAPIは、特定の用途を想定した機能です。すべてのお客様の管理画面での操作を置き換えることを目的としているわけではありません。以下に該当する場合は、APIの利用をご検討ください。
- 管理しているブロックリストや許可リストの値が、管理画面の上限である約17,000件を超えている、または上限に近づいている。
- ルール管理を、自社のシステムやスクリプト、自動処理の一連の流れに組み込みたい。
- 不正判定やトラフィックのブロック条件が頻繁に変わるため、管理画面での手動更新が作業の妨げになっている。
ルールの数が少なく、変更もほとんど行わない場合は、引き続き検証ルールの管理画面で管理するのが最も簡単です。
利用条件と有効化
検証ルールAPIは、Protect360をご契約のお客様が利用できます。現在は限定ベータ版として提供されており、利用はアカウントごとに有効化されます。
- Protect360の契約が必要です。
- 利用可否は、機能の有効・無効を切り替える設定（機能フラグ）で管理されます。利用と有効化を希望する場合は、担当カスタマーサクセスマネージャー（CSM）にお問い合わせください。
- 大規模ルール（最大300,000件の値）を利用するには、通常のAPI利用の有効化に加え、別途有効化が必要です。有効化については、担当CSMにお問い合わせください。
利用方法
認証
このAPIは、Bearerトークン（JWT）による認証を使用します。
- AppsFlyerのアカウントで、セキュリティセンター > APIトークンに進みます。
- トークンを生成します。
- APIリクエストのAuthorizationヘッダーに、トークンを含めます。
注意
トークンを使用するには、事前にアカウントのAPI利用が有効化されている必要があります。有効化については、担当CSMにお問い合わせください。
APIで実行できる操作
| 操作 | 説明 |
|---|---|
| ルール一覧の取得 | アカウント内のすべてのルール（有効・無効の両方）を取得します。 |
| ルールの作成 | プログラムから新しいルールを作成します。 |
| ルールの取得 | すべての条件を含む、ルールの詳細情報を取得します。 |
| ルールの全体更新 | 既存のルールを新しい設定で上書きします。 |
| ルールの有効化・無効化 | ルールを削除せずに、有効・無効を切り替えます。 |
| ルールの削除 | ルールを完全に削除します。 |
| ルールの部分更新 | ルール全体を上書きせずに、1つの条件項目の値を追加、削除、置換します。 |
部分更新（Patch）のエンドポイントは、頻繁な更新に特に便利です。ルール全体ではなく、変更があった部分だけを更新します。不正な流入元のブロックリストを日次で更新するなどの運用に適しています。
対応範囲と設定可能な項目
現在、検証ルールAPIは、管理画面のルール作成機能で利用できる設定の一部に対応しています。
- 適用対象はインストールイベントのみです。このバージョンでは、アプリ内イベントには対応していません。
- 対応している条件項目：
- トラフィックの流入元（Population）：サイトID、メディアソース、代理店、キャンペーン、キャンペーンID、広告セットID、広告ID
- 条件：国・地域、プラットフォーム
- 対応している演算子：リストに含まれる、リストに含まれない。
- 条件項目間の論理演算：AND（すべての条件を満たす）のみ。 OR（いずれかの条件を満たす）には対応していません。
- ルールの種類：「条件に一致する」（一致するトラフィックをブロック）または「条件に一致しない」（一致しないトラフィックをブロック）。
- 流入元の種類：すべてのトラフィック、すべての非オーガニックトラフィック、または特定の代理店からの非オーガニックトラフィック。
- 対応しているブロック時の処理：
- アトリビューションをブロックし、最後の有効なメディアソースに修正する。
- アトリビューションをブロックし、インストールを無効とする。これらのインストールは、Protect360のダッシュボードには表示されません。
ルールの規模と上限
| 標準ルール | 大規模ルール | |
|---|---|---|
| すべての条件に登録した値の合計数 | 最大17,000件 | 最大300,000件 |
| 別途有効化が必要 | はい | はい |
| アカウントあたりのルール数の上限 | 最大5件 |
その他の上限：
- 1つのルールに指定できるアプリIDは最大2,000件です。
- 1回のAPI呼び出しあたり2MBまでです。この上限（値の数で約50,000件）を超えるリクエストは、複数回のAPI呼び出しに分割する必要があります。
- 操作の種類（作成、全体更新、部分更新）にかかわらず、1つの大規模ルールに登録できる値は、すべての条件項目の合計で300,000件までです。
いずれかの上限を超えると、超過した上限を示すエラーが返されます。
ブロックされたトラフィックのデータの確認
APIで管理するルールによってブロックされたトラフィックは、管理画面で作成したルールによってブロックされたトラフィックと同じようにレポートに記録されます。
| レポート | 確認場所 |
|---|---|
| ローデータ出力 | Protect360 & 検証ルール > インストール |
| Data Locker | Protect360レポート > blocked_installsレポート |
| Pull API | ローデータ出力 |
技術ドキュメント
エンドポイントのリファレンス、リクエストとレスポンスの構造、エラーコードなど、技術的な詳細については、検証ルールAPIリファレンスをご覧ください。
仕様と制限事項
| 項目 | 説明 |
|---|---|
| 対応するイベント | インストールイベントのみです。このバージョンでは、アプリ内イベントには対応していません。 |
| 論理演算 | 条件項目間の論理演算は、AND（すべての条件を満たす）のみに対応しています。 OR（いずれかの条件を満たす）には対応していません。 |
| 管理画面での操作 | APIで作成したルールは、管理画面では読み取り専用として表示されます。編集にはAPIを使用してください。 |
| 1回の呼び出しあたりのデータ量 | 1回のAPI呼び出しあたり2MBまでです（値の数で約50,000件）。この上限を超える更新は、複数回のAPI呼び出しに分割する必要があります。 |
よくある質問
検証ルールAPIを利用できるのは誰ですか？
検証ルールAPIは、Protect360をご契約のお客様が利用できます。現在は限定ベータ版として提供されており、利用はアカウントごとに有効化されます。利用を希望する場合は、担当CSMにお問い合わせください。
APIで管理するルールは、管理画面にも表示されますか？
はい。 APIで作成したルールは、AppsFlyerの管理画面にも表示されます。ただし、「API管理」の区分が付き、読み取り専用となります。
一部のルールをAPIで管理し、他のルールを管理画面で管理できますか？
はい。同じアカウント内で、APIで管理するルールと管理画面で作成したルールを併用できます。 APIで管理するルールは、管理画面では読み取り専用として表示されます。管理画面で作成したルールには、APIからアクセスできません。
APIで管理するルールを、管理画面で編集できますか？
いいえ。管理画面では読み取り専用となります。更新にはAPIを使用する必要があります。
全体更新（Update）と部分更新（Patch）の違いは何ですか？
全体更新（Update）は、ルール全体を上書きします。部分更新（Patch）は、1つの条件項目のみを更新します。ルール全体を上書きせずに、値を追加、削除、置換できます。特定の項目を頻繁に更新する場合は、部分更新（Patch）を使用してください。
上限を超えるとどうなりますか？
超過した上限を示すエラーがAPIから返されます。データ量の多い更新は、1回あたり2MBの上限内に収まるよう、複数回のAPI呼び出しに分割してください。
ルールはいくつまで登録できますか？
1つのアカウントに、標準ルールは最大100件、大規模ルールは最大5件まで登録できます。標準ルール・大規模ルールともに、別途有効化が必要です。有効化については、担当CSMにお問い合わせください。
ORによる論理演算には対応していますか？
いいえ。条件項目間の論理演算は、AND（すべての条件を満たす）のみに対応しています。
どのイベントの種類に対応していますか？
インストールイベントのみです。このバージョンでは、アプリ内イベントには対応していません。
関連記事