サブスクリプション管理

Email Experience ManagerクライアントAPI

Version:

日本語翻訳に関する免責事項

このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。

Email Experience Manager ClientAPIServiceクラスSitecore.EmailCampaign.Cd.Services.ClientAPIServiceは、EXMが購読と購読解除を処理するために使用されます。これを使用して、リストマネージャーでリストのサブスクリプションを管理し、自動電子メールメッセージを送信できます。

Email Experience ManagerクライアントAPI(ClientApiService)はIOCコンテナに登録されているので、クラスのコンストラクターに挿入するか、次のようにServiceLocatorを使用できます。

IClientApiService _clientApiService;public MyConstructor(IClientApiService clientApiService)
{
  _clientApiService = clientApiService;
}

又は

IClientApiService clientApiService = ServiceLocator.ServiceProvider.GetService< IClientApiService >()

ClientAPIService APIはCDロールにのみ登録されます。また、CDサーバーは、リストマネージャーリストに連絡先を追加または削除したり、EXMキャンペーンを送信したりするように設定されていません。したがって、スケーリングされたサーバーセットアップで作業している場合は、ClientAPIServiceリクエストを使用して、その作業をCMサーバーに委任する必要があります。

次の図は、このプロセスを示しています。

IClientApiServiceでは、次のパブリックメソッドを使用できます。

これらの方法では、ContactIdentifierを使用して、操作を実行する連絡先を識別します。詳細については、「連絡先識別子」および「連絡先の識別」を参照してください。

最初のパブリックメソッドについては、次の表で説明します。

名前：

自動送信メッセージ

形容：

このメソッドは、アクティブ化された自動メールキャンペーン(automatedMessage.MessageId)を連絡先(automatedMessage.ContactIdentifier)に送信し、カスタムトークンのセットとターゲット言語、およびディスパッチ中にメールキャンペーンをレンダリングするときに使用されるカスタムクエリ文字列パラメーターのセットを指定するオプションを提供します。

CustomQueryStringParametersプロパティを使用してAutomatedMessageクラスを拡張し、追加のクエリ文字列パラメーター (IDictionary<string, string> CustomQueryStringParametersなど) をサポートできます。

WebPageMail本文リンクは、GenerateBodyLinkパイプラインに生成されます。このパイプラインは、メールディスパッチ中にEXMがメールキャンペーンコンテンツをダウンロードするためのリンクを生成するときに実行されます。パイプラインは、ベースURLを生成し、既定のクエリ文字列パラメーターを追加してから、カスタムクエリ文字列パラメーターを追加します。例えば：

http://XXXX/?sc_itemid=XXX&sc_lang=XXX&sc_pd_view=XXX&yourParam=someValue&
ec_eq=XXX

この例の .cshtml内に挿入されるコードは次のようになります。

@{
	string customQueryString = Request.Params["yourParam"];
	if (!string.IsNullOrWhiteSpace(customQueryString))
	{
		<div class="customquerystringparameters">@MvcHtmlString.Create(customQueryString)</div>
	}
}

使い：

void SendAutomatedMessage(AutomatedMessage automatedMessage)

2番目のパブリックメソッドについては、次の表で説明します。

名前：	UpdateListサブスクリプション
形容：	この方法では、取引先担当者のリストサブスクリプションを更新できます。メッセージの操作プロパティ (message.ListSubscribeOperation) によって、実行する操作が決まり、次のいずれかの値に設定できます。購読する配信停止アンサブスクライブ・フロム・オールリストに追加リストから削除デフォルトでは、EXMはコンタクトのサブスクリプション解除時にイベントを自動的に登録します。ただし、これは、ClientApiServiceを使用して、購読解除インタラクションデータ(message.UnsubscribeInteractionData)を定義することで実現することもできます。これを行うには、次のパラメーターを設定します。メッセージ。MessageId: メールキャンペーンID メッセージ。InstanceId: メールキャンペーンID メッセージ。ManagerRootId: メールキャンペーンに関連付けられているマネージャールートのID メッセージ。UnsubscribeInteractionData.MessageLanguage: 連絡先がメールキャンペーンを受け取る言語メッセージ。UnsubscribeInteractionData.TestValueIndex: メールキャンペーンがABテストの場合のバリアント番号メッセージ。UnsubscribeInteractionData.EmailAddressHistoryEntryId: EmailAddressHistoryファセットのメールアドレスのID。メモこれらの値は、静的Sitecore.Modules.EmailCampaign.Core.ExmContextにもあります。
オペレーションズ：	購読する	この操作により、取引先担当者 (message.ContactIdentifier) が、キャンペーン (message.MessageId) で定義された最初のセグメント化されていないインクルードリストに追加されます。 message.RequireSubscriptionConfirmationが設定されている場合、EXMは確認メールメッセージを連絡先に送信し、リストに追加する前にサブスクリプションを確認するように求めます。さらに、連絡先はデフォルトのグローバルオプトアウトリストから削除されます。手記この機能は、SubscribeEventパイプラインを実装することで拡張できます。
	配信停止	この操作により、電子メールキャンペーンに含まれるすべての連絡先リスト (message.MessageId) から連絡先 (message.ContactIdentifier) が削除されます。連絡先がリストから正常に登録解除され、マネージャールートでSend unsubscribe confirmationsが有効になっている場合、EXMはStandardMessages.UnsubscribeNotification設定で定義された通知を連絡先に送信します連絡先が含まれていた連絡先リストから連絡先を削除できなかった場合、または連絡先がどのリストにも含まれていない場合、連絡先は代わりにマネージャールートで定義されているグローバルオプトアウトリストに追加されます。この動作は、パイプラインでオーバーライドUnsubscribeFromListできます。手記この機能を拡張するには、UnsubscribeFromListパイプラインを変更します。
	アンサブスクライブ・フロム・オール	この操作により、連絡先(message.ContactIdentifier)が、Eメールキャンペーンのマネージャールート(unsubscribeMessage.MessageId)で定義されたグローバルオプトアウトリストに追加されます。手記 UnsubscribeFromAllEventパイプラインを実装する場合は、この機能を拡張できます。
	リストに追加	この操作により、連絡先 (message.ContactIdentifier) が連絡先リスト (message.ListId) に追加されます
	リストから削除	この操作により、連絡先リスト (message.ListId) から連絡先 (message.ContactIdentifier) が削除されます

この記事を改善するための提案がある場合は、お知らせください!