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
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
|
<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="people_v1.html">People API</a> . <a href="people_v1.contactGroups.html">contactGroups</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="people_v1.contactGroups.members.html">members()</a></code>
</p>
<p class="firstline">Returns the members Resource.</p>
<p class="toc_element">
<code><a href="#batchGet">batchGet(groupFields=None, maxMembers=None, resourceNames=None, x__xgafv=None)</a></code></p>
<p class="firstline">Get a list of contact groups owned by the authenticated user by specifying a list of contact group resource names.</p>
<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="#create">create(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Create a new contact group owned by the authenticated user. Created contact group names must be unique to the users contact groups. Attempting to create a group with a duplicate name will return a HTTP 409 error. Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.</p>
<p class="toc_element">
<code><a href="#delete">delete(resourceName, deleteContacts=None, x__xgafv=None)</a></code></p>
<p class="firstline">Delete an existing contact group owned by the authenticated user by specifying a contact group resource name. Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.</p>
<p class="toc_element">
<code><a href="#get">get(resourceName, groupFields=None, maxMembers=None, x__xgafv=None)</a></code></p>
<p class="firstline">Get a specific contact group owned by the authenticated user by specifying a contact group resource name.</p>
<p class="toc_element">
<code><a href="#list">list(groupFields=None, pageSize=None, pageToken=None, syncToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">List all contact groups owned by the authenticated user. Members of the contact groups are not populated.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#update">update(resourceName, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Update the name of an existing contact group owned by the authenticated user. Updated contact group names must be unique to the users contact groups. Attempting to create a group with a duplicate name will return a HTTP 409 error. Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="batchGet">batchGet(groupFields=None, maxMembers=None, resourceNames=None, x__xgafv=None)</code>
<pre>Get a list of contact groups owned by the authenticated user by specifying a list of contact group resource names.
Args:
groupFields: string, Optional. A field mask to restrict which fields on the group are returned. Defaults to `metadata`, `groupType`, `memberCount`, and `name` if not set or set to empty. Valid fields are: * clientData * groupType * memberCount * metadata * name
maxMembers: integer, Optional. Specifies the maximum number of members to return for each group. Defaults to 0 if not set, which will return zero members.
resourceNames: string, Required. The resource names of the contact groups to get. There is a maximum of 200 resource names. (repeated)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response to a batch get contact groups request.
"responses": [ # The list of responses for each requested contact group resource.
{ # The response for a specific contact group.
"contactGroup": { # A contact group. # The contact group.
"clientData": [ # The group's client data.
{ # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.
"key": "A String", # The client specified key of the client data.
"value": "A String", # The client specified value of the client data.
},
],
"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
"formattedName": "A String", # Output only. The name translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale for system groups names. Group names set by the owner are the same as name.
"groupType": "A String", # Output only. The contact group type.
"memberCount": 42, # Output only. The total number of contacts in the group irrespective of max members in specified in the request.
"memberResourceNames": [ # Output only. The list of contact person resource names that are members of the contact group. The field is only populated for GET requests and will only return as many members as `maxMembers` in the get request.
"A String",
],
"metadata": { # The metadata about a contact group. # Output only. Metadata about the contact group.
"deleted": True or False, # Output only. True if the contact group resource has been deleted. Populated only for [`ListContactGroups`](/people/api/rest/v1/contactgroups/list) requests that include a sync token.
"updateTime": "A String", # Output only. The time the group was last updated.
},
"name": "A String", # The contact group name set by the group owner or a system provided name for system groups. For [`contactGroups.create`](/people/api/rest/v1/contactGroups/create) or [`contactGroups.update`](/people/api/rest/v1/contactGroups/update) the name must be unique to the users contact groups. Attempting to create a group with a duplicate name will return a HTTP 409 error.
"resourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`.
},
"requestedResourceName": "A String", # The original requested resource name.
"status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The status of the response.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(body=None, x__xgafv=None)</code>
<pre>Create a new contact group owned by the authenticated user. Created contact group names must be unique to the users contact groups. Attempting to create a group with a duplicate name will return a HTTP 409 error. Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.
Args:
body: object, The request body.
The object takes the form of:
{ # A request to create a new contact group.
"contactGroup": { # A contact group. # Required. The contact group to create.
"clientData": [ # The group's client data.
{ # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.
"key": "A String", # The client specified key of the client data.
"value": "A String", # The client specified value of the client data.
},
],
"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
"formattedName": "A String", # Output only. The name translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale for system groups names. Group names set by the owner are the same as name.
"groupType": "A String", # Output only. The contact group type.
"memberCount": 42, # Output only. The total number of contacts in the group irrespective of max members in specified in the request.
"memberResourceNames": [ # Output only. The list of contact person resource names that are members of the contact group. The field is only populated for GET requests and will only return as many members as `maxMembers` in the get request.
"A String",
],
"metadata": { # The metadata about a contact group. # Output only. Metadata about the contact group.
"deleted": True or False, # Output only. True if the contact group resource has been deleted. Populated only for [`ListContactGroups`](/people/api/rest/v1/contactgroups/list) requests that include a sync token.
"updateTime": "A String", # Output only. The time the group was last updated.
},
"name": "A String", # The contact group name set by the group owner or a system provided name for system groups. For [`contactGroups.create`](/people/api/rest/v1/contactGroups/create) or [`contactGroups.update`](/people/api/rest/v1/contactGroups/update) the name must be unique to the users contact groups. Attempting to create a group with a duplicate name will return a HTTP 409 error.
"resourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`.
},
"readGroupFields": "A String", # Optional. A field mask to restrict which fields on the group are returned. Defaults to `metadata`, `groupType`, and `name` if not set or set to empty. Valid fields are: * clientData * groupType * metadata * name
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A contact group.
"clientData": [ # The group's client data.
{ # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.
"key": "A String", # The client specified key of the client data.
"value": "A String", # The client specified value of the client data.
},
],
"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
"formattedName": "A String", # Output only. The name translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale for system groups names. Group names set by the owner are the same as name.
"groupType": "A String", # Output only. The contact group type.
"memberCount": 42, # Output only. The total number of contacts in the group irrespective of max members in specified in the request.
"memberResourceNames": [ # Output only. The list of contact person resource names that are members of the contact group. The field is only populated for GET requests and will only return as many members as `maxMembers` in the get request.
"A String",
],
"metadata": { # The metadata about a contact group. # Output only. Metadata about the contact group.
"deleted": True or False, # Output only. True if the contact group resource has been deleted. Populated only for [`ListContactGroups`](/people/api/rest/v1/contactgroups/list) requests that include a sync token.
"updateTime": "A String", # Output only. The time the group was last updated.
},
"name": "A String", # The contact group name set by the group owner or a system provided name for system groups. For [`contactGroups.create`](/people/api/rest/v1/contactGroups/create) or [`contactGroups.update`](/people/api/rest/v1/contactGroups/update) the name must be unique to the users contact groups. Attempting to create a group with a duplicate name will return a HTTP 409 error.
"resourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(resourceName, deleteContacts=None, x__xgafv=None)</code>
<pre>Delete an existing contact group owned by the authenticated user by specifying a contact group resource name. Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.
Args:
resourceName: string, Required. The resource name of the contact group to delete. (required)
deleteContacts: boolean, Optional. Set to true to also delete the contacts in the specified group.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(resourceName, groupFields=None, maxMembers=None, x__xgafv=None)</code>
<pre>Get a specific contact group owned by the authenticated user by specifying a contact group resource name.
Args:
resourceName: string, Required. The resource name of the contact group to get. (required)
groupFields: string, Optional. A field mask to restrict which fields on the group are returned. Defaults to `metadata`, `groupType`, `memberCount`, and `name` if not set or set to empty. Valid fields are: * clientData * groupType * memberCount * metadata * name
maxMembers: integer, Optional. Specifies the maximum number of members to return. Defaults to 0 if not set, which will return zero members.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A contact group.
"clientData": [ # The group's client data.
{ # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.
"key": "A String", # The client specified key of the client data.
"value": "A String", # The client specified value of the client data.
},
],
"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
"formattedName": "A String", # Output only. The name translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale for system groups names. Group names set by the owner are the same as name.
"groupType": "A String", # Output only. The contact group type.
"memberCount": 42, # Output only. The total number of contacts in the group irrespective of max members in specified in the request.
"memberResourceNames": [ # Output only. The list of contact person resource names that are members of the contact group. The field is only populated for GET requests and will only return as many members as `maxMembers` in the get request.
"A String",
],
"metadata": { # The metadata about a contact group. # Output only. Metadata about the contact group.
"deleted": True or False, # Output only. True if the contact group resource has been deleted. Populated only for [`ListContactGroups`](/people/api/rest/v1/contactgroups/list) requests that include a sync token.
"updateTime": "A String", # Output only. The time the group was last updated.
},
"name": "A String", # The contact group name set by the group owner or a system provided name for system groups. For [`contactGroups.create`](/people/api/rest/v1/contactGroups/create) or [`contactGroups.update`](/people/api/rest/v1/contactGroups/update) the name must be unique to the users contact groups. Attempting to create a group with a duplicate name will return a HTTP 409 error.
"resourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(groupFields=None, pageSize=None, pageToken=None, syncToken=None, x__xgafv=None)</code>
<pre>List all contact groups owned by the authenticated user. Members of the contact groups are not populated.
Args:
groupFields: string, Optional. A field mask to restrict which fields on the group are returned. Defaults to `metadata`, `groupType`, `memberCount`, and `name` if not set or set to empty. Valid fields are: * clientData * groupType * memberCount * metadata * name
pageSize: integer, Optional. The maximum number of resources to return. Valid values are between 1 and 1000, inclusive. Defaults to 30 if not set or set to 0.
pageToken: string, Optional. The next_page_token value returned from a previous call to [ListContactGroups](/people/api/rest/v1/contactgroups/list). Requests the next page of resources.
syncToken: string, Optional. A sync token, returned by a previous call to `contactgroups.list`. Only resources changed since the sync token was created will be returned.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response to a list contact groups request.
"contactGroups": [ # The list of contact groups. Members of the contact groups are not populated.
{ # A contact group.
"clientData": [ # The group's client data.
{ # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.
"key": "A String", # The client specified key of the client data.
"value": "A String", # The client specified value of the client data.
},
],
"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
"formattedName": "A String", # Output only. The name translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale for system groups names. Group names set by the owner are the same as name.
"groupType": "A String", # Output only. The contact group type.
"memberCount": 42, # Output only. The total number of contacts in the group irrespective of max members in specified in the request.
"memberResourceNames": [ # Output only. The list of contact person resource names that are members of the contact group. The field is only populated for GET requests and will only return as many members as `maxMembers` in the get request.
"A String",
],
"metadata": { # The metadata about a contact group. # Output only. Metadata about the contact group.
"deleted": True or False, # Output only. True if the contact group resource has been deleted. Populated only for [`ListContactGroups`](/people/api/rest/v1/contactgroups/list) requests that include a sync token.
"updateTime": "A String", # Output only. The time the group was last updated.
},
"name": "A String", # The contact group name set by the group owner or a system provided name for system groups. For [`contactGroups.create`](/people/api/rest/v1/contactGroups/create) or [`contactGroups.update`](/people/api/rest/v1/contactGroups/update) the name must be unique to the users contact groups. Attempting to create a group with a duplicate name will return a HTTP 409 error.
"resourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`.
},
],
"nextPageToken": "A String", # The token that can be used to retrieve the next page of results.
"nextSyncToken": "A String", # The token that can be used to retrieve changes since the last request.
"totalItems": 42, # The total number of items in the list without pagination.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="update">update(resourceName, body=None, x__xgafv=None)</code>
<pre>Update the name of an existing contact group owned by the authenticated user. Updated contact group names must be unique to the users contact groups. Attempting to create a group with a duplicate name will return a HTTP 409 error. Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.
Args:
resourceName: string, The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`. (required)
body: object, The request body.
The object takes the form of:
{ # A request to update an existing user contact group. All updated fields will be replaced.
"contactGroup": { # A contact group. # Required. The contact group to update.
"clientData": [ # The group's client data.
{ # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.
"key": "A String", # The client specified key of the client data.
"value": "A String", # The client specified value of the client data.
},
],
"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
"formattedName": "A String", # Output only. The name translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale for system groups names. Group names set by the owner are the same as name.
"groupType": "A String", # Output only. The contact group type.
"memberCount": 42, # Output only. The total number of contacts in the group irrespective of max members in specified in the request.
"memberResourceNames": [ # Output only. The list of contact person resource names that are members of the contact group. The field is only populated for GET requests and will only return as many members as `maxMembers` in the get request.
"A String",
],
"metadata": { # The metadata about a contact group. # Output only. Metadata about the contact group.
"deleted": True or False, # Output only. True if the contact group resource has been deleted. Populated only for [`ListContactGroups`](/people/api/rest/v1/contactgroups/list) requests that include a sync token.
"updateTime": "A String", # Output only. The time the group was last updated.
},
"name": "A String", # The contact group name set by the group owner or a system provided name for system groups. For [`contactGroups.create`](/people/api/rest/v1/contactGroups/create) or [`contactGroups.update`](/people/api/rest/v1/contactGroups/update) the name must be unique to the users contact groups. Attempting to create a group with a duplicate name will return a HTTP 409 error.
"resourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`.
},
"readGroupFields": "A String", # Optional. A field mask to restrict which fields on the group are returned. Defaults to `metadata`, `groupType`, and `name` if not set or set to empty. Valid fields are: * clientData * groupType * memberCount * metadata * name
"updateGroupFields": "A String", # Optional. A field mask to restrict which fields on the group are updated. Multiple fields can be specified by separating them with commas. Defaults to `name` if not set or set to empty. Updated fields are replaced. Valid values are: * clientData * name
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A contact group.
"clientData": [ # The group's client data.
{ # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.
"key": "A String", # The client specified key of the client data.
"value": "A String", # The client specified value of the client data.
},
],
"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
"formattedName": "A String", # Output only. The name translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale for system groups names. Group names set by the owner are the same as name.
"groupType": "A String", # Output only. The contact group type.
"memberCount": 42, # Output only. The total number of contacts in the group irrespective of max members in specified in the request.
"memberResourceNames": [ # Output only. The list of contact person resource names that are members of the contact group. The field is only populated for GET requests and will only return as many members as `maxMembers` in the get request.
"A String",
],
"metadata": { # The metadata about a contact group. # Output only. Metadata about the contact group.
"deleted": True or False, # Output only. True if the contact group resource has been deleted. Populated only for [`ListContactGroups`](/people/api/rest/v1/contactgroups/list) requests that include a sync token.
"updateTime": "A String", # Output only. The time the group was last updated.
},
"name": "A String", # The contact group name set by the group owner or a system provided name for system groups. For [`contactGroups.create`](/people/api/rest/v1/contactGroups/create) or [`contactGroups.update`](/people/api/rest/v1/contactGroups/update) the name must be unique to the users contact groups. Attempting to create a group with a duplicate name will return a HTTP 409 error.
"resourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`.
}</pre>
</div>
</body></html>
|
