このページでは、 Adobe Journey Optimizerの統合機能を、互換性のあるAPIを公開する外部プラットフォームと組み合わせて使用する方法と、運用に関するガードレールとイラストのベンダーパターンを使用して、設定を導く方法について説明します。
お客様は、AJO統合機能および関連するサードパーティベンダーまたは統合機能の使用が、HIPAAなどの適用されるすべての法律および規制に準拠していることを確認する責任があります。
クイックナビゲーション quick-navigation
以下のグループ化されたリンクを使用すると、関連するベンダーパターンにすばやくジャンプできます。
- コンテンツ管理システム:Contentful、Sitecore、Salsify、Contentstack、Akeneo、Magnolia
- ロイヤルティと報酬:Voucherify、Talon.One、Antavo、Salesforce Loyalty、Capillary
- テンプレート、パーソナライゼーション、レコメンデーション:Stensul、Marigold、Adobe Target Recommendations
- データ、天気、操作:AccuWeather、ShipStation、RevenueCat、Databricks
- レビュー、同意、ソーシャル:Bynder、Trustpilot、Bazaarvoice、OneTrust、Meta、Aprimo、Epsilon(Epsilon3)
コンテンツとCMS content-and-cms
Contentful contentful
Contentfulは、RESTまたはGraphQL経由の構造化されたエントリとアセット用のヘッドレス CMSです。これにより、Journey Optimizerは送信時または開封時にコンテンツを取得できます。
一般的なユースケースには、電子メールのローカライズされたヒーローブロック、代替テキスト、CTA、動的モジュールの製品またはプロモ – ションエントリなどがあります。 もうひとつの一般的なパターンは、パーソナライズされたメッセージを配信するために、IDごとに特定のエントリを取得することです。
次の前提条件が適用されます。
- 配信API アクセスと読み取り指向のAPI キーを備えたコンテンツフルスペース。
- コンテンツタイプとフィールド IDをクリアします。Journey Optimizerの管理者アクセス権により、統合を作成できます。
次の制限事項と除外事項が適用されます。
- ブロックリストまたはページ分割されたコンテンツ APIは、このパターンに適していません。特定のエントリまたはアセットをターゲットとする取得呼び出しを優先します。
- 書き戻しまたは双方向の同期は、この例の範囲外です。
Journey Optimizerでこの統合を設定するには、次の手順を使用します。 リクエストの詳細については、統合フィールドのサンプルを参照し、これらの値を環境のベンダードキュメントで確認してください。
-
統合の操作に従います。 コンテンツ配信APIと配信トークンを使用して GET を設定し、サンプル JSONを貼り付け、フィールドをマッピングし、テストしてアクティブ化します。
-
Journey Optimizerで、Configurations > Manageに移動し、Create Integrationを選択します。
-
スペースなしで統合名を入力します。
-
Contentful Content Delivery API (CDA) URLを使用してエンドポイントを設定します:
https://cdn.contentful.com/spaces/{space_id}/environments/{environment_id}/entries/{entry_id} -
HTTP メソッドを選択:GET。
-
認証を追加します。 以下の サンプル統合フィールド に示すように、
access_tokenクエリ パラメーターをContent Delivery API トークンに設定します。 Contentfulは、Authorization: Bearerヘッダーで同じトークンを受け入れます。統合フィールドでサポートされているフィールドを使用してください。 -
必要に応じてパス変数(エントリ ID、ロケールなど)を追加します。
-
フィールドを検出してマッピングできるように、サンプル JSON応答を貼り付けます。
-
パーソナライゼーションの必須フィールドを選択します。
-
必要に応じて、タイムアウトとキャッシュを設定します。
-
接続をテストしてアクティブ化します。
次の表に、この統合リクエストの値の例を示します。
統合フィールドのサンプル(お使いのスペースと環境の コンテンツ配信APIに合わせる):
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 | |
|---|---|
| フィールド | 値 |
| URL | https://cdn.contentful.com/spaces/{{spaceID}}/environments/{{environment_id}}/entries/{{entry_id}} |
| 応答ペイロード | API応答に基づいて、オーサリング中に使用する必要な応答フィールドを選択して設定します。 |
| ポリシー | 必要に応じてポリシーレベルの詳細を設定します。 |
| HTTP メソッド | GET |
パスパラメーター
| table 0-row-3 1-row-3 2-row-3 3-row-3 | ||
|---|---|---|
| パスパラメーター | 名前 | デフォルト値 |
spaceID |
spaceID |
<YOUR_SPACE_ID> |
environment_id |
environment_id |
<YOUR_ENV_ID> |
entry_id |
entry_id |
<YOUR_ENTRY_ID> |
ヘッダー
| table 0-row-5 1-row-5 | ||||
|---|---|---|---|---|
| パラメーター | 名前 | タイプ | 値 | 必須 |
| コンテンツタイプ(デフォルト) | Content-Type | 定数 | application/json | はい(オン) |
認証
| table 0-row-4 1-row-4 | |||
|---|---|---|---|
| タイプ | API キー名 | API キー値 | ロケーション |
| API キー | access_token |
<YOUR_API_KEY> |
クエリパラメーター |
Sitecore sitecore
Sitecore Content Hubと関連するCloud APIは、DAM形式のダウンロードとメタデータフローをサポートしています。以下のパターンの例では、ダウンロード順序をIDで示しています。
一般的なユースケースには、メールコンテンツのアセットやダウンロードのメタデータや、Sitecoreで管理されるDAM ワークフローとの連携が含まれます。
次の前提条件が適用されます。
- テナント URLと資格情報(API サーフェスごとのベアラーまたはトークン)。
- Journey Optimizerの管理者アクセス権にアクセスして、統合を作成できます。
次の制限事項と除外事項が適用されます。
- ホスト名とパスはSitecore製品によって異なります。 テナントが公開するエンドポイントのみを使用します。
- OAuth アクセストークン、更新、および有効期間は、Sitecore セキュリティポリシーに従う必要があります。
Journey Optimizerでこの統合を設定するには、次の手順を使用します。 リクエストの詳細については、統合フィールドのサンプルを参照し、これらの値を環境のベンダードキュメントで確認してください。
-
統合の操作に従います。 ダウンロード注文パスに GET を設定し、Sitecoreごとに認証ヘッダーを設定し、コンテキストから
idをマッピングし、サンプル JSONを貼り付け、フィールドをマッピングし、アセット待ち時間のタイムアウトを調整します。 -
Journey Optimizerで、Configurations > Manageに移動し、Create Integrationを選択します。
-
スペースなしで統合名を入力します。
-
Content Hub APIを使用してエンドポイントを設定します(例:IDによるダウンロード順序)。 URL パターンの例:
https://xmapps-api.sitecorecloud.io/api/v1/downloadorders/{id} -
設定テーブルに表示されるHTTP メソッドを選択します。特に指定がない限り、通常はGETを選択します。
-
テーブルおよびベンダードキュメントで指定されたとおりに認証(ヘッダー、クエリパラメーター、OAuth)を正確に設定します。
-
パス、クエリ、ヘッダーのパラメーターを定義し、必要に応じて変数をプロファイルデータやコンテキストデータにマッピングできます。
-
フィールドを検出してマッピングできるように、サンプル JSON応答を貼り付けます。
-
応答ペイロードマッピングでパーソナライゼーションに必要なフィールドを選択します。
-
予想されるボリュームに基づいて、タイムアウト、再試行、およびキャッシングポリシーを設定します。
-
接続をテストし、統合をアクティブ化します。
次の表に、この統合リクエストの値の例を示します。
Journey Optimizerでこのサンプル呼び出しを設定する場合は、次のフィールドを使用します。 Sitecore ドキュメント で、製品(Content Hub、XM Cloudなど)のホスト名とAPI バージョンを確認します。
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 | |
|---|---|
| フィールド | 値 |
| URL | https://xmapps-api.sitecorecloud.io/api/v1/downloadorders/{{id}} |
| HTTP メソッド | GET |
| 応答ペイロード | API応答に基づいて、オーサリング中に使用する必要な応答フィールドを選択して設定します。 |
| ポリシー | 必要に応じてポリシーレベルの詳細を設定します。 |
パスパラメーター
| table 0-row-3 1-row-3 | ||
|---|---|---|
| パスパラメーター | 名前 | デフォルト値 |
id |
id |
<id_of_download_order> |
ヘッダー
| table 0-row-5 1-row-5 2-row-5 3-row-5 | ||||
|---|---|---|---|---|
| パラメーター | 名前 | タイプ | 値 | 必須 |
| コンテンツタイプ(デフォルト) | Content-Type | 定数 | application/json | はい(オン) |
| 認証 | 認証 | 定数 | ベアラー<token> |
はい(オン) |
| If-Modified-Since | If-Modified-Since | 変数 | 2019-08-24T14:15:22Z | いいえ(オフ) |
認証
| table 0-row-4 1-row-4 | |||
|---|---|---|---|
| タイプ | API キー名 | API キー値 | ロケーション |
| API キー | X-Auth-Token | <token> |
ヘッダー |
Salsify salsify
Salsifyは、商品、チャネル、デジタルアセット用のAPIを備えたPIMです。
一般的なユースケースには、電子メールやメッセージ内の製品属性やメディア URLが、同時配信されたカタログデータと連携して含まれます。
次の前提条件が適用されます。
- API トークンと組織コンテキスト。プロファイルまたはコンテキストから解決可能な製品ID。
- Journey Optimizerでの管理者アクセス:
次の制限事項と除外事項が適用されます。
- 非常に大きなカタログ:統合でエンティティごとの取得が想定される場合は、一括リストエンドポイントを避けます。
- 属性の表示は、Salsifyの役割の権限によって制限できます。
Journey Optimizerでこの統合を設定するには、次の手順を使用します。 リクエストの詳細については、統合フィールドのサンプルを参照し、これらの値を環境のベンダードキュメントで確認してください。
-
統合の操作に従います。 一括カタログ呼び出しよりも単一の製品取得を好み、ベアラー認証を設定し、サンプル JSONを貼り付け、フィールドをマップし、テストし、アクティベートします。
-
Journey Optimizerで、Configurations > Manageに移動し、Create Integrationを選択します。
-
スペースなしで統合名を入力します。
-
Salsify製品APIを使用してエンドポイントを設定します。 URL パターンの例:
https://api.salsify.com/v1/... -
設定テーブルに表示されるHTTP メソッドを選択します。特に指定がない限り、通常はGETを選択します。
-
テーブルおよびベンダードキュメントで指定されたとおりに認証(ヘッダー、クエリパラメーター、OAuth)を正確に設定します。
-
パス、クエリ、ヘッダーのパラメーターを定義し、必要に応じて変数をプロファイルデータやコンテキストデータにマッピングできます。
-
フィールドを検出してマッピングできるように、サンプル JSON応答を貼り付けます。
-
応答ペイロードマッピングでパーソナライゼーションに必要なフィールドを選択します。
-
予想されるボリュームに基づいて、タイムアウト、再試行、およびキャッシングポリシーを設定します。
-
接続をテストし、統合をアクティブ化します。
次の表に、この統合リクエストの値の例を示します。
古い参照の中には、Salsifyのダウンロード注文スタイルのパスを再利用したものもあります。代わりに、https://app.salsify.com/api/v1/orgs/{org_id}/products/{salsify_id}またはそれに類似したものをテナントが使用できます。 Salsify開発者で確認します。
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 | |
|---|---|
| フィールド | 値 |
| URL | https://app.salsify.com/api/v1/orgs/{{org_id}}/products/{{salsify_id}} |
| HTTP メソッド | GET |
| ポリシー | 必要に応じてポリシーレベルの詳細を設定します。 |
| 応答ペイロード | API応答に基づいて、オーサリング中に使用する必要な応答フィールドを選択して設定します。 |
パスパラメーター
| table 0-row-3 1-row-3 2-row-3 | ||
|---|---|---|
| パスパラメーター | 名前 | デフォルト値 |
org_id |
org_id |
<org_id> |
salsify_id |
salsify_id |
<salsify_id> |
ヘッダー
| table 0-row-5 1-row-5 2-row-5 3-row-5 | ||||
|---|---|---|---|---|
| パラメーター | 名前 | タイプ | 値 | 必須 |
| コンテンツタイプ(デフォルトのパラメーター) | Content-Type | 定数 | application/json | はい(オン) |
| 認証 | 認証 | 定数 | Bearer <YOUR_TOKEN_HERE> |
はい(オン) |
| If-Modified-Since | If-Modified-Since | 変数 | 2019-08-24T14:15:22Z | いいえ(オフ) |
認証
| table 0-row-4 1-row-4 | |||
|---|---|---|---|
| タイプ | API キー名 | API キー値 | ロケーション |
| API キー | apiKey |
<your_api_key> |
ヘッダー |
Contentstack contentstack
コンテンツスタックはヘッドレス CMSです。REST配信は、Journey OptimizerのJSON フィールドマッピングに典型的です。
典型的なユースケースは、ロケールを含むパラメーターを含むバナーまたはプロモーションのエントリを使用することです。
次の前提条件が適用されます。
- API キー、配信トークン、環境名、コンテンツタイプ UIDをスタックします。
- Journey Optimizerでの管理者アクセス:
次の制限事項と除外事項が適用されます。
- このパターンでは、フィールドマッピングにREST JSONを使用します。GraphQL配信は、異なる統合パスに従います。
- 実稼動用に適した配信トークンを使用します。プレビューと公開されたフローは互換性がありません。
Journey Optimizerでこの統合を設定するには、次の手順を使用します。 リクエストの詳細については、統合フィールドのサンプルを参照し、これらの値を環境のベンダードキュメントで確認してください。
-
統合の操作に従います。 コンテンツスタックが必要とする
api_keyとaccess_tokenの両方のヘッダーを追加し、environmentクエリパラメーターを含め、サンプル JSONを貼り付け、フィールドをマップ、テスト、アクティベートします。 -
Journey Optimizerで、Configurations > Manageに移動し、Create Integrationを選択します。
-
スペースなしで統合名を入力します。
-
Content Delivery APIを使用してエンドポイントを設定します。 URL パターンの例:
https://cdn.contentstack.io/v3/content_types/{content_type_uid}/entries/{entry_uid} -
設定テーブルに表示されるHTTP メソッドを選択します。特に指定がない限り、通常はGETを選択します。
-
テーブルおよびベンダードキュメントで指定されたとおりに認証(ヘッダー、クエリパラメーター、OAuth)を正確に設定します。
-
パス、クエリ、ヘッダーのパラメーターを定義し、必要に応じて変数をプロファイルデータやコンテキストデータにマッピングできます。
-
フィールドを検出してマッピングできるように、サンプル JSON応答を貼り付けます。
-
応答ペイロードマッピングでパーソナライゼーションに必要なフィールドを選択します。
-
予想されるボリュームに基づいて、タイムアウト、再試行、およびキャッシングポリシーを設定します。
-
接続をテストし、統合をアクティブ化します。
次の表に、この統合リクエストの値の例を示します。
統合フィールドのサンプル。 Contentstack Content Delivery APIを参照してください。
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 | |
|---|---|
| フィールド | 値 |
| URL | https://cdn.contentstack.io/v3/content_types/{{content_type_uid}}/entries/{{entry_uid}} |
| HTTP メソッド | GET |
| 応答ペイロード | API応答に基づいて、オーサリング中に使用する必要な応答フィールドを選択して設定します。 |
| ポリシー | 必要に応じてポリシーレベルの詳細を設定します。 |
| ヘッダー | 追加のヘッダーは必要ありません。 |
パスパラメーター
| table 0-row-3 1-row-3 2-row-3 | ||
|---|---|---|
| パスパラメーター | 名前 | デフォルト値 |
content_type_uid |
Content Type UID | <your_content_type_uid> |
entry_uid |
入口UID | <your_entry_uid> |
認証
| table 0-row-3 1-row-3 2-row-3 | ||
|---|---|---|
| キー名 | キー値 | 追加先 |
api_key |
<YOUR_STACK_API_KEY> |
ヘッダー |
access_token |
<YOUR_DELIVERY_TOKEN> |
ヘッダー |
Contentstackでは、配信リクエストのヘッダーとして 両方 のキーが想定されています。
クエリパラメータ
| table 0-row-5 1-row-5 | ||||
|---|---|---|---|---|
| パラメーター | 名前 | タイプ | 値 | 必須 |
environment |
環境名 | 変数 | <your_environment_name> |
はい(オン) |
アケネオ akeneo
Akeneo PIMは、製品、属性、メディア用にREST APIを公開しています。
一般的なユースケースには、メールモジュールの管理された製品データや、ジャーニーの特定のチャネルの属性などが含まれます。
次の前提条件が適用されます。
- PIM ベース URLとOAuth クライアント、製品UUIDまたはID戦略。
- Journey Optimizerでの管理者アクセス:
次の制限事項と除外事項が適用されます。
- PIM応答が大きい場合があります。 パーソナライゼーションに必要な属性のみをマッピングします。
- 書き込み操作は、一般的な読み取り専用パーソナライゼーションの例の範囲外です。
Journey Optimizerでこの統合を設定するには、次の手順を使用します。 リクエストの詳細については、統合フィールドのサンプルを参照し、これらの値を環境のベンダードキュメントで確認してください。
-
統合の操作に従います。 GETをベアラートークンと共に使用し、クエリフラグに必要な属性オプションのみをリクエストし、サンプル JSONを貼り付け、最小限の属性セットをマッピングし、テストし、アクティブ化します。
-
Journey Optimizerで、Configurations > Manageに移動し、Create Integrationを選択します。
-
スペースなしで統合名を入力します。
-
Akeneo REST APIを使用してエンドポイントを設定します。 URL パターンの例:
https://{pim-host}/api/rest/v1/... -
設定テーブルに表示されるHTTP メソッドを選択します。特に指定がない限り、通常はGETを選択します。
-
テーブルおよびベンダードキュメントで指定されたとおりに認証(ヘッダー、クエリパラメーター、OAuth)を正確に設定します。
-
パス、クエリ、ヘッダーのパラメーターを定義し、必要に応じて変数をプロファイルデータやコンテキストデータにマッピングできます。
-
フィールドを検出してマッピングできるように、サンプル JSON応答を貼り付けます。
-
応答ペイロードマッピングでパーソナライゼーションに必要なフィールドを選択します。
-
予想されるボリュームに基づいて、タイムアウト、再試行、およびキャッシングポリシーを設定します。
-
接続をテストし、統合をアクティブ化します。
次の表に、この統合リクエストの値の例を示します。
パターンの例:https://{pim-host}/api/rest/v1/products-uuid/{uuid} (例:Accept: application/json) Akeneo APIを参照してください。
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 | |
|---|---|
| フィールド | 値 |
| URL | https://{{your-akeneo-domain}}.com/api/rest/v1/products-uuid/{{uuidProduct}} |
| HTTP メソッド | GET |
| ポリシー | 必要に応じてポリシーレベルの詳細を設定します。 |
| 応答ペイロード | API応答に基づいて、オーサリング中に使用する必要な応答フィールドを選択して設定します。 |
パスパラメーター
| table 0-row-3 1-row-3 | ||
|---|---|---|
| パスパラメーター | 名前 | デフォルト値 |
uuidProduct |
UUID | <product_uuid> |
ヘッダー
| table 0-row-5 1-row-5 2-row-5 | ||||
|---|---|---|---|---|
| パラメーター | 名前 | タイプ | 値 | 必須 |
| 認証 | 認証 | 定数 | Bearer <YOUR_TOKEN> |
はい(オン) |
| Accept | Accept | 定数 | application/json | はい(オン) |
クエリパラメータ
| table 0-row-5 1-row-5 2-row-5 3-row-5 | ||||
|---|---|---|---|---|
| パラメーター | 名前 | タイプ | 値 | 必須 |
with_attribute_options |
属性オプションを含める | 変数 | false | いいえ(オフ) |
with_quality_scores |
品質スコアを含める | 変数 | false | いいえ(オフ) |
with_completenesses |
完全性を含める | 変数 | false | いいえ(オフ) |
認証
| table 0-row-4 1-row-4 | |||
|---|---|---|---|
| タイプ | API キー名 | API キー値 | ロケーション |
| API キー | 認証 | Bearer <YOUR_ACCESS_TOKEN> |
ヘッダー |
マグノリア magnolia
Magnoliaでは、デプロイメントに応じて、ヘッドレスエンドポイントとREST配信エンドポイントを提供しています。
典型的なユースケースは、マーケティングモジュール用にコンテンツノードまたはコンテンツフラグメントを配信することです。
次の前提条件が適用されます。
- インスタンス URLとトークンまたは基本的な認証。配信のワークスペースとパス。
- Journey Optimizerでの管理者アクセス:
次の制限事項と除外事項が適用されます。
- REST配信URLは、インストールされているMagnolia モジュールと設定によって異なります。
Journey Optimizerでこの統合を設定するには、次の手順を使用します。 リクエストの詳細については、統合フィールドのサンプルを参照し、これらの値を環境のベンダードキュメントで確認してください。
-
統合の操作に従います。 モジュールが公開するパブリック配信URL パターンを使用し、Magnolia ガイダンス(匿名の配信と保護されたコンテンツのトークン)ごとに認証し、サンプル JSONの貼り付け、フィールドのマッピング、テスト、アクティベートを行います。
-
Journey Optimizerで、Configurations > Manageに移動し、Create Integrationを選択します。
-
スペースなしで統合名を入力します。
-
Magnolia REST (配信)を使用してエンドポイントを設定します。 URL パターンの例:
https://{author-or-public}/.rest/delivery/... -
設定テーブルに表示されるHTTP メソッドを選択します。特に指定がない限り、通常はGETを選択します。
-
テーブルおよびベンダードキュメントで指定されたとおりに認証(ヘッダー、クエリパラメーター、OAuth)を正確に設定します。
-
パス、クエリ、ヘッダーのパラメーターを定義し、必要に応じて変数をプロファイルデータやコンテキストデータにマッピングできます。
-
フィールドを検出してマッピングできるように、サンプル JSON応答を貼り付けます。
-
応答ペイロードマッピングでパーソナライゼーションに必要なフィールドを選択します。
-
予想されるボリュームに基づいて、タイムアウト、再試行、およびキャッシングポリシーを設定します。
-
接続をテストし、統合をアクティブ化します。
次の表に、この統合リクエストの値の例を示します。
パターンの例:https://{domain}/magnoliaAuthor/.rest/delivery/...またはパブリック配信ツアースタイルのURL。 パスは、インストール済みのモジュールによって異なります。 Magnolia ドキュメント を参照してください。
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 | |
|---|---|
| フィールド | 値 |
| URL | http://{{your-domain}}/magnoliaAuthor/.rest/delivery/<myEndpoint>/travel/@nodes |
| HTTP メソッド | GET |
| ポリシー | 必要に応じてポリシーレベルの詳細を設定します。 |
| 応答ペイロード | API応答に基づいて、オーサリング中に使用する必要な応答フィールドを選択して設定します。 |
ヘッダー
| table 0-row-5 1-row-5 2-row-5 | ||||
|---|---|---|---|---|
| パラメーター | 名前 | タイプ | 値 | 必須 |
| Content-Type | Content-Type | 定数 | application/json | はい(オン) |
| Accept | Accept | 定数 | application/json | はい(オン) |
認証
| table 0-row-4 1-row-4 | |||
|---|---|---|---|
| タイプ | API キー名 | API キー値 | ロケーション |
| API キー | 認証 | <bearer_token> |
ヘッダー |
注意:配信APIは、ログインを必要としないコンテンツにrest-anonymous役割を使用することです。 保護されたデータへの安全なアクセスには、API トークンやOAuth 2.0などのより堅牢な方法が適しています。
ロイヤルティとリワード loyalty-and-rewards
Voucherify voucherify
Voucherifyは、プロモーションとロイヤルティ REST API (キャンペーン、バウチャー、ロイヤルティプログラム)を提供します。
一般的なユースケースには、コンテンツのオファーに対して「ロイヤルティ」や「プロモーションの状態」を読み、適切な場合は「レベル」や「バランス」を表示することが含まれます。
次の前提条件が適用されます。
- アプリケーション IDと秘密鍵(地域/クラスターごと)。呼び出すロイヤルティまたはキャンペーンエンドポイントを明確にします。
- Journey Optimizerでの管理者アクセス:
次の制限事項と除外事項が適用されます。
- 顧客向けエラーやメッセージコンテンツで、内部プロモーションやキャンペーンの識別子を公開しないようにする。
- アプリケーションレベルのレート制限が適用されます。 Voucherify ガイダンスごとに再試行とキャッシュを設定します。
Journey Optimizerでこの統合を設定するには、次の手順を使用します。 リクエストの詳細については、統合フィールドのサンプルを参照し、これらの値を環境のベンダードキュメントで確認してください。
-
統合の操作に従います。 クラスターのベース URLの設定、必須ヘッダー(
X-APP-ID、X-APP-TOKEN)の追加、フィルターまたはIDを使用したリスト エンドポイントの制約、サンプル JSONの貼り付け、フィールドのマッピング、テスト、アクティベート。 -
Journey Optimizerで、Configurations > Manageに移動し、Create Integrationを選択します。
-
スペースなしで統合名を入力します。
-
ロイヤルティ / REST APIを使用してエンドポイントを設定します。 Voucherifyごとに、お住まいの地域の クラスター のホストとパスを設定します。 URL パターンの例:
https://{cluster}.voucherify.io/ -
設定テーブルに表示されるHTTP メソッドを選択します。特に指定がない限り、通常はGETを選択します。
-
テーブルおよびベンダードキュメントで指定されたとおりに認証(ヘッダー、クエリパラメーター、OAuth)を正確に設定します。
-
パス、クエリ、ヘッダーのパラメーターを定義し、必要に応じて変数をプロファイルデータやコンテキストデータにマッピングできます。
-
フィールドを検出してマッピングできるように、サンプル JSON応答を貼り付けます。
-
応答ペイロードマッピングでパーソナライゼーションに必要なフィールドを選択します。
-
予想されるボリュームに基づいて、タイムアウト、再試行、およびキャッシングポリシーを設定します。
-
接続をテストし、統合をアクティブ化します。
次の表に、この統合リクエストの値の例を示します。
統合フィールドのサンプル。 完全な参照:Voucherify API。
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 | |
|---|---|
| フィールド | 値 |
| URL | https://{{cluster}}.voucherify.io/v1/loyalties/{{campaignId}}/members |
| HTTP メソッド | GET |
| 応答ペイロード | API応答に基づいて、オーサリング中に使用する必要な応答フィールドを選択して設定します。 |
| ポリシー | 必要に応じてポリシーレベルの詳細を設定します。 |
パスパラメーター
| table 0-row-3 1-row-3 2-row-3 | ||
|---|---|---|
| パスパラメーター | 名前 | デフォルト値 |
cluster |
cluster |
<your_cluster> |
campaignId |
campaignId |
<loyalty_campaign_Id> |
ヘッダー
| table 0-row-5 1-row-5 2-row-5 3-row-5 | ||||
|---|---|---|---|---|
| パラメーター | 名前 | タイプ | 値 | 必須 |
| コンテンツタイプ(デフォルト) | Content-Type | 定数 | application/json | はい(オン) |
| X-APP-ID | X-APP-ID | 定数 | <YOUR-APP-ID> |
はい(オン) |
| X-Voucherify-Channel | X-Voucherify-Channel | 定数 | Voucherify Documentation | いいえ(オフ) |
クエリパラメータ
| table 0-row-5 1-row-5 2-row-5 3-row-5 4-row-5 5-row-5 6-row-5 7-row-5 8-row-5 | ||||
|---|---|---|---|---|
| パラメーター | 名前 | タイプ | 値 | 必須 |
limit |
limit |
変数 | 10 | いいえ(オフ) |
page |
page |
変数 | 1 | いいえ(オフ) |
customer |
customer |
変数 | <customer_identifier> |
いいえ(オフ) |
created_at |
created_at |
変数 | <iso8601_date> |
いいえ(オフ) |
updated_at |
updated_at |
変数 | <iso8601_date> |
いいえ(オフ) |
order |
order |
変数 | <sort_field> |
いいえ(オフ) |
code |
code |
変数 | <loyalty_card_code> |
いいえ(オフ) |
ids |
ids |
変数 | <array_of_ids> |
いいえ(オフ) |
認証
| table 0-row-4 1-row-4 | |||
|---|---|---|---|
| タイプ | API キー名 | API キー値 | ロケーション |
| API キー | X-APP-TOKEN | <YOUR-APP-TOKEN> |
ヘッダー |
Talon.One talon-one
Talon.Oneは、セッション、エフェクト、プロファイル用のREST APIを備えたプロモーションおよびロイヤルティルールエンジンです。
一般的なユースケースには、パーソナライズされたコンテンツやロイヤルティの進捗状況、特典表示における、カートまたはプロファイルレベルでのプロモーションが含まれます。
次の前提条件が適用されます。
- API キーとデプロイメント固有のベース URL。アプリケーションまたはキャンペーンのスコープの識別子。
- Journey Optimizerでの管理者アクセス:
次の制限事項と除外事項が適用されます。
- セッション量の多いフローでは、統合リクエストモデルへの慎重なマッピングが必要になる場合があります。
- Talon.Oneのレート制限とidempotency ガイダンスを確認してください。
Journey Optimizerでこの統合を設定するには、次の手順を使用します。 リクエストの詳細については、統合フィールドのサンプルを参照し、これらの値を環境のベンダードキュメントで確認してください。
-
統合の操作に従います。 必要なプロファイルまたは達成パスで GET を使用し、
Authorization: ApiKey-v1 <key>を文書化して設定し、サンプル JSONを貼り付け、フィールドをマップし、テストしてアクティブ化します。 -
Journey Optimizerで、Configurations > Manageに移動し、Create Integrationを選択します。
-
スペースなしで統合名を入力します。
-
Talon.One統合APIを使用してエンドポイントを設定します。 URL パターンの例:
https://{your-domain}.talon.one/v1/... -
設定テーブルに表示されるHTTP メソッドを選択します。特に指定がない限り、通常はGETを選択します。
-
テーブルおよびベンダードキュメントで指定されたとおりに認証(ヘッダー、クエリパラメーター、OAuth)を正確に設定します。
-
パス、クエリ、ヘッダーのパラメーターを定義し、必要に応じて変数をプロファイルデータやコンテキストデータにマッピングできます。
-
フィールドを検出してマッピングできるように、サンプル JSON応答を貼り付けます。
-
応答ペイロードマッピングでパーソナライゼーションに必要なフィールドを選択します。
-
予想されるボリュームに基づいて、タイムアウト、再試行、およびキャッシングポリシーを設定します。
-
接続をテストし、統合をアクティブ化します。
次の表に、この統合リクエストの値の例を示します。
| table 0-row-2 1-row-2 2-row-2 | |
|---|---|
| フィールド | 値 |
| URL | https://{{your-deployment}}.talon.one/v1/customer_profiles/{{integrationId}}/achievements/{{achievementId}} |
| HTTP メソッド | GET |
パスパラメーター
| table 0-row-3 1-row-3 2-row-3 3-row-3 | ||
|---|---|---|
| パスパラメーター | 名前 | デフォルト値 |
your-deployment |
your-deployment |
<your_deployment> |
integrationId |
integrationId |
<integrationId> |
achievementId |
achievementId |
<achievementId> |
ヘッダー
| table 0-row-5 1-row-5 | ||||
|---|---|---|---|---|
| パラメーター | 名前 | タイプ | 値 | 必須 |
| コンテンツタイプ(デフォルト) | Content-Type | 定数 | application/json | はい(オン) |
クエリパラメータ
| table 0-row-5 1-row-5 2-row-5 3-row-5 4-row-5 5-row-5 | ||||
|---|---|---|---|---|
| パラメーター | 名前 | タイプ | 値 | 必須 |
progressStatus |
progressStatus |
変数 | 進行中/完了/期限切れ | いいえ(オフ) |
startDate |
startDate |
変数 | 2024-05-29T15:04:05+07:00 | いいえ(オフ) |
endDate |
endDate |
変数 | 2024-05-29T15:04:05+07:00 | いいえ(オフ) |
pageSize |
pageSize |
変数 | <default_page_size> |
いいえ(オフ) |
skip |
skip |
変数 | <items_to_skip> |
いいえ(オフ) |
認証
| table 0-row-4 1-row-4 | |||
|---|---|---|---|
| タイプ | API キー名 | API キー値 | ロケーション |
| API キー | 認証 | ApiKey-v1 <YOUR_API_KEY> |
ヘッダー |
アンタボ antavo
Antavoは、メンバー、報酬、イベント用のREST APIを備えたエンタープライズロイヤルティプラットフォームです。
典型的なユースケースとしては、電子メールやプッシュ通知、オファーに対するポイント、階層、報酬などが挙げられます。
次の前提条件が適用されます。
- URLとAPIの資格情報をスタックします。必要に応じて、プログラムまたはショップの識別子を指定します。
- Journey Optimizerでの管理者アクセス:
次の制限事項と除外事項が適用されます。
- お客様のPIIは、Antavo契約およびお客様のプライバシーポリシーに基づいて処理する必要があります。
- お使いの環境に合わせて、APIのバージョンと安定したエンドポイントをAntavoで確認します。
Journey Optimizerでこの統合を設定するには、次の手順を使用します。 リクエストの詳細については、統合フィールドのサンプルを参照し、これらの値を環境のベンダードキュメントで確認してください。
-
統合の操作に従います。 ベンダーの認証(クエリのAPI キーなど)を使用して GET を設定し、ポリシーに対するPIIの公開を避け、サンプル JSONを貼り付け、フィールドをマッピングし、テストしてアクティブ化します。
-
Journey Optimizerで、Configurations > Manageに移動し、Create Integrationを選択します。
-
スペースなしで統合名を入力します。
-
Antavo Enterprise APIを使用してエンドポイントを設定します。
-
設定テーブルに表示されるHTTP メソッドを選択します。特に指定がない限り、通常はGETを選択します。
-
テーブルおよびベンダードキュメントで指定されたとおりに認証(ヘッダー、クエリパラメーター、OAuth)を正確に設定します。
-
パス、クエリ、ヘッダーのパラメーターを定義し、必要に応じて変数をプロファイルデータやコンテキストデータにマッピングできます。
-
フィールドを検出してマッピングできるように、サンプル JSON応答を貼り付けます。
-
応答ペイロードマッピングでパーソナライゼーションに必要なフィールドを選択します。
-
予想されるボリュームに基づいて、タイムアウト、再試行、およびキャッシングポリシーを設定します。
-
接続をテストし、統合をアクティブ化します。
次の表に、この統合リクエストの値の例を示します。
統合フィールドのサンプルには、ステージング ホストが使用されます。実稼動では、Antavo スタック ホスト名が使用されます。 Antavo ドキュメント を参照してください。
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 | |
|---|---|
| フィールド | 値 |
| URL | https://api.staging.antavo.com/customers/{{customer_id}}/activities/offers |
| HTTP メソッド | GET |
| ポリシー | 必要に応じてポリシーレベルの詳細を設定します。 |
| 応答ペイロード | API応答に基づいて、オーサリング中に使用する必要な応答フィールドを選択して設定します。 |
パスパラメーター
| table 0-row-3 1-row-3 | ||
|---|---|---|
| パスパラメーター | 名前 | デフォルト値 |
customer_id |
customer_id |
<customer_id> |
ヘッダー
| table 0-row-5 1-row-5 2-row-5 | ||||
|---|---|---|---|---|
| パラメーター | 名前 | タイプ | 値 | 必須 |
| コンテンツタイプ(デフォルト) | Content-Type | 定数 | application/json | はい(オン) |
| Accept | Accept | 定数 | application/json | いいえ(オフ) |
認証
| table 0-row-4 1-row-4 | |||
|---|---|---|---|
| タイプ | API キー名 | API キー値 | ロケーション |
| API キー | api_key |
<YOUR_API_KEY> |
クエリパラメーター |
Salesforceロイヤルティ salesforce-loyalty
Salesforce Loyalty Managementは、メンバー、プログラム、トランザクション用に、Salesforce プラットフォームでREST APIを公開します。
一般的なユースケースには、ジャーニーの階層、ポイント、メリットを明らかにし、メッセージとCRM データやロイヤルティデータを連携させることが含まれます。
次の前提条件が適用されます。
- Salesforceインスタンス、接続アプリや統合ユーザー、組織に適したOAuth。
- Journey Optimizerでの管理者アクセス:
次の制限事項と除外事項が適用されます。
- Salesforce APIの制限とOAuth トークンの更新は、統合に設計する必要があります。
- API応答に表示されるフィールドを管理する、フィールドレベルのセキュリティおよび共有ルール。
Journey Optimizerでこの統合を設定するには、次の手順を使用します。 リクエストの詳細については、統合フィールドのサンプルを参照し、これらの値を環境のベンダードキュメントで確認してください。
-
統合の操作に従います。 チームが承認したロイヤルティ統合エンドポイントを使用して、Salesforce OAuthを完成させ、サンプル JSONをペーストし、フィールドをマッピングし、複合APIの制限を尊重し、テストし、アクティベートします。
-
Journey Optimizerで、Configurations > Manageに移動し、Create Integrationを選択します。
-
スペースなしで統合名を入力します。
-
Salesforce Loyalty Management RESTを使用してエンドポイントを設定します。 URL パターンの例:
https://{instance}.salesforce.com/services/data/vXX.X/... -
設定テーブルに表示されるHTTP メソッドを選択します。特に指定がない限り、通常はGETを選択します。
-
テーブルおよびベンダードキュメントで指定されたとおりに認証(ヘッダー、クエリパラメーター、OAuth)を正確に設定します。
-
パス、クエリ、ヘッダーのパラメーターを定義し、必要に応じて変数をプロファイルデータやコンテキストデータにマッピングできます。
-
フィールドを検出してマッピングできるように、サンプル JSON応答を貼り付けます。
-
応答ペイロードマッピングでパーソナライゼーションに必要なフィールドを選択します。
-
予想されるボリュームに基づいて、タイムアウト、再試行、およびキャッシングポリシーを設定します。
-
接続をテストし、統合をアクティブ化します。
次の表に、この統合リクエストの値の例を示します。
組織のAPI バージョンについて文書化されたロイヤルティ管理メンバープロファイル GET操作を使用します。パスには、プログラムとメンバーの識別子が含まれます。 Salesforce developersを参照してください。
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 | |
|---|---|
| フィールド | 値 |
| URL | https://{{your-instance}}.my.salesforce.com/services/data/{{version}}/connect/loyalty/management/members |
| HTTP メソッド | GET |
| ポリシー | 必要に応じてポリシーレベルの詳細を設定します。 |
| 応答ペイロード | API応答に基づいて、オーサリング中に使用する必要な応答フィールドを選択して設定します。 |
パスパラメーター
| table 0-row-3 1-row-3 2-row-3 | ||
|---|---|---|
| パスパラメーター | 名前 | デフォルト値 |
your-instance |
your-instance |
<your_instance> |
version |
version |
version |
ヘッダー
| table 0-row-5 1-row-5 2-row-5 | ||||
|---|---|---|---|---|
| パラメーター | 名前 | タイプ | 値 | 必須 |
| コンテンツタイプ(デフォルト) | Content-Type | 定数 | application/json | はい(オン) |
| Accept | Accept | 定数 | application/json | いいえ(オフ) |
クエリパラメータ
| table 0-row-5 1-row-5 2-row-5 3-row-5 | ||||
|---|---|---|---|---|
| パラメーター | 名前 | タイプ | 値 | 必須 |
membershipNumber |
membershipNumber |
変数 | <membership_number> |
いいえ(オフ) * |
membershipId |
membershipId |
変数 | <membership_id> |
いいえ(オフ) * |
posMemId |
posMemId |
変数 | <pos_mem_id> |
いいえ(オフ) * |
* 3つのうち少なくとも1つは必要です。
認証
| table 0-row-4 1-row-4 | |||
|---|---|---|---|
| タイプ | API キー名 | API キー値 | ロケーション |
| API キー | 認証 | <access_token> |
ヘッダー |
Capillary capillary
キャピラリーは、小売スタックで一般的なロイヤルティおよびエンゲージメント APIを提供します。
一般的なユースケースには、パーソナライズされたジャーニー内のポイント、層、オファーなどがあります。
次の前提条件が適用されます。
- API ホストと認証(多くの場合、署名済みリクエスト、Capillaryのドキュメントに従う)。
- エンドポイントのプログラム識別子。
次の制限事項と除外事項が適用されます。
- 認証スキームと地域ホストは、デプロイメントによって異なります。 お使いのスタックのキャピラリーで確認します。
Journey Optimizerでこの統合を設定するには、次の手順を使用します。 リクエストの詳細については、統合フィールドのサンプルを参照し、これらの値を環境のベンダードキュメントで確認してください。
-
統合の操作に従います。 必要に応じて
CAP-API-ACCESS-TOKENなどのヘッダーを設定し、サンプル JSONを貼り付け、フィールドをマッピングし、テストし、アクティブ化します。 -
Journey Optimizerで、Configurations > Manageに移動し、Create Integrationを選択します。
-
スペースなしで統合名を入力します。
-
Capillary APIを使用してエンドポイントを設定します。
-
設定テーブルに表示されるHTTP メソッドを選択します。特に指定がない限り、通常はGETを選択します。
-
テーブルおよびベンダードキュメントで指定されたとおりに認証(ヘッダー、クエリパラメーター、OAuth)を正確に設定します。
-
パス、クエリ、ヘッダーのパラメーターを定義し、必要に応じて変数をプロファイルデータやコンテキストデータにマッピングできます。
-
フィールドを検出してマッピングできるように、サンプル JSON応答を貼り付けます。
-
応答ペイロードマッピングでパーソナライゼーションに必要なフィールドを選択します。
-
予想されるボリュームに基づいて、タイムアウト、再試行、およびキャッシングポリシーを設定します。
-
接続をテストし、統合をアクティブ化します。
次の表に、この統合リクエストの値の例を示します。
例:https://ushc.intouch.capillarytech.com/api/v3/rewards/{reward_id} (ホストは地域によって異なります)。 ホストと認証スキームを キャピラリーで検証します。
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 | |
|---|---|
| フィールド | 値 |
| URL | https://ushc.intouch.capillarytech.com/api/v3/rewards/{{reward_id}} |
| HTTP メソッド | GET |
| ポリシー | 必要に応じてポリシーレベルの詳細を設定します。 |
| 応答ペイロード | API応答に基づいて、オーサリング中に使用する必要な応答フィールドを選択して設定します。 |
パスパラメーター
| table 0-row-3 1-row-3 | ||
|---|---|---|
| パスパラメーター | 名前 | デフォルト値 |
reward_id |
特典ID | <your_reward_id> |
ヘッダー
| table 0-row-5 1-row-5 2-row-5 | ||||
|---|---|---|---|---|
| パラメーター | 名前 | タイプ | 値 | 必須 |
| Content-Type | Content-Type | 定数 | application/json | はい(オン) |
| CAP-API-ACCESS-TOKEN | アクセストークン | 定数 | <YOUR_ACCESS_TOKEN> |
はい(オン) |
認証
| table 0-row-4 1-row-4 | |||
|---|---|---|---|
| タイプ | API キー名 | API キー値 | ロケーション |
| API キー | CAP-API-ACCESS-TOKEN | <YOUR_ACCESS_TOKEN> |
ヘッダー |
テンプレートとメッセージ templates-and-messaging
ステンスル stensul
Stensulは、承認済みテンプレート用のメール作成プラットフォームです。Journey Optimizerは、APIを介してテンプレートメタデータと構造化リージョンを使用できます。
一般的なユースケースには、承認済みテンプレートのインポートや地域のプロファイル属性へのマッピング、管理されたブロックの再利用によるスケーラブルなキャンペーン構築などが含まれます。
次の前提条件が適用されます。
- API アクセス機能を備えたStensul アカウントと、定義されたトークンを備えた公開テンプレート。
- Journey Optimizerの管理者アクセス権にアクセスして、統合を作成できます。
次の制限事項と除外事項が適用されます。
- ここでは、Journey Optimizer内のStensul テンプレートのインプレースでのWYSIWYG編集については説明しません。
- テンプレートペイロード内の大規模または複雑なHTMLでは、セキュリティレビューとサニタイズが必要になる場合があります。
Journey Optimizerでこの統合を設定するには、次の手順を使用します。 リクエストの詳細については、統合フィールドのサンプルを参照し、これらの値を環境のベンダードキュメントで確認してください。
-
Journey Optimizerで、Configurations > Manageに移動し、Create Integrationを選択します。
-
統合名を入力します。
-
Stensul テンプレート API URLを使用してエンドポイントを設定します。 URL パターンの例:
https://api.stensul.com/v1/templates/{template_id} -
認証を設定します(Stensul API ドキュメントごとのAPI キーまたはOAuth)。
-
パス変数(テンプレート IDなど)を定義します。
-
フィールド検出用のサンプル JSON応答を貼り付けます。
-
必須テンプレートフィールドをJourney Optimizer パーソナライゼーションフィールドにマッピングします。
-
接続をテストしてアクティブ化します。
マリゴールド marigold
Marigoldは、ロイヤルティおよびエンゲージメント APIを公開します。ホストは、地域によって異なります(EUと米国のモジュールホスト名)。
典型的なユースケースは、マリーゴールドプログラムからのロイヤルティデータや嗜好データを利用したメッセージの強化です。
次の前提条件が適用されます。
- 契約のベース URLと資格情報。可能な場合は最小権限API ユーザー。
- Journey Optimizerでの管理者アクセス:
次の制限事項と除外事項が適用されます。
- エンドポイントはMarigold製品によって異なります。 お客様のデプロイメントにMarigold サポートを使用した検証。
- 個人情報は、DPAおよび保持ポリシーに準拠する必要があります。
Journey Optimizerでこの統合を設定するには、次の手順を使用します。 リクエストの詳細については、統合フィールドのサンプルを参照し、これらの値を環境のベンダードキュメントで確認してください。
-
統合の操作に従います。 お住まいの地域のMarigold ホストを指定し、認証を設定します(以下のサンプルでは、キーと秘密鍵を使用して
X-Api-Keyを使用しています)。サンプル JSONを貼り付け、フィールドをマップし、テスト、アクティベートします。 -
Journey Optimizerで、Configurations > Manageに移動し、Create Integrationを選択します。
-
スペースなしで統合名を入力します。
-
Marigold REST APIを使用してエンドポイントを設定します。
-
設定テーブルに表示されるHTTP メソッドを選択します。特に指定がない限り、通常はGETを選択します。
-
テーブルおよびベンダードキュメントで指定されたとおりに認証(ヘッダー、クエリパラメーター、OAuth)を正確に設定します。
-
パス、クエリ、ヘッダーのパラメーターを定義し、必要に応じて変数をプロファイルデータやコンテキストデータにマッピングできます。
-
フィールドを検出してマッピングできるように、サンプル JSON応答を貼り付けます。
-
応答ペイロードマッピングでパーソナライゼーションに必要なフィールドを選択します。
-
予想されるボリュームに基づいて、タイムアウト、再試行、およびキャッシングポリシーを設定します。
-
接続をテストし、統合をアクティブ化します。
-
Marigoldは、顧客インスタンスがアクティブな地理的領域に基づいて2つのエンドポイントを使用します。
- ヨーロッパ:
https://{{customername}}.module.slgnt.eu - 米国:
https://{{customername}}.module.slgnt.us
- ヨーロッパ:
次の表に、この統合リクエストの値の例を示します。
ベース ホストは地域によって異なります(例:https://{{customername}}.module.slgnt.euまたはhttps://{{customername}}.module.slgnt.us)。 導入時にMarigoldでパスを確認する。
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 | |
|---|---|
| フィールド | 値 |
| URL | https://{{customername}}.module.slgnt.{{locale}}/Portal/Api/organizations/{{organization}}/content/{{api_name}} |
| HTTP メソッド | GET |
| 応答ペイロード | API応答に基づいて、オーサリング中に使用する必要な応答フィールドを選択して設定します。 |
| ポリシー | 必要に応じてポリシーレベルの詳細を設定します。 |
パスパラメーター
| table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 | ||
|---|---|---|
| パスパラメーター | 名前 | デフォルト値 |
customername |
customername |
<your_name> |
locale |
locale |
eu / us |
organization |
organization |
<your_organization> |
api_name |
api_name |
<api_name> |
ヘッダー
| table 0-row-5 1-row-5 | ||||
|---|---|---|---|---|
| パラメーター | 名前 | タイプ | 値 | 必須 |
| コンテンツタイプ(デフォルト) | Content-Type | 定数 | application/json | はい(オン) |
認証
| table 0-row-4 1-row-4 | |||
|---|---|---|---|
| タイプ | API キー名 | API キー値 | ロケーション |
| API キー | X-Api-Key | <apiKey>:<apiSecret> |
ヘッダー |
Adobe Targetの推奨事項 adobe-target-recommendations
Adobe Targetには、使用権限に応じて、サーバーサイドまたは統合されたエクスペリエンス向けのレコメンデーションおよび配信APIが含まれています。
一般的なユースケースには、Journey Optimizerで作成したエクスペリエンスにレコメンデーションを挿入したり、プロファイルやExperience Platformのコンテキストとキーを整合させたりすることが含まれます。
➡️統合をアクティベートしたら、 コンテンツオーサリングで統合を追加する方法と メッセージテンプレートでAdobe Target データを使用する方法について説明します。
次の前提条件が適用されます。
- Recommendations; IMS組織とサポートされる認証を使用してターゲットを設定します。
- Journey Optimizerでの管理者アクセス:
次の制限事項と除外事項が適用されます。
- レコメンデーションおよび配信APIには、特定のパラメーター(mboxや製品識別子など)が必要です。 Adobe Targetのドキュメントに従ってください。
- 送信ボリュームとユースケースに合わせて、待ち時間とキャッシュを調整します。
Journey Optimizerでこの統合を設定するには、次の手順を使用します。 リクエストの詳細については、統合フィールドのサンプルを参照し、これらの値を環境のベンダードキュメントで確認してください。
-
統合の操作に従います。 配信の呼び出しは、多くの場合、POSTとJSON本文で行われます。 ターゲット認証ごとにOAuthを設定し、サンプル応答を貼り付け、フィールドをマッピングし、想定されるボリュームでテストします。
-
Journey Optimizerで、Configurations > Manageに移動し、Create Integrationを選択します。
-
スペースなしで統合名を入力します。
-
Target Recommendations / delivery APIを使用してエンドポイントを設定します。
-
設定テーブルに表示されるHTTP メソッドを選択します。特に指定がない限り、通常はGETを選択します。
-
テーブルおよびベンダードキュメントで指定されたとおりに認証(ヘッダー、クエリパラメーター、OAuth)を正確に設定します。
-
パス、クエリ、ヘッダーのパラメーターを定義し、必要に応じて変数をプロファイルデータやコンテキストデータにマッピングできます。
-
フィールドを検出してマッピングできるように、サンプル JSON応答を貼り付けます。
-
応答ペイロードマッピングでパーソナライゼーションに必要なフィールドを選択します。
-
予想されるボリュームに基づいて、タイムアウト、再試行、およびキャッシングポリシーを設定します。
-
接続をテストし、統合をアクティブ化します。
次の表に、この統合リクエストの値の例を示します。
| table 0-row-2 1-row-2 2-row-2 3-row-2 | |
|---|---|
| フィールド | 値 |
| URL | https://{{client}}.tt.omtrdc.net/rest/v1/delivery |
| ポリシー | 必要に応じてポリシーレベルの詳細を設定します。 |
| HTTP メソッド | POST |
パスパラメーター
| table 0-row-3 1-row-3 | ||
|---|---|---|
| パスパラメーター | 名前 | デフォルト値 |
client |
client |
<client_name> |
ヘッダー
| table 0-row-5 1-row-5 | ||||
|---|---|---|---|---|
| パラメーター | 名前 | タイプ | 値 | 必須 |
| コンテンツタイプ(デフォルト) | Content-Type | 定数 | application/json | はい(オン) |
クエリパラメータ
| table 0-row-5 1-row-5 2-row-5 | ||||
|---|---|---|---|---|
| パラメーター | 名前 | タイプ | 値 | 必須 |
| クライアント | クライアント | 変数 | <customer_client_code> |
はい(オン) |
| sessionId | sessionId | 変数 | <session_identifier> |
はい(オン) |
認証
Target認証設定を参照し、JSONをペイロードに追加してください。
要求ペイロード
| code language-sample |
|---|
|
データ、天候、運用 data-weather-and-operations
AccuWeather accuweather
AccuWeatherは、予測および場所のREST APIを公開して、メッセージに天候に応じたスニペットを含めることができます。
一般的なユースケースには、電子メールやプッシュ通知での短い予測や、プロファイルやコンテキストに関連する予測値を使用したコンテンツのカスタマイズなどがあります。
次の前提条件が適用されます。
- APIのサブスクリプションとキー、位置情報キーまたは都市検索フロー。
- Journey Optimizerの管理者アクセス権にアクセスして、統合を作成できます。
次の制限事項と除外事項が適用されます。
- AccuWeather サブスクリプション層のJSON応答形状を確認します。統合は、JSON応答からフィールドをマッピングします。
- AccuWeatherのレート制限と推奨されるキャッシュを確認します。
locationKeyを解決するには、多くの場合、予測呼び出しの前に別の位置情報または都市検索リクエストが必要です。
Journey Optimizerでこの統合を設定するには、次の手順を使用します。 リクエストの詳細については、統合フィールドのサンプルを参照し、これらの値を環境のベンダードキュメントで確認してください。
-
統合の操作に従います。 サブスクリプションで必要な場合を除き、GETを使用します。プロファイル/コンテキストから
apiKeyクエリパラメーター、マップlocationKeyおよびその他の変数を添付し、サンプル JSONを貼り付け、フィールドをマッピングし、テストします。 -
Journey Optimizerで、Configurations > Manageに移動し、Create Integrationを選択します。
-
スペースなしで統合名を入力します。
-
Daily Forecasts APIを使用してエンドポイントを設定します。 URL パターンの例:
https://dataservice.accuweather.com/forecasts/v1/daily/{days}day/{locationKey} -
設定テーブルに表示されるHTTP メソッドを選択します。特に指定がない限り、通常はGETを選択します。
-
テーブルおよびベンダードキュメントで指定されたとおりに認証(ヘッダー、クエリパラメーター、OAuth)を正確に設定します。
-
パス、クエリ、ヘッダーのパラメーターを定義し、必要に応じて変数をプロファイルデータやコンテキストデータにマッピングできます。
-
フィールドを検出してマッピングできるように、サンプル JSON応答を貼り付けます。
-
応答ペイロードマッピングでパーソナライゼーションに必要なフィールドを選択します。
-
予想されるボリュームに基づいて、タイムアウト、再試行、およびキャッシングポリシーを設定します。
-
接続をテストし、統合をアクティブ化します。
次の表に、この統合リクエストの値の例を示します。
統合フィールドのサンプル。 詳細と階層については、AccuWeather APIを参照してください。 locationKeyは、別の場所の検索呼び出し(例:.../locations/v1/cities/search?q={{cityName}})で解決することがよくあります。
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 | |
|---|---|
| フィールド | 値 |
| URL | https://dataservice.accuweather.com/forecasts/v1/daily/{{days}}day/{{locationKey}} |
| HTTP メソッド | GET |
| 応答ペイロード | API応答に基づいて、オーサリング中に使用する必要な応答フィールドを選択して設定します。 |
| ポリシー | 必要に応じてポリシーレベルの詳細を設定します。 |
パスパラメーター
| table 0-row-3 1-row-3 2-row-3 | ||
|---|---|---|
| パスパラメーター | 名前 | デフォルト値 |
days |
days |
15 |
locationKey |
locationKey |
<desired_location_key> |
ヘッダー
| table 0-row-5 1-row-5 | ||||
|---|---|---|---|---|
| パラメーター | 名前 | タイプ | 値 | 必須 |
| コンテンツタイプ(デフォルト) | Content-Type | 定数 | application/json | はい(オン) |
クエリパラメータ
| table 0-row-5 1-row-5 2-row-5 3-row-5 4-row-5 | ||||
|---|---|---|---|---|
| パラメーター | 名前 | タイプ | 値 | 必須 |
format |
format |
変数 | json | いいえ(オフ) |
language |
language |
変数 | en-US | いいえ(オフ) |
details |
details |
変数 | False | いいえ(オフ) |
metric |
metric |
変数 | False | いいえ(オフ) |
認証
| table 0-row-4 1-row-4 | |||
|---|---|---|---|
| タイプ | API キー名 | API キー値 | ロケーション |
| API キー | apiKey |
<YOUR_API_KEY> |
クエリパラメーター |
ShipStation shipstation
ShipStationでは、配送業者、ラベル、トラッキング用の配送APIと注文APIを提供しています。
一般的なユースケースには、注文状況、トラッキングリンク、トランザクションメッセージの配信ETAなどがあります。
次の前提条件が適用されます。
- API キーと秘密鍵(ShipStation ドキュメントごとの基本認証)。
- Journey Optimizerでの管理者アクセス:
次の制限事項と除外事項が適用されます。
- メッセージコンテンツでShipStation API キーを公開しないでください。統合設定でのみ資格情報を保持します。
- ページ化されたリストエンドポイントは、統合には適していない可能性があります。可能な場合は、シングルリソース GETを優先します。
Journey Optimizerでこの統合を設定するには、次の手順を使用します。 リクエストの詳細については、統合フィールドのサンプルを参照し、これらの値を環境のベンダードキュメントで確認してください。
-
統合の操作に従います。 必要なリソース(注文と出荷)をターゲットにし、ShipStation APIごとに認証し、サンプル JSONを貼り付け、フィールドをマップし、テストし、アクティベートします。
-
Journey Optimizerで、Configurations > Manageに移動し、Create Integrationを選択します。
-
スペースなしで統合名を入力します。
-
ShipStation REST APIを使用してエンドポイントを設定します。 URL パターンの例:
https://ssapi.shipstation.com/... -
設定テーブルに表示されるHTTP メソッドを選択します。特に指定がない限り、通常はGETを選択します。
-
テーブルおよびベンダードキュメントで指定されたとおりに認証(ヘッダー、クエリパラメーター、OAuth)を正確に設定します。
-
パス、クエリ、ヘッダーのパラメーターを定義し、必要に応じて変数をプロファイルデータやコンテキストデータにマッピングできます。
-
フィールドを検出してマッピングできるように、サンプル JSON応答を貼り付けます。
-
応答ペイロードマッピングでパーソナライゼーションに必要なフィールドを選択します。
-
予想されるボリュームに基づいて、タイムアウト、再試行、およびキャッシングポリシーを設定します。
-
接続をテストし、統合をアクティブ化します。
次の表に、この統合リクエストの値の例を示します。
次の Get Timer の例は、ShipStation オートメーションのタイミング呼び出しを1つ示しています。 Journey Optimizerで再現する場合は、ShipStation統合ガイドの正確なパスと認証を使用してください。
| table 0-row-2 1-row-2 2-row-2 3-row-2 | |
|---|---|
| フィールド | 値 |
| URL | https://dashboard.sendtric.com/api/v1/timers/{{id}} |
| HTTP メソッド | POST |
| ポリシー | 必要に応じてポリシーレベルの詳細を設定します。 |
ヘッダー
| table 0-row-5 1-row-5 | ||||
|---|---|---|---|---|
| パラメーター | 名前 | タイプ | 値 | 必須 |
| コンテンツタイプ(デフォルト) | Content-Type | 定数 | application/json | はい(オン) |
認証
| table 0-row-4 1-row-4 | |||
|---|---|---|---|
| タイプ | API キー名 | API キー値 | ロケーション |
| API キー | apiKey | <your_api_key> |
ヘッダー |
ペイロードのリクエスト
| code language-sample |
|---|
|
RevenueCat revenuecat
RevenueCatは、アプリのサブスクリプションステータスと使用権限APIを提供します。
典型的なユースケースは、ポリシーで許可されているライフサイクルキャンペーンにサブスクリプションの状態を反映することです。
次の前提条件が適用されます。
- 秘密のAPI キーとアプリ識別子。プロファイルとRevenueCat顧客ID間の安定したマッピング。
- Journey Optimizerでの管理者アクセス:
次の制限事項と除外事項が適用されます。
- シークレット API キーを保護し、ローテーション ポリシーに従います。
- 購読データと使用権限データは機密性が高い: プライバシーと同意の要件を満たす。
Journey Optimizerでこの統合を設定するには、次の手順を使用します。 リクエストの詳細については、統合フィールドのサンプルを参照し、これらの値を環境のベンダードキュメントで確認してください。
-
統合の操作に従います。 以下にモデル化されたREST GETを呼び出し、秘密鍵ヘッダーで認証し、サンプル JSON、マップフィールド、テスト、アクティベートを貼り付けます。
-
Journey Optimizerで、Configurations > Manageに移動し、Create Integrationを選択します。
-
スペースなしで統合名を入力します。
-
RevenueCat REST APIを使用してエンドポイントを設定します。 URL パターンの例:
https://api.revenuecat.com/v1/... -
設定テーブルに表示されるHTTP メソッドを選択します。特に指定がない限り、通常はGETを選択します。
-
テーブルおよびベンダードキュメントで指定されたとおりに認証(ヘッダー、クエリパラメーター、OAuth)を正確に設定します。
-
パス、クエリ、ヘッダーのパラメーターを定義し、必要に応じて変数をプロファイルデータやコンテキストデータにマッピングできます。
-
フィールドを検出してマッピングできるように、サンプル JSON応答を貼り付けます。
-
応答ペイロードマッピングでパーソナライゼーションに必要なフィールドを選択します。
-
予想されるボリュームに基づいて、タイムアウト、再試行、およびキャッシングポリシーを設定します。
-
接続をテストし、統合をアクティブ化します。
次の表に、この統合リクエストの値の例を示します。
パターンの例:RevenueCat ドキュメント のRevenueCatの製品の取得 (または同等の製品/使用権限GET)を、プロジェクトのベース URLとバージョンと共に使用します。
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 | |
|---|---|
| フィールド | 値 |
| URL | https://api.revenuecat.com/projects/{{project_id}}/products/{{product_id}} |
| HTTP メソッド | GET |
| ポリシー | 必要に応じてポリシーレベルの詳細を設定します。 |
| 応答ペイロード | API応答に基づいて、オーサリング中に使用する必要な応答フィールドを選択して設定します。 |
パスパラメーター
| table 0-row-3 1-row-3 2-row-3 | ||
|---|---|---|
| パスパラメーター | 名前 | デフォルト値 |
project_id |
project_id |
<project_id> |
product_id |
product_id |
<product_id> |
ヘッダー
| table 0-row-5 1-row-5 | ||||
|---|---|---|---|---|
| パラメーター | 名前 | タイプ | 値 | 必須 |
| コンテンツタイプ(デフォルト) | Content-Type | 定数 | application/json | はい(オン) |
クエリパラメータ
| table 0-row-5 1-row-5 2-row-5 3-row-5 | ||||
|---|---|---|---|---|
| パラメーター | 名前 | タイプ | 値 | 必須 |
country |
country |
変数 | <iso_country_code> |
いいえ(オフ) |
locale |
locale |
変数 | <locale_code> |
いいえ(オフ) |
parentId |
parentId |
変数 | <parent_category_id> |
いいえ(オフ) |
認証
| table 0-row-4 1-row-4 | |||
|---|---|---|---|
| タイプ | API キー名 | API キー値 | ロケーション |
| API キー | 認証 | Bearer <token> |
ヘッダー |
Databricks databricks
Databricksは、レイクハウス データに対してSQL APIとREST APIを提供します。以前のドラフトでは、結合されたステートメント実行ガイダンスとjobs/get サンプルを使用していました。
典型的なユースケースは、最小限の権限でパーソナライズするために、管理されたテーブルからの小さな非正規化属性を使用することです。
次の前提条件が適用されます。
- Workspace ホスト、トークン、または組織ごとのOAuth ポリシー、最小限のスコープを持つサービスプリンシパル。
- Journey Optimizerでの管理者アクセス:
Journey Optimizerでこの統合を設定するには、次の手順を使用します。 リクエストの詳細については、統合フィールドのサンプルを参照し、これらの値を環境のベンダードキュメントで確認してください。
-
統合の操作に従います。 狭い読み取りパスを優先します。POST ステートメントの実行を使用する場合は、APIが必要とするJSON本文を含め、マッピング用に成功レスポンスのサンプルを貼り付け、待ち時間を慎重にテストし、アクティブ化します。
-
Journey Optimizerで、Configurations > Manageに移動し、Create Integrationを選択します。
-
スペースなしで統合名を入力します。
-
Databricks SQL ステートメント実行APIを使用してエンドポイントを設定します。 URL パターンの例:
https://{workspace-host}/api/2.0/sql/statements/... -
設定テーブルに表示されるHTTP メソッドを選択します。特に指定がない限り、通常はGETを選択します。
-
テーブルおよびベンダードキュメントで指定されたとおりに認証(ヘッダー、クエリパラメーター、OAuth)を正確に設定します。
-
パス、クエリ、ヘッダーのパラメーターを定義し、必要に応じて変数をプロファイルデータやコンテキストデータにマッピングできます。
-
フィールドを検出してマッピングできるように、サンプル JSON応答を貼り付けます。
-
応答ペイロードマッピングでパーソナライゼーションに必要なフィールドを選択します。
-
予想されるボリュームに基づいて、タイムアウト、再試行、およびキャッシングポリシーを設定します。
-
接続をテストし、統合をアクティブ化します。
次の表に、この統合リクエストの値の例を示します。
以下のGET ジョブの例は実例です。SQL ドリブン型のパーソナライゼーションの場合は、ワークスペースがサポートする ステートメント実行API パターンを優先します。
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 | |
|---|---|
| フィールド | 値 |
| URL | https://<databricks-instance>/api/2.0/jobs/get |
| HTTP メソッド | GET |
| 応答ペイロード | API応答に基づいて、オーサリング中に使用する必要な応答フィールドを選択して設定します。 |
| ポリシー | 必要に応じてポリシーレベルの詳細を設定します。 |
| 認証 | OAuth |
ヘッダー
| table 0-row-5 1-row-5 | ||||
|---|---|---|---|---|
| パラメーター | 名前 | タイプ | 値 | 必須 |
| Accept | Accept | 定数 | application/json | はい(オン) |
クエリパラメータ
| table 0-row-5 1-row-5 | ||||
|---|---|---|---|---|
| パラメーター | 名前 | タイプ | 値 | 必須 |
job_id |
job_id |
変数 | 12 |
○ |
レビュー、同意、ソーシャル reviews-consent-and-social
バインダー bynder
BynderはREST APIを備えたDAMです。統合では、一般的に、読み取り専用のメタデータまたはアセット URLにOAuth 2.0を使用します。
一般的なユースケースには、アセットのメタデータや配信URLをメッセージに取り込み、Bynderでクリエイティブをジャーニーに沿って承認することです。
次の前提条件が適用されます。
- ポータル ドメインとOAuth クライアント(または承認済みのトークン アプローチ)。
- 読み取り専用アクセスの範囲、Journey Optimizerでの管理者アクセス。
次の制限事項と除外事項が適用されます。
- ページネーションとOAuth トークンの更新は、BynderのAPI ルールに従う必要があります。
- 大きなページ分割された応答:パーソナライゼーションに必要なフィールドのみをマッピングします。
Journey Optimizerでこの統合を設定するには、次の手順を使用します。 リクエストの詳細については、統合フィールドのサンプルを参照し、これらの値を環境のベンダードキュメントで確認してください。
-
統合の操作に従います。 選択したエンドポイントで GET を設定し(1つの一般的なパターンはユーザーリストです)、BynderごとにOAuthを完了し、データの不要なページを引き出すのを避け、フィールドをマッピングし、テストしてからアクティベートします。
-
Journey Optimizerで、Configurations > Manageに移動し、Create Integrationを選択します。
-
スペースなしで統合名を入力します。
-
Bynder API v4を使用してエンドポイントを設定します。 URL パターンの例:
https://{your-bynder-domain}/api/v4/users/ -
設定テーブルに表示されるHTTP メソッドを選択します。特に指定がない限り、通常はGETを選択します。
-
テーブルおよびベンダードキュメントで指定されたとおりに認証(ヘッダー、クエリパラメーター、OAuth)を正確に設定します。
-
パス、クエリ、ヘッダーのパラメーターを定義し、必要に応じて変数をプロファイルデータやコンテキストデータにマッピングできます。
-
フィールドを検出してマッピングできるように、サンプル JSON応答を貼り付けます。
-
応答ペイロードマッピングでパーソナライゼーションに必要なフィールドを選択します。
-
予想されるボリュームに基づいて、タイムアウト、再試行、およびキャッシングポリシーを設定します。
-
接続をテストし、統合をアクティブ化します。
次の表に、この統合リクエストの値の例を示します。
統合フィールドのサンプル。 OAuth 2.0 ペイロードの詳細については、Bynder API ドキュメント を参照してください。
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 | |
|---|---|
| フィールド | 値 |
| URL | https://{{your-bynder-domain}}/api/v4/users/ |
| HTTP メソッド | GET |
| 応答ペイロード | API応答に基づいて、オーサリング中に使用する必要な応答フィールドを選択して設定します。 |
| ポリシー | 必要に応じてポリシーレベルの詳細を設定します。 |
パスパラメーター
| table 0-row-3 1-row-3 | ||
|---|---|---|
| パスパラメーター | 名前 | デフォルト値 |
your-bynder-domain |
your-bynder-domain |
<your-bynder-domain> |
ヘッダー
| table 0-row-5 1-row-5 2-row-5 | ||||
|---|---|---|---|---|
| パラメーター | 名前 | タイプ | 値 | 必須 |
| コンテンツタイプ(デフォルト) | Content-Type | 定数 | application/json | はい(オン) |
| 認証 | 認証 | 定数 | ベアラー<token> |
はい(オン) |
クエリパラメータ
| table 0-row-5 1-row-5 2-row-5 3-row-5 | ||||
|---|---|---|---|---|
| パラメーター | 名前 | タイプ | 値 | 必須 |
includeInActive |
includeInActive |
変数 | False | いいえ(オフ) |
limit |
limit |
変数 | 100 | いいえ(オフ) |
page |
page |
変数 | 1 | いいえ(オフ) |
認証
| table 0-row-2 1-row-2 | |
|---|---|
| タイプ | ペイロード |
| OAuth 2.0 | OAuth 2.0 ペイロード (Bynderのドキュメントを参照) |
| code language-none |
|---|
|
Trustpilot trustpilot
Trustpilotは、ユースケースと契約が許可するビジネスとレビューの概要データ用のAPIを提供します。
一般的なユースケースとしては、Trustpilotの条件に準拠したマーケティングコンテンツのレビュー数や評価が表示されます。
次の前提条件が適用されます。
- API キーと承認済みのユースケース、クエリのビジネス識別子。
- Journey Optimizerでの管理者アクセス:
次の制限事項と除外事項が適用されます。
- Trustpilot データの使用は、Trustpilotのブランディングおよびデータ使用ポリシーに準拠する必要があります。
- レート制限は、概要と関連するエンドポイントのレビューに適用されます。
Journey Optimizerでこの統合を設定するには、次の手順を使用します。 リクエストの詳細については、統合フィールドのサンプルを参照し、これらの値を環境のベンダードキュメントで確認してください。
-
統合の操作に従います。 必須のクエリ認証、プロファイルまたはコンテキストからのIDのマッピング、サンプル JSONの貼り付け、フィールドのマッピング、テスト、アクティベートを使用して GET を設定します。
-
Journey Optimizerで、Configurations > Manageに移動し、Create Integrationを選択します。
-
スペースなしで統合名を入力します。
-
Trustpilot APIを使用してエンドポイントを設定します。 URL パターンの例:
https://api.trustpilot.com/v1/... -
設定テーブルに表示されるHTTP メソッドを選択します。特に指定がない限り、通常はGETを選択します。
-
テーブルおよびベンダードキュメントで指定されたとおりに認証(ヘッダー、クエリパラメーター、OAuth)を正確に設定します。
-
パス、クエリ、ヘッダーのパラメーターを定義し、必要に応じて変数をプロファイルデータやコンテキストデータにマッピングできます。
-
フィールドを検出してマッピングできるように、サンプル JSON応答を貼り付けます。
-
応答ペイロードマッピングでパーソナライゼーションに必要なフィールドを選択します。
-
予想されるボリュームに基づいて、タイムアウト、再試行、およびキャッシングポリシーを設定します。
-
接続をテストし、統合をアクティブ化します。
次の表に、この統合リクエストの値の例を示します。
統合パターンには、Trustpilot開発者のカテゴリ リスト操作を使用します。パラメーターはリソースによって異なります。
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 | |
|---|---|
| フィールド | 値 |
| URL | https://api.trustpilot.com/v1/categories |
| HTTP メソッド | GET |
| ポリシー | 必要に応じてポリシーレベルの詳細を設定します。 |
| 応答ペイロード | API応答に基づいて、オーサリング中に使用する必要な応答フィールドを選択して設定します。 |
ヘッダー
| table 0-row-5 1-row-5 | ||||
|---|---|---|---|---|
| パラメーター | 名前 | タイプ | 値 | 必須 |
| コンテンツタイプ(デフォルト) | Content-Type | 定数 | application/json | はい(オン) |
クエリパラメータ
| table 0-row-5 1-row-5 2-row-5 3-row-5 | ||||
|---|---|---|---|---|
| パラメーター | 名前 | タイプ | 値 | 必須 |
country |
country |
変数 | <iso_country_code> |
いいえ(オフ) |
locale |
locale |
変数 | <locale_code> |
いいえ(オフ) |
parentId |
parentId |
変数 | <parent_category_id> |
いいえ(オフ) |
認証
| table 0-row-4 1-row-4 | |||
|---|---|---|---|
| タイプ | API キー名 | API キー値 | ロケーション |
| API キー | apiKey | <your_api_key> |
ヘッダー |
Bazaarvoice bazaarvoice
Bazaarvoiceは評価、レビュー、UGC APIを提供しています。
典型的なユースケースは、ポリシーで許可されている場合に、レビューの概要や評価をメールで表示することです。
次の前提条件が適用されます。
- 契約のAPI パスキーとクライアント ID。
- Journey Optimizerでの管理者アクセス:
次の制限事項と除外事項が適用されます。
- 評価やレビューの表示はBazaarvoiceのコンテンツポリシーに従う必要があります。
- レート制限とキャッシングルールは、API キーごとに適用されます。
Journey Optimizerでこの統合を設定するには、次の手順を使用します。 リクエストの詳細については、統合フィールドのサンプルを参照し、これらの値を環境のベンダードキュメントで確認してください。
-
統合の操作に従います。 GETを
passkeyと共にConversations APIのクエリパラメーターとして使用し、Accept: application/jsonを設定し、サンプル JSONを貼り付け、フィールドをマッピングし、テストし、アクティブ化します。 -
Journey Optimizerで、Configurations > Manageに移動し、Create Integrationを選択します。
-
スペースなしで統合名を入力します。
-
Bazarvoice Conversations APIを使用してエンドポイントを設定します。 URL パターンの例:
https://api.bazaarvoice.com/... -
設定テーブルに表示されるHTTP メソッドを選択します。特に指定がない限り、通常はGETを選択します。
-
テーブルおよびベンダードキュメントで指定されたとおりに認証(ヘッダー、クエリパラメーター、OAuth)を正確に設定します。
-
パス、クエリ、ヘッダーのパラメーターを定義し、必要に応じて変数をプロファイルデータやコンテキストデータにマッピングできます。
-
フィールドを検出してマッピングできるように、サンプル JSON応答を貼り付けます。
-
応答ペイロードマッピングでパーソナライゼーションに必要なフィールドを選択します。
-
予想されるボリュームに基づいて、タイムアウト、再試行、およびキャッシングポリシーを設定します。
-
接続をテストし、統合をアクティブ化します。
次の表に、この統合リクエストの値の例を示します。
例エントリポイント:https://api.bazaarvoice.com/data/products.json、バージョンおよびフィルタークエリパラメーター。 Bazaarvoice developerを参照してください。
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 | |
|---|---|
| フィールド | 値 |
| URL | https://api.bazaarvoice.com/data/products.json |
| HTTP メソッド | GET |
| ポリシー | 必要に応じてポリシーレベルの詳細を設定します。 |
| 応答ペイロード | API応答に基づいて、オーサリング中に使用する必要な応答フィールドを選択して設定します。 |
ヘッダー
| table 0-row-5 1-row-5 | ||||
|---|---|---|---|---|
| パラメーター | 名前 | タイプ | 値 | 必須 |
| Accept | Accept | 定数 | application/json | はい(オン) |
認証
| table 0-row-3 1-row-3 | ||
|---|---|---|
| タイプ | キー値 | ロケーション |
| パスキー | <YOUR_ACCESS_TOKEN> |
クエリパラメーター |
クエリパラメータ
| table 0-row-5 1-row-5 2-row-5 3-row-5 | ||||
|---|---|---|---|---|
| パラメーター | 名前 | タイプ | 値 | 必須 |
apiversion |
apiversionNumber | 定数 | 5.4 | はい(オン) |
filter |
filter |
変数 | Id:47950830 | いいえ(オフ) |
stats |
stats |
変数 | すべて | いいえ(オフ) |
OneTrust onetrust
OneTrustは、プライバシーおよび同意API (製品固有のURLとスキーマ)を公開しています。
典型的なユースケースは、アーキテクチャと法律のレビューが許可する条件付きコンテンツの同意や嗜好シグナルを読むことです。
次の前提条件が適用されます。
- API資格情報と地域ベース URL。メッセージで使用されるフィールドの法的承認。
- Journey Optimizerでの管理者アクセス:
次の制限事項と除外事項が適用されます。
- 同意や嗜好データは厳しく規制されています。 法務部門とプライバシー部門の連携。
- API パスとペイロードは、OneTrust製品によって異なります。 サブスクリプションのドキュメントを使用します。
Journey Optimizerでこの統合を設定するには、次の手順を使用します。 リクエストの詳細については、統合フィールドのサンプルを参照し、これらの値を環境のベンダードキュメントで確認してください。
-
統合の操作に従います。 公開されたスキーマまたは環境設定センターのパスを使用して、サブスクリプションドキュメントを作成し、必要に応じてOAuthを完了し、サンプル JSON、マップフィールド、テスト、アクティベートを貼り付けます。
-
Journey Optimizerで、Configurations > Manageに移動し、Create Integrationを選択します。
-
スペースなしで統合名を入力します。
-
OneTrust APIを使用してエンドポイントを設定します。 テナント、製品、およびパスは、サブスクリプションのOneTrust ドキュメントに記載されています。 URL パターンの例:
https://{tenant}.my.onetrust.com/api/... -
設定テーブルに表示されるHTTP メソッドを選択します。特に指定がない限り、通常はGETを選択します。
-
テーブルおよびベンダードキュメントで指定されたとおりに認証(ヘッダー、クエリパラメーター、OAuth)を正確に設定します。
-
パス、クエリ、ヘッダーのパラメーターを定義し、必要に応じて変数をプロファイルデータやコンテキストデータにマッピングできます。
-
フィールドを検出してマッピングできるように、サンプル JSON応答を貼り付けます。
-
応答ペイロードマッピングでパーソナライゼーションに必要なフィールドを選択します。
-
予想されるボリュームに基づいて、タイムアウト、再試行、およびキャッシングポリシーを設定します。
-
接続をテストし、統合をアクティブ化します。
次の表に、この統合リクエストの値の例を示します。
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 | |
|---|---|
| フィールド | 値 |
| URL | https://customer.my.onetrust.com/api/consentmanager/v2/preferencecenters/{{preferencecenterid}}/schema |
| HTTP メソッド | GET |
| ポリシー | 必要に応じてポリシーレベルの詳細を設定します。 |
| 応答ペイロード | API応答に基づいて、オーサリング中に使用する必要な応答フィールドを選択して設定します。 |
| 認証 | OAuth |
パスパラメーター
| table 0-row-3 1-row-3 | ||
|---|---|---|
| パラメーター | 名前 | 値 |
preferencecenterid |
preferencecenterid |
<pref-id> |
ヘッダー
| table 0-row-5 1-row-5 | ||||
|---|---|---|---|---|
| パラメーター | 名前 | タイプ | 値 | 必須 |
| Accept | Accept | 定数 | application/json | はい(オン) |
クエリパラメータ
| table 0-row-5 1-row-5 | ||||
|---|---|---|---|---|
| パラメーター | 名前 | タイプ | 値 | 必須 |
state |
state |
定数 | 公開日 | ○ |
プリファレンスセンタースキーマ(公開)
パターン (フラグメント)の例:https://{tenant}.my.onetrust.com/api/consentmanager/v2/preferencecenters/{preferencecenterid}/schema?state=PUBLISHED。 OneTrust Developerで正確なパスを確認します。
Meta meta
Metaのグラフおよびマーケティング APIは、承認済みのビジネス統合のために、カタログとキャンペーンオブジェクトを公開します。
典型的なユースケースは、トークンとポリシーが許可するMetaの属性を使用してコンテンツを強化することです。
次の前提条件が適用されます。
- 正しい権限を持つシステムユーザーまたはアプリトークン。Business Managerの調整。
- Journey Optimizerでの管理者アクセス:
次の制限事項と除外事項が適用されます。
- 短期間有効なアクセストークンには、サーバーサイドの統合に適した更新または長期間有効な戦略が必要です。
- Meta Platformの条件に準拠します。メッセージペイロードにトークンやその他のシークレットを記録しないでください。
Journey Optimizerでこの統合を設定するには、次の手順を使用します。 リクエストの詳細については、統合フィールドのサンプルを参照し、これらの値を環境のベンダードキュメントで確認してください。
-
統合の操作に従います。 Graph呼び出しは、多くの場合、GETでバージョン管理されたパスを持ちます。トークンの有効期限を処理し、サンプル JSONを貼り付け、フィールドをマップし、テストし、アクティブ化します。
-
Journey Optimizerで、Configurations > Manageに移動し、Create Integrationを選択します。
-
スペースなしで統合名を入力します。
-
Meta Graph APIを使用してエンドポイントを設定します。 URL パターンの例:
https://graph.facebook.com/vXX.X/... -
設定テーブルに表示されるHTTP メソッドを選択します。特に指定がない限り、通常はGETを選択します。
-
テーブルおよびベンダードキュメントで指定されたとおりに認証(ヘッダー、クエリパラメーター、OAuth)を正確に設定します。
-
パス、クエリ、ヘッダーのパラメーターを定義し、必要に応じて変数をプロファイルデータやコンテキストデータにマッピングできます。
-
フィールドを検出してマッピングできるように、サンプル JSON応答を貼り付けます。
-
応答ペイロードマッピングでパーソナライゼーションに必要なフィールドを選択します。
-
予想されるボリュームに基づいて、タイムアウト、再試行、およびキャッシングポリシーを設定します。
-
接続をテストし、統合をアクティブ化します。
次の表に、この統合リクエストの値の例を示します。
統合フィールドのサンプル。 バージョン管理とアクセストークンについては、Graph APIを参照してください。
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 | |
|---|---|
| フィールド | 値 |
| URL | https://graph.facebook.com/{{API_VERSION}}/{{PRODUCT_CATALOG_ID}}/products |
| HTTP メソッド | GET |
| 応答ペイロード | API応答に基づいて、オーサリング中に使用する必要な応答フィールドを選択して設定します。 |
| ポリシー | 必要に応じてポリシーレベルの詳細を設定します。 |
| 認証 | OAuth |
パスパラメーター
| table 0-row-3 1-row-3 2-row-3 | ||
|---|---|---|
| パスパラメーター | 名前 | デフォルト値 |
API_VERSION |
API_VERSION |
v19.0 |
PRODUCT_CATALOG_ID |
PRODUCT_CATALOG_ID |
12345 |
ヘッダー
| table 0-row-5 1-row-5 | ||||
|---|---|---|---|---|
| パラメーター | 名前 | タイプ | 値 | 必須 |
| Accept | Accept | 定数 | application/json | はい(オン) |
クエリパラメータ
| table 0-row-5 1-row-5 2-row-5 | ||||
|---|---|---|---|---|
| パラメーター | 名前 | タイプ | 値 | 必須 |
fields |
fields |
変数 | ID | × |
filter |
filter |
変数 | — | × |
Aprimo aprimo
Aprimoは、レコード、アセット、メタデータのマーケティング業務とDAM APIを組み合わせています。
一般的なユースケースには、動的コンテンツの承認済みレコードやアセットフィールド、規制の厳しい業界における管理されたDAM ワークフローなどがあります。
次の前提条件が適用されます。
- テナント URLと資格情報(設定ごとにOAuthまたはAPI キー)。
- Journey Optimizerでの管理者アクセス:
次の制限事項と除外事項が適用されます。
- Aprimoのフィールドレベルのセキュリティは、Journey Optimizerでマッピングする属性と一致している必要があります。
- 大規模なHALまたはJSON ペイロード:マッピングされたフィールドを最小必要セットに制限します。
Journey Optimizerでこの統合を設定するには、次の手順を使用します。 リクエストの詳細については、統合フィールドのサンプルを参照し、これらの値を環境のベンダードキュメントで確認してください。
-
統合の操作に従います。 必要なレコードパスに GET を使用し、
API-VERSIONなどの必須ヘッダーを送信し、サンプル JSON (返されたHALまたはJSON)を貼り付け、最小限のフィールドセットをマッピングし、テストしてアクティブにします。 -
Journey Optimizerで、Configurations > Manageに移動し、Create Integrationを選択します。
-
スペースなしで統合名を入力します。
-
Aprimo DAM / Records APIを使用してエンドポイントを設定します。 テナントのAPI ベース URLとレコードパスを使用します(Aprimoごとに)。 URL パターンの例:
https://{tenant}.dam.aprimo.com/ -
設定テーブルに表示されるHTTP メソッドを選択します。特に指定がない限り、通常はGETを選択します。
-
テーブルおよびベンダードキュメントで指定されたとおりに認証(ヘッダー、クエリパラメーター、OAuth)を正確に設定します。
-
パス、クエリ、ヘッダーのパラメーターを定義し、必要に応じて変数をプロファイルデータやコンテキストデータにマッピングできます。
-
フィールドを検出してマッピングできるように、サンプル JSON応答を貼り付けます。
-
応答ペイロードマッピングでパーソナライゼーションに必要なフィールドを選択します。
-
予想されるボリュームに基づいて、タイムアウト、再試行、およびキャッシングポリシーを設定します。
-
接続をテストし、統合をアクティブ化します。
次の表に、この統合リクエストの値の例を示します。
| table 0-row-2 1-row-2 2-row-2 | |
|---|---|
| フィールド | 値 |
| URL | https://productstrategy1.dam.aprimo.com/api/core/record/{{recordID}} |
| HTTP メソッド | GET |
パスパラメーター
| table 0-row-3 1-row-3 | ||
|---|---|---|
| パスパラメーター | 名前 | デフォルト値 |
recordId |
recordId |
<record_identifier> |
ヘッダー
| table 0-row-5 1-row-5 2-row-5 3-row-5 4-row-5 5-row-5 6-row-5 | ||||
|---|---|---|---|---|
| パラメーター | 名前 | タイプ | 値 | 必須 |
| コンテンツタイプ(デフォルト) | Content-Type | 定数 | application/json | はい(オン) |
| API-VERSION | API-VERSION | 定数 | 1 | はい(オン) |
| Accept | Accept | 定数 | application/hal+jsonまたはapplication/json | いいえ(オフ) |
| select-record | select-record | 変数 | <selection_type> |
いいえ(オフ) |
| select-record-fields | select-record-fields | 変数 | <field_list> |
いいえ(オフ) |
| select-field | select-field | 変数 | <field_selection> |
いいえ(オフ) |
認証
| table 0-row-4 1-row-4 | |||
|---|---|---|---|
| タイプ | API キー名 | API キー値 | ロケーション |
| API キー | 認証 | ベアラー<token> |
ヘッダー |
イプシロン(Epsilon3) epsilon
Epsilonはエンタープライズ契約ごとにAPIを公開します。ベース URLと認証はアカウントチームから取得されます(以下のEvents APIの例は実例です)。
典型的なユースケースは、サポートされているJSON APIを通じてロイヤルティまたはオファー属性を公開することです。
次の前提条件が適用されます。
- Epsilonの資格情報とエンドポイント、Journey Optimizerの管理者アクセス。
次の制限事項と除外事項が適用されます。
- エンドポイントとホストは顧客ごとに異なります。 Epsilon アカウントチームからのドキュメントなしでデプロイしないでください。
Journey Optimizerでこの統合を設定するには、次の手順を使用します。 リクエストの詳細については、統合フィールドのサンプルを参照し、これらの値を環境のベンダードキュメントで確認してください。
-
統合の操作に従います。 公開URLを推測しないでください。 Epsilonの仕様を使用し、サンプル JSONを貼り付け、フィールドをマッピングし、テストし、アクティブにします。
-
Journey Optimizerで、Configurations > Manageに移動し、Create Integrationを選択します。
-
スペースなしで統合名を入力します。
-
Epsilon APIを使用してエンドポイントを設定します(統合仕様に従います)。 ベース URLとリソースパスは、Epsilon アカウントチームによって提供されます。 URL パターンの例:
https://{your-instance}.epsilon3.io/api/... -
設定テーブルに表示されるHTTP メソッドを選択します。特に指定がない限り、通常はGETを選択します。
-
テーブルおよびベンダードキュメントで指定されたとおりに認証(ヘッダー、クエリパラメーター、OAuth)を正確に設定します。
-
パス、クエリ、ヘッダーのパラメーターを定義し、必要に応じて変数をプロファイルデータやコンテキストデータにマッピングできます。
-
フィールドを検出してマッピングできるように、サンプル JSON応答を貼り付けます。
-
応答ペイロードマッピングでパーソナライゼーションに必要なフィールドを選択します。
-
予想されるボリュームに基づいて、タイムアウト、再試行、およびキャッシングポリシーを設定します。
-
接続をテストし、統合をアクティブ化します。
次の表に、この統合リクエストの値の例を示します。
パターンの例:https://{your-instance}.epsilon3.io/api/v1/planning/events、クエリ パラメーターstartおよびendとヘッダーベースのAPI キー。 生産前にEpsilonで確認してください。
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 | |
|---|---|
| フィールド | 値 |
| URL | https://{{your-instance}}.epsilon3.io/api/v1/planning/events |
| HTTP メソッド | GET |
| ポリシー | 必要に応じてポリシーレベルの詳細を設定します。 |
| 応答ペイロード | API応答に基づいて、オーサリング中に使用する必要な応答フィールドを選択して設定します。 |
パスパラメーター
| table 0-row-3 1-row-3 | ||
|---|---|---|
| パスパラメーター | 名前 | デフォルト値 |
your-instance |
your-instance |
<your_instance> |
ヘッダー
| table 0-row-5 1-row-5 | ||||
|---|---|---|---|---|
| パラメーター | 名前 | タイプ | 値 | 必須 |
| コンテンツタイプ(デフォルト) | Content-Type | 定数 | application/json | はい(オン) |
クエリパラメータ
| table 0-row-5 1-row-5 2-row-5 3-row-5 4-row-5 | ||||
|---|---|---|---|---|
| パラメーター | 名前 | タイプ | 値 | 必須 |
start |
start |
変数 | 2019-08-24T14:15:22Z | はい(オン) * |
end |
end |
変数 | 2019-08-24T14:15:22Z | はい(オン) * |
eventType |
eventType |
変数 | スケジュール済み/スケジュール外 | いいえ(オフ) |
exclude_recurrences |
exclude_recurrences |
変数 | true / false | いいえ(オフ) |
* eventType = unscheduledおよびexclude_recurrences = trueではオプションです。
認証
| table 0-row-4 1-row-4 | |||
|---|---|---|---|
| タイプ | API キー名 | API キー値 | ロケーション |
| API キー | <your_username> |
<EPSILON3_API_KEY> |
ヘッダー |
This section contains structured knowledge intended to support interpretation, retrieval, and question answering related to this topic.
For complete understanding, this information should be combined with the documentation on this page. Neither source is intended to stand alone; the page describes the feature, while this section provides additional context that helps disambiguate terminology, intent, applicability, and constraints.
- TL;DR: This page provides sample, Adobe-tested configurations for connecting Adobe Journey Optimizer Integrations to third-party vendors across content, loyalty, recommendation, data, and consent platforms.
Intents:
- Use Integrations with any external platform that exposes a compatible API
- Follow a sample vendor configuration and its example integration fields
- Configure an integration through Configurations > Manage > Create Integration
- Reproduce vendor request details (URL, HTTP method, authentication, path/query/header parameters) as example patterns
Glossary:
- Sample integration fields: Example request values (URL, HTTP method, path/query/header parameters, authentication) provided per vendor to model a compatible API (product-specific)
- Create Integration: Action under Configurations > Manage used to start a new integration configuration in Journey Optimizer (product-specific)
- Example pattern: A vendor configuration independently tested by Adobe that is not maintained or formally supported by the vendor (product-specific)
Guardrails:
- Customers are responsible for ensuring that their use of the AJO Integrations feature and any associated third-party vendors or integrations complies with all applicable laws and regulations, such as HIPAA.
- Each vendor configuration example was independently tested by Adobe as an example pattern; it is not maintained or formally supported by the vendor, so confirm current API details with the vendor documentation.
- Enter an integration name without spaces.
- Prefer single-resource or single-product retrieval over broad list, bulk, or pagination endpoints.
- Map only the attributes required for personalization; large PIM, HAL, or JSON payloads should be restricted to the minimum field set.
- Do not embed secrets or API keys in message content; store and rotate credentials per your policies.
Terminology:
- Canonical name: Sample Vendor configurations — Acronym: n/a — variants: vendor integration patterns, sample integration fields
- Synonyms: “example pattern” = “sample configuration”
- Do not confuse: a configuration “independently tested by Adobe as an example pattern” ≠ a configuration “maintained by or formally supported by” the vendor
- Do not confuse: “GET” retrieval calls (typical for most vendor patterns) ≠ “POST” calls (used for delivery calls such as Adobe Target Recommendations)
FAQ:
- Q: Are these vendor configurations officially supported by the vendors? — No; they were independently tested by Adobe as example patterns and are not maintained or formally supported by the vendor. Confirm current API details with the vendor documentation.
- Q: Who is responsible for legal and regulatory compliance, such as HIPAA? — The customer is responsible for ensuring their use of Integrations and any third-party vendors complies with all applicable laws and regulations.
- Q: Must I use only the listed vendors? — No; you can use any external platform that exposes a compatible API.
- Q: Which HTTP method do the samples use? — Typically GET, unless noted otherwise; some delivery calls, such as Adobe Target Recommendations, use POST with a JSON body.