ドキュメント Experience Platform Privacy Service ガイド

Privacy Service API の認証とアクセス

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

トピック：

作成対象：

開発者

このガイドでは、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

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

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 ServiceAPI を選択します。 select-privacy-service-api

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

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

TIP

ドキュメントを表示 オプションを選択して、別のブラウザーウィンドウに移動し、Privacy ServiceAPI リファレンスドキュメントを参照します。

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

IMPORTANT

今後は OAuth サーバー間 の方法のみがサポートされるので、この方法を選択します。 サービスアカウント（JWT） メソッドは非推奨（廃止予定）となりました。 JWT 認証方法を使用した統合は 2025 年 1 月 1 日（PT）まで引き続き機能しますが、Adobeでは、その日までに既存の統合を新しい OAuth サーバー間認証方法に移行することを強くお勧めします。詳しくは、「[ 非推奨 ]{class="badge informative"}」の節を参照してください。{type=negative}JSON web トークン（JWT）を生成ます。

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

製品プロファイルを使用した権限の割り当て product-profiles

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

NOTE

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

終了したら、「設定済み API を保存」を選択します。

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

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

{API_KEY} （クライアント ID）
{ORG_ID} （組織 ID）

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

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

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

一般に、アクセストークンは次の 2 とおりの方法で生成されます。

テストおよび開発用に手動でトークンを生成します。
API 統合用のトークン生成の自動化。

トークンの手動生成 manual-token

新しい {ACCESS_TOKEN} を手動で生成するには、次に示すように、資格情報/OAuth サーバー間 に移動し、「アクセストークンを生成」を選択します。

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

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

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

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

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

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

次の手順 next-steps

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

recommendation-more-help

9cbf7061-a312-49f7-aaf8-a10885d53580