Show Menu
トピック×

プライバシージョブ

以降の節では、プライバシーサービスAPIの /jobs エンドポイントを使用して行う呼び出しについて説明します。 各呼び出しには、一般的なAPI形式、必要なヘッダーを表示するサンプルリクエスト、サンプルレスポンスが含まれます。

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

新しいジョブリクエストを作成する前に、まず、アクセス、削除、または販売するデータを持つデータサブジェクトに関する識別情報を収集する必要があオプトアウトります。 必要なデータを取得したら、ルートエンドポイントへのPOST要求のペイロードで指定する必要があります。
互換性のあるAdobe Experience Cloudアプリケーションでは、データの件名を識別するために様々な値が使用されます。 アプリに必要な識別子について詳しくは、 プライバシーサービスおよびExperience Cloudアプリケーション (英語のみ)のガイドを参照してください。
Privacy Service APIは、個人データに対する2種類のジョブリクエストをサポートしています。
アクセス要求と削除要求は1回のAPI呼び出しとして組み合わせることができますが、オプトアウト要求は個別に行う必要があります。

アクセスジョブまたは削除ジョブの作成

この節では、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: {IMS_ORG}' \
  -d '{
    "companyContexts": [
      {
        "namespace": "imsOrgID",
        "value": "{IMS_ORG}"
      }
    ],
    "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"],
    "expandIds": false,
    "priority": "normal",
    "analyticsDeleteMethod": "anonymize",
    "regulation": "ccpa"
}'

プロパティ
説明
companyContexts (必須)
組織の認証情報を含む配列。 リストに表示される各識別子には、次の属性が含まれます。
  • namespace : 識別子の名前空間。
  • value : 識別子の値。
識別子の1つがIMS組織の一意のID 含む、その識別子がその識別子として使用されてい imsOrgId``namespace``value る必要があります。
追加の識別子には、製品固有の会社修飾子(例えば Campaign )を使用できます。この修飾子は、組織に属するAdobeアプリケーションとの統合を識別します。 有効な値には、アカウント名、クライアントコード、テナントID、その他のアプリケーション識別子が含まれます。
users (必須)
アクセスまたは削除する情報を持つ少なくとも1人のユーザーのコレクションを含む配列。 1回のリクエストで提供できるユーザーIDは最大1000個です。 各userオブジェクトには、次の情報が含まれます。
  • key : 応答データ内の個別のジョブIDを修飾するために使用されるユーザーの識別子。 ベストプラクティスとして、この値を簡単に参照または後で参照できるように、一意で識別しやすい文字列を選択します。
  • action : ユーザーのデータに対して行うアクションをリストする配列。 実行するアクションに応じて、この配列には、、、 access 、またはその両方を含める必要があり delete ます。
  • userIDs : ユーザーのIDの集まり。 1人のユーザーが持つことのできるIDの数は9個に制限されます。 各IDは、 namespace 、、 value および名前空間修飾子( type )で構成されます。 必要なプロパティの詳細については、 付録 を参照してください。
との詳細については、『トラブルシューティングガイド』 users を参照し userIDs てください APIでプライバシーリクエストを行う場合、ユーザーとユーザーIDの違いは何ですか。
include (必須)
処理に含めるアドビ製品の配列。 この値がない場合や空の場合は、要求は拒否されます。 組織が統合を持つ製品のみを含めます。 詳細については、付録の 受け入れられる製品値 の節を参照してください。
expandIDs
に設定した場合に、アプリケーション内のIDを処理するための最適化を表すオプションのプロパティ true です(現在、Analyticsでのみサポートされています)。 If omitted, this value defaults to false .
priority
Adobe Analyticsで使用されるオプションのプロパティで、リクエストの処理の優先度を設定します。 指定できる値は normal とで low す。 を省略 priority した場合のデフォルトの動作はで normal す。
analyticsDeleteMethod
Adobe Analyticsでの個人データの処理方法を指定するオプションのプロパティです。 この属性には、次の2つの値を指定できます。
  • anonymize : 特定のユーザーIDのコレクションによって参照されるすべてのデータは匿名になります。 を省略 analyticsDeleteMethod した場合の動作はデフォルトです。
  • purge : すべてのデータが完全に削除されます。
regulation (必須)
請求の規則 次の3つの値のいずれかにする必要があります。
  • gdpr
  • ccpa
  • pdpa_tha
