シグナルを使用したオーケストレーションキャンペーンのトリガー trigger-signal

このページ: REST API また別のキャンペーンの終了アクティビティからシグナルを使用してオーケストレーションキャンペーンをトリガーする方法と、ターゲティング、条件、式の変数となるペイロードパラメーターを渡す方法について説明します。

オーケストレーションキャンペーンは、固定スケジュールの代わりにシグナルを使用して開始できます。 キャンペーンがシグナルを受信すると実行され、ペイロードにパラメーターを渡すことができます。 これらは、ターゲティング、条件、式の変数として使用可能になります。

シグナルは、次のいずれかから発生する場合があります。

このページでは、シグナルを受信するキャンペーンの設定方法(スケジュール、パラメーター、テスト、公開)と、API または​ 終了 ​アクティビティから実行する方法について説明します。 変数が使用可能になったら、ルールと​ テスト ​条件での使用方法について詳しくは、オーケストレーションキャンペーンでの変数の使用を参照してください。

トリガーエンドポイントの完全な REST 仕様(パス、ヘッダー、本文、応答、エラー)について詳しくは、Adobe Journey Optimizer API ドキュメントのオーケストレーションキャンペーンの API のトリガーを参照してください。

シグナルを使用してオーケストレーションキャンペーンをトリガーするエンドツーエンドのプロセス:

NOTE
シグナルを使用してオーケストレーションキャンペーンをトリガーするには、Publish orchestrated campaigns 権限(orchestrated-campaign.publish)が必要です。 ビルトインの権限を参照してください。

シグナルでトリガー済みのキャンペーンのスケジュール configure-signal

スケジュールの代わりにシグナルで開始するオーケストレーションキャンペーンを設定するには、次の手順に従います。

  1. シグナルを使用してトリガーするオーケストレーションキャンペーンを開きます。

  2. スケジュール設定を開きます。 オーケストレーションキャンペーンのスケジュール方法の詳細情報。

  3. 「シグナルでトリガー済み」を選択します。これにより、キャンペーンがスケジュールの実行の代わりにシグナルを待機できます。

    選択した「シグナルでトリガー済み」オプションを含むスケジュールメニュー {modal="regular"}

シグナルペイロードのパラメーターの追加(オプション) parameters

トリガーシグナルでパラメーターを渡して、キャンペーンの実行コンテキスト(例:ターゲティング、条件、式など)で使用できます。 最初にスケジュール設定で各パラメーターを定義し、トリガー API を呼び出す際や、アップストリームキャンペーンの​ 終了 ​アクティビティからパラメーターをマッピングする際にその値を渡します(以下を参照)。

  1. キャンペーンスケジューラーを開き、「パラメーターを追加」を選択します。

  2. シグナルペイロードで送信する各パラメーターの名前とデータタイプを定義します。 また、キャンペーンをテストモードでトリガーする際に使用する​ テスト値 ​を指定することもできます。 トリガーされたキャンペーンをテストする方法の詳細情報。

    シグナルペイロードのパラメーターを定義するパラメーターを追加 {modal="regular"}

NOTE
REST API によってトリガーされるオーケストレーションキャンペーンの場合、スケジューラーで定義されていないパラメーターを API 呼び出しで渡しても、API 呼び出しは引き続き成功し、パラメーターは生成され、式で使用できます。 ただし、オーケストレーションキャンペーンのインターフェイスは使用に役立ちません。例えば、テストアクティビティでは、スケジューラーで定義されていないパラメーターを一覧表示または表示しません。

キャンペーンのテスト build-and-test

