このページ: エンドポイント URL、ヘッダー、認証、スロットルポリシー、メッセージペイロード構造を定義することで、Channel Builderを使用してAdobe Journey Optimizerでカスタムチャネルを作成する方法を説明します。
キャンペーンとジャーニーでカスタムチャネルを使用できるようにするには、管理者が最初にチャネルを作成する必要があります。 これには、エンドポイント、認証、スロットルポリシー、メッセージペイロード構造の定義が含まれます。
チャネルビルダー セクションは、新しいカスタムチャネルを定義するための中央インターフェイスです。 カスタムチャネルを作成および設定できるだけでなく、API資格情報を管理したり、サブドメインをデリゲートしたりできます。
カスタムチャネルへのアクセスと管理 access-channel-builder
チャネルビルダーにアクセスし、カスタムチャネルを管理するには、次の手順に従います。
-
左側のナビゲーションパネルで管理 > チャネルに移動します。
-
「チャネルビルダー」セクションで「カスタムチャネル」を選択します。
{width="100%"}
-
インベントリには、サンドボックス内のすべてのカスタムチャネルが一覧表示されます。これには、現在のステータスと、外部エンドポイントへの接続に使用された認証タイプが含まれます。
-
カスタムチャネルは、作成者のステータス(ドラフト、アクティブ、またはアーカイブ)でフィルタリングし、名前で検索できます。
-
チャネルを編集するには、インベントリ内のチャネル名をクリックし、変更を加えて保存します。 アクティブなチャネルの場合は、特定のフィールドのみを編集できます – 詳細情報。
note caution CAUTION アクティブなチャネルのスロットル設定または再試行設定を変更すると、実行中および今後のすべての実行に対して直ちに有効になります。 -
チャネルをアーカイブするには、インベントリからチャネルを開き、アーカイブをクリックします。
アクティブなチャネルをアーカイブすると、キャンペーンアクションセレクター、ジャーニーアクションパレット、個のチャネル設定、コンテンツテンプレートなど、すべての選択ドロップダウンからチャネルが削除されます。 すでにチャネルを使用している既存のジャーニーやキャンペーンは、引き続き正常に機能します。
カスタムチャネルの作成 create-channel
新しいカスタムチャネルを作成するには、次の手順に従います。
-
「カスタムチャネルを作成」ボタンをクリックして、チャネル作成フォームを開きます。 まず、カスタムチャネルの一般的な設定を定義します。
{width="70%"}
-
「プロパティ」セクションに、カスタムチャネルの 名前 を入力します。 この名前は、ジャーニーキャンバスおよびキャンペーンアクションセレクターに表示されます。
note NOTE 名前は一意で、文字(A ~ Z)で始まり、英数字または特殊文字(_、.、 – )のみを含め、1文字より大きくする必要があります。 -
デフォルトのアイコンライブラリからアイコンを選択するか、コンピューターからSVG ファイルを選択できます。
note NOTE ファイルは150 KB以下である必要があります。 このアイコンは、ジャーニーキャンバスのチャネル名の横に表示されます。 アイコンがアップロードされない場合は、デフォルトのアイコンが使用されます。
-
オプションの 説明 を入力します。
エンドポイントの設定 endpoint-configuration
外部メッセージングシステムのHTTP URLであるエンドポイントを設定する必要があります。 プロファイルがキャンペーンまたはジャーニーで適格である場合、Journey Optimizerは、パーソナライズされたペイロードを使用して、このエンドポイントにPOST リクエストを送信します。
-
エンドポイント設定 セクションで、外部メッセージシステムのホスト URLを入力します。 例:
https://api.my-messaging-provider.com/v1/messages。note important IMPORTANT 外部メッセージシステムは、Journey OptimizerがHTTP POST経由で呼び出すことができるHTTPS エンドポイントを公開する必要があります。 エンドポイントは次の必要があります。 - チャネルで定義したペイロード形式(JSON)を受け入れます。
- チャネルビルダーで使用できる認証方法の1つをサポートします。 詳細情報
- リクエストの正常な受信を確認するために、HTTP 2xx応答を返します。
-
必要に応じて Headers を追加します。 ヘッダーは、HTTP リクエストレベルで送信されるキーと値のペアです。 エンドポイントへのあらゆるリクエストと並行して送信され、通常は認証トークン、コンテンツタイプの仕様、または外部システムに必要なその他のメタデータに使用されます。
{width="60%"}
各ヘッダーについて、その値が次であるかどうかを定義できます。
- 定数 – 静的値が1回設定され、すべてのリクエストに含まれます。 例えば、値
application/jsonのContent-Typeパラメーターまたは値UTF-8のCharsetパラメーターを定義できます。 - 変数 - デフォルト値がここに入力されている場合は、チャネル設定で上書きされない限り使用されます。 例えば、実行時に解決されるユーザーIDの変数を定義できます。 詳細情報
- 定数 – 静的値が1回設定され、すべてのリクエストに含まれます。 例えば、値
-
必要に応じて、同じ定数/変数パターンを使用して クエリパラメーター を追加します。 クエリパラメーターは、配信時にエンドポイント URLに追加されます。 定数パラメーターは常に同じ値で追加されます。変数パラメーターは送信時に解決されます。例えば、ユーザー識別子をプロファイルから渡します。
{width="60%"}
-
「ポリシー設定」セクションで、Journey Optimizerがリクエストのスループットと失敗をどのように処理するかを定義します。 これは、外部システムがリクエストの量を処理できるようにし、過剰な負荷を避けるために重要です。
{width="70%"}
- スロットルを有効にする - デフォルトでは無効になっています。 1秒あたりのリクエストの最大数を設定します(デフォルト:5,000c)。 制限に達すると、リクエストはキューに入れられ、できるだけ早く送信されます。
- 再試行を有効にする - デフォルトで有効になっています。 失敗したリクエストの最大再試行回数(デフォルト:3、設定可能な範囲:0 ~ 10)を設定します。 これにより、一時的なエラー時にエンドポイントに負担をかけるのを防ぐことができます。
- タイムアウト - デフォルト:5,000 ミリ秒。 リクエストが失敗したと考える前に、エンドポイントからの応答を待つための最大時間を設定します。
認証設定 authentication-settings
このチャネルに使用する必要がある 認証タイプ を選択します。 使用可能なオプションは、外部メッセージングシステムでサポートされている認証方法によって異なります。
エンドポイントで必要に応じて認証の詳細を指定します。
- なし - リクエストは資格情報なしで送信されます。
- API キー - キー名、値、場所(クエリパラメーターまたはヘッダー)を指定します。
- 基本認証 - ユーザー名とパスワードを入力します。
- OAuth 2.0 - OAuth 2.0認証用のペイロードを設定します。
認証タイプが None 以外の場合、Journey Optimizerは、このチャネルがアクティブ化されたときに、このチャネルの初期のAPI資格情報セットを自動的に生成します。 これらの資格情報を変更し、API資格情報インベントリで新しい資格情報を作成できます。 詳細情報
ただし、認証の詳細は、チャネルをアクティブ化する前にエンドポイントへの接続をテストするために必要です。 認証設定を検証するには、接続をテスト ボタンを使用できます。 詳細情報
ペイロード設定 payload-configuration
ペイロードは、キャンペーンまたはジャーニーでプロファイルが適格である場合に、エンドポイントに送信されます。
ペイロード設定では、メッセージペイロードの構造と、マーケターがオーサリングおよびパーソナライズできるフィールドを定義します。
-
「ペイロードを定義」をクリックし、ペイロードの定義方法を選択します。
-
サンプル JSON ペイロードの貼り付け – 代表的なJSON オブジェクトを貼り付けると、Journey Optimizerは、そのオブジェクトからスキーマを自動的に推測します。 次に例を示します。
code language-json { "channelId": "KakaoTalk08", "title": "Flash Sale: 48 Hours Only", "body": "New arrivals just dropped. Shop now before they're gone!", "image": "https://demo-system-next.s3.amazonaws.com/assets/luma/luma-flash-sale-banner.jpg" } -
JSON スキーマの読み込み (近日リリース予定) – 完全なJSON スキーマファイルをアップロードします。
note availability AVAILABILITY この機能はまだ利用できません。 将来のリリースで追加される予定です。
-
-
スキーマを生成すると、Journey Optimizerは検出されたすべてのフィールドをフォームビューに表示します。
{width="80%"}
-
各フィールドに対して、次の設定を行います。
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 設定 説明 デフォルト値 オプション。 オーサリング時にパーソナライズされた値が提供されない場合に使用されます。 タイプ 読み取り専用。ペイロードから派生します。 サポートされているタイプ: string、integer、decimal、boolean、dateTime、dateTimeOnly、dateOnly、listObject、listString、listInteger、listDecimal、listBoolean、listDateTime、listDateTimeOnly、listDateOnly。必須 有効にした場合、チャネルがキャンペーンまたはジャーニーで使用される場合、フィールドに値が必要です。 必須フィールドが見つからない場合、アクティベーションを妨げる検証エラーがトリガーされます。 チャネル設定 有効にすると、このフィールドはチャネル設定に表示され、管理者は設定ごとに異なる値を設定できます(例えば、ブランドまたは地域ごとに異なる送信者ID)。 詳細情報 ネストされたフィールドは、ドット表記法を使用して表されます(例:
image.id)。
検証と活用 test-activate
チャネルのステータスが ドラフト である間、画面上部の接続をテスト ボタンを使用して、エンドポイントにテストリクエストを送信し、エンドツーエンドの接続を検証します。
外部システムのログを確認して、リクエストが期待される認証とペイロードで受信されたことを確認します。
テストが成功したら、チャネルを保存またはアクティブ化できます。
- 「ドラフトとして保存」をクリックして、チャネルを利用せずに進行状況を保存します。
- 「アクティブ化」をクリックして、チャネルをチャネル設定、キャンペーン、ジャーニーで使用できるようにします。
次の手順 next-steps
これでカスタムチャネルが作成されました。 残りの手順に従って、設定を完了します。
- API資格情報を設定 (チャネルが認証を使用している場合)
- サブドメインをデリゲート (オプション – リンクトラッキングに必要)
- チャネル設定の作成
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 explains how an administrator creates a custom channel in the Channel Builder by defining its general properties, endpoint, authentication, throttling policy, and message payload structure, then tests the connection and activates it.
Intents:
- Access and manage custom channels in the Channel Builder
- Define general properties such as name and icon for a custom channel
- Configure the endpoint URL, headers, query parameters, and policy settings
- Choose an authentication type and provide the authentication details
- Define the message payload structure and which fields marketers can author
- Test the connection and activate the channel
Glossary:
- Channel Builder: The central interface for defining new custom channels and for managing API credentials and subdomains (product-specific)
- Endpoint configuration: The HTTP URL of your external messaging system that Journey Optimizer calls with a POST request when a profile qualifies (product-specific)
- Constant header value: A static value set once and included in every request (product-specific)
- Variable header value: A value with an optional default that can be overridden in the channel configuration and resolved at runtime (product-specific)
- Policy configuration: The section defining how Journey Optimizer handles request throughput and failures through throttling, retry, and timeout settings (product-specific)
- Test connection: A button that sends a test request to your endpoint while the channel is in Draft status to validate the end-to-end connection (product-specific)
Guardrails:
- This capability requires the View custom channels and Manage custom channels permissions.
- The channel name must be unique, begin with a letter (A-Z), include only alphanumeric characters or the special characters _, ., -, and be greater than 1 character.
- An uploaded icon SVG file must be no larger than 150KB.
- The external endpoint must be HTTPS, accept the JSON payload the channel defines, support one of the Channel Builder authentication methods, and return an HTTP 2xx response.
- Throttling is disabled by default; the maximum number of requests per second default is 5,000, and once the limit is reached requests are queued and sent as soon as possible.
- Retry is enabled by default with a maximum retry count default of 3 (configurable range 0-10).
- The endpoint timeout default is 5,000 milliseconds.
- Modifying throttling or retry settings on an active channel takes effect immediately for all in-flight and future executions.
- When the authentication type is anything other than None, an initial set of API credentials is generated automatically when the channel is activated.
- After a channel is activated, only name, description, icon, throttling, and retry configuration remain editable; endpoint URL, headers, query parameters, authentication, and payload structure are locked.
- A required payload field that has no value triggers a validation error that prevents activation.
Terminology:
- Canonical name: custom channel — Acronym: n/a — variants: custom channel definition
- Synonyms: “set up a custom channel” = “create a custom channel” (both are used on this page for the same task)
- Do not confuse: “Constant” (static value included in every request) ≠ “Variable” (default value that can be overridden in the channel configuration)
- Do not confuse: “Enable throttling” (requests per second cap) ≠ “Enable retry” (retry count for failed requests)
- Do not confuse: “Draft” ≠ “Active” ≠ “Archived” channel statuses
FAQ:
- Q: What permissions are required to create a custom channel? — The View custom channels and Manage custom channels permissions.
- Q: What statuses can a custom channel have? — Draft, Active, or Archived.
- Q: Which fields remain editable after activation? — Only name, description, icon, throttling, and retry configuration; endpoint URL, headers, query parameters, authentication, and payload structure are locked.
- Q: How do I validate the connection before activating? — Use the Test connection button while the channel is in Draft status to send a test request to your endpoint, then check your external system’s logs.
- Q: What payload format is supported? — JSON; you can paste a sample JSON payload so that a schema is inferred (importing a JSON schema is coming soon).
- Q: What happens when I archive an active channel? — It is removed from all selection drop-downs, while existing journeys and campaigns that already use it continue to function normally.