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