1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="merchantapi_accounts_v1beta.html">Merchant API</a> . <a href="merchantapi_accounts_v1beta.accounts.html">accounts</a> . <a href="merchantapi_accounts_v1beta.accounts.emailPreferences.html">emailPreferences</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#getEmailPreferences">getEmailPreferences(name, x__xgafv=None)</a></code></p>
<p class="firstline">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.</p>
<p class="toc_element">
<code><a href="#updateEmailPreferences">updateEmailPreferences(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the email preferences for a Merchant Center account user. Advanced account users should specify the advanced account rather than a sub-account of the advanced account. 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.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="getEmailPreferences">getEmailPreferences(name, x__xgafv=None)</code>
<pre>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.
}</pre>
</div>
<div class="method">
<code class="details" id="updateEmailPreferences">updateEmailPreferences(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates the email preferences for a Merchant Center account user. Advanced account users should specify the advanced account rather than a sub-account of the advanced account. 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.
}</pre>
</div>
</body></html>
|