データハイジーン API ガイド
Data Hygiene API を使用すると、Adobe Experience Platform に保存された顧客の個人データをプログラムで修正または削除したり、データセットの有効期限をスケジュール設定したりできます。このガイドでは、API を使用するための前提条件の手順を説明し、よりエンドポイントに特化したドキュメントへのリンクを提供します。
はじめに
ルートパス https://platform.adobe.io/data/core/hygiene/ を使用して、Data Hygiene API にアクセスできます。
これ以降の節では、API を呼び出す前に知っておく必要のある中心概念について説明します。
必須ヘッダーの値の収集
Data Hygiene API を呼び出すには、まず認証資格情報を収集する必要があります。API 認証ガイドに従って、次に示すように、Data Hygiene API に必要な各ヘッダーの値を生成します。
Authorization: Bearer {ACCESS_TOKEN}x-api-key: {API_KEY}x-gw-ims-org-id: {ORG_ID}
ペイロード（POST、PUT、PATCH）を含むすべてのリクエストには、次のような追加ヘッダーが必要です。
Content-Type: application/json
API 呼び出し例の読み取り
このドキュメントでは、リクエストの形式を示すために、API 呼び出しの例を提供しています。サンプル API 呼び出しのドキュメントで使用されている規則については、Experience Platform API の開始ガイドのAPI 呼び出し例の読み方に関する節を参照してください。
データセット有効期限
データセットの有効期限は、時間差の「データセットの削除」アクションです。データセットの有効期限を作成すると、そのデータセットが削除されるべき将来の時間を指定することになります。API でのデータセット有効期限のスケジュール設定について詳しくは、データセット有効期限のエンドポイントガイドを参照してください。
レコード削除
Data Hygiene API を使用すると、1 つまたはすべてのデータセットにわたって、ID に関連付けられたすべてのレコードを削除できます。 ID を削除するすべてのデータライフサイクルタスクは、作業指示と呼ばれる構成によって表されます。 API でのレコード削除の操作について詳しくは、 作業指示エンドポイントガイドを参照してください。
割り当て量
組織は、データライフサイクル操作のタイプごとに、事前に定義された 1 か月のジョブの割り当て量が制限されています。この制限は、ライセンスに応じて異なる場合があります。 データライフサイクルプロセスの現在の割り当て量のステータスを表示する方法について詳しくは、 割り当て量のエンドポイントガイドを参照してください。
次の手順
このガイドでは、API 呼び出しを使用したデータライフサイクルリクエストの管理方法について説明しました。 Platform UI でこれらのアクションを実行する方法について詳しくは、 データライフサイクル UI ガイドを参照してください。