Rules Management API

MAXダッシュボードから、新しい競合他社ルールやリスクのあるコンテンツのルールを作成できます。 これらは一度に1つずつ作成します。 しかし、このページで説明するAd Review Rules Management APIを使用すると、1回のリクエストで多数のルールを表示または作成することもできます。

このAPIには2つのエンドポイントがあります。

1. /v1/rules/competitors
   • 事前に定義されたすべての競合他社ルール（アクティブおよび一時停止中のルール）を表示するには、/v1/rules/competitorsにGETリクエストを送信します。
   • 新しい競合他社ルールを作成するには、/v1/rules/competitorsにPOSTリクエストを送信します。
2. /v1/rules/risky
   • 事前に定義されたすべてのリスクのあるコンテンツのルール（アクティブおよび一時停止中のルール）を表示するには、/v1/rules/riskyにGETリクエストを送信します。
   • 新しいリスクのあるコンテンツのルールを作成するには、/v1/rules/riskyにPOSTリクエストを送信します。

このページの以降のセクションで、これらのエンドポイントについて詳しく説明します。

ターゲットURL

https://api-safedk.applovin.com/v1/rules/competitors

POST リクエストボディ

例

{
  "rules": [
    {
      "name": "android title rule",
      "platform": "android",
      "package_names": ["com.mytest.app"],
      "rule_type": "title",
      "value": ["com.examplegames.solitaire", "com.eg.Bricks"]
    },
    ⋮
  ]
}

リクエストボディ要素の表

発生し得るエラー

• 400 (Bad Request): リクエストのボディ構造が無効な場合。
• 401 (Unauthorized): 各APIリクエストを認証する必要があります。 認証を行うには、リクエストにApi-Key HTTPヘッダーを追加し、その値にお使いのアカウントのAd Review Keyを設定します。 Ad Review Keyは、AppLovinダッシュボードのAccount > General > Keysセクションで確認できます。

レスポンス形式 (POST)

レスポンスには、次の3つの要素を持つハッシュが含まれます。

1. updated_rules — 新しく作成されたルール、およびこのリクエストによって再アクティブ化された一時停止中のルール
2. existing_rules
3. invalid_rules

これらの各要素には以下が含まれます。

1. total — この要素がカバーするルールの総数を示す整数
2. rules — 関連する rule オブジェクトを含む配列（POST リクエスト内にあるものと同じ種類の rule オブジェクト。このオブジェクトの要素については、上記の「リクエストボディ要素の表」を参照してください）

レスポンス形式 (GET)

リクエストが成功すると、既存のすべてのカスタム競合他社ルールオブジェクトの配列が返されます。 これには、MAX Ad Reviewによって自動生成されたルールは含まれません。 このレスポンスオブジェクトの要素には、name、platform、package_names、rule_type、value（これらの要素の説明については、上記の「リクエストボディ要素の表」を参照してください）、およびルールがアクティブな場合は true、そうでない場合は false となる is_active が含まれます。

例

[
  {
    "name": "android title rule",
    "platform": "android",
    "package_names":["com.test.my_first_app","com.test.my_second_app"],
    "rule_type": "title",
    "value": ["solitaire", "block", "com.games.solitaire", "com.bestgames.Bricks"],
    "is_active": "true"
  },
  {
    "name": "ios title rule",
    "platform": "ios",
    "rule_type": "title",
    "value": ["1449713068"],
    "is_active": "false"
  }
]

/v1/rules/risky エンドポイント

新しいリスクのあるコンテンツのルールを作成するには、risky エンドポイントに POST リクエストを送信します。 以下で説明するように、リクエストボディに必要なフィールドを含めます。 1回のリクエストで複数のリスクのあるコンテンツのルールを作成できます。 これにより、すべての新しいルールがアクティブなステータスで作成されます。

同一のアクティブなリスクのあるコンテンツのルールがすでに存在する場合、APIはそのルールを二重に追加しません。 代わりに、レスポンスの existing_rules 配列にそのルールを含めます。 同一の一時停止中のルールが存在する場合、そのステータスはアクティブに変更されます。 すべての新規または再アクティブ化されたルールは、レスポンスの updated_rules 配列に表示されます。 ルールに無効な値が含まれている場合、APIはそのルールを追加せず、レスポンスの invalid_rules 配列に含めます。

既存のすべてのリスクのあるコンテンツのルール（アクティブおよび一時停止中のルール）を表示するには、risky エンドポイントに GET リクエストを送信します。

ターゲットURL

https://api-safedk.applovin.com/v1/rules/competitors

POST リクエストボディ

