オプショングループ

​

オプショングループとは

• 階層は1段階のみ：下位オプションは常に通常のオプション（type: "atomic"）です。オプショングループは常に最上位のオプションで、ほかのオプショングループを含むことはできません。
• 空にはできない：オプショングループには、下位オプションか自身のコンテキストIDが少なくとも1つ必要です。
• 自身のコンテキストIDは一意：オプショングループ自身のコンテキストIDを、プロジェクト内のほかのオプショングループの自身のコンテキストIDと重複させることはできません。制約事項を参照してください。
• 名前：オプショングループと下位オプションの名前は名前のルールに従い、オプショングループと下位オプションを含めてターゲティング内で一意である必要があります。重複すると409 TARGETING_CATEGORY_NAME_DUPLICATEで失敗します。

• オプションの取得のcontextsにはオプショングループ自身のコンテキストIDだけが含まれ、offsetとlimitでページ単位に取得します（合計ownContextCount件）。下位オプションのコンテキストIDは、各下位オプションを取得して確認してください。
• childCountが50を超える場合は、オプション一覧の取得でparentクエリパラメータにオプショングループIDを指定すると、すべての下位オプションを取得できます。

​

オプショングループの作成

​

リクエスト

POST /context-targeting/{targetingId}/category

​

パスパラメータ

​

リクエストボディ

• childrenに1件以上の項目、またはcontextsに1つ以上のコンテキストIDを指定してください。どちらもないオプショングループは400 TARGETING_CATEGORY_NOT_SUPPORTEDで失敗します。type: "atomic"とchildrenを一緒に指定した場合も同様です。
• childrenの項目に指定できるのはnameとcontextsだけです。下位オプションが自身の下位オプションを持つことはできません。
• オプショングループ自身のコンテキストIDのいずれかが、プロジェクト内のほかのオプショングループの自身のコンテキストIDとしてすでに使われている場合、リクエストは400 TARGETING_COLLECTION_CONTEXT_DUPLICATEDで失敗します。制約事項を参照してください。
• 新しいオプショングループは新しい最上位オプションなので、ほかの新しいオプションと同じく広告商品とキャンペーンへの影響が適用されます。

​

リクエスト例

curl -X POST https://lake.adrop.io/context-targeting/01JAB3XK5Q8V7M2N4P6R9T0W1Y/category \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Sports",
    "type": "collection",
    "contexts": ["sport"],
    "children": [
      { "name": "Baseball", "contexts": ["baseball"] }
    ]
  }'

{
  "name": "Sports",
  "type": "collection",
  "contexts": ["sport"]
}

​

レスポンス例

{
  "_id": "01JAB3XK5SB1C2D3E4F5G6H7J8",
  "name": "Sports",
  "type": "collection",
  "contextCount": 2,
  "ownContextCount": 1,
  "exposeChildren": false,
  "children": ["01JAB3XK5TC1D2E3F4G5H6J7K8"],
  "childCount": 1,
  "createdAt": "2026-10-13T01:23:45.000Z",
  "updatedAt": "2026-10-13T01:23:45.000Z"
}

​

オプショングループへのオプション追加

• parentには、同じターゲティング内の最上位のオプショングループを指定する必要があります。ターゲティングにそのIDのオプションがない場合、リクエストは404 TARGETING_CATEGORY_NOT_FOUNDで失敗します。そのオプションがオプショングループでない場合は400 TARGETING_CATEGORY_NOT_SUPPORTEDで失敗します。
• 新しいオプションは通常のオプションになります。parentと一緒にtype: "collection"、children、exposeChildrenのいずれかを指定すると、400 TARGETING_CATEGORY_NOT_SUPPORTEDで失敗します。
• オプショングループは、新しいオプションのコンテキストIDにも一致するようになります。オプショングループを含むキャンペーンはそれらのコンテキストIDもターゲットにし、オプショングループを除外するキャンペーンはそれらも除外するようになります。広告商品の設定は変わりません。

​

リクエスト

POST /context-targeting/{targetingId}/category

​

パスパラメータ

​

リクエストボディ

​

リクエスト例

curl -X POST https://lake.adrop.io/context-targeting/01JAB3XK5Q8V7M2N4P6R9T0W1Y/category \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Soccer",
    "contexts": ["soccer"],
    "parent": "01JAB3XK5SB1C2D3E4F5G6H7J8"
  }'

​

レスポンス例

{
  "_id": "01JAB3XK5TC1D2E3F4G5H6J7K9",
  "name": "Soccer",
  "type": "atomic",
  "contextCount": 1,
  "parent": "01JAB3XK5SB1C2D3E4F5G6H7J8",
  "createdAt": "2026-10-13T01:25:10.000Z",
  "updatedAt": "2026-10-13T01:25:10.000Z"
}

​

オプションの移動と切り離し

• オプショングループIDを指定すると、オプションは最上位またはほかのオプショングループから、そのオプショングループの下に移動します。
• nullを指定すると、下位オプションはオプショングループから切り離され、最上位に移動します。

• オプショングループは移動できません。オプショングループにparentを指定すると400 TARGETING_CATEGORY_NOT_SUPPORTEDで失敗します。
• 移動先は、同じターゲティング内の最上位のオプショングループである必要があります。そうでない場合、リクエストは404 TARGETING_CATEGORY_NOT_FOUNDまたは400 TARGETING_CATEGORY_NOT_SUPPORTEDで失敗します。
• 自身のコンテキストIDを持たないオプショングループの最後の下位オプションは、移動も切り離しもできません。リクエストは400 TARGETING_CATEGORY_NOT_SUPPORTEDで失敗します。

