Platform に関する FAQ とトラブルシューティングガイド

このドキュメントでは、Adobe Experience Platform に関するよくある質問への回答と、Experience Platform API で発生する可能性がある一般的なエラーの高度なトラブルシューティングガイドを提供します。個々の Platform サービスのトラブルシューティングガイドについては、以下のサービストラブルシューティングディレクトリを参照してください。

FAQ faq

次に、Adobe Experience Platform に関するよくある質問に対する回答をリストします。

Experience Platform API とは何ですか？ what-are-experience-platform-apis

Experience Platform では、HTTP リクエストを使用して Platform リソースにアクセスするために複数の RESTful API が使用されます。これらのサービス API は、それぞれ複数のエンドポイントを公開し、リスト（GET）、ルックアップ（GET）、編集（PUT または PATCH）および削除（DELETE）リソースに対する操作を実行できます。各サービスで使用できる特定のエンドポイントと操作について詳しくは、Adobe I/O の API リファレンスドキュメントを参照してください。

API リクエストの形式を設定する方法を教えてください。 how-do-i-format-an-api-request

リクエストの形式は、使用する Platform API によって異なります。API 呼び出しの構造を学ぶ最善の方法は、使用している特定の Platform サービスのドキュメントに記載されている例に従うことです。

API リクエストの形式について詳しくは、『Platform API 入門ガイド』の API 呼び出しのサンプルを参照するの節を参照してください。

組織とは何ですか？ what-is-my-ims-organization

組織は、アドビにおいて顧客を表現したものです。ライセンスを取得したアドビのソリューションは、この顧客組織に統合されます。組織が Experience Platform の権利を付与されると、開発者にアクセス権を割り当てることができます。組織 ID（x-gw-ims-org-id）は、API 呼び出しの実行対象となる組織を表しているので、すべての API リクエストのヘッダーとして必要です。この ID は、Adobe Developer Console で確認できます。「統合」タブで、特定の統合の「概要」セクションに移動すると「クライアント資格情報」の下に ID が表示されます。Platform への認証方法の詳しい手順については、認証に関するチュートリアルを参照してください。

API キーはどこで入手できますか？ where-can-i-find-my-api-key

API キーは、すべての API リクエストのヘッダーとして必要です。これは、Adobe Developer Console から入手できます。コンソールの「統合」タブで、特定の統合の「概要」セクションに移動すると、「クライアント資格情報」の下にキーが表示されます。Platform への認証方法の詳しい手順については、認証に関するチュートリアルを参照してください。

アクセストークンはどのように入手できますか？ how-do-i-get-an-access-token

アクセストークンは、すべての API 呼び出しの Authorization ヘッダーに必要です。組織の統合にアクセスできる場合は、CURL コマンドを使用して生成できます。アクセストークンは 24 時間のみ有効で、その後 API を使用し続けるためには新しいトークンを生成する必要があります。アクセストークンの生成について詳しくは、認証に関するチュートリアルを参照してください。

クエリーパラメーターの使用方法 how-do-i-user-query-parameters

一部の 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 リクエストで更新する JSON フィールドを指定する方法を教えてください。 how-do-i-indicate-a-json-field-to-update-in-a-patch-request

Platform API の多くの PATCH 操作では、JSON Pointer 文字列を使用して、更新する JSON プロパティを示します。これらは通常、JSON パッチ 形式を使用してリクエストペイロードに含まれます。これらのテクノロジーに必要な構文について詳しくは、API の基本原則ガイドを参照してください。

Postman を使用して Platform API を呼び出すことはできますか？ how-do-i-use-postman-to-make-calls-to-platform-apis

Postman は、RESTful API への呼び出しを視覚化する便利なツールです。『Platform API 入門ガイド』には、Postman コレクションを読み込むためのビデオと手順が含まれています。さらに、各サービスについて Postman コレクションのリストが提供されます。

Platform の必要システム構成は何ですか？ what-are-the-system-requirements-for-platform

UI と API のどちらを使用しているかによって、次のシステム要件が適用されます。

UI ベースの操作の場合：

API および開発者のインタラクションの場合：

エラーとトラブルシューティング errors-and-troubleshooting

以下は、Experience Platform サービスの使用時に発生する可能性のあるエラーのリストです。個々の Platform サービスのトラブルシューティングガイドについては、以下のサービストラブルシューティングディレクトリを参照してください。

