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

blob: 04ac9906af309c5cf50ddb86a52572934118a139 [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">
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	83	<code><a href="#batchGet">batchGet(groupFields=None, maxMembers=None, resourceNames=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">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	86	<code><a href="#close">close()</a></code></p>
				87	<p class="firstline">Close httplib2 connections.</p>
				88	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	89	<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]	90	<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 Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	93	<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]	94	<p class="toc_element">
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	95	<code><a href="#get">get(resourceName, groupFields=None, maxMembers=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	96	<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]	97	<p class="toc_element">
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	98	<code><a href="#list">list(groupFields=None, pageSize=None, pageToken=None, syncToken=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	99	<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]	100	<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'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	104	<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]	105	<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]	106	<h3>Method Details</h3>
				107	<div class="method">
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	108	<code class="details" id="batchGet">batchGet(groupFields=None, maxMembers=None, resourceNames=None, x__xgafv=None)</code>
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	109	<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]	110
				111	Args:
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	112	groupFields: string, Optional. A field mask to restrict which fields on the group are returned. Defaults to `metadata`, `groupType`, `memberCount`, and `name` if not set or set to empty. Valid fields are: * clientData * groupType * memberCount * metadata * name
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	113	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 Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	114	resourceNames: string, Required. The resource names of the contact groups to get. (repeated)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	115	x__xgafv: string, V1 error format.
				116	Allowed values
				117	1 - v1 error format
				118	2 - v2 error format
				119
				120	Returns:
				121	An object of the form:
				122
				123	{ # The response to a batch get contact groups request.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	124	"responses": [ # The list of responses for each requested contact group resource.
				125	{ # The response for a specific contact group.
				126	"contactGroup": { # A contact group. # The contact group.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	127	"clientData": [ # The group's client data.
yoshi-code-bot	6970659	2021-03-03 03:54:02 -0800	[diff] [blame]	128	{ # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	129	"key": "A String", # The client specified key of the client data.
				130	"value": "A String", # The client specified value of the client data.
				131	},
				132	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	133	"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
				134	"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.
				135	"groupType": "A String", # Output only. The contact group type.
				136	"memberCount": 42, # Output only. The total number of contacts in the group irrespective of max members in specified in the request.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	137	"memberResourceNames": [ # Output only. The list of contact person resource names that are members of the contact group. The field is only populated for GET requests and will only return as many members as `maxMembers` in the get request.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	138	"A String",
				139	],
				140	"metadata": { # The metadata about a contact group. # Output only. Metadata about the contact group.
				141	"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.
				142	"updateTime": "A String", # Output only. The time the group was last updated.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	143	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	144	"name": "A String", # The contact group name set by the group owner or a system provided name for system groups.
				145	"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}`.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	146	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	147	"requestedResourceName": "A String", # The original requested resource name.
				148	"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.
				149	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				150	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				151	{
				152	"a_key": "", # Properties of the object. Contains field @type with type URL.
				153	},
				154	],
				155	"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.
				156	},
				157	},
				158	],
				159	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	160	</div>
				161
				162	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	163	<code class="details" id="close">close()</code>
				164	<pre>Close httplib2 connections.</pre>
				165	</div>
				166
				167	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	168	<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]	169	<pre>Create a new contact group owned by the authenticated user.
				170
				171	Args:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	172	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	173	The object takes the form of:
				174
				175	{ # A request to create a new contact group.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	176	"contactGroup": { # A contact group. # Required. The contact group to create.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	177	"clientData": [ # The group's client data.
yoshi-code-bot	6970659	2021-03-03 03:54:02 -0800	[diff] [blame]	178	{ # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	179	"key": "A String", # The client specified key of the client data.
				180	"value": "A String", # The client specified value of the client data.
				181	},
				182	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	183	"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
				184	"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.
				185	"groupType": "A String", # Output only. The contact group type.
				186	"memberCount": 42, # Output only. The total number of contacts in the group irrespective of max members in specified in the request.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	187	"memberResourceNames": [ # Output only. The list of contact person resource names that are members of the contact group. The field is only populated for GET requests and will only return as many members as `maxMembers` in the get request.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	188	"A String",
				189	],
				190	"metadata": { # The metadata about a contact group. # Output only. Metadata about the contact group.
				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	"updateTime": "A String", # Output only. The time the group was last updated.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	193	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	194	"name": "A String", # The contact group name set by the group owner or a system provided name for system groups.
				195	"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}`.
				196	},
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	197	"readGroupFields": "A String", # Optional. A field mask to restrict which fields on the group are returned. Defaults to `metadata`, `groupType`, and `name` if not set or set to empty. Valid fields are: * clientData * groupType * metadata * name
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	198	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	199
				200	x__xgafv: string, V1 error format.
				201	Allowed values
				202	1 - v1 error format
				203	2 - v2 error format
				204
				205	Returns:
				206	An object of the form:
				207
				208	{ # A contact group.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	209	"clientData": [ # The group's client data.
yoshi-code-bot	6970659	2021-03-03 03:54:02 -0800	[diff] [blame]	210	{ # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	211	"key": "A String", # The client specified key of the client data.
				212	"value": "A String", # The client specified value of the client data.
				213	},
				214	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	215	"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
				216	"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.
				217	"groupType": "A String", # Output only. The contact group type.
				218	"memberCount": 42, # Output only. The total number of contacts in the group irrespective of max members in specified in the request.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	219	"memberResourceNames": [ # Output only. The list of contact person resource names that are members of the contact group. The field is only populated for GET requests and will only return as many members as `maxMembers` in the get request.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	220	"A String",
				221	],
				222	"metadata": { # The metadata about a contact group. # Output only. Metadata about the contact group.
				223	"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.
				224	"updateTime": "A String", # Output only. The time the group was last updated.
				225	},
				226	"name": "A String", # The contact group name set by the group owner or a system provided name for system groups.
				227	"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}`.
				228	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	229	</div>
				230
				231	<div class="method">
				232	<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]	233	<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]	234
				235	Args:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	236	resourceName: string, Required. The resource name of the contact group to delete. (required)
				237	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]	238	x__xgafv: string, V1 error format.
				239	Allowed values
				240	1 - v1 error format
				241	2 - v2 error format
				242
				243	Returns:
				244	An object of the form:
				245
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	246	{ # 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 `{}`.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	247	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	248	</div>
				249
				250	<div class="method">
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	251	<code class="details" id="get">get(resourceName, groupFields=None, maxMembers=None, x__xgafv=None)</code>
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	252	<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]	253
				254	Args:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	255	resourceName: string, Required. The resource name of the contact group to get. (required)
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	256	groupFields: string, Optional. A field mask to restrict which fields on the group are returned. Defaults to `metadata`, `groupType`, `memberCount`, and `name` if not set or set to empty. Valid fields are: * clientData * groupType * memberCount * metadata * name
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	257	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]	258	x__xgafv: string, V1 error format.
				259	Allowed values
				260	1 - v1 error format
				261	2 - v2 error format
				262
				263	Returns:
				264	An object of the form:
				265
				266	{ # A contact group.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	267	"clientData": [ # The group's client data.
yoshi-code-bot	6970659	2021-03-03 03:54:02 -0800	[diff] [blame]	268	{ # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	269	"key": "A String", # The client specified key of the client data.
				270	"value": "A String", # The client specified value of the client data.
				271	},
				272	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	273	"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
				274	"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.
				275	"groupType": "A String", # Output only. The contact group type.
				276	"memberCount": 42, # Output only. The total number of contacts in the group irrespective of max members in specified in the request.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	277	"memberResourceNames": [ # Output only. The list of contact person resource names that are members of the contact group. The field is only populated for GET requests and will only return as many members as `maxMembers` in the get request.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	278	"A String",
				279	],
				280	"metadata": { # The metadata about a contact group. # Output only. Metadata about the contact group.
				281	"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.
				282	"updateTime": "A String", # Output only. The time the group was last updated.
				283	},
				284	"name": "A String", # The contact group name set by the group owner or a system provided name for system groups.
				285	"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}`.
				286	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	287	</div>
				288
				289	<div class="method">
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	290	<code class="details" id="list">list(groupFields=None, pageSize=None, pageToken=None, syncToken=None, x__xgafv=None)</code>
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	291	<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]	292
				293	Args:
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	294	groupFields: string, Optional. A field mask to restrict which fields on the group are returned. Defaults to `metadata`, `groupType`, `memberCount`, and `name` if not set or set to empty. Valid fields are: * clientData * groupType * memberCount * metadata * name
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	295	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	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	296	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 Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	297	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 Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	298	x__xgafv: string, V1 error format.
				299	Allowed values
				300	1 - v1 error format
				301	2 - v2 error format
				302
				303	Returns:
				304	An object of the form:
				305
				306	{ # The response to a list contact groups request.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	307	"contactGroups": [ # The list of contact groups. Members of the contact groups are not populated.
				308	{ # A contact group.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	309	"clientData": [ # The group's client data.
yoshi-code-bot	6970659	2021-03-03 03:54:02 -0800	[diff] [blame]	310	{ # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	311	"key": "A String", # The client specified key of the client data.
				312	"value": "A String", # The client specified value of the client data.
				313	},
				314	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	315	"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
				316	"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.
				317	"groupType": "A String", # Output only. The contact group type.
				318	"memberCount": 42, # Output only. The total number of contacts in the group irrespective of max members in specified in the request.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	319	"memberResourceNames": [ # Output only. The list of contact person resource names that are members of the contact group. The field is only populated for GET requests and will only return as many members as `maxMembers` in the get request.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	320	"A String",
				321	],
				322	"metadata": { # The metadata about a contact group. # Output only. Metadata about the contact group.
				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	"updateTime": "A String", # Output only. The time the group was last updated.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	325	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	326	"name": "A String", # The contact group name set by the group owner or a system provided name for system groups.
				327	"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}`.
				328	},
				329	],
				330	"nextPageToken": "A String", # The token that can be used to retrieve the next page of results.
				331	"nextSyncToken": "A String", # The token that can be used to retrieve changes since the last request.
				332	"totalItems": 42, # The total number of items in the list without pagination.
				333	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	334	</div>
				335
				336	<div class="method">
				337	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				338	<pre>Retrieves the next page of results.
				339
				340	Args:
				341	previous_request: The request for the previous page. (required)
				342	previous_response: The response from the request for the previous page. (required)
				343
				344	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	345	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]	346	page. Returns None if there are no more items in the collection.
				347	</pre>
				348	</div>
				349
				350	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	351	<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]	352	<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]	353
				354	Args:
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	355	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]	356	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	357	The object takes the form of:
				358
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	359	{ # A request to update an existing user contact group. All updated fields will be replaced.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	360	"contactGroup": { # A contact group. # Required. The contact group to update.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	361	"clientData": [ # The group's client data.
yoshi-code-bot	6970659	2021-03-03 03:54:02 -0800	[diff] [blame]	362	{ # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	363	"key": "A String", # The client specified key of the client data.
				364	"value": "A String", # The client specified value of the client data.
				365	},
				366	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	367	"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
				368	"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.
				369	"groupType": "A String", # Output only. The contact group type.
				370	"memberCount": 42, # Output only. The total number of contacts in the group irrespective of max members in specified in the request.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	371	"memberResourceNames": [ # Output only. The list of contact person resource names that are members of the contact group. The field is only populated for GET requests and will only return as many members as `maxMembers` in the get request.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	372	"A String",
				373	],
				374	"metadata": { # The metadata about a contact group. # Output only. Metadata about the contact group.
				375	"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.
				376	"updateTime": "A String", # Output only. The time the group was last updated.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	377	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	378	"name": "A String", # The contact group name set by the group owner or a system provided name for system groups.
				379	"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}`.
				380	},
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	381	"readGroupFields": "A String", # Optional. A field mask to restrict which fields on the group are returned. Defaults to `metadata`, `groupType`, and `name` if not set or set to empty. Valid fields are: * clientData * groupType * memberCount * metadata * name
				382	"updateGroupFields": "A String", # Optional. A field mask to restrict which fields on the group are updated. Multiple fields can be specified by separating them with commas. Defaults to `name` if not set or set to empty. Updated fields are replaced. Valid values are: * clientData * name
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	383	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	384
				385	x__xgafv: string, V1 error format.
				386	Allowed values
				387	1 - v1 error format
				388	2 - v2 error format
				389
				390	Returns:
				391	An object of the form:
				392
				393	{ # A contact group.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	394	"clientData": [ # The group's client data.
yoshi-code-bot	6970659	2021-03-03 03:54:02 -0800	[diff] [blame]	395	{ # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	396	"key": "A String", # The client specified key of the client data.
				397	"value": "A String", # The client specified value of the client data.
				398	},
				399	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	400	"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
				401	"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.
				402	"groupType": "A String", # Output only. The contact group type.
				403	"memberCount": 42, # Output only. The total number of contacts in the group irrespective of max members in specified in the request.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	404	"memberResourceNames": [ # Output only. The list of contact person resource names that are members of the contact group. The field is only populated for GET requests and will only return as many members as `maxMembers` in the get request.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	405	"A String",
				406	],
				407	"metadata": { # The metadata about a contact group. # Output only. Metadata about the contact group.
				408	"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.
				409	"updateTime": "A String", # Output only. The time the group was last updated.
				410	},
				411	"name": "A String", # The contact group name set by the group owner or a system provided name for system groups.
				412	"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}`.
				413	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	414	</div>
				415
				416	</body></html>