このドキュメントでは、Adobe Experience Platformに関するよくある質問に対する回答と、どのドキュメントでも発生する可能性のある一般的なエラーの高度なトラブルシューティングガイドを提供します Experience Platform API 個々のに関するトラブルシューティングガイドの場合 Platform サービスについては、 サービストラブルシューティングディレクトリ 下
次に、Adobe Experience Platform に関するよくある質問に対する回答をリストします。
Experience Platform は、HTTP リクエストを使用してにアクセスする複数の RESTful API を提供します Platform リソース。 これらのサービス API は、それぞれ複数のエンドポイントを公開し、リスト(GET)、ルックアップ(GET)、編集(PUT または PATCH)および削除(DELETE)リソースに対する操作を実行できます。各サービスで使用できる特定のエンドポイントと操作について詳しくは、Adobe I/O の API リファレンスドキュメントを参照してください。
リクエストの形式は Platform 使用中の API。 API 呼び出しの構造を学ぶ最善の方法は、特定の Platform 使用しているサービス。
API リクエストの形式について詳しくは、『Platform API 入門ガイド』を参照してください サンプル API 呼び出しの読み取り 」セクションに入力します。
IMS 組織は、顧客のアドビ代表です。ライセンスを取得したアドビのソリューションは、この顧客組織に統合されます。IMS 組織が次の権限を持つ場合 Experience Platformを使用すると、開発者にアクセスを割り当てることができます。 IMS 組織 ID(x-gw-ims-org-id
)は、API 呼び出しを実行する必要がある組織を表すもので、すべての API リクエストのヘッダーとして必要です。この ID は、 Adobe Developer Console:内 統合 タブで、 概要 のセクションを使用して、 クライアント資格情報. への認証方法の詳しい手順については、 Platformを参照し、 認証チュートリアル.
API キーは、すべての API リクエストのヘッダーとして必要です。これは、 Adobe Developer Console. コンソールの「統合」タブで、特定の統合の「概要」セクションに移動すると、「クライアント資格情報」の下にキーが表示されます。への認証方法の詳しい手順 Platformを参照し、 認証チュートリアル.
アクセストークンは、すべての API 呼び出しの Authorization ヘッダーに必要です。IMS 組織の統合にアクセスできる場合は、curl
コマンドを使用して生成できます。アクセストークンは 24 時間のみ有効で、その後 API を使用し続けるためには新しいトークンを生成する必要があります。アクセストークンの生成について詳しくは、認証に関するチュートリアルを参照してください。
一部 Platform API エンドポイントは、クエリパラメーターを受け取って、特定の情報を見つけ、応答で返される結果をフィルタリングします。 リクエストパスに疑問符(?
)記号が付加され、その後に 1 つ以上のクエリーパラメーターが paramName=paramValue
形式で追加されます。1 回の呼び出しで複数のパラメーターを組み合わせる場合、アンパサンド(&
)を使用して個々のパラメーターを区切る必要があります。次の例は、複数のクエリーパラメーターを使用するリクエストがドキュメントでどのように表現されているかを示しています。
以下は、一般的に使用されるクエリーパラメーターの例です。
GET /tenant/schemas?orderby=title
GET /datasets?limit=36&start=10
GET /batches?createdAfter=1559775880000&orderBy=desc:created
特定のサービスまたはクエリで使用できるエンドポイントパラメーターの詳細については、サービス固有のドキュメントを参照してください。
での多くのPATCH操作 Platform 使用する API JSON ポインター 更新する JSON プロパティを示す文字列。 これらは通常、JSON パッチ 形式を使用してリクエストペイロードに含まれます。これらのテクノロジーに必要な構文について詳しくは、API の基本原則ガイドを参照してください。
Postman は、RESTful API への呼び出しを視覚化する便利なツールです。この Platform API 入門ガイド には、Postmanコレクションを読み込むためのビデオと手順が含まれています。 また、各サービスのPostmanコレクションのリストも表示されます。
UI と API のどちらを使用しているかによって、次の必要システム構成が適用されます。
UI ベースの操作の場合:
API および開発者のインタラクションの場合:
以下は、 Experience Platform サービス。 個々のに関するトラブルシューティングガイドの場合 Platform サービスについては、 サービストラブルシューティングディレクトリ 下
以下のステータスコードは、 Experience Platform API それぞれに様々な原因があり、本項で述べる説明は概して一般的なものです。個々の特定のエラーに関する詳細 Platform サービスについては、 サービストラブルシューティングディレクトリ 下
ステータスコード | 説明 | 考えられる原因 |
---|---|---|
400 | Bad request | リクエストが不適切に構築され、キー情報が欠落している、または正しくない構文が含まれていました。 |
401 | Authentication failed | リクエストが認証チェックに合格しませんでした。アクセストークンが見つからないか、無効です。詳しくは、以下の「OAuth トークンエラー」の節を参照してください。 |
403 | Forbidden | リソースが見つかりましたが、リソースを表示するための正しい資格情報がありません。 |
404 | Not found | リクエストされたリソースがサーバーで見つかりませんでした。リソースが削除されたか、リクエストされたパスが正しく入力されていない可能性があります。 |
500 | Internal server error | これはサーバーサイドのエラーです。同時に多数の呼び出しをおこなう場合、API の制限に達し、結果をフィルターする必要がある可能性があります。( Catalog Service API 開発者ガイド ( フィルターデータ 詳細はこちら )。 リクエストを再試行する前にしばらく待ち、問題が解決しない場合は管理者に問い合わせてください。 |
のすべての API 呼び出し Platform には特定のリクエストヘッダーが必要です。 個々のサービスに必要なヘッダーを確認するには、 API リファレンスのドキュメントを参照してください。必要な認証ヘッダーの値を確認するには、認証に関するチュートリアルを参照してください。API 呼び出しをおこなう際に、これらのヘッダーのいずれかが見つからないか無効な場合は、次のエラーが発生する可能性があります。
{
"error_code": "403010",
"message": "Oauth token is missing."
}
このエラーメッセージは、API リクエストに Authorization
ヘッダーがない場合に表示されます。再試行する前に、Authorization ヘッダーが有効なアクセストークンに含まれていることを確認してください。
{
"error_code": "401013",
"message": "Oauth token is not valid"
}
このエラーメッセージは、Authorization
ヘッダーに指定されたアクセストークンが無効な場合に表示されます。トークンが正しく入力されていることを確認するか、Adobe I/O コンソールで新しいトークンを生成します。
{
"error_code": "403000",
"message": "Api Key is required"
}
このエラーメッセージは、API リクエストに API キーヘッダー(x-api-key
)がない場合に表示されます。再試行する前に、ヘッダーが有効な API キーに含まれていることを確認してください。
{
"error_code": "403003",
"message": "Api Key is invalid"
}
このエラーメッセージは、指定された API キーヘッダー(x-api-key
)の値が無効な場合に表示されます。再試行する前に、キーが正しく入力されていることを確認してください。API キーがわからない場合は、Adobe I/O コンソールで確認できます。「統合」タブで 、特定の統合の「概要」セクションに移動すると、「クライアント資格情報」の下に API キーが表示されます。
{
"error_code": "400003",
"message": "Missing header"
}
このエラーメッセージは、IMS 組織ヘッダー(x-gw-ims-org-id
)が API リクエストに存在しない場合に表示されます。再試行する前に、IMS 組織の ID を含むヘッダーが含まれていることを確認してください。
{
"error_code": "403025",
"message": "Profile is not valid"
}
このエラーメッセージは、ユーザーまたは Adobe I/O 統合(🔗 ヘッダーのAuthorization
アクセストークンExperience Platformによって識別)が、x-gw-ims-org-id
ヘッダーで提供された IMS 組織に対して API を呼び出す権利がない場合に表示されます。再試行する前に、ヘッダーに IMS 組織の正しい ID が指定されていることを確認してください。組織 ID が不明な場合は、Adobe I/O コンソールで確認できます。「統合」タブで、特定の統合の「概要」セクションに移動すると、「クライアント資格情報」の下に ID が表示されます。
{
"errorMessage":"Supplied version=[\\\\\\\"a200a2a3-0000-0200-0000-123178f90000\\\\\\\"] does not match the current version on entity=[\\\\\\\"a200cdb2-0000-0200-0000-456179940000\\\\\\\"]"
}
フロー、接続、ソースコネクタ、またはターゲット接続など、別の API 呼び出し元がソースまたは宛先エンティティに対して変更を加えた場合、etag エラーが発生することがあります。 バージョンの不一致により、行おうとしている変更はエンティティの最新バージョンには適用されません。
これを解決するには、エンティティを再度取得し、変更がエンティティの新しいバージョンと互換性があることを確認して、新しい etag を If-Match
ヘッダーを呼び出し、最後に API 呼び出しをおこないます。
{
"type": "/placeholder/type/uri",
"status": 400,
"title": "BadRequestError",
"detail": "A valid content-type must be specified"
}
このエラーメッセージは、POST、PUT、PATCH リクエストの Content-Type
ヘッダーが無効か、見つからない場合に表示されます。ヘッダーがリクエストに含まれ、その値が application/json
であることを確認します。
{
"error_code": "403027",
"message": "User region is missing"
}
このエラーメッセージは、次の 2 つの場合のいずれかに表示されます。
x-gw-ims-org-id
) は API リクエストで渡されます。 再試行する前に、IMS 組織の正しい ID が含まれていることを確認してください。以下は、のトラブルシューティングガイドと API リファレンスドキュメントのリストです。 Experience Platform API 各トラブルシューティングガイドでは、個々のユーザーに固有のよくある質問と問題の解決方法を示します Platform サービス。 API リファレンスドキュメントは、各サービスで使用可能なすべてのエンドポイントの包括的なガイドを提供し、受け取る可能性のあるリクエストの本文、応答、エラーコードのサンプルを示します。
サービス | API リファレンス | トラブルシューティング |
---|---|---|
アクセス制御 | アクセス制御 API | アクセス制御トラブルシューティングガイド |
Adobe Experience Platformでのデータ取得 | Data Ingestion API | バッチ取得トラブルシューティングガイド ストリーミング取得トラブルシューティングガイド |
Adobe Experience Platform Data Science Workspace | Sensei Machine Learning API | Data Science Workspace トラブルシューティングガイド |
Adobe Experience Platform のデータガバナンス | Policy Service API | |
Adobe Experience Platform ID サービス | Identity Service API | Identity Service トラブルシューティングガイド |
Adobe Experience Platform クエリサービス | Query Service API | Query Service トラブルシューティングガイド |
Adobe Experience Platform Segmentation | Segmentation API | |
Catalog Service | Catalog Service API | |
Experience Data Model (XDM) | Schema Registry API | XDM System FAQ とトラブルシューティングガイド |
Flow Service (Sources および Destinations) | Flow Service API | |
Real-time Customer Profile | Real-time Customer Profile API | Profile トラブルシューティングガイド |
サンドボックス | サンドボックス API | サンドボックストラブルシューティングガイド |