このガイドでは、EmailPreferences リソースを使用して Merchant Center のメール通知を管理し、アカウントの users が受信するメールの種類を確認する方法について説明します。メール通知の種類の一覧については、EmailPreferences リファレンスをご覧ください。
Merchant API を使用して管理できるのは、自分がユーザーとして追加されているアカウントのメール通知のみです。
メール通知を表示または更新するには、次の値が必要です。
- メールを受信するユーザーのメールアドレス。メールアドレスは、
Userリソースのnameフィールドで確認できます。 - メールの受信を開始または停止するアカウントの販売者 ID。販売者アカウントがアドバンス アカウントで、ユーザーがアドバンス アカウントにアクセスできる場合は、アドバンス アカウントの販売者 ID を使用します。
通知のオプトインとオプトアウト
特定の販売者アカウントのメール通知設定を更新するには、アカウントの merchantId とユーザーのメールアドレスを指定して accounts.v1beta.accounts.users.updateEmailPreference を呼び出します。
ユーザーに送信されるメール通知を制御するには、次の値を使用します。
OPTED_IN: アカウントのメール通知を受け取る。OPTED_OUT: アカウントのメール通知を受け取らない。
特定の販売者アカウントのメール通知をオプトアウトするリクエストの例を次に示します。
PATCH https://merchantapi.googleapis.com/accounts/v1beta/accounts/merchantId/users/emailAddress/emailPreferences
{
"newsAndTips": "OPTED_OUT"
}
既存の通知を表示する
特定のユーザーの現在のメール通知設定を表示するには、accounts.v1beta.accounts.users.getEmailPreferences を呼び出します。
以下にリクエストの例を示します。merchantId はメール通知の対象となるアカウントの販売者 ID、emailAddress はメールを受信するユーザーのメールアドレスです。
GET https://merchantapi.googleapis.com/accounts/v1beta/accounts/merchantId/users/emailAddress/emailPreferences
呼び出しが成功した場合のレスポンスの例を次に示します。
{
"name": "accounts/merchantId/users/emailAddress/emailPreferences",
"newsAndTips": "OPTED_IN"
}
メール通知の詳細については、Merchant Center のメール設定を変更するをご覧ください。