Show Menu
トピック×

Privacy Service開発ガイド

Adobe Experience Platform Privacy Serviceは、Adobe Experience Cloudアプリケーション全体でデータサブジェクト(お客様)の個人データを管理(アクセスおよび削除)できるRESTful APIおよびユーザーインターフェイスを提供します。 Privacy Serviceは、Experience Cloudアプリケーションに関連するジョブのステータスと結果にアクセスできる、中央の監査とログのメカニズムも提供します。
このガイドはPrivacy ServiceAPIの使用方法をカバーしています。 UIの使用方法について詳しくは、 Privacy ServiceUIの概要を参照してください 。 Privacy ServiceAPIで使用可能なすべてのエンドポイントの包括的なリストについては、 APIリファレンスを参照してください

はじめに

このガイドでは、次のExperience Platform機能を理解している必要があります。
  • Privacy Service : RESTful APIとユーザーインターフェイスを提供します。このインターフェイスを使用すると、Adobe Experience Cloudアプリケーション全体で、データサブジェクト(顧客)からのアクセス要求と削除要求を管理できます。
以下の節では、Privacy ServiceAPIを正しく呼び出すために知る必要がある追加情報について説明します。

サンプルAPI呼び出しの読み取り

このチュートリアルでは、リクエストをフォーマットする方法を示すAPI呼び出しの例を提供します。 例えば、パス、必須のヘッダー、適切にフォーマットされた要求ペイロードなどです。 API応答で返されるサンプルJSONも提供されます。 サンプルAPI呼び出しのドキュメントで使用される規則について詳しくは、Experience PlatformトラブルシューティングガイドのAPI呼び出し例 の読み方に関する節 を参照してください。

必要なヘッダーの値の収集

Privacy ServiceAPIを呼び出すには、まずアクセス資格情報を収集し、必要なヘッダーで使用する必要があります。
  • 認証: 無記名 {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}
これには、アドビAdmin ConsoleでExperience Platformの開発者権限を取得し、Adobe Developer Consoleで資格情報を生成する必要があります。

Experience Platformへの開発者のアクセス権を取得

開発者がPlatformにアクセスするには、 Experience Platform認証チュートリアルの最初の手順に従い ます。 「Generate access credentials in Adobe Developer Console」の手順に到達したら、このチュートリアルに戻って、Privacy Serviceに固有の秘密鍵証明書を生成します。

アクセス資格情報の生成

Adobe Developer Consoleを使用して、次の3つのアクセス資格情報を生成する必要があります。
  • {IMS_ORG}
  • {API_KEY}
  • {ACCESS_TOKEN}
およ {IMS_ORG}``{API_KEY} びは1回だけ生成する必要があり、今後のAPI呼び出しで再利用できます。 ただし、一時的な {ACCESS_TOKEN} ので、24時間ごとに再生成する必要があります。
これらの値の生成手順の詳細は以下のとおりです。

1回限りのセットアップ

Adobe Developer Consoleに移動し、 Adobe IDでサインインします 。 次に、Adobe Developer Consoleドキュメントで空のプロジェクトの 作成に関するチュートリアルに概要を説明している手順に従い ます。
新しいプロジェクトを作成したら、プ ロジェクト概要 画面の「 API 」をクリックします。
API __追加画面が表示されます。 「 ​次へ​ 」をクリックする前に、利用可能なAPIのリストから​ Privacy ServiceAPIを選択します​
API _を設定_画面が表示されます。 「キーペアを​ ​生成する」オプションを選択し​ 、右下隅の「キーペアを​ ​生成​ 」をクリックします。
キーペアが自動的に生成され、秘密鍵と公開証明書を含むZIPファイルがローカルマシンにダウンロードされます(後の手順で使用します)。 「設定済みAPI を保存 」を選択して設定を完了します。
APIがプロジェクトに追加されると、 Privacy ServiceAPIの概要 ページにプロジェクトページが再び表示されます。 ここから、「 サービスアカウント(JWT) 」セクションまで下にスクロールします。このセクションには、Privacy ServiceAPIのすべての呼び出しで必要な次のアクセス資格情報が含まれます。
  • クライアントID : クライアントIDは、x-api-keyヘッダー {API_KEY} で指定する必要があるクライアントIDです。
  • 組織ID : 組織IDは、x-gw-ims-org-idヘッダーで使用する必要がある {IMS_ORG} 値です。

各セッションの認証

収集する必要がある最後の必要な秘密鍵証明書 {ACCESS_TOKEN} は、「認証」ヘッダーで使用される、自分の秘密鍵証明書です。 との値とは異なり、新しいトークン {API_KEY}``{IMS_ORG} は、PlatformAPIを引き続き使用するために24時間ごとに生成する必要があります。
新しい秘密鍵を生成するに {ACCESS_TOKEN} は、「トークンの生成」をクリックする前に、以前にダウンロードした秘密鍵を開き、「 _アクセストークンの_生成​ 」の横のテキストボックスにその内容を貼り付けます​
新しいアクセストークンが生成され、トークンをクリップボードにコピーするためのボタンが提供されます。 この値は、必要な認証ヘッダーに使用され、形式で指定する必要があり Bearer {ACCESS_TOKEN} ます。

次の手順

これで、使用するヘッダーが分かったので、Privacy ServiceAPIの呼び出しを開始する準備が整いました。 プ ライバシージョブに関するドキュメントでは 、Privacy ServiceAPIを使用して実行できる様々なAPI呼び出しについて詳しく説明します。 各サンプル呼び出しには、一般的なAPI形式、必要なヘッダーを表示するサンプルリクエスト、サンプルレスポンスが含まれます。