Method: accounts.emailPreferences.getEmailPreferences
Stay organized with collections
Save and categorize content based on your preferences.
Returns the email preferences for a Merchant Center account user. This service only permits retrieving and updating email preferences for the authenticated user. Use the name=accounts/*/users/me/emailPreferences alias to get preferences for the authenticated user.
HTTP request
GET https://merchantapi.googleapis.com/accounts/v1beta/{name=accounts/*/users/*/emailPreferences}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
name |
string
Required. The name of the EmailPreferences resource. Format: accounts/{account}/users/{email}/emailPreferences
|
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of EmailPreferences.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/content
For more information, see the OAuth 2.0 Overview.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-05-27 UTC.
[null,null,["Last updated 2025-05-27 UTC."],[[["\u003cp\u003eThis API endpoint retrieves email preferences for a specific Merchant Center account user.\u003c/p\u003e\n"],["\u003cp\u003eOnly authenticated users can access and update their own email preferences using this service.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires the \u003ccode\u003ename\u003c/code\u003e path parameter to identify the user's email preferences resource.\u003c/p\u003e\n"],["\u003cp\u003eSuccessful responses will contain an \u003ccode\u003eEmailPreferences\u003c/code\u003e object with the user's current settings.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization requires the \u003ccode\u003ehttps://www.googleapis.com/auth/content\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"]]],["This document outlines retrieving email preferences for a Merchant Center account user. It uses a `GET` HTTP request to the specified URL, employing gRPC Transcoding syntax. The `name` path parameter is required, following the format `accounts/{account}/users/{email}/emailPreferences`. The request body must be empty. A successful response returns an `EmailPreferences` instance. Authorization requires the `https://www.googleapis.com/auth/content` OAuth scope, and focuses only in the authenticated user.\n"],null,["# Method: accounts.emailPreferences.getEmailPreferences\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nReturns the email preferences for a Merchant Center account user. This service only permits retrieving and updating email preferences for the authenticated user. Use the name=accounts/\\*/users/me/emailPreferences alias to get preferences for the authenticated user.\n\n### HTTP request\n\n`GET https://merchantapi.googleapis.com/accounts/v1beta/{name=accounts/*/users/*/emailPreferences}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|-----------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Required. The name of the `EmailPreferences` resource. Format: `accounts/{account}/users/{email}/emailPreferences` |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains an instance of [EmailPreferences](/merchant/api/reference/rest/accounts_v1beta/accounts.emailPreferences#EmailPreferences).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/content`\n\nFor more information, see the [OAuth 2.0 Overview](/identity/protocols/OAuth2)."]]
