Skip to content

ユーザー設定センターの作成

post

/preference_center/v1

このエンドポイントを使用してユーザー設定センターを作成し、ユーザーs がメール キャンペーンs の通知設定を管理できるようにします。API で生成されるユーザー設定センターの構築方法のステップについては、API を使用したユーザー設定センターの作成を参照してください。

前提条件

このエンドポイントを使用するには、API キーpreference_center.updateの権限が必要です。

レート制限

このエンドポイントには、1分あたり、ワークスペースあたり、10件のリクエストというレート制限があります。

要求本文:

リクエストパラメーター

パラメーター required データ型 説明
name 必須 文字列 次の条件を満たすユーザー設定センターの名前。
- 文字、数字、ハイフン、およびアンダースコアのみを含む
- スペースがない
preference_center_title オプション 文字列 ユーザー設定センターおよび確定ページのタイトル。タイトルが指定されていない場合、ページのタイトルはデフォルトで「ユーザー設定センター」になります。
preference_center_page_html 必須 文字列 ユーザー設定センター画面のHTMLです。
confirmation_page_html 必須 文字列 確定画面のHTML。
state オプション 文字列 active またはdraft を選択する。指定がない場合のデフォルトはactive である。
options オプション オブジェクト 属性:
meta-viewport-content:存在する場合、viewport メタタグがcontent= <value of attribute> でページに追加されます。

link-tags:ページのファビコンを設定します。設定すると、rel 属性を持つ<link> タグがページに追加されます。

Liquid タグ

ユーザー設定センター画面でユーザーのサブスクリプションステートを生成するには、HTMLに含めることができる以下のリキッドタグを参照してください。

ユーザーサブスクリプションの状態

Liquid 説明
{{subscribed_state.${email_global}}} ユーザーのグローバルメールのサブスクリプション状態を取得します (“opted_in”、”subscribed” または “unsubscribed” など)。
{{subscribed_state.${<subscription_group_id>}}} ユーザーの指定されたサブスクリプショングループのサブスクリプション状態を取得します (“subscribed” や “unsubscribed” など)。

フォームのインプットとアクション

Liquid 説明
{% form_field_name :email_global_state %} 特定のフォーム入力要素が、ユーザーのグローバルメール購読状態に対応することを示します。ユーザーの選択状態は、グローバルメールのサブスクリプション状態の選択データとともにフォームが送信されるときに、”opted_in”、”subscribed” または “unsubscribed” でなければなりません。これがチェックボックスの場合、ユーザーは “opted_in” または “unsubscribed” のいずれかになります。非表示入力の場合、”subscribed”state も有効になります。
{% form_field_name :subscription_group <subscription_group_id> %} 指定したフォーム入力要素が指定したサブスクリプショングループに対応することを示します。ユーザーの選択状態は、特定のサブスクリプショングループの選択データとともにフォームが送信されるときに、”subscribed” または “unsubscribed” のいずれかでなければなりません。
{{preference_center_submit_url}} フォーム送信用のURL を生成します。

回答例

ユーザー設定センターの作成

フォーム入力のHTML

「このページはどの程度役に立ちましたか?」
New Stuff!