Campaigns (Legacy) の概要

MoEngage Campaigns API を使用すると、Push および Email キャンペーンを作成および管理できます。これらのエンドポイントを使用して、キャンペーンの作成を自動化し、既存のキャンペーンを更新し、キャンペーンのステータスを制御し、キャンペーンの詳細を取得できます。

お使いのアカウントでこの API が有効になっていない場合は、MoEngage のカスタマーサクセスマネージャー (CSM) またはサポートチームに連絡して、有効化をリクエストしてください。

エンドポイント

Campaigns API は、次のエンドポイントで構成されています。

Create Campaign: 新しい Push または Email キャンペーンを作成します。
Update Campaign: MoEngage の既存の Push または Email キャンペーンを更新します。
Search Campaigns: Push、Email、または SMS キャンペーンの一覧を、現在のすべてのフィールドとステータスとともに取得します。
Test Campaign: 開始前に、特定のユーザーにテスト用の Push または Email キャンペーンを送信します。
Personalized Preview: Push、Email、または SMS キャンペーンを送信する前に、特定のユーザー向けのパーソナライズされたコンテンツを表示します。
Get Campaign Meta: スケジュール済みキャンペーンのキャンペーン詳細とリーチ情報を取得します。
Change Campaign Status: キャンペーンのステータスを更新して、停止、一時停止、または再開します。
Get Child Campaigns: Periodic または Business Event-triggered キャンペーンの子キャンペーンの実行詳細を取得します。

よくある質問

Email キャンペーンの作成

この API で作成したキャンペーンをパーソナライズするにはどうすればよいですか?

ユーザー属性、イベント属性、プロダクトセット、Content API、コンテンツブロックを使用してキャンペーンをパーソナライズできます。パーソナライズ用の Jinja の構文は、MoEngage ダッシュボードでサポートされているものと同じです。

同じペイロードで複数のキャンペーンが作成されないようにする方法はありますか?

MoEngage はリクエスト ID を使用してキャンペーンの重複を排除します。24 時間以内に同じリクエスト ID が 2 回渡された場合、2 回目のキャンペーン作成は失敗します。

これらのキャンペーンは UI にどのように表示されますか?

キャンペーンは、この API で作成されたときと同じ配信タイプ (One-Time、Periodic など) の下に表示されます。

コンテンツオブジェクトでテンプレート ID と HTML コンテンツを一緒に渡すことはできますか?

いいえ。キャンペーンの作成に必要なのはどちらか一方のみです。両方を渡すと、キャンペーンの作成時にエラーが表示されます。

カスタムセグメントを使用してキャンペーンを作成するにはどうすればよいですか?

カスタムセグメントを使用するキャンペーンを作成するには、キャンペーン作成リクエストに segmentation_details を含めます。included_filters 内で filter_type を “custom_segments” に設定し、カスタムセグメントの ID を指定します。次のコードスニペットは、カスタムセグメントを組み込む方法を示しています。

"segmentation_details": {
  "included_filters": {
    "filter_operator": "and",
    "filters": [
      {
        "filter_type": "custom_segments",
        "name": "segment",
        "id": "{{id}}"
      }
    ]
  }
}

Push キャンペーンの作成

1 つのプラットフォームのみを対象とした Push キャンペーンを作成できますか?

はい。Android、iOS、Web などの単一のプラットフォームを対象とした Push キャンペーンを作成できます。これらのプラットフォームを組み合わせたキャンペーンを作成することもできます。

Push キャンペーンのペイロードで必要なテンプレート ID はどのように取得できますか?

Search Push Template API を使用し、テンプレート名、作成者、またはその他のサポートされているパラメーターなどのリクエストパラメーターを渡すと、レスポンスでテンプレート ID を取得できます。

コンテンツセクションに含めるフィールドはどのように決めればよいですか?

Stylized Basic、Timer、またはその他の利用可能なオプションなどのテンプレートタイプを選択します。次に、テンプレートの要件を参照し、そのテンプレートタイプで必須とされているすべてのフィールドを含めます。

カスタムセグメントを使用してキャンペーンを作成するにはどうすればよいですか?

"segmentation_details": {
  "included_filters": {
    "filter_operator": "and",
    "filters": [
      {
        "filter_type": "custom_segments",
        "name": "segment",
        "id": "{{id}}"
      }
    ]
  }
}

Push キャンペーンの更新

アクティブなキャンペーンでテンプレートタイプを変更できますか?

必要なプラットフォームでテンプレートタイプを変更できます。その場合、更新後のテンプレートタイプ用の新しいコンテンツを指定する必要があります。

アクティブなキャンペーンでプラットフォームを追加または削除できますか?

キャンペーンの更新時にプラットフォームを追加または削除できます。キャンペーンに新しく追加したプラットフォーム用のコンテンツを指定する必要があります。

更新したコンテンツはいつからユーザーに送信され始めますか?

Event-triggered キャンペーンを除き、更新されたキャンペーンは変更が完了するとすぐに送信が開始されます。Event-triggered キャンペーンでは詳細がキャッシュされるため、更新されたキャンペーンが送信されるまでに最大 30 分かかります。

Email キャンペーンの更新

キャンペーンが Active 状態のときにセグメンテーションのオーディエンスを更新できますか?

