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

このドキュメントでは、API 呼び出しを使用してプライバシージョブを操作する方法について説明します。 特に、 /job エンドポイント Privacy Service API. このガイドを読む前に、 入門ガイド を参照してください。

NOTE
顧客からの同意またはオプトアウトリクエストを管理する場合は、 同意エンドポイントガイド.

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

に対してGETリクエストをおこなうことで、組織内で使用可能なすべてのプライバシージョブのリストを表示できます /jobs endpoint.

API 形式

このリクエストの形式では、 regulation クエリパラメーターを /jobs エンドポイントの場合、疑問符 (?) を使用します。 リソースをリストする場合、Privacy ServiceAPI は最大 1,000 個のジョブを返し、応答をページ化します。 他のクエリパラメーター (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
  • cpra_usa
  • ctdpa
  • ctdpa_usa
  • gdpr
  • hipaa_usa
  • lgpd_bra
  • mhmda
  • nzpa_nzl
  • pdpa_tha
  • ucpa_usa
  • vcdpa_usa

概要については、 サポート規制 上記の値が表すプライバシー規制に関する詳細。

{PAGE}
0 を基準とする番号を使用した、表示するデータのページ。デフォルトは 0 です。
{SIZE}
各ページに表示する結果の数。デフォルトは 100 で、最大は 1000 です。最大値を超えると、API は 400 コードエラーを返します。
{status}

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

  • processing
  • complete
  • error
{toDate}
このパラメーターは、結果を、指定された日付より前に処理される結果に制限します。 リクエストの日付から、システムは 45 日間を振り返ることができます。 ただし、30 日を超える期間は指定できません。
YYYY-MM-DD 形式を受け入れます。 指定した日付は、グリニッジ標準時 (GMT) で表される終了日と解釈されます。
このパラメーター ( および対応する fromDate) の場合、デフォルトの動作では過去 7 日間にデータを返すジョブが返されます。 次を使用する場合、 toDateを使用する場合は、 fromDate クエリパラメーター。 両方を使用しない場合、呼び出しは 400 エラーを返します。
{fromDate}
このパラメーターは、結果を、指定された日付の後に処理される結果に制限します。 リクエストの日付から、システムは 45 日間を振り返ることができます。 ただし、30 日を超える期間は指定できません。
YYYY-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 の適切な使用について議論が行われます。

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

NOTE
互換性のあるAdobe Experience Cloudアプリケーションは、データの主体を識別するために異なる値を使用します。 次のガイドを参照してください: Privacy Service/Experience Cloud・アプリケーション を参照してください。 送信先 ID の決定に関する一般的なガイダンスについて Privacy Serviceを参照してください。 プライバシーリクエストの id データ.

The 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",
    "analyticsDeleteMethod": "anonymize",
    "mergePolicyId": 124,
    "regulation": "ccpa"
}'
プロパティ
説明
companyContexts (必須)

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

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

それは 必須 識別子の 1 つが使用する imsOrgId そのまま namespaceを、 value 組織の一意の ID を含む。

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

users (必須)

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

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

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

include (必須)
処理に含めるアドビ製品の配列。この値がない場合や空の場合、リクエストは拒否されます。組織が統合している製品のみを含めます。詳しくは、付録の「受け入れられる製品値」の節を参照してください。
expandIDs
に設定した場合のオプションのプロパティです。 trueは、アプリケーションで ID を処理するための最適化を表します ( 現在、は Analytics) をクリックします。 省略した場合、この値はデフォルトで false になります。
priority
リクエストの処理の優先度を設定する、Adobe Analytics で使用されるオプションのプロパティです。指定できる値は、normal および low です。priority を省略した場合のデフォルトの動作は normal です。
analyticsDeleteMethod

Adobe Analytics での個人データの処理方法を指定するオプションのプロパティです。この属性には、次の 2 つの値を指定できます。

  • anonymize:特定のユーザー ID のコレクションによって参照されるすべてのデータは匿名になります。analyticsDeleteMethod を省略した場合のデフォルトの動作です。
  • purge:すべてのデータが完全に削除されます。
mergePolicyId
リアルタイム顧客プロファイル (profileService) を使用する場合は、必要に応じて特定の 結合ポリシー ID ステッチに使用する 結合ポリシーを指定すると、プライバシーリクエストには、顧客のデータを返す際にオーディエンス情報を含めることができます。 1 回のリクエストにつき、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 endpoint.

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

API 形式

GET /jobs/{JOB_ID}
パラメーター
説明
{JOB_ID}
検索するジョブの ID。 この ID は、以下で返されます。 jobId (次の API 応答に成功) ジョブの作成 および すべてのジョブのリスト表示.

リクエスト

次のリクエストは、リクエストパスで 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
一部の製品では、特定のステータスに対して results 次の条件に該当しない追加情報を提供するオブジェクト responseMsgDetail.
downloadURL
ジョブのステータスが complete の場合、この属性はジョブの結果を ZIP ファイルとしてダウンロードする URL を指定します。このファイルは、ジョブの完了後 60 日間ダウンロードできます。

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

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

ステータスカテゴリ
意味
complete
ジョブが完了し、(必要に応じて)すべてのアプリケーションからファイルがアップロードされます。
processing
アプリケーションはジョブを確認し、現在処理中です。
submitted
ジョブは、該当するすべてのアプリケーションに送信されます。
error
ジョブを処理できませんでした。個々のジョブの詳細を取得することで、より具体的な情報を取得できます。
NOTE
送信されたジョブが processing 依存する子ジョブがまだ処理中の場合は、状態。

次の手順

これで、 Privacy Service API. ユーザーインターフェイスを使用して同じタスクを実行する方法について詳しくは、「Privacy Service UI の概要」を参照してください。

recommendation-more-help
9cbf7061-a312-49f7-aaf8-a10885d53580