キャンバスでキャンペーンを作成し、REST API を通じてシグナルを送信して公開する前に​ ドラフト ​でテストします。

  • REST API によってトリガーされるオーケストレーションキャンペーン - キャンペーンをドラフトで実行し、公開前にターゲティング、パラメーター、配信ロジックを検証するには、次の手順に従います。

  • 終了アクティビティによってトリガーされたオーケストレーションキャンペーン - ドラフトでチェーン全体をエンドツーエンドで実行できません。アップストリームキャンペーンを公開すると、その​ 終了 ​アクティビティは公開したダウンストリームキャンペーンのみを開始します。 両方のキャンペーンを公開する前にダウンストリームサイドをテストするには、そのキャンペーンを​ ドラフト ​に保持し、スケジューラーでシグナルパラメーターに​ テスト値 ​を設定し(シグナルペイロードのパラメーターを追加)、次の API 手順に従います。 トリガー API 呼び出しは、実行時に​ 終了 ​アクティビティと同じペイロードを使用するので、ダウンストリームキャンペーンを公開し、アップストリーム​ 終了 ​アクティビティ(別のキャンペーンの終了アクティビティからのトリガー)を設定する前に、パラメータールーティングとキャンバスロジックを検証できます。

  1. キャンバス上のアクティビティ(オーディエンス、ターゲティング、配信)を追加して接続します。 キャンペーンアクティビティの調整方法の詳細情報

  2. シグナルでパラメーターを定義した場合は、キャンバスロジック(例:条件やターゲティング)にパラメーターを関連付けることができます。 この例では、「チャネル」パラメーターが​ テスト ​アクティビティの条件として使用されています。

    テストアクティビティで条件として使用されるチャネルパラメーター

    式エディターでシグナルパラメーターを使用するには(例:オーディエンスを作成​アクティビティでクエリを作成するには)、「式」フィールドに $(vars/@<parameterName>) と入力します。 <parameterName> を、スケジューラーで定義されたパラメーター名(例:$(vars/@channel))に置き換えます。 詳しくは、式エディターの操作方法を参照してください。

  3. キャンペーンスケジューラーを開き、「API リクエストをコピー」を選択して、形式(cURL または HTTP リクエスト)を選択します。

    コピーした情報には、オーケストレーションキャンペーン ID、サンドボックス名、組織 ID、(パラメータを追加している場合は)パラメーターのテスト値が含まれます。

    スケジュール設定の「API リクエストをコピー」オプション

    accordion
    パラメーターとテスト値を含むサンプル cURL リクエスト
    code language-bash
    POST https://platform.adobe.io/ajo/campaign-orchestration/orchestratedCampaigns/1c7529c7-7a8c-491a-a2c6-3d8131d2e17d/trigger
    
    Headers:
    Authorization: Bearer ## Access token ##
    Content-Type: application/json
    x-api-key: ## Provide API Key here ##
    x-api-version: 1
    x-gw-ims-org-id: 123456ABCDEFG@LumaOrg
    x-sandbox-name: prod
    
    Body:
    {
    "variables": {
       "channel": "sms"
    }
    }
    
  4. 「開始」をクリックして、キャンペーンを開始します。

  5. スケジューラーからコピーしたサンプルリクエストを使用して、トリガー API 呼び出しを送信します。 リクエストと応答について詳しくは、オーケストレーションキャンペーンの API のトリガーを参照してください。

テスト結果に満足したら、キャンペーンを公開します。

キャンペーンの公開とトリガー publish

キャンペーンをテストしたら、公開します。これにより、アプリケーションや他のキャンペーンの​ 終了 ​アクティビティからシグナルを受信できます。 キャンペーンの開始とモニタリングの詳細情報。

次に、REST API または別のキャンペーンの​ 終了 ​アクティビティからトリガーできます。 以下の節を参照してください。

REST API を使用したシグナルの送信 publish-api