いいえ。キャンペーンが Active 状態になった後は、セグメンテーションのオーディエンスを更新できません。キャンペーンが Scheduled 状態であればセグメンテーションのオーディエンスを更新できます。または、既存のキャンペーンを停止して複製を作成し、新しいセグメンテーションの詳細を渡すこともできます。

更新したキャンペーンはいつからユーザーに送信され始めますか?

更新するキャンペーンのキャンペーン ID はどのように取得できますか?

キャンペーン名、チャネル、またはその他のフィルターを指定して “GET” API を呼び出し、目的のキャンペーンのキャンペーン ID を取得する必要があります。詳細については、Search Campaigns を参照してください。

Search Campaigns - Push

Push チャネルのフローキャンペーンノードの情報を取得できますか?

はい。フローノードのキャンペーンを取得するには、include_child_campaigns キーの値として true を渡す必要があります。

どのキャンペーンがフローのものかを識別するにはどうすればよいですか?

レスポンスの flow_name および flow_id キーを使用します。これらのキーは、キャンペーンがフローの一部であることを示します。

API への入力として One_Time を渡した場合、レスポンスにはどのキャンペーンが含まれますか?

レスポンスには、フローの配信タイプにかかわらずすべてのフローノードのキャンペーンと、配信タイプが one_time の Engage キャンペーンが含まれます。

Search Campaigns - SMS

SMS チャネルのフローキャンペーンノードの情報を取得できますか?

はい。フローノードのキャンペーンを取得するには、include_child_campaigns キーの値として true を渡す必要があります。

どのキャンペーンがフローのものかを識別するにはどうすればよいですか?

レスポンスの flow_name および flow_id キーを使用します。これらのキーは、キャンペーンがフローの一部であることを示します。

特定の送信者のキャンペーン情報を取得できますか?

いいえ。現在、リクエスト本文には送信者名のフィルターはありません。

アーカイブされたキャンペーンの情報を取得できますか?

はい。アーカイブされたキャンペーンを取得するには、include_archived_campaigns キーの値として true を渡す必要があります。

Push キャンペーンのテスト

MoEngage に含まれていない ID にテストプッシュを送信できますか?

はい。識別子として “Email” を渡すことで、任意のユーザーにテストキャンペーンを送信できます。送信されるキャンペーンはパーソナライズされません。

パーソナライズ用にコンテンツで使用されているユーザー属性値の一部のみを渡した場合、パーソナライズはどのように機能しますか?

パーソナライズの詳細で渡された値は、テストキャンペーンの送信先となるすべてのユーザーに使用され、残りのユーザー属性値はユーザープロファイルから取得されます。

Email キャンペーンのテスト

MoEngage に含まれていない ID にテストメールを送信できますか?

パーソナライズ用にコンテンツで使用されているユーザー属性値の一部のみを渡した場合、パーソナライズはどのように機能しますか?

Get Campaign Meta

スケジュール済みキャンペーンの正確なリーチを取得できますか?

いいえ。リーチは推定値であり、アプリのインストール、アンインストール、メールのサブスクリプションステータスの変更などの要因により、時間の経過とともに変動する場合があります。

API 呼び出しのたびにリーチを更新できますか?

いいえ。リーチは 1 日に 1 回計算され、24 時間キャッシュされます。同じ日に複数回 API を呼び出すと、キャッシュされた値が返されます。

Personalized Preview

Personalization Preview でカスタムテンプレートを使用できますか? 使用できる場合、出力はどうなりますか?

はい。Personalization Preview ではカスタムテンプレートを使用できます。API は、指定されたユーザー識別子に基づいてテンプレート内のコンテンツをパーソナライズし、パーソナライズされた HTML をレスポンスとして返します。

Personalization Preview でイベントを使用してコンテンツをパーソナライズできますか?

はい。イベントの詳細を API への入力として渡すことができます。イベント名がワークスペース内のイベント名と一致していることを確認してください。

Change Campaign Status

この API を使用して Periodic キャンペーンを停止できますか?

Periodic キャンペーンでは、キャンペーンの一時停止 (Pause) と再開 (Resume) アクションのみがサポートされています。停止できるのは One-time キャンペーンのみです。

送信中の状態にある One-time キャンペーンを停止できますか?

いいえ。One-time キャンペーンが Active 状態に移行した後は、停止できません。

Postman コレクション

API を簡単にテストできるようにしています。Postman コレクションを表示するには、こちらをクリックしてください。

​エンドポイント

​よくある質問

​Email キャンペーンの作成

​Push キャンペーンの作成

​Push キャンペーンの更新

​Email キャンペーンの更新

​Search Campaigns - Push

​Search Campaigns - SMS

​Push キャンペーンのテスト

​Email キャンペーンのテスト

​Get Campaign Meta

​Personalized Preview

​Change Campaign Status

​Postman コレクション

エンドポイント

よくある質問

Email キャンペーンの作成

Push キャンペーンの作成

Push キャンペーンの更新

Email キャンペーンの更新

Search Campaigns - Push

Search Campaigns - SMS

Push キャンペーンのテスト

Email キャンペーンのテスト

Get Campaign Meta

Personalized Preview

Change Campaign Status

Postman コレクション