プロファイルシステムジョブエンドポイント(削除要求)

Adobe Experience Platform を使用すると、複数のソースからデータを取得し、個々の顧客に対して堅牢なプロファイルを構築できます。 Experience Platformに取り込まれたデータはData Lakeに保存され、データセットがプロファイルに対して有効になっている場合、そのデータもReal-Time Customer Profile データストアに保存されます。 場合によっては、不要になったデータやエラーで追加されたデータを削除するために、プロファイルストアからデータセットに関連付けられたプロファイルデータを削除する必要があります。 これには、Real-Time Customer Profile APIを使用してProfile システムジョブまたは「delete リクエスト」を作成する必要があります。

NOTE
Data Lakeからデータセットまたはバッチを削除する場合は、​ カタログサービスの概要にアクセスして詳細を確認してください。

はじめに

このガイドで使用する API エンドポイントは、Real-Time Customer Profile API の一部です。 先に進む前に、はじめる前にを参照し、関連ドキュメントへのリンク、このドキュメントのサンプル API 呼び出しを読み取るためのガイドおよび任意の Experience Platform API を正常に呼び出すために必要なヘッダーに関する重要な情報を確認してください。

削除リクエストの表示 view

削除リクエストは長時間実行される非同期プロセスです。つまり、組織が複数の削除リクエストを一度に実行している場合があります。 組織で現在実行中のすべての削除リクエストを表示するには、/system/jobs エンドポイントに対して GET リクエストを実行できます。

また、オプションのクエリーパラメーターを使用して、応答で返される削除リクエストのリストをフィルタリングすることもできます。 複数のパラメーターを使用するには、アンパサンド (&)を使用して各パラメーターを分離します。

API 形式

このエンドポイントを使用する場合、最初の100個のシステムジョブは、作成日に基づいて昇順で返されます。

GET /system/jobs
GET /system/jobs?{QUERY_PARAMETERS}
パラメーター
説明
start
返される結果セットの開始ページを指定します。 ページ番号は0から始まります。つまり、start=0は0から始まる結果を返します。
start=4
limit
ページごとに返される結果の数。
limit=10

例えば、クエリパラメーターが?start=1&limit=10の場合、応答はレコード 10 ~ 19を返します。

リクエスト

システムジョブを表示するためのサンプルリクエスト。
code language-shell
curl -X GET https://platform.adobe.io/data/core/ups/system/jobs \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \

応答

応答が成功すると、ページ情報と、各システムリクエストのオブジェクトを含む子配列が返されます。

システムリクエストを表示するための正常な応答
code language-json
{
    "_page": {
        "pageSize": 2,
        "start": "0",
        "totalCount": 2,
        "next": 1
    },
    "children:" [
        {
            "requestId": "80a9405a-21ca-4278-aedf-99367f90c055",
            "requestType": "DELETE_EE_BATCH",
            "imsOrgId": "{ORG_ID}",
            "sandbox": {
                "sandboxName": "prod",
                "sandboxId": "8129954b-fa83-43ba-a995-4bfa8373ba2b"
            },
            "status": "SUCCESS",
            "properties": {
                "batchId": "01JFSYFDFW9JAAEKHX672JMPSB",
                "datasetId": "66a92c5910df2d1767de13f3"
            },
            "createdAt": "2024-12-22T19:44:50.250006Z",
            "updatedAt": "2024-12-22T19:52:13.380706Z"
        },
        {
            "requestId": "38a835eb-b491-4864-902b-be07fa4d6a6d",
            "requestType": "TRUNCATE_DATASET",
            "imsOrgId": "{ORG_ID}",
            "sandbox": {
                "sandboxName": "prod",
                "sandboxId": "8129954b-fa83-43ba-a995-4bfa8373ba2b"
            },
            "status": "SUCCESS",
            "properties": {
                "datasetId": "66a92c5910df2d1767de13f3"
            },
            "createdAt": "2024-12-22T19:44:50.250006Z",
            "updatedAt": "2024-12-22T19:52:13.380706Z"
        }
    ]
}
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2
プロパティ 説明
requestId システムジョブのID。
requestType システムジョブのタイプ。 使用可能な値には、BACKFILL_TTLDELETE_EE_BATCHおよびTRUNCATE_DATASETが含まれます。
status システム ジョブのステータス。 使用可能な値には、NEWSUCCESSERRORFAILEDおよびIN-PROGRESSが含まれます。
properties システムジョブのバッチ IDやデータセット IDを含むオブジェクト。

