Moments APIエンジンの管理

Moments APIをアカウントで有効にするには、アカウントマネージャーに連絡してください。

エンジンの作成

エンジン属性を選択する前に、プロファイルの変更が公開されていることを確認してください。

エンジンを作成するには、次の手順を完了します：

1. AudienceStream > Moments API に移動し、+ New Engine をクリックします。

2. Details 画面で、以下のエンジン詳細を構成します：

   • Name: エンジンの名前を入力します。
   • Enable Engine: エンジンをオンまたはオフに切り替えます。デフォルトではエンジンエンドポイントはオフです。エンジンを有効にし、訪問がアクティブなセッションを記録し、システムでイベントを生成した後、訪問のデータが利用可能になります。
   • Domain Allow List: このエンドポイントを使用できるドメインを指定します。詳細については、About Moments API > Domain allow listを参照してください。

3. Next をクリックします。

4. Response 画面で、エンジンに含めるオーディエンス、バッジ、および属性を選択します。Example Response パネルを使用して選択を確認できます。

   Select all current and future audiences 機能を使用する場合、オーディエンスが後で削除されたとしても、エンジンデータを消去するかデータが期限切れになるまでMoments APIエンジンに含まれ続ける可能性があります。

5. ペイロードでオーディエンスと訪問属性のID（UID）または名前を使用するかどうかを選択します。大きなレスポンスでIDの代わりにオーディエンス、バッジ、および属性の名前を使用すると、ペイロードサイズに影響を与える可能性があります。

6. Next をクリックしてエンジンを作成します。

7. Summary 画面で、エンドポイントの詳細を含む一意のエンドポイントURLを確認します。

8. Done をクリックします。エンジンを作成した後、プロファイルを公開する必要はありません。

エンジンが有効になり、訪問がアクティブなセッションを持っている場合、訪問データが収集されます。

エンジンの編集

エンジンを編集するには、Moments API画面に移動し、更新したいエンジンをクリックします。Edit Engine 画面から、エンジンの詳細とレスポンス構成を更新し、エンジンデータを消去し、必要に応じてエンジンをオンまたはオフに切り替えることができます。

エンジンを編集した後、プロファイルを公開する必要はありません。構成変更を保存してから5分後にMoments APIエンジンの変更が利用可能になります。

データの消去

ユーザーがAudienceStreamのオーディエンス、バッジ、属性を削除または名前を変更すると、エンジンでも使用されている場合、エンドポイントのレスポンスに予期しない結果が生じる可能性があります。このような場合、エンジンデータの消去を検討することが望ましいかもしれません。データの消去についての詳細は、About Moments API > Purge Dataを参照してください。

必要に応じてエンジンデータを消去するための2つの方法がMoments APIにはあります：

1. Moments API 画面で、データを消去したいエンジンの横にあるアクションメニューをクリックし、Purge Data を選択します。
2. Edit Engines 画面で、スライドアウトアクションから Purge Data をクリックします。

データを消去した後、以前に保存された訪問データは利用できなくなります。