1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5  margin: 0;
6  padding: 0;
7  border: 0;
8  font-weight: inherit;
9  font-style: inherit;
10  font-size: 100%;
11  font-family: inherit;
12  vertical-align: baseline;
13}
14
15body {
16  font-size: 13px;
17  padding: 1em;
18}
19
20h1 {
21  font-size: 26px;
22  margin-bottom: 1em;
23}
24
25h2 {
26  font-size: 24px;
27  margin-bottom: 1em;
28}
29
30h3 {
31  font-size: 20px;
32  margin-bottom: 1em;
33  margin-top: 1em;
34}
35
36pre, code {
37  line-height: 1.5;
38  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42  margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46  font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50  border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54  margin-top: 0.5em;
55}
56
57.firstline {
58  margin-left: 2 em;
59}
60
61.method  {
62  margin-top: 1em;
63  border: solid 1px #CCC;
64  padding: 1em;
65  background: #EEE;
66}
67
68.details {
69  font-weight: bold;
70  font-size: 14px;
71}
72
73</style>
74
75<h1><a href="groupssettings_v1.html">Groups Settings API</a> . <a href="groupssettings_v1.groups.html">groups</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#get">get(groupUniqueId)</a></code></p>
79<p class="firstline">Gets one resource by id.</p>
80<p class="toc_element">
81  <code><a href="#patch">patch(groupUniqueId, body)</a></code></p>
82<p class="firstline">Updates an existing resource. This method supports patch semantics.</p>
83<p class="toc_element">
84  <code><a href="#update">update(groupUniqueId, body)</a></code></p>
85<p class="firstline">Updates an existing resource.</p>
86<h3>Method Details</h3>
87<div class="method">
88    <code class="details" id="get">get(groupUniqueId)</code>
89  <pre>Gets one resource by id.
90
91Args:
92  groupUniqueId: string, The resource ID (required)
93
94Returns:
95  An object of the form:
96
97    { # JSON template for Group resource
98      "allowExternalMembers": "A String", # Are external members allowed to join the group.
99      "whoCanPostMessage": "A String", # Permissions to post messages to the group. Possible values are: NONE_CAN_POST ALL_MANAGERS_CAN_POST ALL_MEMBERS_CAN_POST ALL_IN_DOMAIN_CAN_POST ANYONE_CAN_POST
100      "primaryLanguage": "A String", # Primary language for the group.
101      "whoCanViewMembership": "A String", # Permissions to view membership. Possible values are: ALL_IN_DOMAIN_CAN_VIEW ALL_MEMBERS_CAN_VIEW ALL_MANAGERS_CAN_VIEW
102      "includeCustomFooter": "A String", # Whether to include custom footer.
103      "defaultMessageDenyNotificationText": "A String", # Default message deny notification message
104      "includeInGlobalAddressList": "A String", # If this groups should be included in global address list or not.
105      "archiveOnly": "A String", # If the group is archive only
106      "isArchived": "A String", # If the contents of the group are archived.
107      "membersCanPostAsTheGroup": "A String", # Can members post using the group email address.
108      "allowWebPosting": "A String", # If posting from web is allowed.
109      "email": "A String", # Email id of the group
110      "sendMessageDenyNotification": "A String", # Should the member be notified if his message is denied by owner.
111      "description": "A String", # Description of the group
112      "replyTo": "A String", # Whome should the default reply to a message go to. Possible values are: REPLY_TO_CUSTOM REPLY_TO_SENDER REPLY_TO_LIST REPLY_TO_OWNER REPLY_TO_IGNORE REPLY_TO_MANAGERS
113      "customReplyTo": "A String", # Default email to which reply to any message should go.
114      "messageModerationLevel": "A String", # Moderation level for messages. Possible values are: MODERATE_ALL_MESSAGES MODERATE_NON_MEMBERS MODERATE_NEW_MEMBERS MODERATE_NONE
115      "whoCanContactOwner": "A String", # Permission to contact owner of the group via web UI. Possible values are: ANYONE_CAN_CONTACT ALL_IN_DOMAIN_CAN_CONTACT ALL_MEMBERS_CAN_CONTACT ALL_MANAGERS_CAN_CONTACT
116      "messageDisplayFont": "A String", # Default message display font. Possible values are: DEFAULT_FONT FIXED_WIDTH_FONT
117      "whoCanLeaveGroup": "A String", # Permission to leave the group. Possible values are: ALL_MANAGERS_CAN_LEAVE ALL_MEMBERS_CAN_LEAVE NONE_CAN_LEAVE
118      "whoCanAdd": "A String", # Permissions to add members. Possible values are: ALL_MANAGERS_CAN_ADD ALL_MEMBERS_CAN_ADD NONE_CAN_ADD
119      "whoCanJoin": "A String", # Permissions to join the group. Possible values are: ANYONE_CAN_JOIN ALL_IN_DOMAIN_CAN_JOIN INVITED_CAN_JOIN CAN_REQUEST_TO_JOIN
120      "whoCanInvite": "A String", # Permissions to invite members. Possible values are: ALL_MEMBERS_CAN_INVITE ALL_MANAGERS_CAN_INVITE NONE_CAN_INVITE
121      "kind": "groupsSettings#groups", # The type of the resource.
122      "name": "A String", # Name of the Group
123      "spamModerationLevel": "A String", # Moderation level for messages detected as spam. Possible values are: ALLOW MODERATE SILENTLY_MODERATE REJECT
124      "whoCanViewGroup": "A String", # Permissions to view group. Possible values are: ANYONE_CAN_VIEW ALL_IN_DOMAIN_CAN_VIEW ALL_MEMBERS_CAN_VIEW ALL_MANAGERS_CAN_VIEW
125      "showInGroupDirectory": "A String", # Is the group listed in groups directory
126      "maxMessageBytes": 42, # Maximum message size allowed.
127      "customFooterText": "A String", # Custom footer text.
128      "allowGoogleCommunication": "A String", # Is google allowed to contact admins.
129    }</pre>
130</div>
131
132<div class="method">
133    <code class="details" id="patch">patch(groupUniqueId, body)</code>
134  <pre>Updates an existing resource. This method supports patch semantics.
135
136Args:
137  groupUniqueId: string, The resource ID (required)
138  body: object, The request body. (required)
139    The object takes the form of:
140
141{ # JSON template for Group resource
142    "allowExternalMembers": "A String", # Are external members allowed to join the group.
143    "whoCanPostMessage": "A String", # Permissions to post messages to the group. Possible values are: NONE_CAN_POST ALL_MANAGERS_CAN_POST ALL_MEMBERS_CAN_POST ALL_IN_DOMAIN_CAN_POST ANYONE_CAN_POST
144    "primaryLanguage": "A String", # Primary language for the group.
145    "whoCanViewMembership": "A String", # Permissions to view membership. Possible values are: ALL_IN_DOMAIN_CAN_VIEW ALL_MEMBERS_CAN_VIEW ALL_MANAGERS_CAN_VIEW
146    "includeCustomFooter": "A String", # Whether to include custom footer.
147    "defaultMessageDenyNotificationText": "A String", # Default message deny notification message
148    "includeInGlobalAddressList": "A String", # If this groups should be included in global address list or not.
149    "archiveOnly": "A String", # If the group is archive only
150    "isArchived": "A String", # If the contents of the group are archived.
151    "membersCanPostAsTheGroup": "A String", # Can members post using the group email address.
152    "allowWebPosting": "A String", # If posting from web is allowed.
153    "email": "A String", # Email id of the group
154    "sendMessageDenyNotification": "A String", # Should the member be notified if his message is denied by owner.
155    "description": "A String", # Description of the group
156    "replyTo": "A String", # Whome should the default reply to a message go to. Possible values are: REPLY_TO_CUSTOM REPLY_TO_SENDER REPLY_TO_LIST REPLY_TO_OWNER REPLY_TO_IGNORE REPLY_TO_MANAGERS
157    "customReplyTo": "A String", # Default email to which reply to any message should go.
158    "messageModerationLevel": "A String", # Moderation level for messages. Possible values are: MODERATE_ALL_MESSAGES MODERATE_NON_MEMBERS MODERATE_NEW_MEMBERS MODERATE_NONE
159    "whoCanContactOwner": "A String", # Permission to contact owner of the group via web UI. Possible values are: ANYONE_CAN_CONTACT ALL_IN_DOMAIN_CAN_CONTACT ALL_MEMBERS_CAN_CONTACT ALL_MANAGERS_CAN_CONTACT
160    "messageDisplayFont": "A String", # Default message display font. Possible values are: DEFAULT_FONT FIXED_WIDTH_FONT
161    "whoCanLeaveGroup": "A String", # Permission to leave the group. Possible values are: ALL_MANAGERS_CAN_LEAVE ALL_MEMBERS_CAN_LEAVE NONE_CAN_LEAVE
162    "whoCanAdd": "A String", # Permissions to add members. Possible values are: ALL_MANAGERS_CAN_ADD ALL_MEMBERS_CAN_ADD NONE_CAN_ADD
163    "whoCanJoin": "A String", # Permissions to join the group. Possible values are: ANYONE_CAN_JOIN ALL_IN_DOMAIN_CAN_JOIN INVITED_CAN_JOIN CAN_REQUEST_TO_JOIN
164    "whoCanInvite": "A String", # Permissions to invite members. Possible values are: ALL_MEMBERS_CAN_INVITE ALL_MANAGERS_CAN_INVITE NONE_CAN_INVITE
165    "kind": "groupsSettings#groups", # The type of the resource.
166    "name": "A String", # Name of the Group
167    "spamModerationLevel": "A String", # Moderation level for messages detected as spam. Possible values are: ALLOW MODERATE SILENTLY_MODERATE REJECT
168    "whoCanViewGroup": "A String", # Permissions to view group. Possible values are: ANYONE_CAN_VIEW ALL_IN_DOMAIN_CAN_VIEW ALL_MEMBERS_CAN_VIEW ALL_MANAGERS_CAN_VIEW
169    "showInGroupDirectory": "A String", # Is the group listed in groups directory
170    "maxMessageBytes": 42, # Maximum message size allowed.
171    "customFooterText": "A String", # Custom footer text.
172    "allowGoogleCommunication": "A String", # Is google allowed to contact admins.
173  }
174
175
176Returns:
177  An object of the form:
178
179    { # JSON template for Group resource
180      "allowExternalMembers": "A String", # Are external members allowed to join the group.
181      "whoCanPostMessage": "A String", # Permissions to post messages to the group. Possible values are: NONE_CAN_POST ALL_MANAGERS_CAN_POST ALL_MEMBERS_CAN_POST ALL_IN_DOMAIN_CAN_POST ANYONE_CAN_POST
182      "primaryLanguage": "A String", # Primary language for the group.
183      "whoCanViewMembership": "A String", # Permissions to view membership. Possible values are: ALL_IN_DOMAIN_CAN_VIEW ALL_MEMBERS_CAN_VIEW ALL_MANAGERS_CAN_VIEW
184      "includeCustomFooter": "A String", # Whether to include custom footer.
185      "defaultMessageDenyNotificationText": "A String", # Default message deny notification message
186      "includeInGlobalAddressList": "A String", # If this groups should be included in global address list or not.
187      "archiveOnly": "A String", # If the group is archive only
188      "isArchived": "A String", # If the contents of the group are archived.
189      "membersCanPostAsTheGroup": "A String", # Can members post using the group email address.
190      "allowWebPosting": "A String", # If posting from web is allowed.
191      "email": "A String", # Email id of the group
192      "sendMessageDenyNotification": "A String", # Should the member be notified if his message is denied by owner.
193      "description": "A String", # Description of the group
194      "replyTo": "A String", # Whome should the default reply to a message go to. Possible values are: REPLY_TO_CUSTOM REPLY_TO_SENDER REPLY_TO_LIST REPLY_TO_OWNER REPLY_TO_IGNORE REPLY_TO_MANAGERS
195      "customReplyTo": "A String", # Default email to which reply to any message should go.
196      "messageModerationLevel": "A String", # Moderation level for messages. Possible values are: MODERATE_ALL_MESSAGES MODERATE_NON_MEMBERS MODERATE_NEW_MEMBERS MODERATE_NONE
197      "whoCanContactOwner": "A String", # Permission to contact owner of the group via web UI. Possible values are: ANYONE_CAN_CONTACT ALL_IN_DOMAIN_CAN_CONTACT ALL_MEMBERS_CAN_CONTACT ALL_MANAGERS_CAN_CONTACT
198      "messageDisplayFont": "A String", # Default message display font. Possible values are: DEFAULT_FONT FIXED_WIDTH_FONT
199      "whoCanLeaveGroup": "A String", # Permission to leave the group. Possible values are: ALL_MANAGERS_CAN_LEAVE ALL_MEMBERS_CAN_LEAVE NONE_CAN_LEAVE
200      "whoCanAdd": "A String", # Permissions to add members. Possible values are: ALL_MANAGERS_CAN_ADD ALL_MEMBERS_CAN_ADD NONE_CAN_ADD
201      "whoCanJoin": "A String", # Permissions to join the group. Possible values are: ANYONE_CAN_JOIN ALL_IN_DOMAIN_CAN_JOIN INVITED_CAN_JOIN CAN_REQUEST_TO_JOIN
202      "whoCanInvite": "A String", # Permissions to invite members. Possible values are: ALL_MEMBERS_CAN_INVITE ALL_MANAGERS_CAN_INVITE NONE_CAN_INVITE
203      "kind": "groupsSettings#groups", # The type of the resource.
204      "name": "A String", # Name of the Group
205      "spamModerationLevel": "A String", # Moderation level for messages detected as spam. Possible values are: ALLOW MODERATE SILENTLY_MODERATE REJECT
206      "whoCanViewGroup": "A String", # Permissions to view group. Possible values are: ANYONE_CAN_VIEW ALL_IN_DOMAIN_CAN_VIEW ALL_MEMBERS_CAN_VIEW ALL_MANAGERS_CAN_VIEW
207      "showInGroupDirectory": "A String", # Is the group listed in groups directory
208      "maxMessageBytes": 42, # Maximum message size allowed.
209      "customFooterText": "A String", # Custom footer text.
210      "allowGoogleCommunication": "A String", # Is google allowed to contact admins.
211    }</pre>
212</div>
213
214<div class="method">
215    <code class="details" id="update">update(groupUniqueId, body)</code>
216  <pre>Updates an existing resource.
217
218Args:
219  groupUniqueId: string, The resource ID (required)
220  body: object, The request body. (required)
221    The object takes the form of:
222
223{ # JSON template for Group resource
224    "allowExternalMembers": "A String", # Are external members allowed to join the group.
225    "whoCanPostMessage": "A String", # Permissions to post messages to the group. Possible values are: NONE_CAN_POST ALL_MANAGERS_CAN_POST ALL_MEMBERS_CAN_POST ALL_IN_DOMAIN_CAN_POST ANYONE_CAN_POST
226    "primaryLanguage": "A String", # Primary language for the group.
227    "whoCanViewMembership": "A String", # Permissions to view membership. Possible values are: ALL_IN_DOMAIN_CAN_VIEW ALL_MEMBERS_CAN_VIEW ALL_MANAGERS_CAN_VIEW
228    "includeCustomFooter": "A String", # Whether to include custom footer.
229    "defaultMessageDenyNotificationText": "A String", # Default message deny notification message
230    "includeInGlobalAddressList": "A String", # If this groups should be included in global address list or not.
231    "archiveOnly": "A String", # If the group is archive only
232    "isArchived": "A String", # If the contents of the group are archived.
233    "membersCanPostAsTheGroup": "A String", # Can members post using the group email address.
234    "allowWebPosting": "A String", # If posting from web is allowed.
235    "email": "A String", # Email id of the group
236    "sendMessageDenyNotification": "A String", # Should the member be notified if his message is denied by owner.
237    "description": "A String", # Description of the group
238    "replyTo": "A String", # Whome should the default reply to a message go to. Possible values are: REPLY_TO_CUSTOM REPLY_TO_SENDER REPLY_TO_LIST REPLY_TO_OWNER REPLY_TO_IGNORE REPLY_TO_MANAGERS
239    "customReplyTo": "A String", # Default email to which reply to any message should go.
240    "messageModerationLevel": "A String", # Moderation level for messages. Possible values are: MODERATE_ALL_MESSAGES MODERATE_NON_MEMBERS MODERATE_NEW_MEMBERS MODERATE_NONE
241    "whoCanContactOwner": "A String", # Permission to contact owner of the group via web UI. Possible values are: ANYONE_CAN_CONTACT ALL_IN_DOMAIN_CAN_CONTACT ALL_MEMBERS_CAN_CONTACT ALL_MANAGERS_CAN_CONTACT
242    "messageDisplayFont": "A String", # Default message display font. Possible values are: DEFAULT_FONT FIXED_WIDTH_FONT
243    "whoCanLeaveGroup": "A String", # Permission to leave the group. Possible values are: ALL_MANAGERS_CAN_LEAVE ALL_MEMBERS_CAN_LEAVE NONE_CAN_LEAVE
244    "whoCanAdd": "A String", # Permissions to add members. Possible values are: ALL_MANAGERS_CAN_ADD ALL_MEMBERS_CAN_ADD NONE_CAN_ADD
245    "whoCanJoin": "A String", # Permissions to join the group. Possible values are: ANYONE_CAN_JOIN ALL_IN_DOMAIN_CAN_JOIN INVITED_CAN_JOIN CAN_REQUEST_TO_JOIN
246    "whoCanInvite": "A String", # Permissions to invite members. Possible values are: ALL_MEMBERS_CAN_INVITE ALL_MANAGERS_CAN_INVITE NONE_CAN_INVITE
247    "kind": "groupsSettings#groups", # The type of the resource.
248    "name": "A String", # Name of the Group
249    "spamModerationLevel": "A String", # Moderation level for messages detected as spam. Possible values are: ALLOW MODERATE SILENTLY_MODERATE REJECT
250    "whoCanViewGroup": "A String", # Permissions to view group. Possible values are: ANYONE_CAN_VIEW ALL_IN_DOMAIN_CAN_VIEW ALL_MEMBERS_CAN_VIEW ALL_MANAGERS_CAN_VIEW
251    "showInGroupDirectory": "A String", # Is the group listed in groups directory
252    "maxMessageBytes": 42, # Maximum message size allowed.
253    "customFooterText": "A String", # Custom footer text.
254    "allowGoogleCommunication": "A String", # Is google allowed to contact admins.
255  }
256
257
258Returns:
259  An object of the form:
260
261    { # JSON template for Group resource
262      "allowExternalMembers": "A String", # Are external members allowed to join the group.
263      "whoCanPostMessage": "A String", # Permissions to post messages to the group. Possible values are: NONE_CAN_POST ALL_MANAGERS_CAN_POST ALL_MEMBERS_CAN_POST ALL_IN_DOMAIN_CAN_POST ANYONE_CAN_POST
264      "primaryLanguage": "A String", # Primary language for the group.
265      "whoCanViewMembership": "A String", # Permissions to view membership. Possible values are: ALL_IN_DOMAIN_CAN_VIEW ALL_MEMBERS_CAN_VIEW ALL_MANAGERS_CAN_VIEW
266      "includeCustomFooter": "A String", # Whether to include custom footer.
267      "defaultMessageDenyNotificationText": "A String", # Default message deny notification message
268      "includeInGlobalAddressList": "A String", # If this groups should be included in global address list or not.
269      "archiveOnly": "A String", # If the group is archive only
270      "isArchived": "A String", # If the contents of the group are archived.
271      "membersCanPostAsTheGroup": "A String", # Can members post using the group email address.
272      "allowWebPosting": "A String", # If posting from web is allowed.
273      "email": "A String", # Email id of the group
274      "sendMessageDenyNotification": "A String", # Should the member be notified if his message is denied by owner.
275      "description": "A String", # Description of the group
276      "replyTo": "A String", # Whome should the default reply to a message go to. Possible values are: REPLY_TO_CUSTOM REPLY_TO_SENDER REPLY_TO_LIST REPLY_TO_OWNER REPLY_TO_IGNORE REPLY_TO_MANAGERS
277      "customReplyTo": "A String", # Default email to which reply to any message should go.
278      "messageModerationLevel": "A String", # Moderation level for messages. Possible values are: MODERATE_ALL_MESSAGES MODERATE_NON_MEMBERS MODERATE_NEW_MEMBERS MODERATE_NONE
279      "whoCanContactOwner": "A String", # Permission to contact owner of the group via web UI. Possible values are: ANYONE_CAN_CONTACT ALL_IN_DOMAIN_CAN_CONTACT ALL_MEMBERS_CAN_CONTACT ALL_MANAGERS_CAN_CONTACT
280      "messageDisplayFont": "A String", # Default message display font. Possible values are: DEFAULT_FONT FIXED_WIDTH_FONT
281      "whoCanLeaveGroup": "A String", # Permission to leave the group. Possible values are: ALL_MANAGERS_CAN_LEAVE ALL_MEMBERS_CAN_LEAVE NONE_CAN_LEAVE
282      "whoCanAdd": "A String", # Permissions to add members. Possible values are: ALL_MANAGERS_CAN_ADD ALL_MEMBERS_CAN_ADD NONE_CAN_ADD
283      "whoCanJoin": "A String", # Permissions to join the group. Possible values are: ANYONE_CAN_JOIN ALL_IN_DOMAIN_CAN_JOIN INVITED_CAN_JOIN CAN_REQUEST_TO_JOIN
284      "whoCanInvite": "A String", # Permissions to invite members. Possible values are: ALL_MEMBERS_CAN_INVITE ALL_MANAGERS_CAN_INVITE NONE_CAN_INVITE
285      "kind": "groupsSettings#groups", # The type of the resource.
286      "name": "A String", # Name of the Group
287      "spamModerationLevel": "A String", # Moderation level for messages detected as spam. Possible values are: ALLOW MODERATE SILENTLY_MODERATE REJECT
288      "whoCanViewGroup": "A String", # Permissions to view group. Possible values are: ANYONE_CAN_VIEW ALL_IN_DOMAIN_CAN_VIEW ALL_MEMBERS_CAN_VIEW ALL_MANAGERS_CAN_VIEW
289      "showInGroupDirectory": "A String", # Is the group listed in groups directory
290      "maxMessageBytes": 42, # Maximum message size allowed.
291      "customFooterText": "A String", # Custom footer text.
292      "allowGoogleCommunication": "A String", # Is google allowed to contact admins.
293    }</pre>
294</div>
295
296</body></html>