Context APIエンジンを作成および構成し、アクセス制御と属性選択を含む。
エンジンを作成する前に、アカウントでContext APIが有効になっている必要があります。有効にするにはサポートに連絡してください。
エンジンの作成
エンジン属性を選択する前に、プロファイルの変更が公開されていることを確認してください。
詳細画面のフィルタールールフィールドは、プロファイルがバージョン管理保存に移行された後にのみ表示されます。詳細については、エンジン構成の移行を参照してください。
エンジンを作成するには、次の手順を完了します：
Activate > Context API に移動し、+ New Engine をクリックします。
Details 画面で、以下のエンジン詳細を構成します：
- Name: エンジンの名前を入力します。
- Enable Engine: エンジンをオンまたはオフに切り替えます。デフォルトではエンジンエンドポイントはオフです。エンジンを有効にし、訪問がアクティブなセッションを記録し、システムでイベントを生成した後、訪問のデータが利用可能になります。
認証とPIIの許可はリクエストによりのみ利用可能です。これらの機能を試してみたい場合は、サポートに連絡してください。
- Authentication: このエンドポイントへのリクエストが認証を必要とするかどうかを制御します。
- Public (デフォルト): エンジンIDを持つ任意の呼び出し元がエンドポイントを呼び出すことができます。
- Require Authentication: 認証されたクライアントのみがエンジンを呼び出すことができます。認証されていないリクエストは401エラーを返します。呼び出し元はDeveloper PortalでContext APIを購読し、
Authorizationヘッダーにベアラートークンを含める必要があります。詳細については、開発者ポータルのサブスクリプションを参照してください。
- Allow PII: Require Authenticationが選択されている場合にのみ利用可能です。オンの場合、制限された（PIIとマークされた）属性がResponse画面で標準属性とともに選択可能になります。自動的には何も選択されません。
- Allow PIIをオフにすると、すぐにエンジンからすべての制限された属性が削除されます。変更が有効になる前に、影響を受ける属性をリストする確認ダイアログが表示されます。これらの属性は復元できません。
- Allow PIIをオフにしても、以前に保存されたPIIは削除されません。以前に保存されたデータをアクセス不可能にするには、Allow PIIをオフにした後にエンジンデータをパージします。詳細については、データのパージを参照してください。
- Publicに戻すと、Allow PIIは自動的にオフになり、同じ確認ダイアログがトリガーされます。
- Filter Rule: 必要に応じて、このエンジンに書き込まれ、読み取られる訪問を制限するルールを追加します。詳細については、Context APIについて: フィルタールールを参照してください。
- Domain Allow List: このエンドポイントを使用できるドメインを指定します。詳細については、Context APIについて: ドメイン許可リストを参照してください。
Next をクリックします。
Response 画面で、エンジンに含めるオーディエンス、バッジ、および属性を選択します。Example Responseパネルを使用して選択を確認します。
Select all current and future audiences機能を使用する場合、後でオーディエンスが削除された場合でも、エンジンデータをパージするか、データが期限切れになるまでContext APIエンジンに含まれ続ける可能性があります。
ペイロードでオーディエンスと訪問属性のID（UID）または名前を使用するかどうかを選択します。大きなレスポンスでオーディエンス、バッジ、および属性の名前をIDの代わりに使用すると、ペイロードサイズに影響を与える可能性があります。
Next をクリックしてエンジンを作成します。
Summary 画面で、エンドポイントの詳細を含む一意のエンドポイントURLを確認します。
Done をクリックし、その後 Save and Publish をクリックしてエンジン構成を適用します。
訪問データは、エンジンが有効になり、訪問がアクティブなセッションを持っている後に収集されます。
エンジンの編集
エンジンを編集するには、Context API画面に移動し、更新したいエンジンをクリックします。編集画面から、エンジンの詳細とレスポンス構成を更新し、エンジンデータをパージし、エンジンをオンまたはオフに切り替え、認証とPIIの構成を調整することができます。
編集画面からAllow PIIをオフにすると、エンジンの作成で説明されている同じ確認ダイアログがトリガーされます。
エンジンを編集した後はSave and Publishをクリックして変更を適用してください。
フィルタールールの追加
Filter Ruleセクションは、プロファイルがバージョン管理保存に移行された後にのみ表示されます。表示されない場合は、エンジン構成の移行を参照してください。
フィルタールールは、エンジンに書き込まれ、読み取られる訪問を制限します。概念的な概要については、Context APIについて: フィルタールールを参照してください。
既存のエンジンにフィルタールールを追加するには：
- Activate > Context API に移動し、更新したいエンジンをクリックします。
- Detailsタブで、Filter Ruleセクションに移動します。
- + Add Ruleをクリックします。
- ルールビルダーで、訪問属性を使用して条件を構成します。利用可能なのは訪問属性のみです。has changed演算子は利用できません。
- Saveをクリックします。
フィルタールールがアクティブになると、条件に一致する訪問のみがエンジンに書き込まれ、返されます。条件に一致しない訪問は読み取り時に404を返します。
フィルタールールを削除するには、Filter Ruleセクションを開き、+ Add Ruleの隣のドロップダウン矢印をクリックしてRemove ruleを選択します。
データのパージ
次の状況では、エンジンデータのパージをお勧めします：
- エンジン構成に含まれているオーディエンス、バッジ、または属性の名前を変更または削除する場合。
- エンジン構成からオーディエンス、バッジ、または属性を削除する場合。
- エンジンでAllow PIIをオフにする場合。制限された属性は将来のレスポンスからすぐに削除されますが、以前に保存されたデータはパージするまでエンジンに残ります。パージすると、そのデータはアクセス不可能になります。
データのパージについての詳細は、Context APIについて: データのパージを参照してください。
必要に応じてエンジンデータをパージするための2つの方法がContext APIにはあります：
- Context API画面で、データをパージしたいエンジンのアクションメニューをクリックし、Purge Dataを選択します。
- Edit Engines画面で、スライドアウトアクションからPurge Dataをクリックします。
データをパージした後、以前に保存されたエンジンデータは返されなくなります。
エンジン構成の移行
2026年9月30日から、Context APIのエンジン構成が標準の保存および公開ワークフローに移行します。移行後、エンジン構成の変更はバージョン管理され、プロファイルと共にロールバックされます。
既存の構成を移行するために、ログイン時に移行ポップアップが表示されます。このポップアップでは移行について説明し、移行するか、メッセージを閉じて後で移行するかのオプションが提供されます。
次のすべての条件が満たされた場合に移行ポップアップが表示されます：
- プロファイルに公開権限がある。
- プロファイルが現在の公開バージョンにある。
- 他の保留中の未保存変更がない。
公開権限がないユーザーには移行を促すプロンプトが表示されず、通常どおりContext APIを使用できます。移行を完了するには、公開権限を持つユーザーがプロンプトを受け入れて保存して公開をクリックする必要があります。
今はしないを選択した場合、プロンプトは閉じられ、移行を完了するまで将来のページ読み込み時に再表示されます。
エンジン構成を移行するには：
- 移行プロンプトが表示されたら、エンジンの移行をクリックします。
- 変更を適用して移行を完了するために、保存して公開をクリックします。
移行プロンプトを受け入れると、既存のエンジン構成が保存および公開ワークフローに移動します。エンジンは削除または置換されません。エンジン構成は移行時点からバージョン管理されます。移行前に行われた変更は遡ってバージョン管理されません。
移行を完了したプロファイルに追加された新しいエンジンはバージョン管理されます。まだ移行していないプロファイルに追加された新しいエンジンは、移行が完了するまでバージョン管理されません。
最終更新日 :: 2026年September月30日