削除リクエストの作成 create-a-delete-request

新しい削除リクエストの開始は、/systems/jobs エンドポイントへの POST リクエストを通じて行われます。このエンドポイントでは、削除するデータセットまたはバッチの ID がリクエストの本文に表示されます。

データセットと関連プロファイルデータの削除

データセットと、そのデータセットに関連付けられたすべてのプロファイルデータをプロファイルストアから削除するには、データセット IDをPOST リクエストの本文に含める必要があります。 この操作により、特定のデータセットのすべてのデータが削除されます。 Experience Platformを使用すると、レコードと時系列の両方のスキーマに基づいてデータセットを削除できます。

API 形式

POST /system/jobs

リクエスト

データセットを削除するサンプルリクエスト。
code language-shell
curl -X POST \
  https://platform.adobe.io/data/core/ups/system/jobs \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '{
        "dataSetId": "66a92c5910df2d1767de13f3"
      }'
プロパティ
説明
dataSetId
削除するデータセットのID。

応答

応答が成功すると、新しく作成されたシステムリクエストの詳細が返されます。これには、リクエストに対して一意のシステム生成された読み取り専用IDが含まれます。 これは、リクエストを検索し、そのステータスを確認するために使用できます。 作成時のリクエストのstatusは、処理が開始されるまでNEWです(IN-PROGRESS)。 応答のdataSetIdは、リクエストで送信されたdataSetIdと一致する必要があります。

削除リクエストを作成するための応答が成功しました。
code language-json
{
    "requestId": "80a9405a-21ca-4278-aedf-99367f90c055",
    "requestType": "TRUNCATE_DATASET",
    "imsOrgId": "{ORG_ID}",
    "sandbox": {
        "sandboxName": "prod",
        "sandboxId": "8129954b-fa83-43ba-a995-4bfa8373ba2b"
    },
    "status": "NEW",
    "properties": {
        "datasetId": "66a92c5910df2d1767de13f3"
    },
    "createdAt": "2024-12-22T19:44:50.250006Z",
    "updatedAt": "2024-12-22T19:44:50.250006Z"
}
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2
プロパティ 説明
requestId システムで生成された、システム ジョブの読み取り専用ID。
requestType システムジョブのタイプ。 データセットを削除しているので、この値はTRUNCATE_DATASETです。
status システム ジョブのステータス。 使用可能な値には、NEWSUCCESSERRORFAILEDおよびIN-PROGRESSが含まれます。
properties システムジョブのデータセット IDを含むオブジェクト。

バッチの削除

バッチを削除するには、バッチ ID を POST リクエストの本文に含める必要があります。 レコードスキーマに基づくデータセットのバッチは削除できません。 時系列スキーマに基づくデータセットのバッチのみが削除できます。

NOTE
レコードスキーマに基づくデータセットのバッチを削除できないのは、レコードタイプのデータセットバッチが以前のレコードを上書きするため、「取り消し」または削除できないためです。 レコードスキーマに基づくデータセットの誤ったバッチの影響を取り除く唯一の方法は、誤ったレコードを上書きするために正しいデータでバッチを再取り込みすることです。

レコードと時系列動作について詳しくは、XDM Systemの概要のXDM データ動作の節を参照してください。

API 形式

POST /system/jobs

リクエスト

バッチを削除するためのサンプルリクエスト。
code language-shell
curl -X POST \
  https://platform.adobe.io/data/core/ups/system/jobs \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '{
        "datasetId": "66a92c5910df2d1767de13f3",
        "batchId": "01JFSYFDFW9JAAEKHX672JMPSB"
      }'
プロパティ
説明
datasetId
削除するバッチのデータセットのID。
batchId
削除するバッチのID。

応答

