Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3bf2781e29cb828409f3a8a21939323286524569 / . / docs / dyn / people_v1.contactGroups.html
blob: 947f0b99031ed8ff2af838e3dbb4d88538426dfc [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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="people_v1.html">People API</a> . <a href="people_v1.contactGroups.html">contactGroups</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="people_v1.contactGroups.members.html">members()</a></code>
79</p>
80<p class="firstline">Returns the members Resource.</p>
81
82<p class="toc_element">
83 <code><a href="#batchGet">batchGet(resourceNames=None, maxMembers=None, x__xgafv=None)</a></code></p>
84<p class="firstline">Get a list of contact groups owned by the authenticated user by specifying</p>
85<p class="toc_element">
86 <code><a href="#create">create(body, x__xgafv=None)</a></code></p>
87<p class="firstline">Create a new contact group owned by the authenticated user.</p>
88<p class="toc_element">
89 <code><a href="#delete">delete(resourceName, deleteContacts=None, x__xgafv=None)</a></code></p>
90<p class="firstline">Delete an existing contact group owned by the authenticated user by</p>
91<p class="toc_element">
92 <code><a href="#get">get(resourceName, maxMembers=None, x__xgafv=None)</a></code></p>
93<p class="firstline">Get a specific contact group owned by the authenticated user by specifying</p>
94<p class="toc_element">
95 <code><a href="#list">list(pageSize=None, syncToken=None, pageToken=None, x__xgafv=None)</a></code></p>
96<p class="firstline">List all contact groups owned by the authenticated user. Members of the</p>
97<p class="toc_element">
98 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
99<p class="firstline">Retrieves the next page of results.</p>
100<p class="toc_element">
101 <code><a href="#update">update(resourceName, body, x__xgafv=None)</a></code></p>
102<p class="firstline">Update the name of an existing contact group owned by the authenticated</p>
103<h3>Method Details</h3>
104<div class="method">
105 <code class="details" id="batchGet">batchGet(resourceNames=None, maxMembers=None, x__xgafv=None)</code>
106 <pre>Get a list of contact groups owned by the authenticated user by specifying
107a list of contact group resource names.
108
109Args:
110 resourceNames: string, The resource names of the contact groups to get. (repeated)
111 maxMembers: integer, Specifies the maximum number of members to return for each group.
112 x__xgafv: string, V1 error format.
113 Allowed values
114 1 - v1 error format
115 2 - v2 error format
116
117Returns:
118 An object of the form:
119
120 { # The response to a batch get contact groups request.
121 "responses": [ # The list of responses for each requested contact group resource.
122 { # The response for a specific contact group.
123 "status": { # The `Status` type defines a logical error model that is suitable for # The status of the response.
124 # different programming environments, including REST APIs and RPC APIs. It is
125 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
126 # three pieces of data: error code, error message, and error details.
127 #
128 # You can find out more about this error model and how to work with it in the
129 # [API Design Guide](https://cloud.google.com/apis/design/errors).
130 "message": "A String", # A developer-facing error message, which should be in English. Any
131 # user-facing error message should be localized and sent in the
132 # google.rpc.Status.details field, or localized by the client.
133 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
134 "details": [ # A list of messages that carry the error details. There is a common set of
135 # message types for APIs to use.
136 {
137 "a_key": "", # Properties of the object. Contains field @type with type URL.
138 },
139 ],
140 },
141 "requestedResourceName": "A String", # The original requested resource name.
142 "contactGroup": { # A contact group. # The contact group.
143 "formattedName": "A String", # The read-only name translated and formatted in the viewer's account locale
144 # or the `Accept-Language` HTTP header locale for system groups names.
145 # Group names set by the owner are the same as name.
146 "groupType": "A String", # The read-only contact group type.
147 "name": "A String", # The contact group name set by the group owner or a system provided name
148 # for system groups.
149 "memberResourceNames": [ # The list of contact person resource names that are members of the contact
150 # group. The field is not populated for LIST requests and can only be updated
151 # through the
152 # [ModifyContactGroupMembers](/people/api/rest/v1/contactgroups/members/modify).
153 "A String",
154 ],
155 "memberCount": 42, # The total number of contacts in the group irrespective of max members in
156 # specified in the request.
157 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
158 # resource. Used for web cache validation.
159 "resourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII
160 # string, in the form of `contactGroups/`<var>contact_group_id</var>.
161 "metadata": { # The read-only metadata about a contact group. # Metadata about the contact group.
162 "deleted": True or False, # True if the contact group resource has been deleted. Populated only for
163 # [`ListContactGroups`](/people/api/rest/v1/contactgroups/list) requests
164 # that include a sync token.
165 "updateTime": "A String", # The time the group was last updated.
166 },
167 },
168 },
169 ],
170 }</pre>
171</div>
172
173<div class="method">
174 <code class="details" id="create">create(body, x__xgafv=None)</code>
175 <pre>Create a new contact group owned by the authenticated user.
176
177Args:
178 body: object, The request body. (required)
179 The object takes the form of:
180
181{ # A request to create a new contact group.
182 "contactGroup": { # A contact group. # The contact group to create.
183 "formattedName": "A String", # The read-only name translated and formatted in the viewer's account locale
184 # or the `Accept-Language` HTTP header locale for system groups names.
185 # Group names set by the owner are the same as name.
186 "groupType": "A String", # The read-only contact group type.
187 "name": "A String", # The contact group name set by the group owner or a system provided name
188 # for system groups.
189 "memberResourceNames": [ # The list of contact person resource names that are members of the contact
190 # group. The field is not populated for LIST requests and can only be updated
191 # through the
192 # [ModifyContactGroupMembers](/people/api/rest/v1/contactgroups/members/modify).
193 "A String",
194 ],
195 "memberCount": 42, # The total number of contacts in the group irrespective of max members in
196 # specified in the request.
197 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
198 # resource. Used for web cache validation.
199 "resourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII
200 # string, in the form of `contactGroups/`<var>contact_group_id</var>.
201 "metadata": { # The read-only metadata about a contact group. # Metadata about the contact group.
202 "deleted": True or False, # True if the contact group resource has been deleted. Populated only for
203 # [`ListContactGroups`](/people/api/rest/v1/contactgroups/list) requests
204 # that include a sync token.
205 "updateTime": "A String", # The time the group was last updated.
206 },
207 },
208 }
209
210 x__xgafv: string, V1 error format.
211 Allowed values
212 1 - v1 error format
213 2 - v2 error format
214
215Returns:
216 An object of the form:
217
218 { # A contact group.
219 "formattedName": "A String", # The read-only name translated and formatted in the viewer's account locale
220 # or the `Accept-Language` HTTP header locale for system groups names.
221 # Group names set by the owner are the same as name.
222 "groupType": "A String", # The read-only contact group type.
223 "name": "A String", # The contact group name set by the group owner or a system provided name
224 # for system groups.
225 "memberResourceNames": [ # The list of contact person resource names that are members of the contact
226 # group. The field is not populated for LIST requests and can only be updated
227 # through the
228 # [ModifyContactGroupMembers](/people/api/rest/v1/contactgroups/members/modify).
229 "A String",
230 ],
231 "memberCount": 42, # The total number of contacts in the group irrespective of max members in
232 # specified in the request.
233 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
234 # resource. Used for web cache validation.
235 "resourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII
236 # string, in the form of `contactGroups/`<var>contact_group_id</var>.
237 "metadata": { # The read-only metadata about a contact group. # Metadata about the contact group.
238 "deleted": True or False, # True if the contact group resource has been deleted. Populated only for
239 # [`ListContactGroups`](/people/api/rest/v1/contactgroups/list) requests
240 # that include a sync token.
241 "updateTime": "A String", # The time the group was last updated.
242 },
243 }</pre>
244</div>
245
246<div class="method">
247 <code class="details" id="delete">delete(resourceName, deleteContacts=None, x__xgafv=None)</code>
248 <pre>Delete an existing contact group owned by the authenticated user by
249specifying a contact group resource name.
250
251Args:
252 resourceName: string, The resource name of the contact group to delete. (required)
253 deleteContacts: boolean, Set to true to also delete the contacts in the specified group.
254 x__xgafv: string, V1 error format.
255 Allowed values
256 1 - v1 error format
257 2 - v2 error format
258
259Returns:
260 An object of the form:
261
262 { # A generic empty message that you can re-use to avoid defining duplicated
263 # empty messages in your APIs. A typical example is to use it as the request
264 # or the response type of an API method. For instance:
265 #
266 # service Foo {
267 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
268 # }
269 #
270 # The JSON representation for `Empty` is empty JSON object `{}`.
271 }</pre>
272</div>
273
274<div class="method">
275 <code class="details" id="get">get(resourceName, maxMembers=None, x__xgafv=None)</code>
276 <pre>Get a specific contact group owned by the authenticated user by specifying
277a contact group resource name.
278
279Args:
280 resourceName: string, The resource name of the contact group to get. (required)
281 maxMembers: integer, Specifies the maximum number of members to return.
282 x__xgafv: string, V1 error format.
283 Allowed values
284 1 - v1 error format
285 2 - v2 error format
286
287Returns:
288 An object of the form:
289
290 { # A contact group.
291 "formattedName": "A String", # The read-only name translated and formatted in the viewer's account locale
292 # or the `Accept-Language` HTTP header locale for system groups names.
293 # Group names set by the owner are the same as name.
294 "groupType": "A String", # The read-only contact group type.
295 "name": "A String", # The contact group name set by the group owner or a system provided name
296 # for system groups.
297 "memberResourceNames": [ # The list of contact person resource names that are members of the contact
298 # group. The field is not populated for LIST requests and can only be updated
299 # through the
300 # [ModifyContactGroupMembers](/people/api/rest/v1/contactgroups/members/modify).
301 "A String",
302 ],
303 "memberCount": 42, # The total number of contacts in the group irrespective of max members in
304 # specified in the request.
305 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
306 # resource. Used for web cache validation.
307 "resourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII
308 # string, in the form of `contactGroups/`<var>contact_group_id</var>.
309 "metadata": { # The read-only metadata about a contact group. # Metadata about the contact group.
310 "deleted": True or False, # True if the contact group resource has been deleted. Populated only for
311 # [`ListContactGroups`](/people/api/rest/v1/contactgroups/list) requests
312 # that include a sync token.
313 "updateTime": "A String", # The time the group was last updated.
314 },
315 }</pre>
316</div>
317
318<div class="method">
319 <code class="details" id="list">list(pageSize=None, syncToken=None, pageToken=None, x__xgafv=None)</code>
320 <pre>List all contact groups owned by the authenticated user. Members of the
321contact groups are not populated.
322
323Args:
324 pageSize: integer, The maximum number of resources to return.
325 syncToken: string, A sync token, returned by a previous call to `contactgroups.list`.
326Only resources changed since the sync token was created will be returned.
327 pageToken: string, The next_page_token value returned from a previous call to
328[ListContactGroups](/people/api/rest/v1/contactgroups/list).
329Requests the next page of resources.
330 x__xgafv: string, V1 error format.
331 Allowed values
332 1 - v1 error format
333 2 - v2 error format
334
335Returns:
336 An object of the form:
337
338 { # The response to a list contact groups request.
339 "nextPageToken": "A String", # The token that can be used to retrieve the next page of results.
340 "contactGroups": [ # The list of contact groups. Members of the contact groups are not
341 # populated.
342 { # A contact group.
343 "formattedName": "A String", # The read-only name translated and formatted in the viewer's account locale
344 # or the `Accept-Language` HTTP header locale for system groups names.
345 # Group names set by the owner are the same as name.
346 "groupType": "A String", # The read-only contact group type.
347 "name": "A String", # The contact group name set by the group owner or a system provided name
348 # for system groups.
349 "memberResourceNames": [ # The list of contact person resource names that are members of the contact
350 # group. The field is not populated for LIST requests and can only be updated
351 # through the
352 # [ModifyContactGroupMembers](/people/api/rest/v1/contactgroups/members/modify).
353 "A String",
354 ],
355 "memberCount": 42, # The total number of contacts in the group irrespective of max members in
356 # specified in the request.
357 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
358 # resource. Used for web cache validation.
359 "resourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII
360 # string, in the form of `contactGroups/`<var>contact_group_id</var>.
361 "metadata": { # The read-only metadata about a contact group. # Metadata about the contact group.
362 "deleted": True or False, # True if the contact group resource has been deleted. Populated only for
363 # [`ListContactGroups`](/people/api/rest/v1/contactgroups/list) requests
364 # that include a sync token.
365 "updateTime": "A String", # The time the group was last updated.
366 },
367 },
368 ],
369 "nextSyncToken": "A String", # The token that can be used to retrieve changes since the last request.
370 "totalItems": 42, # The total number of items in the list without pagination.
371 }</pre>
372</div>
373
374<div class="method">
375 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
376 <pre>Retrieves the next page of results.
377
378Args:
379 previous_request: The request for the previous page. (required)
380 previous_response: The response from the request for the previous page. (required)
381
382Returns:
383 A request object that you can call 'execute()' on to request the next
384 page. Returns None if there are no more items in the collection.
385 </pre>
386</div>
387
388<div class="method">
389 <code class="details" id="update">update(resourceName, body, x__xgafv=None)</code>
390 <pre>Update the name of an existing contact group owned by the authenticated
391user.
392
393Args:
394 resourceName: string, The resource name for the contact group, assigned by the server. An ASCII
395string, in the form of `contactGroups/`<var>contact_group_id</var>. (required)
396 body: object, The request body. (required)
397 The object takes the form of:
398
399{ # A request to update an existing user contact group. All updated fields will
400 # be replaced.
401 "contactGroup": { # A contact group. # The contact group to update.
402 "formattedName": "A String", # The read-only name translated and formatted in the viewer's account locale
403 # or the `Accept-Language` HTTP header locale for system groups names.
404 # Group names set by the owner are the same as name.
405 "groupType": "A String", # The read-only contact group type.
406 "name": "A String", # The contact group name set by the group owner or a system provided name
407 # for system groups.
408 "memberResourceNames": [ # The list of contact person resource names that are members of the contact
409 # group. The field is not populated for LIST requests and can only be updated
410 # through the
411 # [ModifyContactGroupMembers](/people/api/rest/v1/contactgroups/members/modify).
412 "A String",
413 ],
414 "memberCount": 42, # The total number of contacts in the group irrespective of max members in
415 # specified in the request.
416 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
417 # resource. Used for web cache validation.
418 "resourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII
419 # string, in the form of `contactGroups/`<var>contact_group_id</var>.
420 "metadata": { # The read-only metadata about a contact group. # Metadata about the contact group.
421 "deleted": True or False, # True if the contact group resource has been deleted. Populated only for
422 # [`ListContactGroups`](/people/api/rest/v1/contactgroups/list) requests
423 # that include a sync token.
424 "updateTime": "A String", # The time the group was last updated.
425 },
426 },
427 }
428
429 x__xgafv: string, V1 error format.
430 Allowed values
431 1 - v1 error format
432 2 - v2 error format
433
434Returns:
435 An object of the form:
436
437 { # A contact group.
438 "formattedName": "A String", # The read-only name translated and formatted in the viewer's account locale
439 # or the `Accept-Language` HTTP header locale for system groups names.
440 # Group names set by the owner are the same as name.
441 "groupType": "A String", # The read-only contact group type.
442 "name": "A String", # The contact group name set by the group owner or a system provided name
443 # for system groups.
444 "memberResourceNames": [ # The list of contact person resource names that are members of the contact
445 # group. The field is not populated for LIST requests and can only be updated
446 # through the
447 # [ModifyContactGroupMembers](/people/api/rest/v1/contactgroups/members/modify).
448 "A String",
449 ],
450 "memberCount": 42, # The total number of contacts in the group irrespective of max members in
451 # specified in the request.
452 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
453 # resource. Used for web cache validation.
454 "resourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII
455 # string, in the form of `contactGroups/`<var>contact_group_id</var>.
456 "metadata": { # The read-only metadata about a contact group. # Metadata about the contact group.
457 "deleted": True or False, # True if the contact group resource has been deleted. Populated only for
458 # [`ListContactGroups`](/people/api/rest/v1/contactgroups/list) requests
459 # that include a sync token.
460 "updateTime": "A String", # The time the group was last updated.
461 },
462 }</pre>
463</div>
464
465</body></html>