ドキュメント Experience Platform Privacy Service ガイド

プライバシージョブエンドポイント

最終更新日： 2025年10月14日

作成対象：

{"id":"ff6a42d2-313e-452e-93a6-792e4fad9ff8"}

IMPORTANT

米国の州のプライバシー法の増加をサポートするために、Privacy Serviceはregulation_typeの値を変更しています。 2025年6月12日 以降の状態の略語（例：ucpa_ut_usa）を含む新しい値を使用します。 古い値（例：ucpa_usa）は、2025年7月28日以降に機能しなくなります。

リクエストの失敗を避けるために、この期限までに統合を更新してください。

このドキュメントでは、API呼び出しを使用してプライバシージョブを操作する方法について説明します。具体的には、Privacy Service APIでの/job エンドポイントの使用について説明します。このガイドを読む前に、必要なヘッダーやサンプル API呼び出しの読み取り方法など、APIを正常に呼び出すために知っておく必要がある重要な情報については、入門ガイドを参照してください。

NOTE

顧客からの同意またはオプトアウト要求を管理する場合は、同意エンドポイントガイドを参照してください。

すべてのジョブをリスト list

/jobs エンドポイントにGET リクエストを実行すると、組織内で利用可能なすべてのプライバシージョブのリストを表示できます。

API 形式

このリクエスト形式では、/jobs エンドポイントでregulation クエリパラメーターを使用しているため、次に示すように疑問符（?）で始まります。リソースを一覧表示する場合、Privacy Service APIは最大1000件のジョブを返し、応答をページ分割します。他のクエリパラメーター（page、sizeおよび日付フィルター）を使用して、応答をフィルターします。アンパサンド（&）を使用して、複数のパラメーターを区切ることができます。

TIP

追加のクエリパラメーターを使用して、特定のクエリの結果をさらにフィルタリングします。例えば、特定の期間に送信されたプライバシージョブの数と、そのステータスがstatus、fromDate、およびtoDateのクエリパラメーターを使用していることを確認できます。

GET /jobs?regulation={REGULATION}
GET /jobs?regulation={REGULATION}&page={PAGE}
GET /jobs?regulation={REGULATION}&size={SIZE}
GET /jobs?regulation={REGULATION}&page={PAGE}&size={SIZE}
GET /jobs?regulation={REGULATION}&fromDate={FROMDATE}&toDate={TODATE}&status={STATUS}

パラメーター

説明

{REGULATION}

クエリする規制の種類。使用可能な値は次のとおりです。

apa_aus
ccpa
cpa_co_usa
cpra_ca_usa
ctdpa_ct_usa
dpdpa_de_usa
fdbr_fl_usa
gdpr
hipaa_usa
icdpa_ia_usa
lgpd_bra
mcdpa_mn_usa
mcdpa_mt_usa
mhmda_wa_usa
ndpa_ne_usa
nhpa_nh_usa
njdpa_nj_usa
nzpa_nzl
ocpa_or_usa
pdpa_tha
ql25_qc_can
tdpsa_tx_usa
tipa_tn_usa
ucpa_ut_usa
vcdpa_va_usa

上記の値が表すプライバシー規制について詳しくは、サポートされている規制の概要を参照してください。

{PAGE}

0 を基準とする番号を使用した、表示するデータのページ。デフォルトは 0 です。

{SIZE}

各ページに表示する結果の数。デフォルトは 100 で、最大は 1000 です。最大値を超えると、API は 400 コードエラーを返します。

{status}

デフォルトの動作は、すべてのステータスを含めることです。ステータスタイプを指定すると、リクエストはそのステータスタイプに一致するプライバシージョブのみを返します。使用可能な値は次のとおりです。

processing
complete
error

{toDate}

このパラメーターは、指定された日付より前に処理された結果に制限されます。リクエスト日から、システムは45日振り返ることができます。ただし、範囲は30日を超えることはできません。
YYY-MM-DD形式を受け入れます。指定した日付は、グリニッジ標準時（GMT）で表される終了日として解釈されます。
このパラメーター（および対応するfromDate）を指定しない場合、デフォルトの動作は、過去7日間のデータを返すジョブを返します。 toDateを使用する場合は、fromDate クエリパラメーターも使用する必要があります。両方を使用しない場合、呼び出しは400 エラーを返します。

{fromDate}