応答
正常に応答すると、新しく作成されたジョブの詳細が返されます。
{
    "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。 この値は、特定のジョブを検索する次の手順で使用されます。
ジョブリクエストが正常に送信されたら、次のステップに進んで、ジョブのステータス を確認できます

販売中止のジョブの作成

この節では、APIを使用して販売中止のジョブリクエストを作成する方法を説明します。
API形式
POST /jobs

リクエスト
次のリクエストは、以下に示すように、ペイロードで指定された属性で設定された新しいジョブリクエストを作成します。
curl -X POST \
  https://platform.adobe.io/data/privacy/gdpr/ \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -d '{
    "companyContexts": [
      {
        "namespace": "imsOrgID",
        "value": "{IMS_ORG}"
      }
    ],
    "users": [
      {
        "key": "DavidSmith",
        "action": ["opt-out-of-sale"],
        "userIDs": [
          {
            "namespace": "email",
            "value": "dsmith@acme.com",
            "type": "standard"
          },
          {
            "namespace": "ECID",
            "type": "standard",
            "value":  "443636576799758681021090721276",
            "isDeletedClientSide": false
          }
        ]
      },
      {
        "key": "user12345",
        "action": ["opt-out-of-sale"],
        "userIDs": [
          {
            "namespace": "email",
            "value": "ajones@acme.com",
            "type": "standard"
          },
          {
            "namespace": "loyaltyAccount",
            "value": "12AD45FE30R29",
            "type": "integrationCode"
          }
        ]
      }
    ],
    "include": ["Analytics", "AudienceManager"],
    "expandIds": false,
    "priority": "normal",
    "analyticsDeleteMethod": "anonymize",
    "regulation": "ccpa"
}'

プロパティ
説明
companyContexts (必須)
組織の認証情報を含む配列。 リストに表示される各識別子には、次の属性が含まれます。
  • namespace : 識別子の名前空間。
  • value : 識別子の値。
識別子の1つがIMS組織の一意のID 含む、その識別子がその識別子として使用されてい imsOrgId``namespace``value る必要があります。
追加の識別子には、製品固有の会社修飾子(例えば Campaign )を使用できます。この修飾子は、組織に属するAdobeアプリケーションとの統合を識別します。 有効な値には、アカウント名、クライアントコード、テナントID、その他のアプリケーション識別子が含まれます。
users (必須)
アクセスまたは削除する情報を持つ少なくとも1人のユーザーのコレクションを含む配列。 1回のリクエストで提供できるユーザーIDは最大1000個です。 各userオブジェクトには、次の情報が含まれます。
  • key : 応答データ内の個別のジョブIDを修飾するために使用されるユーザーの識別子。 ベストプラクティスとして、この値を簡単に参照または後で参照できるように、一意で識別しやすい文字列を選択します。
  • action : データに対して行う必要のあるアクションをリストする配列。 販売中止のリクエストの場合、配列には値のみを含める必要があり opt-out-of-sale ます。
  • userIDs : ユーザーのIDの集まり。 1人のユーザーが持つことのできるIDの数は9個に制限されます。 各IDは、 namespace 、、 value および名前空間修飾子( type )で構成されます。 必要なプロパティの詳細については、 付録 を参照してください。
との詳細については、『トラブルシューティングガイド』 users を参照し userIDs てください APIでプライバシーリクエストを行う場合、ユーザーとユーザーIDの違いは何ですか。
include (必須)
処理に含めるアドビ製品の配列。 この値がない場合や空の場合は、要求は拒否されます。 組織が統合を持つ製品のみを含めます。 詳細については、付録の 受け入れられる製品値 の節を参照してください。
expandIDs
に設定した場合に、アプリケーション内のIDを処理するための最適化を表すオプションのプロパティ true です(現在、Analyticsでのみサポートされています)。 If omitted, this value defaults to false .
priority
Adobe Analyticsで使用されるオプションのプロパティで、リクエストの処理の優先度を設定します。 指定できる値は normal とで low す。 を省略 priority した場合のデフォルトの動作はで normal す。
analyticsDeleteMethod
Adobe Analyticsでの個人データの処理方法を指定するオプションのプロパティです。 この属性には、次の2つの値を指定できます。
  • anonymize : 特定のユーザーIDのコレクションによって参照されるすべてのデータは匿名になります。 を省略 analyticsDeleteMethod した場合の動作はデフォルトです。
  • purge : すべてのデータが完全に削除されます。
regulation (必須)
請求の規則 次の3つの値のいずれかにする必要があります。
  • gdpr
  • ccpa
  • pdpa_tha
