【第113回】 REST API を使って Journey Builder のジャーニーを一時停止する方法

今回は REST API と Talend API Tester を使って Salesforce Marketing Cloud の Journey Builder のジャーニーを一時停止してみます。今回使用する API の詳細は、下記リンクとなります。

Interaction: Pause a Journey by Definition Key | Marketing Cloud APIs and SDKs | Salesforce Developers

今回の記事では REST API を使用します。過去の記事「Salesforce Marketing Cloud で REST API を叩いてみよう」の Part.1 と Part.2 の記事で取得できる以下の 2 つが必要となりますので、事前に用意してください。

■ Part.1 の REST ベース URL
■ Part.2 の アクセストークン

まずは、一時停止する対象のジャーニーを用意します。

Query Studio を使って Journey ID を検索します。

SELECT JourneyID
FROM _Journey
WHERE JourneyName = 'ジャーニー名'

続いて、Talend API Tester に移動します。新規リクエストを立ち上げてください。新規リクエストの画面を立ち上げたら、以下の情報を入力してください。入力後に「送信」ボタンを押します。

--- メソッド 
POST 

--- エンドポイント 
[REST ベース URL].rest.marketingcloudapis.com/interaction/v1/interactions/pause/[JourneyID]?allVersions=true

--- ヘッダー 
Content-Type：application/json 
Authorization：Bearer [アクセストークン] 

--- ボディ（サンプル）
{
  "ExtendWaitEndDates":false,
  "PausedDays":14,
  "ProcessWaitUntilEvents":true,
  "GuardrailAction":"Resume", 
  "RetainContactInjectionWhileJourneyPaused":true,
  "id":"[JourneyID]"
}

■ ExtendWaitEndDates
一時停止の期間を「待機」アクティビティの待機期間にさらに追加して、各連絡先の待機期間を延長するかしないかを指定するオプション。True が延長で、False は延長しない（デフォルトは False）

■ PausedDays
一時停止の期間を指定するオプション（最大 14 日間まで延長可能）

■ ProcessWaitUntilEvents
「待機終了日」のアクティビティを構成している場合に、一時停止ステータスで、処理されるかどうかを指定するオプション（デフォルトは True）

■ GuardrailAction
一時停止期間が満了した後、どうするかの指定をするオプション。Resume（再開）か Stop（停止）を選択

■ RetainContactInjectionWhileJourneyPaused
（このオプションをサポートするエントリソースの場合に）ジャーニーを一時停止している間、コンタクトインジェクション（連絡先の注入）を保持するか、どうかを指定するオプション。True はジャーニーが再開したときにそれらをキューに入れて処理するで、False は新しい連絡先を無視する（デフォルトは False）

■ id
（Query Studio などで検索した）Journey ID

送信の結果 202 Accepted でレスポンスがあれば、リクエストは成功です。

今回入力した、アクセストークン以外は、今後も Talend API Tester で使い回しができるので、必要に応じて保存してください。

最後に Journey Builder に戻って、設定した条件でジャーニーが一時停止していることを確認します。

REST API の基本を押さえていれば簡単でしたね。

今回は以上です。

次の記事はこちら

前回の記事はこちら

私の note のトップページはこちら

Nobuyuki Watanabe｜note