例

{
  "rules": [
    {
      "name": "android title rule",
      "platform": "android",
      "package_names": ["com.mytest.app"],
      "rule_type": "title",
      "value": ["com.examplegames.solitaire", "com.eg.Bricks"]
    },
    ⋮
  ]
}

リクエストボディ要素の表

発生し得るエラー

• 400 (Bad Request): リクエストのボディ構造が無効な場合。
• 401 (Unauthorized): 各APIリクエストを認証する必要があります。 認証を行うには、リクエストにApi-Key HTTPヘッダーを追加し、その値にお使いのアカウントのAd Review Keyを設定します。 Ad Review Keyは、AppLovinダッシュボードのAccount > General > Keysセクションで確認できます。

レスポンス形式 (POST)

レスポンスには、次の3つの要素を持つハッシュが含まれます。

1. updated_rules — 新しく作成されたルール、およびこのリクエストによって再アクティブ化された一時停止中のルール
2. existing_rules
3. invalid_rules

これらの各要素には以下が含まれます。

1. total — この要素がカバーするルールの総数を示す整数
2. rules — 関連する rule オブジェクトを含む配列（POST リクエスト内にあるものと同じ種類の rule オブジェクト。このオブジェクトの要素については、上記の「リクエストボディ要素の表」を参照してください）

レスポンス形式 (GET)

リクエストが成功すると、既存のすべてのカスタム競合他社ルールオブジェクトの配列が返されます。 これには、MAX Ad Reviewによって自動生成されたルールは含まれません。 このレスポンスオブジェクトの要素には、name、platform、package_names、rule_type、value（これらの要素の説明については、上記の「リクエストボディ要素の表」を参照してください）、およびルールがアクティブな場合は true、そうでない場合は false となる is_active が含まれます。

例

[
  {
    "name": "android title rule",
    "platform": "android",
    "package_names":["com.test.my_first_app","com.test.my_second_app"],
    "rule_type": "title",
    "value": ["solitaire", "block", "com.games.solitaire", "com.bestgames.Bricks"],
    "is_active": "true"
  },
  {
    "name": "ios title rule",
    "platform": "ios",
    "rule_type": "title",
    "value": ["1449713068"],
    "is_active": "false"
  }
]

/v1/rules/risky エンドポイント

新しいリスクのあるコンテンツ of ルールを作成するには、risky エンドポイントに POST リクエストを送信します。 以下で説明するように、リクエストボディに必要なフィールドを含めます。 1回のリクエストで複数のリスクのあるコンテンツのルールを作成できます。 これにより、すべての新しいルールがアクティブなステータスで作成されます。

同一のアクティブなリスクのあるコンテンツのルールがすでに存在する場合、APIはそのルールを二重に追加しません。 代わりに、レスポンスの existing_rules 配列にそのルールを含めます。 同一の一時停止中のルールが存在する場合、そのステータスはアクティブに変更されます。 すべての新規または再アクティブ化されたルールは、レスポンスの updated_rules 配列に表示されます。 ルールに無効な値が含まれている場合、APIはそのルールを追加せず、レスポンスの invalid_rules 配列に含めます。

既存のすべてのリスクのあるコンテンツのルール（アクティブおよび一時停止中のルール）を表示するには、risky エンドポイントに GET リクエストを送信します。

ターゲットURL

https://api-safedk.applovin.com/v1/rules/risky

POST リクエストボディ

例

{
  "rules": [
    {
      "name": "android title rule",
      "platform": "android",
      "package_names": ["com.my.android.test.app"],
      "rule_type": "title",
      "value": ["com.games.solitaire","com.games.Bricks"]
    },
    {
      "name": "ios title rule",
      "platform": "ios",
      "rule_type": "title",
      "value": ["1349713000"]
    },
    {
      "name": "store_category rule",
      "platform": "ios",
      "rule_type": "store_category",
      "value": ["Action", "Card"]
    },
    {
      "name": "advertiser ios rule",
      "platform": "ios",
      "rule_type": "advertiser",
      "value": ["ExampleAdvertiser1", "ExampleAdvertiser2"]
    },
    {
      "name": "content_rating ios rule",
      "platform": "ios",
      "rule_type": "content_rating",
      "value": ["12+", "17+"]
    },
    {
      "name": "advisory ios rule",
      "platform": "ios",
      "rule_type": "advisory",
      "value": ["Frequent/Intense Alcohol, Tobacco or Drug Use or References"]
    },
    {
      "name": "web_domain rule",
      "platform": "ios",
      "rule_type": "web_domain",
      "value": ["test.com", "example.com"]
    },
    {
      "name": "ios_platform_with_android_package_name_rule",  //invalid rule
      "platform": "ios",
      "package_names": "com.my.android.test.app",
      "rule_type": "title",
      "value": ["1449713068"]
    },
    {
      "name": "ios_platform_with_android_title_value",  //invalid rule
      "platform": "ios",
      "rule_type": "title",
      "value": ["1449713068", "com.games.solitaire1"]
    },
    {
      "name": "ios_platform_with_android_content_rating_value",  //invalid rule
      "platform": "ios",
      "rule_type": "content_rating",
      "value": ["Everyone"]
    }
  ]
}

