テンプレート化された顧客フィールドの検証

最終更新日: 2023-06-12
  • トピック:
  • Destinations
    このトピックの詳細を表示
  • 作成対象:
  • Developer
    User
    Admin
    Leader

概要

/authoring/testing/template/render エンドポイントは、宛先設定で定義された、テンプレート化された顧客データフィールドの外観を視覚化するのに役立ちます。

このエンドポイントは、顧客データフィールド用にランダムな値を生成し、応答でそれらを返します。これは、顧客データフィールド(バケット名やフォルダーパスなど)のセマンティック構造を検証するのに役立ちます。

はじめに

続行する前に、「はじめる前に」を参照し、API の呼び出しを正常に行うために必要となる重要な情報(必要な宛先オーサリング権限および必要なヘッダーの取得方法など)を確認してください。

前提条件

/template/render エンドポイントを使用する前に、以下の条件を満たしていることを確認してください。

  • Destination SDK で作成した既存のファイルベースの宛先があり、宛先カタログで確認できる。

  • API リクエストを成功させるには、テストする宛先インスタンスに対応する宛先インスタンス ID が必要です。Platform UI で宛先との接続を参照する際に、URL から、API 呼び出しで使用する必要がある宛先インスタンス ID を取得します。

    URL から宛先インスタンス ID を取得する方法を示す UI 画像。

テンプレート化された顧客フィールドのレンダリング

API 形式

POST /authoring/testing/template/render/destination

この API エンドポイントの動作を説明するために、以下の顧客データフィールド設定のファイルベースの宛先について見てみましょう。

"fileBasedS3Destination":{
   "bucket":{
      "templatingStrategy":"PEBBLE_V1",
      "value":"{{customerData.bucket}}"
   },
   "path":{
      "templatingStrategy":"PEBBLE_V1",
      "value":"{{customerData.path}}"
   }
}

リクエスト

以下のリクエストは、/authoring/testing/template/render エンドポイントを呼び出し、前述の 2 つの顧客データフィールドに対してランダムに生成された値を含む応答を返します。

curl -X POST 'https://platform.adobe.io/data/core/activation/authoring/testing/template/render/destination' \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'Content-Type: application/json' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \
 -d '
 {
    "destinationId": "{DESTINATION_CONFIGURATION_ID}",
    "templates": {
        "bucket": "{{customerData.bucket}}",
        "path": "{{customerData.bucket}}/{{customerData.path}}"
    }
}'
パラメーター 説明
destinationId テストしている宛先設定の ID。
templates 宛先サーバー設定で定義された、テンプレート化されたフィールド名。

応答

応答が成功すると、HTTP 200 OK ステータスが返され、本文には、テンプレート化されたフィールドに対するランダムに生成された値が含まれます。

この応答は、顧客データフィールド(バケット名やフォルダーパスなど)の正しい構造を検証するのに役立ちます。

{
    "results": {
        "bucket": "hfWpE-bucket",
        "path": "hfWpE-bucket/ceC"
    }
}

API エラー処理

Destination SDK API エンドポイントは、一般的な Experience Platform API エラーメッセージの原則に従います。Platform トラブルシューティングガイドの API ステータスコードおよびリクエストヘッダーエラーを参照してください。

次の手順

このドキュメントでは、宛先サーバーで定義された顧客データフィールド設定の検証方法を確認しました。

このページ