Privacy Service API の認証とアクセス

このガイドでは、Adobe Experience Platform Privacy Service APIを呼び出す前に知っておく必要があるコアコンセプトについて説明します。

前提条件 prerequisites

このガイドでは、Privacy Serviceについて理解し、Adobe Experience Cloud アプリケーション全体でデータ主体(お客様)からのアクセス要求と削除要求を管理する方法を理解する必要があります。

APIのアクセス資格情報を作成するには、組織内の管理者がAdobe Admin Console内でPrivacy Serviceの製品プロファイルを事前に設定している必要があります。 API統合に割り当てる製品プロファイルによって、Privacy Service機能にアクセスする際に統合が持つ権限が決まります。 詳しくは、Privacy Service権限の管理に関するガイドを参照してください。

必須ヘッダーの値の収集 gather-values-required-headers

Privacy Service APIを呼び出すには、まずアクセス資格情報を収集して、必要なヘッダーで使用する必要があります。

  • Authorization: Bearer {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {ORG_ID}

これらの値は、Adobe Developer Consoleを使用して生成されます。 {ORG_ID}{API_KEY}は1回のみ生成する必要があり、今後のAPI呼び出しで再利用できます。 ただし、{ACCESS_TOKEN}は一時的なものであり、24時間ごとに再生成する必要があります。

これらの値を生成する手順については、以下で詳しく説明します。

1 回限りのセットアップ one-time-setup

Adobe Developer Console に移動し 、Adobe ID を使用してログインします。 次に、Developer Console のドキュメントにある空のプロジェクトを作成に関するチュートリアルで説明されている手順に従います。

新しいプロジェクトを作成したら、プロジェクトに追加​を選択し、ドロップダウンメニューから​ API ​を選択します。

Developer Console のプロジェクト詳細ページの​ プロジェクトに追加 ドロップダウンから選択されているAPI オプション

Privacy Service APIを選択します select-privacy-service-api

API の追加​画面が表示されます。 Experience Cloud​を選択して使用可能なAPIのリストを絞り込み、Privacy Service API​のカードを選択してから、次へ​を選択します。

使用可能なAPIのリストから選択されているPrivacy Service API カード ​

TIP
ドキュメントを表示」オプションを選択すると、別のブラウザーウィンドウに移動して、完全なPrivacy Service API リファレンスドキュメント ​に移動します。

次に、認証タイプを選択してアクセストークンを生成し、Privacy Service APIにアクセスします。

IMPORTANT
OAuth サーバー間​方式を選択します。これは、今後サポートされる唯一の方法です。 サービスアカウント (JWT) メソッドは非推奨です。 JWT認証方式を使用した統合は2025年1月1日まで引き続き機能しますが、Adobeでは、その日以前に既存の統合を新しいOAuth サーバー間メソッドに移行することを強くお勧めします。 詳細については、「[非推奨]{class="badge negative"} JSON Web トークンを生成(JWT) ​」の節を参照してください。

Oauth サーバー間の認証方法を選択します。

製品プロファイルによる権限の割り当て product-profiles

最後の設定手順は、この統合が権限を継承する製品プロファイルを選択することです。 複数のプロファイルを選択すると、それらの権限セットが統合に組み合わされます。

NOTE
製品プロファイルと詳細な権限は、管理者がAdobe Admin Consoleを通じて作成、管理します。 詳しくは、Privacy Service権限に関するガイドを参照してください。

完了したら、設定したAPIを保存​を選択します。

設定を保存する前に、リストから1つの製品プロファイルを選択しています

APIがプロジェクトに追加されると、プロジェクトの​Privacy Service API ページに、Privacy Service APIへのすべての呼び出しに必要な次の資格情報が表示されます。

  • {API_KEY} (​ クライアント ID)
  • {ORG_ID} (組織ID)

Developer ConsoleでAPIを追加した後の統合情報。

各セッションの認証 authentication-each-session

最後に収集する必要がある資格情報は{ACCESS_TOKEN}です。これは、認証ヘッダーで使用されます。 {API_KEY}および{ORG_ID}の値とは異なり、APIを引き続き使用するには、24時間ごとに新しいトークンを生成する必要があります。

一般的に、アクセストークンを生成する方法は2つあります。

トークンを手動で生成 manual-token

新しい{ACCESS_TOKEN}を手動で生成するには、資格情報 > OAuth サーバー間​に移動し、アクセストークンを生成​を選択します(下図を参照)。

Developer Console UIでアクセストークンが生成される方法を示す画面記録。

新しいアクセストークンが生成され、トークンをクリップボードにコピーするためのボタンが表示されます。 この値は、必要な Authorization ヘッダーに使用され、Bearer {ACCESS_TOKEN} の形式で指定する必要があります。

トークン生成の自動化 auto-token

また、Postman環境とコレクションを使用して、アクセストークンを生成することもできます。 詳しくは、Experience Platform API認証ガイドの「Postmanを使用したAPI呼び出しの認証とテスト ​」の節を参照してください。

API 呼び出し例の読み取り read-sample-api-calls

各エンドポイントガイドには、リクエストのフォーマット方法を示すAPI呼び出しの例が記載されています。 これには、パス、必須ヘッダー、適切な形式のリクエストペイロードが含まれます。 また、API レスポンスで返されるサンプル JSON も示されています。 サンプル API 呼び出しのドキュメントで使用されている規則については、Experience Platform API の開始ガイドのAPI 呼び出し例の読み方に関する節を参照してください。

次の手順 next-steps

使用するヘッダーを理解できたので、Privacy Service API への呼び出しを開始できます。 開始するエンドポイントガイドのいずれかを選択します。

recommendation-more-help
experience-platform-help-privacy-service