応答
正常に応答すると、新しく作成されたジョブの詳細が返されます。
{
    "jobs": [
        {
            "jobId": "6fc09b53-c24f-4a6c-9ca2-c6076bd9vjs0",
            "customer": {
                "user": {
                    "key": "DavidSmith",
                    "action": [
                        "opt-out-of-sale"
                    ]
                }
            }
        },
        {
            "jobId": "6fc09b53-c24f-4a6c-9ca2-c6076bes0ewj2",
            "customer": {
                "user": {
                    "key": "user12345",
                    "action": [
                        "opt-out-of-sale"
                    ]
                }
            }
        }
    ],
    "requestStatus": 1,
    "totalRecords": 2
}

プロパティ
説明
jobId
ジョブに対する、一意で読み取り専用のシステム生成ID。 この値は、次の手順で特定のジョブを検索するために使用します。
ジョブリクエストが正常に送信されたら、次のステップに進んで、ジョブのステータスを確認できます。

ジョブのステータスの確認

前の手順で返した値の1つを使用して、そのジョブに関する情報(現在の処理ステータスなど)を取得できます。 jobId
以前に作成したジョブのデータは、ジョブの完了日から30日以内にのみ取得できます。
API形式
GET /jobs/{JOB_ID}

パラメーター
説明
{JOB_ID}
検索するジョブのID。前の手順 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: {IMS_ORG}'

応答
正常な応答は、指定されたジョブの詳細を返します。
{
    "jobId": "527ef92d-6cd9-45cc-9bf1-477cfa1e2ca2",
    "requestId": "15700479082313109RX-899",
    "userKey": "David Smith",
    "action": "access",
    "status": "error",
    "submittedBy": "02b38adf-6573-401e-b4cc-6b08dbc0e61c@techacct.adobe.com",
    "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": "submitted",
                "message": "processing"
            }
        },
        {
            "product": "AudienceManager",
            "retryCount": 0,
            "processedDate": "10/02/2019 08:25 PM GMT",
            "productStatusResponse": {
                "status": "submitted",
                "message": "processing"
            }
        }
    ],
    "downloadURL": "http://...",
    "regulation": "ccpa"
}

プロパティ
説明
productStatusResponse
ジョブの現在のステータス。 可能な各ステータスの詳細を次の表に示します。
downloadURL
ジョブのステータスがZIPファイルの場合 complete 、この属性はジョブの結果をダウンロードするためのURLを提供します。 このファイルは、ジョブの完了後60日間ダウンロードできます。

ジョブステータス応答

次の表に、様々なジョブのステータスと対応する意味をリストします。
ステータスコード
ステータスメッセージ
意味
1
完了
ジョブが完了し、(必要に応じて)各アプリケーションからファイルがアップロードされます。
2
処理
アプリケーションはジョブを確認し、現在処理中です。
3
Submitted
ジョブは、該当するすべての申し込みに送信されます。
4
エラー
ジョブの処理でエラーが発生しました。個々のジョブの詳細を取得することで、より具体的な情報を取得できる場合があります。
依存する子ジョブがまだ処理中の場合、送信されたジョブは、処理状態のままになる可能性があります。

すべてのジョブのリスト

ルート( / )エンドポイントにGETリクエストを行うことで、組織内で使用可能なすべてのジョブリクエストのリストを表示できます。
API形式
このリクエスト形式では、ルート( regulation )エンドポイントで / クエリパラメーターが使用されるので、次に示す疑問符( ? )で始まります。 応答はページ分割され、他のクエリパラメーター( page および size )を使用して応答をフィルターできます。 アンパサンド( & )を使用して、複数のパラメーターを区切ることができます。
GET /jobs?regulation={REGULATION}
GET /jobs?regulation={REGULATION}&page={PAGE}
GET /jobs?regulation={REGULATION}&size={SIZE}
GET /jobs?regulation={REGULATION}&page={PAGE}&size={SIZE}

パラメーター
説明
{REGULATION}
クエリする規則のタイプ。 指定できる値は、 gdpr ccpa および pdpa_tha です。
{PAGE}
0を基準とするページ番号を使用して、表示するデータのページ。 デフォルトは 0 です。
{SIZE}
各ページに表示する結果の数。 デフォルトはです。最大値 1 はで 100 す。 最大値を超えると、APIは400コードエラーを返します。
リクエスト
次のリクエストは、ページサイズが50の3番目のページから、IMS組織内のすべてのジョブのページ分割リストを取得します。
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: {IMS_ORG}'

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

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

ページ分割応答の次の結果セットを取得するには、 page クエリパラメーターを1増やしながら、同じエンドポイントに対して別のAPI呼び出しを行う必要があります。

次の手順

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