You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<pre>Get a list of contact groups owned by the authenticated user by specifying a list of contact group resource names.
110
110
111
111
Args:
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
112
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.
113
114
resourceNames: string, Required. The resource names of the contact groups to get. (repeated)
114
115
x__xgafv: string, V1 error format.
@@ -123,11 +124,17 @@ <h3>Method Details</h3>
123
124
"responses": [ # The list of responses for each requested contact group resource.
124
125
{ # The response for a specific contact group.
125
126
"contactGroup": { # A contact group. # The contact group.
127
+
"clientData": [ # The group's client data.
128
+
{ # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed. LINT.IfChange(GroupClientData)
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
+
],
126
133
"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
127
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.
128
135
"groupType": "A String", # Output only. The contact group type.
129
136
"memberCount": 42, # Output only. The total number of contacts in the group irrespective of max members in specified in the request.
130
-
"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).
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.
131
138
"A String",
132
139
],
133
140
"metadata": { # The metadata about a contact group. # Output only. Metadata about the contact group.
@@ -167,11 +174,17 @@ <h3>Method Details</h3>
167
174
168
175
{ # A request to create a new contact group.
169
176
"contactGroup": { # A contact group. # Required. The contact group to create.
177
+
"clientData": [ # The group's client data.
178
+
{ # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed. LINT.IfChange(GroupClientData)
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
+
],
170
183
"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
171
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.
172
185
"groupType": "A String", # Output only. The contact group type.
173
186
"memberCount": 42, # Output only. The total number of contacts in the group irrespective of max members in specified in the request.
174
-
"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).
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.
175
188
"A String",
176
189
],
177
190
"metadata": { # The metadata about a contact group. # Output only. Metadata about the contact group.
@@ -181,6 +194,7 @@ <h3>Method Details</h3>
181
194
"name": "A String", # The contact group name set by the group owner or a system provided name for system groups.
182
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}`.
183
196
},
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
184
198
}
185
199
186
200
x__xgafv: string, V1 error format.
@@ -192,11 +206,17 @@ <h3>Method Details</h3>
192
206
An object of the form:
193
207
194
208
{ # A contact group.
209
+
"clientData": [ # The group's client data.
210
+
{ # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed. LINT.IfChange(GroupClientData)
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
+
],
195
215
"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
196
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.
197
217
"groupType": "A String", # Output only. The contact group type.
198
218
"memberCount": 42, # Output only. The total number of contacts in the group irrespective of max members in specified in the request.
199
-
"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).
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.
200
220
"A String",
201
221
],
202
222
"metadata": { # The metadata about a contact group. # Output only. Metadata about the contact group.
<pre>Get a specific contact group owned by the authenticated user by specifying a contact group resource name.
233
253
234
254
Args:
235
255
resourceName: string, Required. The resource name of the contact group to get. (required)
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
236
257
maxMembers: integer, Optional. Specifies the maximum number of members to return. Defaults to 0 if not set, which will return zero members.
237
258
x__xgafv: string, V1 error format.
238
259
Allowed values
@@ -243,11 +264,17 @@ <h3>Method Details</h3>
243
264
An object of the form:
244
265
245
266
{ # A contact group.
267
+
"clientData": [ # The group's client data.
268
+
{ # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed. LINT.IfChange(GroupClientData)
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
+
],
246
273
"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
247
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.
248
275
"groupType": "A String", # Output only. The contact group type.
249
276
"memberCount": 42, # Output only. The total number of contacts in the group irrespective of max members in specified in the request.
250
-
"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).
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.
251
278
"A String",
252
279
],
253
280
"metadata": { # The metadata about a contact group. # Output only. Metadata about the contact group.
<pre>List all contact groups owned by the authenticated user. Members of the contact groups are not populated.
265
292
266
293
Args:
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
267
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.
268
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.
269
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.
@@ -278,11 +306,17 @@ <h3>Method Details</h3>
278
306
{ # The response to a list contact groups request.
279
307
"contactGroups": [ # The list of contact groups. Members of the contact groups are not populated.
280
308
{ # A contact group.
309
+
"clientData": [ # The group's client data.
310
+
{ # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed. LINT.IfChange(GroupClientData)
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
+
],
281
315
"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
282
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.
283
317
"groupType": "A String", # Output only. The contact group type.
284
318
"memberCount": 42, # Output only. The total number of contacts in the group irrespective of max members in specified in the request.
285
-
"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).
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.
286
320
"A String",
287
321
],
288
322
"metadata": { # The metadata about a contact group. # Output only. Metadata about the contact group.
@@ -324,11 +358,17 @@ <h3>Method Details</h3>
324
358
325
359
{ # A request to update an existing user contact group. All updated fields will be replaced.
326
360
"contactGroup": { # A contact group. # Required. The contact group to update.
361
+
"clientData": [ # The group's client data.
362
+
{ # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed. LINT.IfChange(GroupClientData)
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
+
],
327
367
"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
328
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.
329
369
"groupType": "A String", # Output only. The contact group type.
330
370
"memberCount": 42, # Output only. The total number of contacts in the group irrespective of max members in specified in the request.
331
-
"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).
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.
332
372
"A String",
333
373
],
334
374
"metadata": { # The metadata about a contact group. # Output only. Metadata about the contact group.
@@ -338,6 +378,8 @@ <h3>Method Details</h3>
338
378
"name": "A String", # The contact group name set by the group owner or a system provided name for system groups.
339
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}`.
340
380
},
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
341
383
}
342
384
343
385
x__xgafv: string, V1 error format.
@@ -349,11 +391,17 @@ <h3>Method Details</h3>
349
391
An object of the form:
350
392
351
393
{ # A contact group.
394
+
"clientData": [ # The group's client data.
395
+
{ # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed. LINT.IfChange(GroupClientData)
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
+
],
352
400
"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
353
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.
354
402
"groupType": "A String", # Output only. The contact group type.
355
403
"memberCount": 42, # Output only. The total number of contacts in the group irrespective of max members in specified in the request.
356
-
"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).
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.
357
405
"A String",
358
406
],
359
407
"metadata": { # The metadata about a contact group. # Output only. Metadata about the contact group.
0 commit comments