Method: accounts.emailPreferences.getEmailPreferences

Page Summary

• This API endpoint retrieves email preferences for a specific Merchant Center account user.

• Only authenticated users can access and update their own email preferences using this service.

• The request requires the name path parameter to identify the user's email preferences resource.

• Successful responses will contain an EmailPreferences object with the user's current settings.

• Authorization requires the https://www.googleapis.com/auth/content OAuth scope.

• HTTP request
• Path parameters
• Request body
• Response body
• Authorization scopes
• Try it!

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.