Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / people_v1.contactGroups.html
blob: a194da78a57f8b017c5d90785c489dd8adf23511 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="people_v1.html">People API</a> . <a href="people_v1.contactGroups.html">contactGroups</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="people_v1.contactGroups.members.html">members()</a></code>
79</p>
80<p class="firstline">Returns the members Resource.</p>
81
82<p class="toc_element">
83 <code><a href="#batchGet">batchGet(resourceNames=None, maxMembers=None, x__xgafv=None)</a></code></p>
84<p class="firstline">Get a list of contact groups owned by the authenticated user by specifying</p>
85<p class="toc_element">
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">
95 <code><a href="#list">list(pageSize=None, syncToken=None, pageToken=None, x__xgafv=None)</a></code></p>
96<p class="firstline">List all contact groups owned by the authenticated user. Members of the</p>
97<p class="toc_element">
98 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
99<p class="firstline">Retrieves the next page of results.</p>
100<p class="toc_element">
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">
105 <code class="details" id="batchGet">batchGet(resourceNames=None, maxMembers=None, x__xgafv=None)</code>
106 <pre>Get a list of contact groups owned by the authenticated user by specifying
107a list of contact group resource names.
108
109Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]110 resourceNames: string, Required. The resource names of the contact groups to get. (repeated)
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.
122 "responses": [ # The list of responses for each requested contact group resource.
123 { # The response for a specific contact group.
124 "status": { # The `Status` type defines a logical error model that is suitable for # The status of the response.
125 # different programming environments, including REST APIs and RPC APIs. It is
126 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
127 # three pieces of data: error code, error message, and error details.
128 #
129 # You can find out more about this error model and how to work with it in the
130 # [API Design Guide](https://cloud.google.com/apis/design/errors).
131 "message": "A String", # A developer-facing error message, which should be in English. Any
132 # user-facing error message should be localized and sent in the
133 # google.rpc.Status.details field, or localized by the client.
134 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
135 "details": [ # A list of messages that carry the error details. There is a common set of
136 # message types for APIs to use.
137 {
138 "a_key": "", # Properties of the object. Contains field @type with type URL.
139 },
140 ],
141 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]142 "contactGroup": { # A contact group. # The contact group.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]143 "groupType": "A String", # Output only. The contact group type.
144 "formattedName": "A String", # Output only. The name translated and formatted in the viewer's account locale
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]145 # or the `Accept-Language` HTTP header locale for system groups names.
146 # Group names set by the owner are the same as name.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]147 "name": "A String", # The contact group name set by the group owner or a system provided name
148 # for system groups.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]149 "memberResourceNames": [ # 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]150 # group. The field is not populated for LIST requests and can only be updated
151 # through the
152 # [ModifyContactGroupMembers](/people/api/rest/v1/contactgroups/members/modify).
153 "A String",
154 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]155 "memberCount": 42, # Output only. The total number of contacts in the group irrespective of max members in
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]156 # specified in the request.
157 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
158 # resource. Used for web cache validation.
159 "resourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]160 # string, in the form of `contactGroups/{contact_group_id}`.
161 "metadata": { # The metadata about a contact group. # Output only. Metadata about the contact group.
162 "deleted": 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]163 # [`ListContactGroups`](/people/api/rest/v1/contactgroups/list) requests
164 # that include a sync token.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]165 "updateTime": "A String", # Output only. The time the group was last updated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]166 },
167 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]168 "requestedResourceName": "A String", # The original requested resource name.
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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]183 "contactGroup": { # A contact group. # Required. The contact group to create.
184 "groupType": "A String", # Output only. The contact group type.
185 "formattedName": "A String", # Output only. The name translated and formatted in the viewer's account locale
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]186 # or the `Accept-Language` HTTP header locale for system groups names.
187 # Group names set by the owner are the same as name.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]188 "name": "A String", # The contact group name set by the group owner or a system provided name
189 # for system groups.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]190 "memberResourceNames": [ # 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]191 # group. The field is not populated for LIST requests and can only be updated
192 # through the
193 # [ModifyContactGroupMembers](/people/api/rest/v1/contactgroups/members/modify).
194 "A String",
195 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]196 "memberCount": 42, # Output only. The total number of contacts in the group irrespective of max members in
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]197 # specified in the request.
198 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
199 # resource. Used for web cache validation.
200 "resourceName": "A 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^]201 # string, in the form of `contactGroups/{contact_group_id}`.
202 "metadata": { # The metadata about a contact group. # Output only. Metadata about the contact group.
203 "deleted": 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]204 # [`ListContactGroups`](/people/api/rest/v1/contactgroups/list) requests
205 # that include a sync token.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]206 "updateTime": "A String", # Output only. The time the group was last updated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]207 },
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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]220 "groupType": "A String", # Output only. The contact group type.
221 "formattedName": "A String", # Output only. The name translated and formatted in the viewer's account locale
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]222 # or the `Accept-Language` HTTP header locale for system groups names.
223 # Group names set by the owner are the same as name.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]224 "name": "A String", # The contact group name set by the group owner or a system provided name
225 # for system groups.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]226 "memberResourceNames": [ # 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]227 # group. The field is not populated for LIST requests and can only be updated
228 # through the
229 # [ModifyContactGroupMembers](/people/api/rest/v1/contactgroups/members/modify).
230 "A String",
231 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]232 "memberCount": 42, # Output only. The total number of contacts in the group irrespective of max members in
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]233 # specified in the request.
234 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
235 # resource. Used for web cache validation.
236 "resourceName": "A 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^]237 # string, in the form of `contactGroups/{contact_group_id}`.
238 "metadata": { # The metadata about a contact group. # Output only. Metadata about the contact group.
239 "deleted": 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]240 # [`ListContactGroups`](/people/api/rest/v1/contactgroups/list) requests
241 # that include a sync token.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]242 "updateTime": "A String", # Output only. The time the group was last updated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]243 },
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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]293 "groupType": "A String", # Output only. The contact group type.
294 "formattedName": "A String", # Output only. The name translated and formatted in the viewer's account locale
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]295 # or the `Accept-Language` HTTP header locale for system groups names.
296 # Group names set by the owner are the same as name.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]297 "name": "A String", # The contact group name set by the group owner or a system provided name
298 # for system groups.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]299 "memberResourceNames": [ # 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]300 # group. The field is not populated for LIST requests and can only be updated
301 # through the
302 # [ModifyContactGroupMembers](/people/api/rest/v1/contactgroups/members/modify).
303 "A String",
304 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]305 "memberCount": 42, # Output only. The total number of contacts in the group irrespective of max members in
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]306 # specified in the request.
307 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
308 # resource. Used for web cache validation.
309 "resourceName": "A 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^]310 # string, in the form of `contactGroups/{contact_group_id}`.
311 "metadata": { # The metadata about a contact group. # Output only. Metadata about the contact group.
312 "deleted": 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]313 # [`ListContactGroups`](/people/api/rest/v1/contactgroups/list) requests
314 # that include a sync token.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]315 "updateTime": "A String", # Output only. The time the group was last updated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]316 },
317 }</pre>
318</div>
319
320<div class="method">
321 <code class="details" id="list">list(pageSize=None, syncToken=None, pageToken=None, x__xgafv=None)</code>
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 pageSize: integer, Optional. The maximum number of resources to return. Valid values are between 1 and
3271000, inclusive. Defaults to 30 if not set or set to 0.
328 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]329Only resources changed since the sync token was created will be returned.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]330 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]331[ListContactGroups](/people/api/rest/v1/contactgroups/list).
332Requests the next page of resources.
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.
342 "nextPageToken": "A String", # The token that can be used to retrieve the next page of results.
343 "contactGroups": [ # The list of contact groups. Members of the contact groups are not
344 # populated.
345 { # A contact group.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]346 "groupType": "A String", # Output only. The contact group type.
347 "formattedName": "A String", # Output only. The name translated and formatted in the viewer's account locale
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]348 # or the `Accept-Language` HTTP header locale for system groups names.
349 # Group names set by the owner are the same as name.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]350 "name": "A String", # The contact group name set by the group owner or a system provided name
351 # for system groups.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]352 "memberResourceNames": [ # 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]353 # group. The field is not populated for LIST requests and can only be updated
354 # through the
355 # [ModifyContactGroupMembers](/people/api/rest/v1/contactgroups/members/modify).
356 "A String",
357 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]358 "memberCount": 42, # Output only. The total number of contacts in the group irrespective of max members in
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]359 # specified in the request.
360 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
361 # resource. Used for web cache validation.
362 "resourceName": "A 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^]363 # string, in the form of `contactGroups/{contact_group_id}`.
364 "metadata": { # The metadata about a contact group. # Output only. Metadata about the contact group.
365 "deleted": 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]366 # [`ListContactGroups`](/people/api/rest/v1/contactgroups/list) requests
367 # that include a sync token.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]368 "updateTime": "A String", # Output only. The time the group was last updated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]369 },
370 },
371 ],
372 "nextSyncToken": "A String", # The token that can be used to retrieve changes since the last request.
373 "totalItems": 42, # The total number of items in the list without pagination.
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:
386 A request object that you can call 'execute()' on to request the next
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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]404 "contactGroup": { # A contact group. # Required. The contact group to update.
405 "groupType": "A String", # Output only. The contact group type.
406 "formattedName": "A String", # Output only. The name translated and formatted in the viewer's account locale
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]407 # or the `Accept-Language` HTTP header locale for system groups names.
408 # Group names set by the owner are the same as name.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]409 "name": "A String", # The contact group name set by the group owner or a system provided name
410 # for system groups.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]411 "memberResourceNames": [ # 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]412 # group. The field is not populated for LIST requests and can only be updated
413 # through the
414 # [ModifyContactGroupMembers](/people/api/rest/v1/contactgroups/members/modify).
415 "A String",
416 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]417 "memberCount": 42, # Output only. The total number of contacts in the group irrespective of max members in
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]418 # specified in the request.
419 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
420 # resource. Used for web cache validation.
421 "resourceName": "A 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^]422 # string, in the form of `contactGroups/{contact_group_id}`.
423 "metadata": { # The metadata about a contact group. # Output only. Metadata about the contact group.
424 "deleted": 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]425 # [`ListContactGroups`](/people/api/rest/v1/contactgroups/list) requests
426 # that include a sync token.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]427 "updateTime": "A String", # Output only. The time the group was last updated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]428 },
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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]441 "groupType": "A String", # Output only. The contact group type.
442 "formattedName": "A String", # Output only. The name translated and formatted in the viewer's account locale
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]443 # or the `Accept-Language` HTTP header locale for system groups names.
444 # Group names set by the owner are the same as name.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]445 "name": "A String", # The contact group name set by the group owner or a system provided name
446 # for system groups.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]447 "memberResourceNames": [ # 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]448 # group. The field is not populated for LIST requests and can only be updated
449 # through the
450 # [ModifyContactGroupMembers](/people/api/rest/v1/contactgroups/members/modify).
451 "A String",
452 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]453 "memberCount": 42, # Output only. The total number of contacts in the group irrespective of max members in
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]454 # specified in the request.
455 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
456 # resource. Used for web cache validation.
457 "resourceName": "A 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^]458 # string, in the form of `contactGroups/{contact_group_id}`.
459 "metadata": { # The metadata about a contact group. # Output only. Metadata about the contact group.
460 "deleted": 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]461 # [`ListContactGroups`](/people/api/rest/v1/contactgroups/list) requests
462 # that include a sync token.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]463 "updateTime": "A String", # Output only. The time the group was last updated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]464 },
465 }</pre>
466</div>
467
468</body></html>