コマースキャンペーンのマーケティングオートメーションAPI
このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。
オートメーション プロバイダーは、すべてのマーケティング オートメーション キャンペーンに汎用的であり、次の機能が含まれています。
-
既存のテンプレートに基づく放棄されたカートのマーケティングオートメーションキャンペーンの作成。
-
既存のテンプレートに基づく新規注文マーケティングオートメーションキャンペーンの作成。
-
自動化キャンペーンへの連絡先の登録。
-
自動化キャンペーンからの連絡先の削除。
次のクラス図は、IAutomationProviderとAutomationProviderの関係を示し、それらに含まれるメソッドの一覧を示しています。

メソッド
次の表に、オートメーション プロバイダーで使用できるメソッドを示します。
方式 |
形容 |
---|---|
CreateFromTemplate |
テンプレートに基づいてマーケティングオートメーションキャンペーンを作成します。 shopNameは、キャンペーンが作成されるストアフロントの名前を表します。 templateNameは、プランの作成に使用されるテンプレートの名前です。 結果のキャンペーン名は、shopName + " " + templateNameとなります。 大事な Commerceマーケティング オートメーション キャンペーンでは、shopName + " " + templateNameという命名規則に従う必要があります。 Activatesキャンペーンが作成後すぐにアクティブ化されるかどうかを示します。 マーケティングオートメーションキャンペーンはデフォルトで有効になっています。 |
EnrollCurrentContact |
現在の連絡先をプランに登録します。 shopNameとbasePlanNameは連結されて、IAutomationPlanProviderを介して取得されるプランの名前を形成します。 customValuesは、Automationキャンペーンの連絡先と共に保存される値を表します。 このメソッドは、たとえば、取引先担当者がショッピング サイトのカートを操作して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インターフェイスを実装し、上記の構成を変更します。
自動化プラン プロバイダー
Automation Plan Providerは、現在のストアフロントのプランを返却する責任があります。

次の表に、使用可能なメソッドの詳細を示します。
方式 |
形容 |
---|---|
GetPlan |
指定されたshopNameとbasePlanNameに基づいて自動化プランを返します。デフォルトの実装では、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インターフェイスを実装し、上記の構成を変更します。
Automation Planカスタム値プロバイダー
これらのカスタム値プロバイダーは、プランに登録されたときにキャンペーンの状態の一部である追加情報を提供します。 現在、カートと注文のバージョンが利用可能です。これらは、IAutomationProviderインターフェイスのEnrollCurrentContactメソッドのcustomValuesに渡される値です。

次の表に、使用可能な方法を示します。
方式 |
形容 |
---|---|
GetCustomValues |
呼び出されたパイプラインの引数は、入力パラメータとしてメソッドに渡されます。カートの場合、デフォルトでは、次の情報が返されます。
注文の場合、デフォルトでは、次の情報が返されます。
Send Commerce Emailマーケティング オートメーション キャンペーン アクティビティは、カスタム値を使用してEメール レンダリングに情報を渡し、レンダリングでマーケティング オートメーション キャンペーンEメールの一部となるカート情報を抽出できるようにします。 大事な Commerceマーケティング オートメーション キャンペーンでは、メールの送信 アクションを使用しないでください。 |