応答が成功すると、新しく作成したシステムリクエストの詳細が返されます。

削除リクエストを作成するための応答が成功しました。
code language-json
{
    "requestId": "80a9405a-21ca-4278-aedf-99367f90c055",
    "requestType": "DELETE_EE_BATCH",
    "imsOrgId": "{ORG_ID}",
    "sandbox": {
        "sandboxName": "prod",
        "sandboxId": "8129954b-fa83-43ba-a995-4bfa8373ba2b"
    },
    "status": "NEW",
    "properties": {
        "datasetId": "66a92c5910df2d1767de13f3",
        "batchId": "01JFSYFDFW9JAAEKHX672JMPSB"
    },
    "createdAt": "2024-12-22T19:44:50.250006Z",
    "updatedAt": "2024-12-22T19:44:50.250006Z"
}
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2
プロパティ 説明
requestId システムで生成された、システム ジョブの読み取り専用ID。
requestType システムジョブのタイプ。 バッチを削除しているので、この値はDELETE_EE_BATCHです。
status システム ジョブのステータス。 使用可能な値には、NEWSUCCESSERRORFAILEDおよびIN-PROGRESSが含まれます。
properties システムジョブのバッチ IDとデータセット IDを含むオブジェクト。

レコードデータセットのバッチに対して削除リクエストを開始しようとすると、リクエストは失敗します。

特定の削除リクエストの表示 view-a-specific-delete-request

特定の削除リクエスト(ステータスなどの詳細を含む)を表示するには、/system/jobs エンドポイントに対してルックアップ(GET)リクエストを実行し、削除リクエストの ID をパスに含めることができます。

API 形式

GET /system/jobs/{DELETE_REQUEST_ID}
パラメーター
説明
{DELETE_REQUEST_ID}
表示する削除リクエストのID。

リクエスト

プロファイルジョブを表示するためのサンプルリクエスト。
code language-shell
curl -X GET https://platform.adobe.io/data/core/ups/system/jobs/9c2018e2-cd04-46a4-b38e-89ef7b1fcdf4 \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

応答

応答が成功すると、更新されたステータスを含む、指定されたシステムリクエストの詳細が返されます。 応答のシステムリクエストのIDは、リクエストパスで送信されるIDと一致する必要があります。

削除リクエストを表示するための応答が成功しました。
code language-json
{
    "requestId": "9c2018e2-cd04-46a4-b38e-89ef7b1fcdf4",
    "requestType": "DELETE_EE_BATCH",
    "imsOrgId": "{ORG_ID}",
    "sandbox": {
        "sandboxName": "prod",
        "sandboxId": "8129954b-fa83-43ba-a995-4bfa8373ba2b"
    },
    "status": "SUCCESS",
    "properties": {
        "batchId": "01JFSYFDFW9JAAEKHX672JMPSB",
        "datasetId": "66a92c5910df2d1767de13f3"
    },
    "createdAt": "2024-12-22T19:44:50.250006Z",
    "updatedAt": "2024-12-22T19:52:13.380706Z"
}
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2
プロパティ 説明
requestId システムで生成された、システム ジョブの読み取り専用ID。
requestType システムジョブのタイプ。 使用可能な値には、BACKFILL_TTLDELETE_EE_BATCHおよびTRUNCATE_DATASETが含まれます。
status システム ジョブのステータス。 使用可能な値には、NEWSUCCESSERRORFAILEDおよびIN-PROGRESSが含まれます。
properties システムジョブのバッチ IDやデータセット IDを含むオブジェクト。

削除要求のステータスが"SUCCESS"になると、Data Access APIを使用して削除されたデータにアクセスしようとすることで、データが削除されたことを確認できます。 データアクセス API を使用してデータセットやバッチにアクセスする手順については、データアクセスのドキュメントを参照してください。

次の手順

Experience Platform内のProfile storeからデータセットとバッチを削除する手順を理解したので、誤って追加されたデータや組織が不要になったデータを安全に削除できます。 削除リクエストは元に戻せないので、今は不要で将来は不要になると確信しているデータのみを削除するようにしてください。

recommendation-more-help
experience-platform-help-profile