自動プライバシーリクエストプロセス automatic-privacy-request-api
Adobe Campaign には、プライバシーリクエストの自動プロセスを設定できる API があります。
この API を使用した場合の一般的なプライバシープロセスは、インターフェイスを使用した場合と変わりません。ただし、プライバシーリクエストの作成のみが異なります。Adobe Campaign でリクエストを作成するかわりに、リクエスト情報を含む POST が Campaign に送信されます。リクエストごとに、新しいエントリが プライバシーリクエスト 画面に追加されます。その後、プライバシーのテクニカルワークフローにおいてリクエストが処理されます。これもインターフェイスからリクエストを追加した場合と変わりません。
API を使用してプライバシーリクエストを送信する場合、最初の削除リクエストについては、返されるデータをテストできるよう、2 段階プロセス を有効にしておくことをお勧めします。テストが終了したら、削除リクエストプロセスが自動的に実行されるよう、2 段階プロセスを無効にできます。
CreateRequestByName JS API は次のように定義されます。
<method library="nms:gdpr.js" name="CreateRequestByName" static="true">
<help>Create a new GDPR Request using namespace internal name</help>
<parameters>
<param name="namespaceName" type="string" desc="Namespace internal name"/>
<param name="reconciliationValue" type="string" desc="Reconciliation value"/>
<param name="type" type="long" desc="Reconciliation value"/>
<param name="confirmDeletePending" type="boolean" desc="Request confirm before deleting data"/>
<param name="regulation" type="long" desc="regulation of newly created request"/>
<param name="id" type="long" inout="out" desc="ID of newly created request"/>
</parameters>
</method>
外部からの API の呼び出し invoking-api-externally
外部から API を呼び出す方法の例（具体的には API を使用した認証と、プライバシー API の詳細）を以下に示します。プライバシー API について詳しくは、API のドキュメントを参照してください。また、Web サービス呼び出しに関するドキュメントも参照してください。
最初に、API を通じて認証を実行する必要があります。
-
URL「
<server url>/nl/jsp/schemawsdl.jsp?schema=xtk:session」から xtk:session WSDL をダウンロードします。 -
"Logon" メソッドを使用し、リクエストのパラメーターとしてユーザー名とパスワードを渡します。セッショントークンを含む応答が返されます。SoapUI を使用する場合の例を以下に示します。
-
返されたセッショントークンを後続のすべての API 呼び出しの認証として使用します。これは 24 時間後に有効期限切れになります。
次に、プライバシー API を呼び出します。
-
URL
<server url>/nl/jsp/schemawsdl.jsp?schema=nms:privacyRequest を使用して、WSDL をダウンロードします。 -
CreateRequestByName を使用して、特定のプライバシーリクエストを作成します。
CreateRequestByName を使用する場合の例を以下に示します。上記で提供されたセッショントークンを認証として使用する方法に注目してください。応答は、作成されたリクエストの ID になります。
上記の手順を実行するためには、以下の点を考慮してください。
- nms:gdprRequest スキーマで queryDef を使用すると、アクセスリクエストのステータスを確認できます。
- nms:gdprRequestData スキーマで queryDef を使用すると、アクセスリクエストの結果を取得できます。
- 「$(serverUrl)'/nms/gdpr.jssp?id='@id」 から XML ファイルをダウンロードするには、許可リスト登録済みの IP からログインしてファイルにアクセスする必要があります。これを行うには、JSSP で生成されたファイルにアクセスできる web アプリケーションを作成します。
JS からの API の呼び出し invoking-api-from-js
Campaign Classic 内で JS から API を呼び出す方法の例を以下に示します。
-
以前のビルドを GDPR パッケージと一緒に使用 している場合、下記のように「regulation」フィールドなしで API を引き続き使用できます。
code language-none loadLibrary("nms:gdpr.js"); /**************************** This code calls an API to create new Privacy request on the DB. It requires 4 parameters below. Feel free to change parameter values. ****************************/ // 1. Namespace internal name var namespaceName = "defaultNamespace1"; // 2. Reconciliation value for privacy request var reconciliationValue = "example@adobe.com"; // 3. Privacy request type // GDPR_REQUEST_TYPE_ACCESS = 1; // GDPR_REQUEST_TYPE_DELETE = 2; var requestType = GDPR_REQUEST_TYPE_ACCESS; // 4. Confirm deleting data required. // value : true or false var ConfirmDeletePending = true; // BEGIN var requestId = nms.privacyRequest.CreateRequestByName(namespaceName, reconciliationValue, requestType, ConfirmDeletePending); // User can use a simple queryDef with requestID as a parameter to check request status. -
20.2 に移行 しており、既に API を使用している場合は、下記のように「regulation」フィールドを追加する必要があります。
code language-none loadLibrary("nms:gdpr.js"); /**************************** This code calls an API to create new Privacy request on the DB. It requires 5 parameters below. Feel free to change parameter values. ****************************/ // 1. Namespace internal name var namespaceName = "defaultNamespace1"; // 2. Reconciliation value for privacy request var reconciliationValue = "example@adobe.com"; // 3. Privacy request type // PRIVACY_REQUEST_TYPE_ACCESS = 1; // PRIVACY_REQUEST_TYPE_DELETE = 2; var requestType = PRIVACY_REQUEST_TYPE_ACCESS; // 4. Confirm deleting data required. // value : true or false var ConfirmDeletePending = true; // 5. Specify which regulation applies to newly created request. This is mandatory parameter. // GDPR = 1 // CCPA = 2 // PDPA = 3 // LGPD = 4 var regulation = 1; // BEGIN var requestId = nms.privacyRequest.CreateRequestByName(namespaceName, reconciliationValue, requestType, ConfirmDeletePending, regulation); // User can use a simple queryDef with requestID as a parameter to check request status. -
Campaign Classic 20.2（ビルド 9178 以降）以降を使用 している場合は、下記のように「regulation」フィールドはオプションです。
code language-none loadLibrary("nms:gdpr.js"); /**************************** This code calls an API to create new Privacy request on the DB. It requires 5 parameters below. Feel free to change parameter values ****************************/ // 1. Namespace internal name var namespaceName = "defaultNamespace1"; // 2. Reconciliation value for privacy request var reconciliationValue = "example@adobe.com"; // 3. Privacy request type // PRIVACY_REQUEST_TYPE_ACCESS = 1; // PRIVACY_REQUEST_TYPE_DELETE = 2; var requestType = PRIVACY_REQUEST_TYPE_ACCESS; // 4. Confirm deleting data required. // value : true or false var ConfirmDeletePending = true; // 5. Specify which regulation applies to newly created request. This is optional parameter. // GDPR = 1 // CCPA = 2 // PDPA = 3 // LGPD = 4 var regulation = 1; // BEGIN var requestId = nms.privacyRequest.CreateRequestByName(namespaceName, reconciliationValue, requestType, ConfirmDeletePending, regulation); // User can use a simple queryDef with requestID as a parameter to check request status.