Blame - docs/dyn/people_v1.contactGroups.html - platform/external/python/google-api-python-client

blob: 9394f3e76c6203f592b2827b858211e76af3311c [file] [log] [blame]

Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	1	<html><body>
				2	<style>
				3
				4	body, 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
				15	body {
				16	font-size: 13px;
				17	padding: 1em;
				18	}
				19
				20	h1 {
				21	font-size: 26px;
				22	margin-bottom: 1em;
				23	}
				24
				25	h2 {
				26	font-size: 24px;
				27	margin-bottom: 1em;
				28	}
				29
				30	h3 {
				31	font-size: 20px;
				32	margin-bottom: 1em;
				33	margin-top: 1em;
				34	}
				35
				36	pre, code {
				37	line-height: 1.5;
				38	font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
				39	}
				40
				41	pre {
				42	margin-top: 0.5em;
				43	}
				44
				45	h1, h2, h3, p {
				46	font-family: Arial, sans serif;
				47	}
				48
				49	h1, 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 Kim	4ed7d3f	2020-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 Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	84	<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 Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	85	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	86	<code><a href="#create">create(body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-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>
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	90	<p class="firstline">Delete an existing contact group owned by the authenticated user by specifying a contact group resource name.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	91	<p class="toc_element">
				92	<code><a href="#get">get(resourceName, maxMembers=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	93	<p class="firstline">Get a specific contact group owned by the authenticated user by specifying a contact group resource name.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	94	<p class="toc_element">
Bu Sun Kim	4ed7d3f	2020-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 Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	96	<p class="firstline">List all contact groups owned by the authenticated user. Members of the contact groups are not populated.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	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'Meara	dd49464	2020-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 Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	102	<p class="firstline">Update the name of an existing contact group owned by the authenticated user.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	103	<h3>Method Details</h3>
				104	<div class="method">
Bu Sun Kim	4ed7d3f	2020-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 Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	106	<pre>Get a list of contact groups owned by the authenticated user by specifying a list of contact group resource names.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	107
				108	Args:
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	109	resourceNames: string, Required. The resource names of the contact groups to get. (repeated)
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	110	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.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	111	x__xgafv: string, V1 error format.
				112	Allowed values
				113	1 - v1 error format
				114	2 - v2 error format
				115
				116	Returns:
				117	An object of the form:
				118
				119	{ # The response to a batch get contact groups request.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	120	"responses": [ # The list of responses for each requested contact group resource.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	121	{ # The response for a specific contact group.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	122	"requestedResourceName": "A String", # The original requested resource name.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	123	"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.
				124	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	125	{
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	126	"a_key": "", # Properties of the object. Contains field @type with type URL.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	127	},
				128	],
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	129	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	130	"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.
				131	},
				132	"contactGroup": { # A contact group. # The contact group.
				133	"name": "A String", # The contact group name set by the group owner or a system provided name for system groups.
				134	"groupType": "A String", # Output only. The contact group type.
				135	"metadata": { # The metadata about a contact group. # Output only. Metadata about the contact group.
				136	"updateTime": "A String", # Output only. The time the group was last updated.
				137	"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.
				138	},
				139	"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.
				140	"memberResourceNames": [ # 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).
				141	"A String",
				142	],
				143	"memberCount": 42, # Output only. The total number of contacts in the group irrespective of max members in specified in the request.
				144	"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}`.
				145	"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	146	},
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	147	},
				148	],
				149	}</pre>
				150	</div>
				151
				152	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	153	<code class="details" id="create">create(body=None, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	154	<pre>Create a new contact group owned by the authenticated user.
				155
				156	Args:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	157	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	158	The object takes the form of:
				159
				160	{ # A request to create a new contact group.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	161	"contactGroup": { # A contact group. # Required. The contact group to create.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	162	"name": "A String", # The contact group name set by the group owner or a system provided name for system groups.
				163	"groupType": "A String", # Output only. The contact group type.
				164	"metadata": { # The metadata about a contact group. # Output only. Metadata about the contact group.
				165	"updateTime": "A String", # Output only. The time the group was last updated.
				166	"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.
				167	},
				168	"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.
				169	"memberResourceNames": [ # 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).
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	170	"A String",
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	171	],
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	172	"memberCount": 42, # Output only. The total number of contacts in the group irrespective of max members in specified in the request.
				173	"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}`.
				174	"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	175	},
				176	}
				177
				178	x__xgafv: string, V1 error format.
				179	Allowed values
				180	1 - v1 error format
				181	2 - v2 error format
				182
				183	Returns:
				184	An object of the form:
				185
				186	{ # A contact group.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	187	"name": "A String", # The contact group name set by the group owner or a system provided name for system groups.
				188	"groupType": "A String", # Output only. The contact group type.
				189	"metadata": { # The metadata about a contact group. # Output only. Metadata about the contact group.
				190	"updateTime": "A String", # Output only. The time the group was last updated.
				191	"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.
				192	},
				193	"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.
				194	"memberResourceNames": [ # 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).
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	195	"A String",
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	196	],
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	197	"memberCount": 42, # Output only. The total number of contacts in the group irrespective of max members in specified in the request.
				198	"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}`.
				199	"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	200	}</pre>
				201	</div>
				202
				203	<div class="method">
				204	<code class="details" id="delete">delete(resourceName, deleteContacts=None, x__xgafv=None)</code>
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	205	<pre>Delete an existing contact group owned by the authenticated user by specifying a contact group resource name.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	206
				207	Args:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	208	resourceName: string, Required. The resource name of the contact group to delete. (required)
				209	deleteContacts: boolean, Optional. Set to true to also delete the contacts in the specified group.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	210	x__xgafv: string, V1 error format.
				211	Allowed values
				212	1 - v1 error format
				213	2 - v2 error format
				214
				215	Returns:
				216	An object of the form:
				217
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	218	{ # 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 Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	219	}</pre>
				220	</div>
				221
				222	<div class="method">
				223	<code class="details" id="get">get(resourceName, maxMembers=None, x__xgafv=None)</code>
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	224	<pre>Get a specific contact group owned by the authenticated user by specifying a contact group resource name.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	225
				226	Args:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	227	resourceName: string, Required. The resource name of the contact group to get. (required)
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	228	maxMembers: integer, Optional. Specifies the maximum number of members to return. Defaults to 0 if not set, which will return zero members.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	229	x__xgafv: string, V1 error format.
				230	Allowed values
				231	1 - v1 error format
				232	2 - v2 error format
				233
				234	Returns:
				235	An object of the form:
				236
				237	{ # A contact group.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	238	"name": "A String", # The contact group name set by the group owner or a system provided name for system groups.
				239	"groupType": "A String", # Output only. The contact group type.
				240	"metadata": { # The metadata about a contact group. # Output only. Metadata about the contact group.
				241	"updateTime": "A String", # Output only. The time the group was last updated.
				242	"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.
				243	},
				244	"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.
				245	"memberResourceNames": [ # 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).
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	246	"A String",
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	247	],
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	248	"memberCount": 42, # Output only. The total number of contacts in the group irrespective of max members in specified in the request.
				249	"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}`.
				250	"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	251	}</pre>
				252	</div>
				253
				254	<div class="method">
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	255	<code class="details" id="list">list(syncToken=None, pageToken=None, pageSize=None, x__xgafv=None)</code>
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	256	<pre>List all contact groups owned by the authenticated user. Members of the contact groups are not populated.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	257
				258	Args:
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	259	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.
				260	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.
				261	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 Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	262	x__xgafv: string, V1 error format.
				263	Allowed values
				264	1 - v1 error format
				265	2 - v2 error format
				266
				267	Returns:
				268	An object of the form:
				269
				270	{ # The response to a list contact groups request.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	271	"nextSyncToken": "A String", # The token that can be used to retrieve changes since the last request.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	272	"totalItems": 42, # The total number of items in the list without pagination.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	273	"nextPageToken": "A String", # The token that can be used to retrieve the next page of results.
				274	"contactGroups": [ # The list of contact groups. Members of the contact groups are not populated.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	275	{ # A contact group.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	276	"name": "A String", # The contact group name set by the group owner or a system provided name for system groups.
				277	"groupType": "A String", # Output only. The contact group type.
				278	"metadata": { # The metadata about a contact group. # Output only. Metadata about the contact group.
				279	"updateTime": "A String", # Output only. The time the group was last updated.
				280	"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.
				281	},
				282	"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.
				283	"memberResourceNames": [ # 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).
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	284	"A String",
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	285	],
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	286	"memberCount": 42, # Output only. The total number of contacts in the group irrespective of max members in specified in the request.
				287	"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}`.
				288	"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	289	},
				290	],
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	291	}</pre>
				292	</div>
				293
				294	<div class="method">
				295	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				296	<pre>Retrieves the next page of results.
				297
				298	Args:
				299	previous_request: The request for the previous page. (required)
				300	previous_response: The response from the request for the previous page. (required)
				301
				302	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	303	A request object that you can call 'execute()' on to request the next
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	304	page. Returns None if there are no more items in the collection.
				305	</pre>
				306	</div>
				307
				308	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	309	<code class="details" id="update">update(resourceName, body=None, x__xgafv=None)</code>
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	310	<pre>Update the name of an existing contact group owned by the authenticated user.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	311
				312	Args:
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	313	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'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	314	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	315	The object takes the form of:
				316
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	317	{ # A request to update an existing user contact group. All updated fields will be replaced.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	318	"contactGroup": { # A contact group. # Required. The contact group to update.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	319	"name": "A String", # The contact group name set by the group owner or a system provided name for system groups.
				320	"groupType": "A String", # Output only. The contact group type.
				321	"metadata": { # The metadata about a contact group. # Output only. Metadata about the contact group.
				322	"updateTime": "A String", # Output only. The time the group was last updated.
				323	"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.
				324	},
				325	"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.
				326	"memberResourceNames": [ # 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).
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	327	"A String",
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	328	],
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	329	"memberCount": 42, # Output only. The total number of contacts in the group irrespective of max members in specified in the request.
				330	"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}`.
				331	"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	332	},
				333	}
				334
				335	x__xgafv: string, V1 error format.
				336	Allowed values
				337	1 - v1 error format
				338	2 - v2 error format
				339
				340	Returns:
				341	An object of the form:
				342
				343	{ # A contact group.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	344	"name": "A String", # The contact group name set by the group owner or a system provided name for system groups.
				345	"groupType": "A String", # Output only. The contact group type.
				346	"metadata": { # The metadata about a contact group. # Output only. Metadata about the contact group.
				347	"updateTime": "A String", # Output only. The time the group was last updated.
				348	"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.
				349	},
				350	"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.
				351	"memberResourceNames": [ # 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).
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	352	"A String",
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	353	],
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	354	"memberCount": 42, # Output only. The total number of contacts in the group irrespective of max members in specified in the request.
				355	"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}`.
				356	"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	357	}</pre>
				358	</div>
				359
				360	</body></html>