このパラメーターは、指定された日付以降に処理された結果に制限されます。リクエスト日から、システムは45日振り返ることができます。ただし、範囲は30日を超えることはできません。
YYY-MM-DD形式を受け入れます。指定した日付は、グリニッジ標準時（GMT）で表されるリクエストの開始日として解釈されます。
このパラメーター（および対応するtoDate）を指定しない場合、デフォルトの動作は、過去7日間にデータを返すジョブを返します。 fromDateを使用する場合は、toDate クエリパラメーターも使用する必要があります。両方を使用しない場合、呼び出しは400 エラーを返します。

{filterDate}

このパラメーターは、指定された日付に処理された結果に制限されます。 YYYY-MM-DD形式を受け入れます。過去45日間を振り返ることができます。

リクエスト

次のリクエストは、ページサイズが50の3番目のページから始まる、組織内のすべてのジョブのページ付きリストを取得します。

curl -X GET \
  https://platform.adobe.io/data/core/privacy/jobs?regulation=gdpr&page=2&size=50 \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}'

応答

正常な応答は、ジョブのリストを返し、各ジョブに jobId などの詳細などが含まれます。この例では、結果の 3 ページ目から始まる 50 個のリストのジョブが応答に含まれます。

後続のページへのアクセス

ページ分割された応答の次の結果セットを取得するには、page クエリパラメーターを 1 増やして、同じエンドポイントに対して別の API 呼び出しをおこないます。

プライバシージョブの作成 create-job

IMPORTANT

Privacy Service は、データ主体と消費者の権利リクエストのみを目的としています。それ以外にデータのクリーンアップやメンテナンスに Privacy Service を使用することは、サポートされておらず、許可もされていません。アドビには、それらをタイムリーに履行する法的義務があります。したがって、これが本番稼働専用の環境であり、有効なプライバシーリクエストの不要なバックログが作成されるので、Privacy Service の読み込みテストは許可されていません。

サービスの不正使用を防ぐために、1 日あたりのアップロードに対するハードリミットが設定されるようになりました。システムの不正使用が判明したユーザーは、サービスへのアクセスが無効になります。その後、それらのユーザーのアクションに対処するための会議がユーザー本人を交えて開催され、Privacy Service の適切な使用について議論が行われます。

新しいジョブリクエストを作成する前に、まず、データにアクセス、削除、またはオプトアウトするデータ主体の識別情報を収集する必要があります。必要なデータを取得したら、POST リクエストのペイロードで/jobs エンドポイントに提供する必要があります。

NOTE

互換性のあるAdobe Experience Cloud アプリケーションでは、データ主体を識別するために異なる値を使用します。アプリケーションに必要なIDについて詳しくは、Privacy ServiceおよびExperience Cloud アプリケーションのガイドを参照してください。 Privacy Serviceに送信するIDの決定に関する一般的なガイダンスについては、プライバシーリクエストのID データに関するドキュメントを参照してください。

Privacy Service APIは、個人データに対する2種類のジョブ要求をサポートしています。

アクセスや削除：個人データにアクセス（読み取り）または削除します。
販売オプトアウト：個人データを販売しないものとして指定します。

IMPORTANT

アクセス要求と削除要求は1つのAPI呼び出しとして組み合わせることができますが、オプトアウトリクエストは個別に行う必要があります。

アクセス/削除ジョブの作成 access-delete

この節では、API を使用してアクセスおよび削除ジョブリクエストを作成する方法を説明します。

API 形式

POST /jobs

リクエスト

次のリクエストは、以下で説明するように、ペイロードで提供される属性によって構成された新しいジョブリクエストを作成します。

curl -X POST \
  https://platform.adobe.io/data/core/privacy/jobs \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -d '{
    "companyContexts": [
      {
        "namespace": "imsOrgID",
        "value": "{ORG_ID}"
      }
    ],
    "users": [
      {
        "key": "DavidSmith",
        "action": ["access"],
        "userIDs": [
          {
            "namespace": "email",
            "value": "dsmith@acme.com",
            "type": "standard"
          },
          {
            "namespace": "ECID",
            "type": "standard",
            "value":  "443636576799758681021090721276",
            "isDeletedClientSide": false
          }
        ]
      },
      {
        "key": "user12345",
        "action": ["access","delete"],
        "userIDs": [
          {
            "namespace": "email",
            "value": "ajones@acme.com",
            "type": "standard"
          },
          {
            "namespace": "loyaltyAccount",
            "value": "12AD45FE30R29",
            "type": "integrationCode"
          }
        ]
      }
    ],
    "include": ["Analytics", "AudienceManager","profileService"],
    "expandIds": false,
    "priority": "normal",
    "mergePolicyId": 124,
    "regulation": "ccpa"
}'

プロパティ

説明

companyContexts (必須)

組織の認証情報を含む配列。リストに表示される各識別子には、次の属性が含まれます。