公開後、独自のアプリケーションからキャンペーンをトリガーするたびに、次の手順に従います。

  1. キャンペーンスケジューラーを開き、「API リクエストをコピー」を選択して、形式(cURL または HTTP リクエスト)を選択します。

    コピーした情報には、オーケストレーションキャンペーン ID、サンドボックス名、組織 ID、(パラメータを追加している場合は)パラメーターが含まれます。

    スケジュール設定の「API リクエストをコピー」

  2. システムからトリガー API を呼び出します。 ライブエンドポイントの仕様について詳しくは、オーケストレーションキャンペーンの API のトリガーを参照してください。

    note important
    IMPORTANT
    ライブオーケストレーションキャンペーンの場合、スロットルガードレールにより、2 つの API トリガーの実行の間に最低 1 時間の間隔が適用されます。 間隔が経過する前に API を再度呼び出すと、API は HTTP 429(リクエストが多すぎる)を返します。 このガードレールは、ドラフトバージョンをトリガーしてテストする場合は適用されません。

    シグナルペイロードにパラメーターを追加した場合、API 呼び出しで渡した値は、キャンペーンの実行時にキャンペーンイベント変数として公開されます。 これらを検査するには、キャンペーンキャンバスツールバーからキャンペーンログを開きます。 「タスク」タブで、シグナルに対応するタスクを特定し、鉛筆アイコンをクリックして、関連するイベント変数にアクセスします。 ログとタスクへのアクセス方法の詳細情報。

    ​ キャンペーンイベント変数が使用可能なログとタスク画面 {modal="regular"}

別のキャンペーンの終了アクティビティからのシグナルの送信 signal-end

このパスを使用して、オーケストレーションキャンペーンを連結します。アップストリームキャンペーンが分岐を完了すると、終了​アクティビティは、シグナルでトリガー済み​に既に設定されているダウンストリームキャンペーンにシグナルを送信します。 これにより、小規模なキャンペーンを再利用し、各呼び出し元から異なるペイロードを渡すことができます。

NOTE
  • 同じキャンバスで複数の​ 終了 ​アクティビティを使用し、それぞれ設定して異なるダウンストリームキャンペーンをトリガーできます。
  • 複数のキャンペーンが同じダウンストリームキャンペーンをトリガーできます。 各呼び出しは異なるペイロードを送信できます。

最初に実行する必要があるキャンペーンで、次の手順に従います。

  1. シグナルを送信する必要があるオーケストレーションキャンペーンを開き、ダウンストリームキャンペーンが開始する前に完了する必要がある分岐の末尾にある​ 終了 ​アクティビティを選択します。

  2. 「外部シグナル」セクションで、トリガーするダウンストリームキャンペーンを選択します。

  3. オプションで、パラメーターを追加します。ダウンストリームキャンペーンのスケジュールと同じ名前を使用し、各値を設定します。

  4. ダウンストリームキャンペーンを公開する前にドラフトモードでテストするには、キャンペーンをテストの節の手順に従って、REST API を使用してドラフトでトリガーします。

終了 アクティビティで参照するアップストリームキャンペーンを公開する前に、ダウンストリームキャンペーンを公開する必要があります。 ターゲットキャンペーンが公開されていない間にシグナルが送信された場合、実行は失敗します。 ダウンストリームキャンペーンを公開し、必要に応じて再開または再起動します。

AI Knowledge Reference

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 to trigger an Orchestrated campaign with a signal from the REST API or from another campaign’s End activity, and how to pass payload parameters that become variables for targeting, conditions, and expressions.

Intents:

  • Schedule an Orchestrated campaign to start on a signal instead of a fixed schedule.
  • Define parameters for the signal payload, with test values for use in test mode.
  • Build and test the campaign in Draft before publishing, including copying a sample API request.
  • Publish the campaign and trigger it from the REST API.
  • Chain campaigns by configuring an End activity to send a signal to a downstream campaign.
  • Inspect campaign event variables passed in a trigger signal from the campaign logs.

Glossary:

  • Triggered by a signal: the schedule option that makes a campaign wait for a signal instead of running on a schedule (product-specific)
  • End activity: the campaign activity, placed at the end of a branch, that can send a signal to a downstream campaign through its External signal section (product-specific)
  • External signal: the section of the End activity where the downstream campaign to trigger is selected (product-specific)
  • Test values: values defined for signal parameters in the scheduler, used when the campaign is triggered in test mode (product-specific)
  • Copy API request: the scheduler option that copies the orchestrated campaign ID, sandbox name, organization ID, and parameter values, in cURL or HTTP Request format (product-specific)

