Commerce キャンペーンのマーケティング オートメーション API

概要

オートメーション プロバイダーと使用可能なメソッドの概要。

オートメーション プロバイダーは、すべてのマーケティング オートメーション キャンペーンの汎用であり、次の機能を備えています。

  • 既存のテンプレートに基づいたカート放棄マーケティング オートメーション キャンペーンの作成。

  • 既存のテンプレートに基づいた新規注文マーケティング オートメーション キャンペーンの作成。

  • オートメーション キャンペーンへのコンタクトの登録。

  • オートメーション キャンペーンからのコンタクトの削除。

次のクラス図は、IAutomationProviderAutomationProvider の関係と含まれているメソッドを示しています。

IAutomationProvider.png

次の表に、オートメーション プロバイダーで使用できるメソッドを示します。

メソッド

説明

CreateFromTemplate

テンプレートに基づいてマーケティング オートメーション キャンペーンを作成します。

shopName は、キャンペーンを作成するストアフロントの名前を表します。 templateName は、プランの作成に使用するテンプレートの名前です。

結果のキャンペーン名は、shopName + “ “ + templateName です。

重要

Commerce マーケティング オートメーション キャンペーンでは、shopName + “ “ + templateName という名前付け規則に従う必要があります。

EnrollCurrentContact

現在のコンタクトをプランに登録します。

shopNamebasePlanName が連結されて、IAutomationPlanProvider で取得するプランの名前になります。

customValues は、オートメーション キャンペーンでコンタクトと一緒に保存される値を表します。

このメソッドは、たとえば、コンタクトがショッピング サイトのカートを操作して Commerce マーケティング オートメーション キャンペーンに登録されるたびに呼び出されます。

RemoveContactFromPlan

現在のプランからコンタクトを削除します。たとえば、ショッピング カートが送信されて注文に変換されると、このメソッドが呼び出されてカート放棄キャンペーンからコンタクトが削除されます。

RemoveCurrentContactFromPlan

指定されたプランから現在のコンタクトを削除します。

デフォルトの実装は、次の設定に基づいて動的に読み込まれます。

<configuration xmlns:patch="http://www.sitecore.net/xmlconfig/">
  <sitecore>

    <automationProvider type="Sitecore.Commerce.MarketingAutomation.Providers.AutomationProvider, Sitecore.Commerce.Connect.MarketingAutomation" singleInstance="true"/>

  </sitecore>
</configuration>

現在の実装を拡張するには、IAutomationProvider インターフェイスを実装して、上記の設定を変更できます。

オートメーション プラン プロバイダーは、現在のストアフロントのプランを返します。

AutomationPlanProviderClassDiagram.png

次の表に、使用できるメソッドを示します。

メソッド

説明

GetPlan

指定された shopNamebasePlanName に基づいて、オートメーション プランを返します。デフォルトの実装は、単に shopName と basePlanName を連結して、その名前に一致するプランを返します。何も見つからない場合は、null が返されます。

デフォルトの実装は、次の設定に基づいて動的に読み込まれます。

Sitecore.Commerce.MarketingAutomation.config
<configuration xmlns:patch="http://www.sitecore.net/xmlconfig/">
  <sitecore>

    <automationPlanProvider type="Sitecore.Commerce.MarketingAutomation.Providers.AutomationPlanProvider, Sitecore.Commerce.Connect.MarketingAutomation" singleInstance="true"/>

  </sitecore>
</configuration>

現在の実装を拡張するには、IAutomationPlanProvider インターフェイスを実装して、上記の設定を変更できます。

これらのカスタム値プロバイダーは、プランに登録したときのキャンペーンの状態の一部である追加情報を提供します。現時点では、カートと注文のバージョンが使用可能です。これらは、IAutomationProvider インターフェイスの EnrollCurrentContact メソッドの customValues に渡される値です。

CustomValueProvidersClassDiagram.png

次の表に、使用できるメソッドを示します。

メソッド

説明

GetCustomValues

呼び出されたパイプラインの引数は、入力パラメーターとしてメソッドに渡されます。カートの場合、デフォルトでは以下の情報が返されます。

  • 外部 ID

  • ショップ名

  • シリアル化されたカート

注文の場合、デフォルトでは以下の情報が返されます。

  • 注文 ID

  • 外部 ID

コマース メールの送信マーケティング オートメーション キャンペーン アクティビティは、カスタム値を使用して情報を電子メールのレンダリングに渡し、レンダリングがカートの情報を抽出してマーケティング オートメーション キャンペーンのメールの一部にできるようにします。

重要

Commerce マーケティング オートメーション キャンペーンでは、メールの送信アクションは使用しないでください。