namespace：識別子の名前空間。
value：識別子の値。

識別子の1つがimsOrgIdをnamespaceとして使用し、そのvalueに組織の一意のIDが含まれていることが必須です。

追加の識別子は、組織に属するアドビ会社との統合を識別する、製品固有の会社修飾子（例：Campaign）にすることができます。有効な値には、アカウント名、クライアントコード、テナント ID、その他のアプリケーション識別子が含まれます。

users (必須)

アクセスまたは削除する情報を持つユーザーの少なくとも 1 人のコレクションを含む配列。 1回のリクエストで最大1000人のユーザーを指定できます。各ユーザーオブジェクトには、次の情報が含まれます。

key：応答データ内の個別のジョブ ID を修飾するために使用されるユーザーの識別子。この値に対して一意の、簡単に識別できる文字列を選択し、後で簡単に参照または参照できるようにすることをお勧めします。
action：ユーザーのデータに対して実行する必要のあるアクションをリストする配列。実行するアクションに応じて、この配列には access、delete またはその両方を含める必要があります。
userIDs：ユーザーの ID のコレクションです。 1 人のユーザーが持つことのできる ID の数は 9 個に制限されます。各 ID はnamespace、value、および名前空間修飾子（type）で構成されます。これらの必須プロパティの詳細については、付録を参照してください。

users と userIDs の詳細については、トラブルシューティングガイドを参照してください。

include (必須)

処理に含めるアドビ製品の配列。この値がない場合や空の場合、リクエストは拒否されます。組織が統合している製品のみを含めます。詳しくは、付録の「受け入れられる製品値」の節を参照してください。

expandIDs

trueに設定すると、アプリケーションのIDを処理するための最適化を表すオプションのプロパティ（現在はAnalyticsでのみサポートされています）。省略した場合、この値はデフォルトで false になります。

priority

リクエストの処理の優先度を設定する、Adobe Analytics で使用されるオプションのプロパティです。指定できる値は、normal および low です。 priority を省略した場合のデフォルトの動作は normal です。

mergePolicyId

リアルタイム顧客プロファイル（profileService）に対してプライバシーリクエストを行う場合は、オプションで、ID ステッチに使用する特定の結合ポリシーのIDを指定できます。結合ポリシーを指定することで、プライバシーリクエストに顧客のデータを返す際にオーディエンス情報を含めることができます。リクエストごとに1つの結合ポリシーのみを指定できます。結合ポリシーが指定されていない場合、セグメント化情報は応答に含まれません。

regulation (必須)

プライバシー業務に関する規制以下の値を使用できます。

apa_aus
ccpa
cpra_usa
gdpr
hipaa_usa
lgpd_bra
nzpa_nzl
pdpa_tha
vcdpa_usa

上記の値が表すプライバシー規制について詳しくは、サポートされている規制の概要を参照してください。

応答

正常な応答は、新しく作成されたジョブの詳細を返します。

{
    "jobs": [
        {
            "jobId": "6fc09b53-c24f-4a6c-9ca2-c6076b0842b6",
            "customer": {
                "user": {
                    "key": "DavidSmith",
                    "action": [
                        "access"
                    ]
                }
            }
        },
        {
            "jobId": "6fc09b53-c24f-4a6c-9ca2-c6076be029f3",
            "customer": {
                "user": {
                    "key": "user12345",
                    "action": [
                        "access"
                    ]
                }
            }
        },
        {
            "jobId": "6fc09b53-c24f-4a6c-9ca2-c6076bd023j1",
            "customer": {
                "user": {
                    "key": "user12345",
                    "action": [
                        "delete"
                    ]
                }
            }
        }
    ],
    "requestStatus": 1,
    "totalRecords": 3
}

プロパティ

説明

jobId

ジョブの読み取り専用の、一意のシステム生成 ID。この値は、特定のジョブを検索する次の手順で使用されます。

ジョブリクエストの送信が完了したら、次の、ジョブのステータスを確認する手順に進むことができます。

ジョブのステータスの確認 check-status

特定のジョブに関する情報（現在の処理ステータスなど）を取得するには、そのジョブのjobIdを/jobs エンドポイントへのGET リクエストのパスに含めます。

IMPORTANT

以前に作成したジョブのデータは、ジョブの完了日から30日以内にのみ取得できます。

API 形式

GET /jobs/{JOB_ID}

パラメーター

説明

{JOB_ID}

検索するジョブのID。このIDは、ジョブの作成およびすべてのジョブのリストに対する正常なAPI応答のjobIdに返されます。

リクエスト