Guardrails:

  • To trigger an Orchestrated campaign using a signal, you need the Publish orchestrated campaigns permission (orchestrated-campaign.publish).
  • For a live orchestrated campaign, a throttle guardrail enforces a minimum interval of one hour between two API trigger executions (hard limit); calling the API again before that interval has elapsed returns HTTP 429 (Too many requests). This guardrail is not applied when you trigger a draft version to test it.
  • For Orchestrated campaigns triggered by the REST API, if you pass a parameter in the API call that has not been defined in the scheduler, the API call still succeeds and the parameter is propagated and can be used in expressions; however, the orchestrated campaign interface will not help you use it — for example, the Test activity will not list or show parameters that were not defined in the scheduler.
  • You cannot run the full chain end-to-end in draft for campaigns triggered by an End activity: once the upstream campaign is published, its End activity only starts a published downstream campaign.
  • The downstream campaign must be live before you can publish the upstream campaign that references it in an End activity; if the signal is sent while the target campaign is not published, execution will fail.
  • You can use several End activities on the same canvas, each configured to trigger a different downstream campaign.
  • Several campaigns can trigger the same downstream campaign, and each call can send a different payload.

Terminology:

  • Canonical name: Triggered by a signal — variant: signal.
  • Do not confuse: “End activity” signal (sent at runtime to a published downstream campaign) ≠ REST API trigger call used to test a draft downstream campaign before both campaigns are published.

FAQ:

  • Q: How do I make a campaign start from a signal instead of a schedule? — Open the schedule configuration and select Triggered by a signal.
  • Q: Where do I define parameters for the signal payload? — In the campaign scheduler, using Add parameter, where you can also set Test values for test mode.
  • Q: What happens if I pass a parameter in the API call that was not defined in the scheduler? — The API call still succeeds and the parameter is propagated for use in expressions, but the Test activity will not list or show it.
  • Q: How often can I call the trigger API for a live campaign? — A throttle guardrail enforces a minimum interval of one hour between two API trigger executions; calling again sooner returns HTTP 429 (Too many requests). This guardrail does not apply when triggering a draft version to test it.
  • Q: Can I test the full chain from an upstream End activity to a downstream campaign before publishing both? — No; once published, an End activity only starts a published downstream campaign. To test the downstream side first, keep it in Draft, set Test values for its signal parameters, and trigger it directly with the REST API using the same payload the End activity would send.
  • Q: What must be true of the downstream campaign before I publish the upstream campaign’s End activity that references it? — The downstream campaign must be live; if the signal is sent while it is not published, execution will fail.

Personas:

  • developer: Can trigger a published Orchestrated campaign by calling the trigger API, and pass parameters in the payload that become variables for targeting, conditions, and expressions. Can copy a sample cURL or HTTP Request from the campaign scheduler, including the campaign ID, sandbox name, organization ID, and parameter values. The page states that a throttle guardrail enforces a minimum one-hour interval between two API trigger executions for a live campaign. Where: “Send the signal with the REST API”.

Onboarding:

  • Level: Intermediate
  • First minimal step: Open the schedule configuration and select Triggered by a signal.
  • Success check: In the Tasks tab of the campaign logs, you can access the event variables passed in the trigger signal.
  • Previous: Opening the schedule configuration to set up the Orchestrated campaign: Create and schedule Orchestrated campaigns with Journey Optimizer (orchestrated/create-orchestrated-campaign.md); Adding and connecting activities on the campaign canvas: Create Orchestrated campaigns with Adobe Journey Optimizer (orchestrated/orchestrate-activities.md)
  • Next: Using signal parameters as variables in targeting, conditions, or expressions: Use variables in Orchestrated campaigns (orchestrated/variables-orchestrated-campaigns.md); Publishing and monitoring the campaign after testing it: Start and monitor Orchestrated campaigns with Adobe Journey Optimizer (orchestrated/start-monitor-campaigns.md)
recommendation-more-help
journey-optimizer-help