Merchant API . accounts . emailPreferences

close()

Close httplib2 connections.

getEmailPreferences(name, x__xgafv=None)

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.

Args:
  name: string, Required. The name of the `EmailPreferences` resource. Format: `accounts/{account}/users/{email}/emailPreferences` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The categories of notifications the user opted into / opted out of. The email preferences do not include mandatory announcements as users can't opt out of them.
  "name": "A String", # Identifier. The name of the EmailPreferences. The endpoint is only supported for the authenticated user.
  "newsAndTips": "A String", # Optional. Updates on new features, tips and best practices.
}

updateEmailPreferences(name, body=None, updateMask=None, x__xgafv=None)

Updates the email preferences for a Merchant Center account user. MCA users should specify the MCA account rather than a sub-account of the MCA. Preferences which are not explicitly selected in the update mask will not be updated. It is invalid for updates to specify an UNCONFIRMED opt-in status value. Use the name=accounts/*/users/me/emailPreferences alias to update preferences for the authenticated user.

Args:
  name: string, Identifier. The name of the EmailPreferences. The endpoint is only supported for the authenticated user. (required)
  body: object, The request body.
    The object takes the form of:

{ # The categories of notifications the user opted into / opted out of. The email preferences do not include mandatory announcements as users can't opt out of them.
  "name": "A String", # Identifier. The name of the EmailPreferences. The endpoint is only supported for the authenticated user.
  "newsAndTips": "A String", # Optional. Updates on new features, tips and best practices.
}

  updateMask: string, Required. List of fields being updated. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `news_and_tips`
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The categories of notifications the user opted into / opted out of. The email preferences do not include mandatory announcements as users can't opt out of them.
  "name": "A String", # Identifier. The name of the EmailPreferences. The endpoint is only supported for the authenticated user.
  "newsAndTips": "A String", # Optional. Updates on new features, tips and best practices.
}