次のリクエストは、リクエストパスで jobId が指定されたジョブの詳細を取得します。

curl -X GET \
  https://platform.adobe.io/data/core/privacy/jobs/6fc09b53-c24f-4a6c-9ca2-c6076b0842b6 \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}'

応答

正常な応答は、指定されたジョブの詳細を返します。

{
    "jobId": "6fc09b53-c24f-4a6c-9ca2-c6076b0842b6",
    "requestId": "15700479082313109RX-899",
    "userKey": "David Smith",
    "action": "access",
    "status": "complete",
    "submittedBy": "{ACCOUNT_ID}",
    "createdDate": "10/02/2019 08:25 PM GMT",
    "lastModifiedDate": "10/02/2019 08:25 PM GMT",
    "userIds": [
        {
            "namespace": "email",
            "value": "dsmith@acme.com",
            "type": "standard",
            "namespaceId": 6,
            "isDeletedClientSide": false
        },
        {
            "namespace": "ECID",
            "value": "1123A4D5690B32A",
            "type": "standard",
            "namespaceId": 4,
            "isDeletedClientSide": false
        }
    ],
    "productResponses": [
        {
            "product": "Analytics",
            "retryCount": 0,
            "processedDate": "10/02/2019 08:25 PM GMT",
            "productStatusResponse": {
                "status": "complete",
                "message": "Success",
                "responseMsgCode": "PRVCY-6000-200",
                "responseMsgDetail": "Finished successfully."
            }
        },
        {
            "product": "Profile",
            "retryCount": 0,
            "processedDate": "10/02/2019 08:25 PM GMT",
            "productStatusResponse": {
                "status": "complete",
                "message": "Success",
                "responseMsgCode": "PRVCY-6000-200",
                "responseMsgDetail": "Success dataSetIds = [5dbb87aad37beb18a96feb61], Failed dataSetIds = []"
            }
        },
        {
            "product": "AudienceManager",
            "retryCount": 0,
            "processedDate": "10/02/2019 08:25 PM GMT",
            "productStatusResponse": {
                "status": "complete",
                "message": "Success",
                "responseMsgCode": "PRVCY-6054-200",
                "responseMsgDetail": "PARTIALLY COMPLETED- Data not found for some requests, check results for more info.",
                "results": {
                  "processed": ["1123A4D5690B32A"],
                  "ignored": ["dsmith@acme.com"]
                }
            }
        }
    ],
    "downloadURL": "http://...",
    "regulation": "ccpa"
}

プロパティ

説明

productStatusResponse

productResponses配列内の各オブジェクトには、特定のExperience Cloud アプリケーションに関するジョブの現在のステータスに関する情報が含まれています。

productStatusResponse.status

ジョブの現在のステータスカテゴリ。使用可能なステータスカテゴリとその対応する意味の一覧については、次の表を参照してください。

productStatusResponse.message

ステータスカテゴリに対応する、ジョブの特定のステータス。

productStatusResponse.responseMsgCode

Privacy Service様が受信した製品応答メッセージの標準コード。メッセージの詳細はresponseMsgDetailに記載されています。

productStatusResponse.responseMsgDetail

ジョブのステータスに関するより詳細な説明。同様のステータスに関するメッセージは、製品によって異なります。

productStatusResponse.results

特定のステータスでは、一部の製品がresponseMsgDetailの対象外の追加情報を提供するresults オブジェクトを返す場合があります。

downloadURL

ジョブのステータスが complete の場合、この属性はジョブの結果を ZIP ファイルとしてダウンロードする URL を指定します。このファイルは、ジョブの完了後 60 日間ダウンロードできます。

ジョブステータスカテゴリ status-categories

次の表に、考えられる様々なジョブステータスカテゴリとそれに対応する意味を示します。

ステータスカテゴリ

意味

complete

ジョブが完了し、（必要に応じて）すべてのアプリケーションからファイルがアップロードされます。

processing

アプリケーションはジョブを確認し、現在処理中です。

submitted

ジョブは、該当するすべてのアプリケーションに送信されます。

error

ジョブを処理できませんでした。個々のジョブの詳細を取得することで、より具体的な情報を取得できます。

NOTE

送信されたジョブが、処理中の依存する子ジョブがある場合、そのジョブはprocessing状態のままになる可能性があります。

次の手順

Privacy Service APIを使用してプライバシージョブを作成および監視する方法を理解しました。ユーザーインターフェイスを使用して同じタスクを実行する方法について詳しくは、「Privacy Service UI の概要」を参照してください。

recommendation-more-help

experience-platform-help-privacy-service