--- title: "コマースキャンペーン向けのマーケティングオートメーションAPI" slug: "marketing-automation-api-for-commerce-campaigns" abstract: "自動化プロバイダーの概要と利用可能な手法。" --- # コマースキャンペーン向けのマーケティングオートメーションAPI 自動化プロバイダーはすべてのマーケティングオートメーションキャンペーンに共通し、以下の機能を含みます。 - 既存のテンプレートに基づく放棄カートマーケティングオートメーションキャンペーンの作成。 - 既存のテンプレートに基づく新規注文配置マーケティングオートメーションキャンペーンの作成。 - 自動化キャンペーンへの登録に連絡しましょう。 - 自動化キャンペーンからの連絡先削除。 以下のクラス図は、IAutomationProviderとAutomationProviderの関係を示し、それらに含まれるメソッドを一覧にしています。 ![IAutomationProvider.png](https://doc.sitecore.com/api/markdown-image/xp/ja/developers/101/sitecore-experience-commerce/images/IAutomationProvider.png) ## 方法 以下の表は、自動化プロバイダーで利用可能な方法を示しています。 方法 概要 CreateFromTemplate テンプレートに基づいたマーケティングオートメーションキャンペーンを作成します。 shopName キャンペーンが作成されている店舗の名前を表します。 templateName はプラン作成に使われるテンプレートの名前です。 その結果、キャンペーン名は shopName + " " + templateName となります。 \>\[!重要\] \> Commerceのマーケティングオートメーションキャンペーンでは、命名規則 shopName + " " " + templateName に従う必要があります。 EnrollCurrent連絡先 現在の連絡先をプランに登録します。 shopNamebasePlanNameは連結されて、IAutomationPlanProviderで取得する計画名を形成します。 customValues 自動化キャンペーンで連絡先と共に保存される値を表現します。 この方法は、例えば、コンタクトがショッピングサイトのカートとやり取りし、Commerceのマーケティングオートメーションキャンペーンに登録する際に使われます。 計画から連絡先を外す 現在のプランからその連絡先を削除します。例えば、ショッピングカートが提出されて注文に変換されたとき、このメソッドは放棄されたカートキャンペーンから連絡先を削除するために呼び出されます。 現在の連絡先を計画から削除する 現在の接点をプランから削除します。 デフォルトの実装は、以下の構成に基づいて動的に読み込まれます。 現在の実装を拡張するには、IAutomationProviderインターフェースを実装し、上記の構成を変更することができます。 ## オートメーションプランプロバイダー 自動化プランプロバイダーは、現在の店舗のプランを返品する責任があります: ![AutomationPlanProviderClassDiagram.png](https://doc.sitecore.com/api/markdown-image/xp/ja/developers/101/sitecore-experience-commerce/images/AutomationPlanProviderClassDiagram.png) 以下の表は利用可能な方法の詳細を示しています。 方法 概要 GetPlan(ゲットプラン) 与えられた shopName と basePlanNameに基づいて自動化計画を返します。デフォルトの実装は単に shopName と basePlanName を連結し、その名前に合致する計画を返します。もし見つからなければ、null が返されます。 デフォルトの実装は、以下の構成に基づいて動的に読み込まれます。 Sitecore.Commerce.MarketingAutomation.config 現在の実装を拡張するには、IAutomationPlanProviderインターフェースを実装し、上記の構成を変更することができます。 ## オートメーションプラン カスタムバリュープロバイダー これらのカスタムバリュープロバイダーは、プランに登録された際にキャンペーン状態に含まれる追加情報を提供します。現在、カートおよびオーダー用のバージョンが利用可能です。これらはIAutomationProviderインターフェースのEnrollCurrentContactメソッドのcustomValuesに渡される値を含みます。 ![CustomValueProvidersClassDiagram.png](https://doc.sitecore.com/api/markdown-image/xp/ja/developers/101/sitecore-experience-commerce/images/CustomValueProvidersClassDiagram.png) 以下の表は利用可能な方法を示しています。 方法 概要 GetCustomValues 呼び出しされたパイプラインの引数は、メソッドへの入力パラメータとして渡されます。カートリッジの場合、デフォルトで以下の情報が返されます。 - 外部ID - 店名 - シリアル化されたカートリッジ 注文の場合、デフォルトで以下の情報が返されます: - 命令ID - 外部ID **Send Commerce Email**のマーケティングオートメーションキャンペーン活動は、カスタム値を用いてメールレンダリングに情報を渡し、レンダリングがカート情報を抽出してマーケティングオートメーションキャンペーンメールの一部にできるようにします。 \>\[!重要\] \> Commerceのマーケティングオートメーションキャンペーンでは、Sendメールアクションは使わないでください。