このリクエストに対するレスポンスで、無効なルールがどのように報告されるかについては、下記の「レスポンス形式 (POST): 例」を参照してください。

リクエストボディ要素の表

発生し得るエラー

• 400 (Bad Request): リクエストのボディ構造が無効な場合。
• 401 (Unauthorized): 各APIリクエストを認証する必要があります。 認証を行うには、リクエストにApi-Key HTTPヘッダーを追加し、その値にお使いのアカウントのAd Review Keyを設定します。 Ad Review Keyは、AppLovinダッシュボードのAccount > General > Keysセクションで確認できます。

レスポンス形式 (POST)

レスポンスには、次の3つの要素を持つハッシュが含まれます。

1. updated_rules — 新しく作成されたルール、およびこのリクエストによって再アクティブ化された一時停止中のルール
2. existing_rules
3. invalid_rules

これらの各要素には以下が含まれます。

1. total — この要素がカバーするルールの総数を示す整数
2. rules — 関連する rule オブジェクトを含む配列（POST リクエスト内にあるものと同じ種類の rule オブジェクト。このオブジェクトの要素については、上記の「リクエストボディ要素の表」を参照してください）

例

"updated_rules": {
  "total": 6
  "rules": {[
    {
      "name": "android title rule",
      "platform": "android",
      "package_names": ["com.my.android.test.app"],
      "rule_type": "title",
      "value": ["com.games.solitaire","com.games.Bricks"]
    }, {…},{…},{…},{…},{…}
  ]
},
"invalid_rules": {
  "total": 3
  "rules": [
    {
      "name": "ios_platform_with_android_package_name_rule",  //invalid rule
      "platform": "ios",
      "my_apps_package_name": "com.my.android.test.app",
      "rule_type": "title",
      "value": ["1449713068"]
    }, {…},{…}
  ]
},
"existing_rules": {
  "total": 1
  "rules":[
    {
      "name": "web_domain rule",
      "platform": "ios",
      "rule_type": "web_domain",
      "value": ["test.com", "example.com"]
    }
  ]
}

レスポンス形式 (GET)

リクエストが成功すると、既存のすべてのカスタムリスクのあるコンテンツのルールオブジェクトの配列が返されます。 これには、MAX Ad Reviewによって自動生成されたルールは含まれません。 このレスポンスオブジェクトの要素には、name、platform、package_names、rule_type、value（これらの要素の説明については、上記の「リクエストボディ要素の表」を参照してください）、およびルールがアクティブな場合は true、そうでない場合は false となる is_active が含まれます。

例

[
  {
    "name": "android title rule",
    "platform": "android",
    "package_names":["com.test.my_first_app","com.test.my_second_app"],
    "rule_type": "title",
    "value": ["solitaire", "block", "com.games.solitaire", "com.bestgames.Bricks"],
    "is_active": "true"
  },
  {
    "name": "ios title rule",
    "platform": "ios",
    "rule_type": "title",
    "value": ["1449713068"],
    "is_active": "false"
  }
]

タイムアウトを回避するための GET リクエストの制限

ルールが多すぎる場合、これらのエンドポイントへの GET リクエストは、すべてのルールを取得して送信しようとする間にタイムアウトする可能性があります。 これを解決するには、これらのエンドポイントが返すルールの数を制限できます。 これを行うには、limit クエリパラメータを追加します。 その後、offset クエリパラメータを追加することで、すべてのルールをページネーションできます。 例えば：

1. GET /v1/rules/risky?limit=10&offset=0 — 最初のリスクのあるコンテンツのルール10件を取得する
2. GET /v1/rules/risky?limit=10&offset=10 — 次のリスクのあるコンテンツのルール10件を取得する
3. GET /v1/rules/risky?limit=10&offset=20 — さらに次のリスクのあるコンテンツのルール10件を取得する
4. ⋮

リストの最後に達し、返すルールがなくなると、レスポンスは空の配列になります。

有効なルール値

変更履歴