blob: 418ac493a5d9ca6d991294edeeed7e032011d64e [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001<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">
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -080083 <code><a href="#batchGet">batchGet(maxMembers=None, resourceNames=None, x__xgafv=None)</a></code></p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -070084<p class="firstline">Get a list of contact groups owned by the authenticated user by specifying a list of contact group resource names.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070085<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070086 <code><a href="#close">close()</a></code></p>
87<p class="firstline">Close httplib2 connections.</p>
88<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070089 <code><a href="#create">create(body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070090<p class="firstline">Create a new contact group owned by the authenticated user.</p>
91<p class="toc_element">
92 <code><a href="#delete">delete(resourceName, deleteContacts=None, x__xgafv=None)</a></code></p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -070093<p class="firstline">Delete an existing contact group owned by the authenticated user by specifying a contact group resource name.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070094<p class="toc_element">
95 <code><a href="#get">get(resourceName, maxMembers=None, x__xgafv=None)</a></code></p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -070096<p class="firstline">Get a specific contact group owned by the authenticated user by specifying a contact group resource name.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070097<p class="toc_element">
Yoshi Automation Botb6971b02020-11-26 17:16:03 -080098 <code><a href="#list">list(syncToken=None, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -070099<p class="firstline">List all contact groups owned by the authenticated user. Members of the contact groups are not populated.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700100<p class="toc_element">
101 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
102<p class="firstline">Retrieves the next page of results.</p>
103<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700104 <code><a href="#update">update(resourceName, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700105<p class="firstline">Update the name of an existing contact group owned by the authenticated user.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700106<h3>Method Details</h3>
107<div class="method">
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800108 <code class="details" id="batchGet">batchGet(maxMembers=None, resourceNames=None, x__xgafv=None)</code>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700109 <pre>Get a list of contact groups owned by the authenticated user by specifying a list of contact group resource names.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700110
111Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700112 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.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800113 resourceNames: string, Required. The resource names of the contact groups to get. (repeated)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700114 x__xgafv: string, V1 error format.
115 Allowed values
116 1 - v1 error format
117 2 - v2 error format
118
119Returns:
120 An object of the form:
121
122 { # The response to a batch get contact groups request.
Bu Sun Kim65020912020-05-20 12:08:20 -0700123 &quot;responses&quot;: [ # The list of responses for each requested contact group resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700124 { # The response for a specific contact group.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700125 &quot;contactGroup&quot;: { # A contact group. # The contact group.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800126 &quot;formattedName&quot;: &quot;A String&quot;, # Output only. The name translated and formatted in the viewer&#x27;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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800127 &quot;groupType&quot;: &quot;A String&quot;, # Output only. The contact group type.
128 &quot;etag&quot;: &quot;A String&quot;, # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700129 &quot;memberCount&quot;: 42, # Output only. The total number of contacts in the group irrespective of max members in specified in the request.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800130 &quot;memberResourceNames&quot;: [ # Output only. The list of contact person resource names that are members of the contact group. The field is not populated for LIST requests and can only be updated through the [ModifyContactGroupMembers](/people/api/rest/v1/contactgroups/members/modify).
131 &quot;A String&quot;,
132 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700133 &quot;metadata&quot;: { # The metadata about a contact group. # Output only. Metadata about the contact group.
134 &quot;deleted&quot;: 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.
135 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time the group was last updated.
136 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800137 &quot;resourceName&quot;: &quot;A String&quot;, # The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`.
138 &quot;name&quot;: &quot;A String&quot;, # The contact group name set by the group owner or a system provided name for system groups.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700139 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800140 &quot;requestedResourceName&quot;: &quot;A String&quot;, # The original requested resource name.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700141 &quot;status&quot;: { # 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.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800142 &quot;message&quot;: &quot;A String&quot;, # 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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700143 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700144 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700145 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700146 },
147 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800148 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700149 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700150 },
151 ],
152 }</pre>
153</div>
154
155<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700156 <code class="details" id="close">close()</code>
157 <pre>Close httplib2 connections.</pre>
158</div>
159
160<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700161 <code class="details" id="create">create(body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700162 <pre>Create a new contact group owned by the authenticated user.
163
164Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700165 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700166 The object takes the form of:
167
168{ # A request to create a new contact group.
Bu Sun Kim65020912020-05-20 12:08:20 -0700169 &quot;contactGroup&quot;: { # A contact group. # Required. The contact group to create.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800170 &quot;formattedName&quot;: &quot;A String&quot;, # Output only. The name translated and formatted in the viewer&#x27;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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800171 &quot;groupType&quot;: &quot;A String&quot;, # Output only. The contact group type.
172 &quot;etag&quot;: &quot;A String&quot;, # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700173 &quot;memberCount&quot;: 42, # Output only. The total number of contacts in the group irrespective of max members in specified in the request.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800174 &quot;memberResourceNames&quot;: [ # Output only. The list of contact person resource names that are members of the contact group. The field is not populated for LIST requests and can only be updated through the [ModifyContactGroupMembers](/people/api/rest/v1/contactgroups/members/modify).
175 &quot;A String&quot;,
176 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700177 &quot;metadata&quot;: { # The metadata about a contact group. # Output only. Metadata about the contact group.
178 &quot;deleted&quot;: 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.
179 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time the group was last updated.
180 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800181 &quot;resourceName&quot;: &quot;A String&quot;, # The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`.
182 &quot;name&quot;: &quot;A String&quot;, # The contact group name set by the group owner or a system provided name for system groups.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700183 },
184 }
185
186 x__xgafv: string, V1 error format.
187 Allowed values
188 1 - v1 error format
189 2 - v2 error format
190
191Returns:
192 An object of the form:
193
194 { # A contact group.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800195 &quot;formattedName&quot;: &quot;A String&quot;, # Output only. The name translated and formatted in the viewer&#x27;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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800196 &quot;groupType&quot;: &quot;A String&quot;, # Output only. The contact group type.
197 &quot;etag&quot;: &quot;A String&quot;, # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700198 &quot;memberCount&quot;: 42, # Output only. The total number of contacts in the group irrespective of max members in specified in the request.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800199 &quot;memberResourceNames&quot;: [ # Output only. The list of contact person resource names that are members of the contact group. The field is not populated for LIST requests and can only be updated through the [ModifyContactGroupMembers](/people/api/rest/v1/contactgroups/members/modify).
200 &quot;A String&quot;,
201 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700202 &quot;metadata&quot;: { # The metadata about a contact group. # Output only. Metadata about the contact group.
203 &quot;deleted&quot;: 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.
204 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time the group was last updated.
205 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800206 &quot;resourceName&quot;: &quot;A String&quot;, # The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`.
207 &quot;name&quot;: &quot;A String&quot;, # The contact group name set by the group owner or a system provided name for system groups.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700208 }</pre>
209</div>
210
211<div class="method">
212 <code class="details" id="delete">delete(resourceName, deleteContacts=None, x__xgafv=None)</code>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700213 <pre>Delete an existing contact group owned by the authenticated user by specifying a contact group resource name.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700214
215Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700216 resourceName: string, Required. The resource name of the contact group to delete. (required)
217 deleteContacts: boolean, Optional. Set to true to also delete the contacts in the specified group.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700218 x__xgafv: string, V1 error format.
219 Allowed values
220 1 - v1 error format
221 2 - v2 error format
222
223Returns:
224 An object of the form:
225
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700226 { # 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); } The JSON representation for `Empty` is empty JSON object `{}`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700227 }</pre>
228</div>
229
230<div class="method">
231 <code class="details" id="get">get(resourceName, maxMembers=None, x__xgafv=None)</code>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700232 <pre>Get a specific contact group owned by the authenticated user by specifying a contact group resource name.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700233
234Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700235 resourceName: string, Required. The resource name of the contact group to get. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700236 maxMembers: integer, Optional. Specifies the maximum number of members to return. Defaults to 0 if not set, which will return zero members.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700237 x__xgafv: string, V1 error format.
238 Allowed values
239 1 - v1 error format
240 2 - v2 error format
241
242Returns:
243 An object of the form:
244
245 { # A contact group.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800246 &quot;formattedName&quot;: &quot;A String&quot;, # Output only. The name translated and formatted in the viewer&#x27;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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800247 &quot;groupType&quot;: &quot;A String&quot;, # Output only. The contact group type.
248 &quot;etag&quot;: &quot;A String&quot;, # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700249 &quot;memberCount&quot;: 42, # Output only. The total number of contacts in the group irrespective of max members in specified in the request.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800250 &quot;memberResourceNames&quot;: [ # Output only. The list of contact person resource names that are members of the contact group. The field is not populated for LIST requests and can only be updated through the [ModifyContactGroupMembers](/people/api/rest/v1/contactgroups/members/modify).
251 &quot;A String&quot;,
252 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700253 &quot;metadata&quot;: { # The metadata about a contact group. # Output only. Metadata about the contact group.
254 &quot;deleted&quot;: 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.
255 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time the group was last updated.
256 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800257 &quot;resourceName&quot;: &quot;A String&quot;, # The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`.
258 &quot;name&quot;: &quot;A String&quot;, # The contact group name set by the group owner or a system provided name for system groups.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700259 }</pre>
260</div>
261
262<div class="method">
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800263 <code class="details" id="list">list(syncToken=None, pageToken=None, pageSize=None, x__xgafv=None)</code>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700264 <pre>List all contact groups owned by the authenticated user. Members of the contact groups are not populated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700265
266Args:
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800267 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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700268 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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800269 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700270 x__xgafv: string, V1 error format.
271 Allowed values
272 1 - v1 error format
273 2 - v2 error format
274
275Returns:
276 An object of the form:
277
278 { # The response to a list contact groups request.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800279 &quot;nextSyncToken&quot;: &quot;A String&quot;, # The token that can be used to retrieve changes since the last request.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700280 &quot;contactGroups&quot;: [ # The list of contact groups. Members of the contact groups are not populated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700281 { # A contact group.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800282 &quot;formattedName&quot;: &quot;A String&quot;, # Output only. The name translated and formatted in the viewer&#x27;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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800283 &quot;groupType&quot;: &quot;A String&quot;, # Output only. The contact group type.
284 &quot;etag&quot;: &quot;A String&quot;, # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700285 &quot;memberCount&quot;: 42, # Output only. The total number of contacts in the group irrespective of max members in specified in the request.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800286 &quot;memberResourceNames&quot;: [ # Output only. The list of contact person resource names that are members of the contact group. The field is not populated for LIST requests and can only be updated through the [ModifyContactGroupMembers](/people/api/rest/v1/contactgroups/members/modify).
287 &quot;A String&quot;,
288 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700289 &quot;metadata&quot;: { # The metadata about a contact group. # Output only. Metadata about the contact group.
290 &quot;deleted&quot;: 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.
291 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time the group was last updated.
292 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800293 &quot;resourceName&quot;: &quot;A String&quot;, # The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`.
294 &quot;name&quot;: &quot;A String&quot;, # The contact group name set by the group owner or a system provided name for system groups.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700295 },
296 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800297 &quot;totalItems&quot;: 42, # The total number of items in the list without pagination.
298 &quot;nextPageToken&quot;: &quot;A String&quot;, # The token that can be used to retrieve the next page of results.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700299 }</pre>
300</div>
301
302<div class="method">
303 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
304 <pre>Retrieves the next page of results.
305
306Args:
307 previous_request: The request for the previous page. (required)
308 previous_response: The response from the request for the previous page. (required)
309
310Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700311 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700312 page. Returns None if there are no more items in the collection.
313 </pre>
314</div>
315
316<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700317 <code class="details" id="update">update(resourceName, body=None, x__xgafv=None)</code>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700318 <pre>Update the name of an existing contact group owned by the authenticated user.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700319
320Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700321 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)
Dan O'Mearadd494642020-05-01 07:42:23 -0700322 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700323 The object takes the form of:
324
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700325{ # A request to update an existing user contact group. All updated fields will be replaced.
Bu Sun Kim65020912020-05-20 12:08:20 -0700326 &quot;contactGroup&quot;: { # A contact group. # Required. The contact group to update.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800327 &quot;formattedName&quot;: &quot;A String&quot;, # Output only. The name translated and formatted in the viewer&#x27;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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800328 &quot;groupType&quot;: &quot;A String&quot;, # Output only. The contact group type.
329 &quot;etag&quot;: &quot;A String&quot;, # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700330 &quot;memberCount&quot;: 42, # Output only. The total number of contacts in the group irrespective of max members in specified in the request.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800331 &quot;memberResourceNames&quot;: [ # Output only. The list of contact person resource names that are members of the contact group. The field is not populated for LIST requests and can only be updated through the [ModifyContactGroupMembers](/people/api/rest/v1/contactgroups/members/modify).
332 &quot;A String&quot;,
333 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700334 &quot;metadata&quot;: { # The metadata about a contact group. # Output only. Metadata about the contact group.
335 &quot;deleted&quot;: 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.
336 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time the group was last updated.
337 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800338 &quot;resourceName&quot;: &quot;A String&quot;, # The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`.
339 &quot;name&quot;: &quot;A String&quot;, # The contact group name set by the group owner or a system provided name for system groups.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700340 },
341 }
342
343 x__xgafv: string, V1 error format.
344 Allowed values
345 1 - v1 error format
346 2 - v2 error format
347
348Returns:
349 An object of the form:
350
351 { # A contact group.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800352 &quot;formattedName&quot;: &quot;A String&quot;, # Output only. The name translated and formatted in the viewer&#x27;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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800353 &quot;groupType&quot;: &quot;A String&quot;, # Output only. The contact group type.
354 &quot;etag&quot;: &quot;A String&quot;, # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700355 &quot;memberCount&quot;: 42, # Output only. The total number of contacts in the group irrespective of max members in specified in the request.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800356 &quot;memberResourceNames&quot;: [ # Output only. The list of contact person resource names that are members of the contact group. The field is not populated for LIST requests and can only be updated through the [ModifyContactGroupMembers](/people/api/rest/v1/contactgroups/members/modify).
357 &quot;A String&quot;,
358 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700359 &quot;metadata&quot;: { # The metadata about a contact group. # Output only. Metadata about the contact group.
360 &quot;deleted&quot;: 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.
361 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time the group was last updated.
362 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800363 &quot;resourceName&quot;: &quot;A String&quot;, # The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`.
364 &quot;name&quot;: &quot;A String&quot;, # The contact group name set by the group owner or a system provided name for system groups.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700365 }</pre>
366</div>
367
368</body></html>