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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
|
<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="groupssettings_v1.html">Groups Settings API</a> . <a href="groupssettings_v1.groups.html">groups</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(groupUniqueId)</a></code></p>
<p class="firstline">Gets one resource by id.</p>
<p class="toc_element">
<code><a href="#patch">patch(groupUniqueId, body)</a></code></p>
<p class="firstline">Updates an existing resource. This method supports patch semantics.</p>
<p class="toc_element">
<code><a href="#update">update(groupUniqueId, body)</a></code></p>
<p class="firstline">Updates an existing resource.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="get">get(groupUniqueId)</code>
<pre>Gets one resource by id.
Args:
groupUniqueId: string, The resource ID (required)
Returns:
An object of the form:
{ # JSON template for Group resource
"allowExternalMembers": "A String", # Are external members allowed to join the group.
"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
"primaryLanguage": "A String", # Primary language for the group.
"whoCanViewMembership": "A String", # Permissions to view membership. Possible values are: ALL_IN_DOMAIN_CAN_VIEW ALL_MEMBERS_CAN_VIEW ALL_MANAGERS_CAN_VIEW
"includeCustomFooter": "A String", # Whether to include custom footer.
"defaultMessageDenyNotificationText": "A String", # Default message deny notification message
"includeInGlobalAddressList": "A String", # If this groups should be included in global address list or not.
"archiveOnly": "A String", # If the group is archive only
"isArchived": "A String", # If the contents of the group are archived.
"membersCanPostAsTheGroup": "A String", # Can members post using the group email address.
"allowWebPosting": "A String", # If posting from web is allowed.
"email": "A String", # Email id of the group
"sendMessageDenyNotification": "A String", # Should the member be notified if his message is denied by owner.
"description": "A String", # Description of the group
"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
"customReplyTo": "A String", # Default email to which reply to any message should go.
"messageModerationLevel": "A String", # Moderation level for messages. Possible values are: MODERATE_ALL_MESSAGES MODERATE_NON_MEMBERS MODERATE_NEW_MEMBERS MODERATE_NONE
"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
"messageDisplayFont": "A String", # Default message display font. Possible values are: DEFAULT_FONT FIXED_WIDTH_FONT
"whoCanLeaveGroup": "A String", # Permission to leave the group. Possible values are: ALL_MANAGERS_CAN_LEAVE ALL_MEMBERS_CAN_LEAVE NONE_CAN_LEAVE
"whoCanAdd": "A String", # Permissions to add members. Possible values are: ALL_MANAGERS_CAN_ADD ALL_MEMBERS_CAN_ADD NONE_CAN_ADD
"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
"whoCanInvite": "A String", # Permissions to invite members. Possible values are: ALL_MEMBERS_CAN_INVITE ALL_MANAGERS_CAN_INVITE NONE_CAN_INVITE
"kind": "groupsSettings#groups", # The type of the resource.
"name": "A String", # Name of the Group
"spamModerationLevel": "A String", # Moderation level for messages detected as spam. Possible values are: ALLOW MODERATE SILENTLY_MODERATE REJECT
"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
"showInGroupDirectory": "A String", # Is the group listed in groups directory
"maxMessageBytes": 42, # Maximum message size allowed.
"customFooterText": "A String", # Custom footer text.
"allowGoogleCommunication": "A String", # Is google allowed to contact admins.
}</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(groupUniqueId, body)</code>
<pre>Updates an existing resource. This method supports patch semantics.
Args:
groupUniqueId: string, The resource ID (required)
body: object, The request body. (required)
The object takes the form of:
{ # JSON template for Group resource
"allowExternalMembers": "A String", # Are external members allowed to join the group.
"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
"primaryLanguage": "A String", # Primary language for the group.
"whoCanViewMembership": "A String", # Permissions to view membership. Possible values are: ALL_IN_DOMAIN_CAN_VIEW ALL_MEMBERS_CAN_VIEW ALL_MANAGERS_CAN_VIEW
"includeCustomFooter": "A String", # Whether to include custom footer.
"defaultMessageDenyNotificationText": "A String", # Default message deny notification message
"includeInGlobalAddressList": "A String", # If this groups should be included in global address list or not.
"archiveOnly": "A String", # If the group is archive only
"isArchived": "A String", # If the contents of the group are archived.
"membersCanPostAsTheGroup": "A String", # Can members post using the group email address.
"allowWebPosting": "A String", # If posting from web is allowed.
"email": "A String", # Email id of the group
"sendMessageDenyNotification": "A String", # Should the member be notified if his message is denied by owner.
"description": "A String", # Description of the group
"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
"customReplyTo": "A String", # Default email to which reply to any message should go.
"messageModerationLevel": "A String", # Moderation level for messages. Possible values are: MODERATE_ALL_MESSAGES MODERATE_NON_MEMBERS MODERATE_NEW_MEMBERS MODERATE_NONE
"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
"messageDisplayFont": "A String", # Default message display font. Possible values are: DEFAULT_FONT FIXED_WIDTH_FONT
"whoCanLeaveGroup": "A String", # Permission to leave the group. Possible values are: ALL_MANAGERS_CAN_LEAVE ALL_MEMBERS_CAN_LEAVE NONE_CAN_LEAVE
"whoCanAdd": "A String", # Permissions to add members. Possible values are: ALL_MANAGERS_CAN_ADD ALL_MEMBERS_CAN_ADD NONE_CAN_ADD
"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
"whoCanInvite": "A String", # Permissions to invite members. Possible values are: ALL_MEMBERS_CAN_INVITE ALL_MANAGERS_CAN_INVITE NONE_CAN_INVITE
"kind": "groupsSettings#groups", # The type of the resource.
"name": "A String", # Name of the Group
"spamModerationLevel": "A String", # Moderation level for messages detected as spam. Possible values are: ALLOW MODERATE SILENTLY_MODERATE REJECT
"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
"showInGroupDirectory": "A String", # Is the group listed in groups directory
"maxMessageBytes": 42, # Maximum message size allowed.
"customFooterText": "A String", # Custom footer text.
"allowGoogleCommunication": "A String", # Is google allowed to contact admins.
}
Returns:
An object of the form:
{ # JSON template for Group resource
"allowExternalMembers": "A String", # Are external members allowed to join the group.
"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
"primaryLanguage": "A String", # Primary language for the group.
"whoCanViewMembership": "A String", # Permissions to view membership. Possible values are: ALL_IN_DOMAIN_CAN_VIEW ALL_MEMBERS_CAN_VIEW ALL_MANAGERS_CAN_VIEW
"includeCustomFooter": "A String", # Whether to include custom footer.
"defaultMessageDenyNotificationText": "A String", # Default message deny notification message
"includeInGlobalAddressList": "A String", # If this groups should be included in global address list or not.
"archiveOnly": "A String", # If the group is archive only
"isArchived": "A String", # If the contents of the group are archived.
"membersCanPostAsTheGroup": "A String", # Can members post using the group email address.
"allowWebPosting": "A String", # If posting from web is allowed.
"email": "A String", # Email id of the group
"sendMessageDenyNotification": "A String", # Should the member be notified if his message is denied by owner.
"description": "A String", # Description of the group
"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
"customReplyTo": "A String", # Default email to which reply to any message should go.
"messageModerationLevel": "A String", # Moderation level for messages. Possible values are: MODERATE_ALL_MESSAGES MODERATE_NON_MEMBERS MODERATE_NEW_MEMBERS MODERATE_NONE
"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
"messageDisplayFont": "A String", # Default message display font. Possible values are: DEFAULT_FONT FIXED_WIDTH_FONT
"whoCanLeaveGroup": "A String", # Permission to leave the group. Possible values are: ALL_MANAGERS_CAN_LEAVE ALL_MEMBERS_CAN_LEAVE NONE_CAN_LEAVE
"whoCanAdd": "A String", # Permissions to add members. Possible values are: ALL_MANAGERS_CAN_ADD ALL_MEMBERS_CAN_ADD NONE_CAN_ADD
"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
"whoCanInvite": "A String", # Permissions to invite members. Possible values are: ALL_MEMBERS_CAN_INVITE ALL_MANAGERS_CAN_INVITE NONE_CAN_INVITE
"kind": "groupsSettings#groups", # The type of the resource.
"name": "A String", # Name of the Group
"spamModerationLevel": "A String", # Moderation level for messages detected as spam. Possible values are: ALLOW MODERATE SILENTLY_MODERATE REJECT
"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
"showInGroupDirectory": "A String", # Is the group listed in groups directory
"maxMessageBytes": 42, # Maximum message size allowed.
"customFooterText": "A String", # Custom footer text.
"allowGoogleCommunication": "A String", # Is google allowed to contact admins.
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(groupUniqueId, body)</code>
<pre>Updates an existing resource.
Args:
groupUniqueId: string, The resource ID (required)
body: object, The request body. (required)
The object takes the form of:
{ # JSON template for Group resource
"allowExternalMembers": "A String", # Are external members allowed to join the group.
"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
"primaryLanguage": "A String", # Primary language for the group.
"whoCanViewMembership": "A String", # Permissions to view membership. Possible values are: ALL_IN_DOMAIN_CAN_VIEW ALL_MEMBERS_CAN_VIEW ALL_MANAGERS_CAN_VIEW
"includeCustomFooter": "A String", # Whether to include custom footer.
"defaultMessageDenyNotificationText": "A String", # Default message deny notification message
"includeInGlobalAddressList": "A String", # If this groups should be included in global address list or not.
"archiveOnly": "A String", # If the group is archive only
"isArchived": "A String", # If the contents of the group are archived.
"membersCanPostAsTheGroup": "A String", # Can members post using the group email address.
"allowWebPosting": "A String", # If posting from web is allowed.
"email": "A String", # Email id of the group
"sendMessageDenyNotification": "A String", # Should the member be notified if his message is denied by owner.
"description": "A String", # Description of the group
"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
"customReplyTo": "A String", # Default email to which reply to any message should go.
"messageModerationLevel": "A String", # Moderation level for messages. Possible values are: MODERATE_ALL_MESSAGES MODERATE_NON_MEMBERS MODERATE_NEW_MEMBERS MODERATE_NONE
"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
"messageDisplayFont": "A String", # Default message display font. Possible values are: DEFAULT_FONT FIXED_WIDTH_FONT
"whoCanLeaveGroup": "A String", # Permission to leave the group. Possible values are: ALL_MANAGERS_CAN_LEAVE ALL_MEMBERS_CAN_LEAVE NONE_CAN_LEAVE
"whoCanAdd": "A String", # Permissions to add members. Possible values are: ALL_MANAGERS_CAN_ADD ALL_MEMBERS_CAN_ADD NONE_CAN_ADD
"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
"whoCanInvite": "A String", # Permissions to invite members. Possible values are: ALL_MEMBERS_CAN_INVITE ALL_MANAGERS_CAN_INVITE NONE_CAN_INVITE
"kind": "groupsSettings#groups", # The type of the resource.
"name": "A String", # Name of the Group
"spamModerationLevel": "A String", # Moderation level for messages detected as spam. Possible values are: ALLOW MODERATE SILENTLY_MODERATE REJECT
"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
"showInGroupDirectory": "A String", # Is the group listed in groups directory
"maxMessageBytes": 42, # Maximum message size allowed.
"customFooterText": "A String", # Custom footer text.
"allowGoogleCommunication": "A String", # Is google allowed to contact admins.
}
Returns:
An object of the form:
{ # JSON template for Group resource
"allowExternalMembers": "A String", # Are external members allowed to join the group.
"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
"primaryLanguage": "A String", # Primary language for the group.
"whoCanViewMembership": "A String", # Permissions to view membership. Possible values are: ALL_IN_DOMAIN_CAN_VIEW ALL_MEMBERS_CAN_VIEW ALL_MANAGERS_CAN_VIEW
"includeCustomFooter": "A String", # Whether to include custom footer.
"defaultMessageDenyNotificationText": "A String", # Default message deny notification message
"includeInGlobalAddressList": "A String", # If this groups should be included in global address list or not.
"archiveOnly": "A String", # If the group is archive only
"isArchived": "A String", # If the contents of the group are archived.
"membersCanPostAsTheGroup": "A String", # Can members post using the group email address.
"allowWebPosting": "A String", # If posting from web is allowed.
"email": "A String", # Email id of the group
"sendMessageDenyNotification": "A String", # Should the member be notified if his message is denied by owner.
"description": "A String", # Description of the group
"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
"customReplyTo": "A String", # Default email to which reply to any message should go.
"messageModerationLevel": "A String", # Moderation level for messages. Possible values are: MODERATE_ALL_MESSAGES MODERATE_NON_MEMBERS MODERATE_NEW_MEMBERS MODERATE_NONE
"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
"messageDisplayFont": "A String", # Default message display font. Possible values are: DEFAULT_FONT FIXED_WIDTH_FONT
"whoCanLeaveGroup": "A String", # Permission to leave the group. Possible values are: ALL_MANAGERS_CAN_LEAVE ALL_MEMBERS_CAN_LEAVE NONE_CAN_LEAVE
"whoCanAdd": "A String", # Permissions to add members. Possible values are: ALL_MANAGERS_CAN_ADD ALL_MEMBERS_CAN_ADD NONE_CAN_ADD
"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
"whoCanInvite": "A String", # Permissions to invite members. Possible values are: ALL_MEMBERS_CAN_INVITE ALL_MANAGERS_CAN_INVITE NONE_CAN_INVITE
"kind": "groupsSettings#groups", # The type of the resource.
"name": "A String", # Name of the Group
"spamModerationLevel": "A String", # Moderation level for messages detected as spam. Possible values are: ALLOW MODERATE SILENTLY_MODERATE REJECT
"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
"showInGroupDirectory": "A String", # Is the group listed in groups directory
"maxMessageBytes": 42, # Maximum message size allowed.
"customFooterText": "A String", # Custom footer text.
"allowGoogleCommunication": "A String", # Is google allowed to contact admins.
}</pre>
</div>
</body></html>
|