API ステータスコード api-status-codes

以下のステータスコードは、どの Experience Platform API でも発生する場合があります。それぞれに様々な原因があり、本項で述べる説明は概して一般的なものです。個々の Platform サービスで発生する特定のエラーについて詳しくは、以下のサービストラブルシューティングディレクトリを参照してください。

リクエストヘッダーエラー request-header-errors

Platform 内のすべての API 呼び出しには、特定のリクエストヘッダーが必要です。個々のサービスに必要なヘッダーを確認するには、 API リファレンスのドキュメントを参照してください。必要な認証ヘッダーの値を確認するには、認証に関するチュートリアルを参照してください。API 呼び出しをおこなう際に、これらのヘッダーのいずれかが見つからないか無効な場合は、次のエラーが発生する可能性があります。

OAuth トークンがありません oauth-token-is-missing

{
    "error_code": "403010",
    "message": "Oauth token is missing."
}

このエラーメッセージは、API リクエストに Authorization ヘッダーがない場合に表示されます。再試行する前に、Authorization ヘッダーが有効なアクセストークンに含まれていることを確認してください。

OAuth token is not valid oauth-token-is-not-valid

{
    "error_code": "401013",
    "message": "Oauth token is not valid"
}

このエラーメッセージは、Authorization ヘッダーに指定されたアクセストークンが無効な場合に表示されます。トークンが正しく入力されていることを確認するか、Adobe I/O コンソールで新しいトークンを生成します。

API key is required api-key-is-required

{
    "error_code": "403000",
    "message": "Api Key is required"
}

このエラーメッセージは、API リクエストに API キーヘッダー（x-api-key）がない場合に表示されます。再試行する前に、ヘッダーが有効な API キーに含まれていることを確認してください。

API key is invalid api-key-is-invalid

{
    "error_code": "403003",
    "message": "Api Key is invalid"
}

このエラーメッセージは、指定された API キーヘッダー（x-api-key）の値が無効な場合に表示されます。再試行する前に、キーが正しく入力されていることを確認してください。API キーがわからない場合は、Adobe I/O コンソールで確認できます。「統合」タブで、特定の統合の「概要」セクションに移動すると、「クライアント資格情報」の下に API キーが表示されます。

Missing header missing-header

{
    "error_code": "400003",
    "message": "Missing header"
}

このエラーメッセージは、API リクエストに組織ヘッダー（x-gw-ims-org-id）がない場合に表示されます。再試行する前に、組織の ID と共にヘッダーが含まれていることを確認してください。

プロファイルが有効ではありません profile-is-not-valid

{
    "error_code": "403025",
    "message": "Profile is not valid"
}

このエラーメッセージが表示されるのは、ユーザーまたは Adobe I/O 統合（Authorization ヘッダーのアクセストークンによって識別）が、x-gw-ims-org-id ヘッダーで指定された組織に対して Experience Platform API を呼び出す権利がない場合です。再試行する前に、ヘッダーに組織の正しい ID が指定されていることを確認してください。組織 ID が不明な場合は、Adobe I/O コンソールで確認できます。「統合」タブで、特定の統合の「概要」セクションに移動すると、「クライアント資格情報」の下に ID が表示されます。

etag 更新エラー refresh-etag-error

{
"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 呼び出しを行う必要があります。

Valid content-type not specified valid-content-type-not-specified

{
    "type": "/placeholder/type/uri",
    "status": 400,
    "title": "BadRequestError",
    "detail": "A valid content-type must be specified"
}

このエラーメッセージは、POST、PUT、PATCH リクエストの Content-Type ヘッダーが無効か、見つからない場合に表示されます。ヘッダーがリクエストに含まれ、その値が application/json であることを確認します。

ユーザー領域がありません user-region-is-missing

{
    "error_code": "403027",
    "message": "User region is missing"
}

このエラーメッセージは、次の 2 つの場合のいずれかで表示されます。

サービストラブルシューティングディレクトリ service-troubleshooting-directory

以下は、Experience Platform API のトラブルシューティングガイドと API リファレンスドキュメントのリストです。各トラブルシューティングガイドでは、よくある質問への回答と、個々の Platform サービスに固有の問題に対する解決方法を提供します。API リファレンスドキュメントは、各サービスで使用可能なすべてのエンドポイントの包括的なガイドを提供し、受け取る可能性のあるリクエストの本文、応答、エラーコードのサンプルを示します。