​

リクエスト

PATCH /context-targeting/category/{categoryId}

​

パスパラメータ

​

リクエストボディ

​

リクエスト例

curl -X PATCH https://lake.adrop.io/context-targeting/category/01JAB3XK5TC1D2E3F4G5H6J7K9 \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "parent": null }'

{
  "parent": "01JAB3XK5SB1C2D3E4F5G6H7J8"
}

​

レスポンス例

{
  "_id": "01JAB3XK5TC1D2E3F4G5H6J7K9",
  "name": "Soccer",
  "type": "atomic",
  "contextCount": 1,
  "createdAt": "2026-10-13T01:25:10.000Z",
  "updatedAt": "2026-10-13T01:30:00.000Z"
}

​

下位オプションを広告主に表示

• 広告主が下位オプションを選択できるのは、広告商品でそのオプショングループの選択方法が 自由選択 の場合だけです。ターゲティングの販売を参照してください。
• exposeChildrenによって、オプショングループが一致する対象は変わりません。変更しても、既存の広告商品やキャンペーンは変更されません。
• exposeChildrenを指定できるのはオプショングループだけです。ほかのオプションに指定すると400 TARGETING_CATEGORY_NOT_SUPPORTEDで失敗します。nullは400で失敗するため、値はtrueまたはfalseで指定してください。
• オプショングループの作成時に設定することもできます。

​

リクエスト

PATCH /context-targeting/category/{categoryId}

​

パスパラメータ

​

リクエストボディ

​

リクエスト例

curl -X PATCH https://lake.adrop.io/context-targeting/category/01JAB3XK5SB1C2D3E4F5G6H7J8 \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "exposeChildren": true }'

​

レスポンス例

{
  "_id": "01JAB3XK5SB1C2D3E4F5G6H7J8",
  "name": "Sports",
  "type": "collection",
  "contextCount": 3,
  "ownContextCount": 1,
  "exposeChildren": true,
  "children": ["01JAB3XK5TC1D2E3F4G5H6J7K8", "01JAB3XK5TC1D2E3F4G5H6J7K9"],
  "childCount": 2,
  "createdAt": "2026-10-13T01:23:45.000Z",
  "updatedAt": "2026-10-13T01:35:00.000Z"
}

​

オプショングループの削除

• 下位オプションは最上位に移動し、広告商品とキャンペーンにおけるオプショングループの設定を引き継ぎます。たとえば、広告商品で Sports が 必須含む に設定されている場合は Baseball と Soccer が 必須含む になり、Sportsを含んでいたキャンペーンはBaseballとSoccerを含むようになります。
• オプショングループ自身のコンテキストIDは削除され、一致しなくなります。この例では、Sportsを含んでいたキャンペーンはsportに一致しなくなります。
• 設定の引き継ぎにより 必須含む または 必須除外 に設定されたオプションが500個を超える広告商品が生じる場合、リクエストは400 AD_PRODUCT_TARGETING_POLICY_LIMIT_EXCEEDEDで失敗し、何も削除されません。

​

リクエスト

DELETE /context-targeting/category/{categoryId}

​

パスパラメータ

​

リクエスト例

curl -X DELETE https://lake.adrop.io/context-targeting/category/01JAB3XK5SB1C2D3E4F5G6H7J8 \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

​

レスポンス例

{
  "_id": "01JAB3XK5SB1C2D3E4F5G6H7J8"
}

​

制約事項

• オプショングループは移動できず、オプションのタイプは作成後に変更できません。既存のオプションをまとめるには、オプショングループを作成してから、その下にオプションを移動します。新しいオプショングループは空にできないため、自身のコンテキストIDか新しい下位オプションを指定して作成してください。
• childrenで作成した下位オプションも、1リクエストあたりと1ターゲティングあたりのオプション数の上限に含まれます。上限を参照してください。

• オプショングループ自身のコンテキストIDは、ほかのオプショングループがどのコンテキストターゲティングにあっても、プロジェクト内のほかのオプショングループの自身のコンテキストIDと重複できません。通常のオプションと下位オプションは、どのオプションともコンテキストIDを共有できます。
• このルールは、オプショングループの作成時と、addまたはsetでオプショングループに自身のコンテキストIDを追加するときに適用されます。重複すると400 TARGETING_COLLECTION_CONTEXT_DUPLICATEDで失敗し、detail.conflictsには、重複したコンテキストIDとそれをすでに持つオプショングループが最大20件まで含まれます。エラーコードを参照してください。

• 一括削除の場合、エラーコードはTARGETING_CATEGORY_TREE_ITEMS_LIMIT_EXCEEDEDです。detail.limitは上限、detail.countはリクエストに含まれるオプショングループと下位オプションの数です。
• オプショングループ名の変更、自身のコンテキストIDの変更、exposeChildrenの設定は、オプショングループ関連項目に含まれません。

• オプショングループが先：下位オプションは最上位に移動してオプショングループの設定を引き継いだ後、最上位のオプションとして削除されます。オプショングループを含んでいたキャンペーンから、その条件がなくなることがあります。
• 下位オプションが先：オプショングループが自身のコンテキストIDを持たない場合、最後の下位オプションの削除は400 TARGETING_CATEGORY_NOT_SUPPORTEDで失敗します。そのオプションは、その後オプショングループが削除されたときに最上位に移動します。