シグナルを使用したオーケストレーションキャンペーンのトリガー 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 を使用してドラフトでトリガーします。

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

recommendation-more-help
journey-optimizer-help