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

2019-06-14 16:50:42 -0700

[diff] [blame]

<style>

body, h1, h2, h3, div, span, p, pre, a {

margin: 0;

padding: 0;

border: 0;

font-weight: inherit;

9

font-style: inherit;

10

font-size: 100%;

11

font-family: inherit;

12

vertical-align: baseline;

}

body {

font-size: 13px;

padding: 1em;

}

h1 {

font-size: 26px;

margin-bottom: 1em;

}

h2 {

font-size: 24px;

margin-bottom: 1em;

}

h3 {

font-size: 20px;

margin-bottom: 1em;

margin-top: 1em;

}

pre, code {

line-height: 1.5;

font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;

}

pre {

margin-top: 0.5em;

}

h1, h2, h3, p {

font-family: Arial, sans serif;

}

h1, h2, h3 {

border-bottom: solid #CCC 1px;

}

.toc_element {

margin-top: 0.5em;

}

.firstline {

margin-left: 2 em;

}

.method {

margin-top: 1em;

border: solid 1px #CCC;

padding: 1em;

background: #EEE;

}

.details {

font-weight: bold;

font-size: 14px;

}

</style>

<h1><a href="people_v1.html">People API</a> . <a href="people_v1.contactGroups.html">contactGroups</a></h1>

76

<h2>Instance Methods</h2>

77

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

83

<code><a href="#batchGet">batchGet(maxMembers=None, resourceNames=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

84

<p class="firstline">Get a list of contact groups owned by the authenticated user by specifying</p>

85

Dan O'Meara

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

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

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

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

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

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

Dan O'Meara

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

2019-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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

105

<code class="details" id="batchGet">batchGet(maxMembers=None, resourceNames=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

106

<pre>Get a list of contact groups owned by the authenticated user by specifying

107

a list of contact group resource names.

108

109

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

110

maxMembers: integer, Optional. Specifies the maximum number of members to return for each group. Defaults

111

to 0 if not set, which will return zero members.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

112

resourceNames: string, Required. The resource names of the contact groups to get. (repeated)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

113

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

120

121

{ # The response to a batch get contact groups request.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

122

"responses": [ # The list of responses for each requested contact group resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

123

{ # The response for a specific contact group.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

124

"contactGroup": { # A contact group. # The contact group.

125

"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the

126

# resource. Used for web cache validation.

127

"memberCount": 42, # Output only. The total number of contacts in the group irrespective of max members in

128

# specified in the request.

129

"groupType": "A String", # Output only. The contact group type.

130

"name": "A String", # The contact group name set by the group owner or a system provided name

131

# for system groups.

132

"memberResourceNames": [ # Output only. The list of contact person resource names that are members of the contact

133

# group. The field is not populated for LIST requests and can only be updated

134

# through the

135

# [ModifyContactGroupMembers](/people/api/rest/v1/contactgroups/members/modify).

136

"A String",

137

],

138

"formattedName": "A String", # Output only. The name translated and formatted in the viewer's account locale

139

# or the `Accept-Language` HTTP header locale for system groups names.

140

# Group names set by the owner are the same as name.

141

"resourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII

142

# string, in the form of `contactGroups/{contact_group_id}`.

143

"metadata": { # The metadata about a contact group. # Output only. Metadata about the contact group.

144

"deleted": True or False, # Output only. True if the contact group resource has been deleted. Populated only for

145

# [`ListContactGroups`](/people/api/rest/v1/contactgroups/list) requests

146

# that include a sync token.

147

"updateTime": "A String", # Output only. The time the group was last updated.

148

},

149

},

150

"requestedResourceName": "A String", # The original requested resource name.

151

"status": { # The `Status` type defines a logical error model that is suitable for # The status of the response.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

152

# different programming environments, including REST APIs and RPC APIs. It is

153

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

154

# three pieces of data: error code, error message, and error details.

155

#

156

# You can find out more about this error model and how to work with it in the

157

# [API Design Guide](https://cloud.google.com/apis/design/errors).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

158

"message": "A String", # A developer-facing error message, which should be in English. Any

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

159

# user-facing error message should be localized and sent in the

160

# google.rpc.Status.details field, or localized by the client.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

161

"details": [ # A list of messages that carry the error details. There is a common set of

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

162

# message types for APIs to use.

163

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

164

"a_key": "", # Properties of the object. Contains field @type with type URL.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

165

},

166

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

167

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

168

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

},

],

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

175

<code class="details" id="create">create(body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

176

<pre>Create a new contact group owned by the authenticated user.

177

178

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

179

body: object, The request body.

Bu Sun Kim

2019-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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

183

"contactGroup": { # A contact group. # Required. The contact group to create.

184

"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the

185

# resource. Used for web cache validation.

186

"memberCount": 42, # Output only. The total number of contacts in the group irrespective of max members in

187

# specified in the request.

188

"groupType": "A String", # Output only. The contact group type.

189

"name": "A String", # The contact group name set by the group owner or a system provided name

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

190

# for system groups.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

191

"memberResourceNames": [ # Output only. The list of contact person resource names that are members of the contact

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

192

# group. The field is not populated for LIST requests and can only be updated

193

# through the

194

# [ModifyContactGroupMembers](/people/api/rest/v1/contactgroups/members/modify).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

195

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

196

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

197

"formattedName": "A String", # Output only. The name translated and formatted in the viewer's account locale

198

# or the `Accept-Language` HTTP header locale for system groups names.

199

# Group names set by the owner are the same as name.

200

"resourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

201

# string, in the form of `contactGroups/{contact_group_id}`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

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 Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

204

# [`ListContactGroups`](/people/api/rest/v1/contactgroups/list) requests

205

# that include a sync token.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

206

"updateTime": "A String", # Output only. The time the group was last updated.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

},

},

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

218

219

{ # A contact group.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

220

"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the

221

# resource. Used for web cache validation.

222

"memberCount": 42, # Output only. The total number of contacts in the group irrespective of max members in

223

# specified in the request.

224

"groupType": "A String", # Output only. The contact group type.

225

"name": "A String", # The contact group name set by the group owner or a system provided name

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

226

# for system groups.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

227

"memberResourceNames": [ # Output only. The list of contact person resource names that are members of the contact

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

228

# group. The field is not populated for LIST requests and can only be updated

229

# through the

230

# [ModifyContactGroupMembers](/people/api/rest/v1/contactgroups/members/modify).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

231

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

232

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

233

"formattedName": "A String", # Output only. The name translated and formatted in the viewer's account locale

234

# or the `Accept-Language` HTTP header locale for system groups names.

235

# Group names set by the owner are the same as name.

236

"resourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

237

# string, in the form of `contactGroups/{contact_group_id}`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

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 Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

240

# [`ListContactGroups`](/people/api/rest/v1/contactgroups/list) requests

241

# that include a sync token.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

242

"updateTime": "A String", # Output only. The time the group was last updated.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

},

}</pre>

</div>

<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

250

specifying a contact group resource name.

251

252

Args:

Dan O'Meara

2020-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 Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

255

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

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 `{}`.

}</pre>

</div>

<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

278

a contact group resource name.

279

280

Args:

Dan O'Meara

2020-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

283

set, which will return zero members.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

284

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

291

292

{ # A contact group.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

293

"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the

294

# resource. Used for web cache validation.

295

"memberCount": 42, # Output only. The total number of contacts in the group irrespective of max members in

296

# specified in the request.

297

"groupType": "A String", # Output only. The contact group type.

298

"name": "A String", # The contact group name set by the group owner or a system provided name

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

299

# for system groups.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

300

"memberResourceNames": [ # Output only. The list of contact person resource names that are members of the contact

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

301

# group. The field is not populated for LIST requests and can only be updated

302

# through the

303

# [ModifyContactGroupMembers](/people/api/rest/v1/contactgroups/members/modify).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

304

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

305

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

306

"formattedName": "A String", # Output only. The name translated and formatted in the viewer's account locale

307

# or the `Accept-Language` HTTP header locale for system groups names.

308

# Group names set by the owner are the same as name.

309

"resourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

310

# string, in the form of `contactGroups/{contact_group_id}`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

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 Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

313

# [`ListContactGroups`](/people/api/rest/v1/contactgroups/list) requests

314

# that include a sync token.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

315

"updateTime": "A String", # Output only. The time the group was last updated.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

},

}</pre>

</div>

<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

323

contact groups are not populated.

324

325

Args:

Dan O'Meara

2020-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

327

1000, 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 Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

329

Only resources changed since the sync token was created will be returned.

Dan O'Meara

2020-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 Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

331

[ListContactGroups](/people/api/rest/v1/contactgroups/list).

332

Requests the next page of resources.

333

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

340

341

{ # The response to a list contact groups request.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

342

"nextSyncToken": "A String", # The token that can be used to retrieve changes since the last request.

343

"contactGroups": [ # The list of contact groups. Members of the contact groups are not

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

344

# populated.

345

{ # A contact group.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

346

"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the

347

# resource. Used for web cache validation.

348

"memberCount": 42, # Output only. The total number of contacts in the group irrespective of max members in

349

# specified in the request.

350

"groupType": "A String", # Output only. The contact group type.

351

"name": "A String", # The contact group name set by the group owner or a system provided name

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

352

# for system groups.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

353

"memberResourceNames": [ # Output only. The list of contact person resource names that are members of the contact

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

354

# group. The field is not populated for LIST requests and can only be updated

355

# through the

356

# [ModifyContactGroupMembers](/people/api/rest/v1/contactgroups/members/modify).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

357

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

358

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

359

"formattedName": "A String", # Output only. The name translated and formatted in the viewer's account locale

360

# or the `Accept-Language` HTTP header locale for system groups names.

361

# Group names set by the owner are the same as name.

362

"resourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

363

# string, in the form of `contactGroups/{contact_group_id}`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

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 Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

366

# [`ListContactGroups`](/people/api/rest/v1/contactgroups/list) requests

367

# that include a sync token.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

368

"updateTime": "A String", # Output only. The time the group was last updated.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

369

},

370

},

371

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

372

"totalItems": 42, # The total number of items in the list without pagination.

373

"nextPageToken": "A String", # The token that can be used to retrieve the next page of results.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

379

<pre>Retrieves the next page of results.

380

381

Args:

382

previous_request: The request for the previous page. (required)

383

previous_response: The response from the request for the previous page. (required)

384

385

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

386

A request object that you can call 'execute()' on to request the next

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

387

page. Returns None if there are no more items in the collection.

</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

392

<code class="details" id="update">update(resourceName, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

393

<pre>Update the name of an existing contact group owned by the authenticated

user.

Args:

resourceName: string, The resource name for the contact group, assigned by the server. An ASCII

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

398

string, in the form of `contactGroups/{contact_group_id}`. (required)

399

body: object, The request body.

Bu Sun Kim

2019-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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

404

"contactGroup": { # A contact group. # Required. The contact group to update.

405

"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the

406

# resource. Used for web cache validation.

407

"memberCount": 42, # Output only. The total number of contacts in the group irrespective of max members in

408

# specified in the request.

409

"groupType": "A String", # Output only. The contact group type.

410

"name": "A String", # The contact group name set by the group owner or a system provided name

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

411

# for system groups.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

412

"memberResourceNames": [ # Output only. The list of contact person resource names that are members of the contact

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

413

# group. The field is not populated for LIST requests and can only be updated

414

# through the

415

# [ModifyContactGroupMembers](/people/api/rest/v1/contactgroups/members/modify).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

416

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

417

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

418

"formattedName": "A String", # Output only. The name translated and formatted in the viewer's account locale

419

# or the `Accept-Language` HTTP header locale for system groups names.

420

# Group names set by the owner are the same as name.

421

"resourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

422

# string, in the form of `contactGroups/{contact_group_id}`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

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 Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

425

# [`ListContactGroups`](/people/api/rest/v1/contactgroups/list) requests

426

# that include a sync token.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

427

"updateTime": "A String", # Output only. The time the group was last updated.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

},

},

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

439

440

{ # A contact group.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

441

"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the

442

# resource. Used for web cache validation.

443

"memberCount": 42, # Output only. The total number of contacts in the group irrespective of max members in

444

# specified in the request.

445

"groupType": "A String", # Output only. The contact group type.

446

"name": "A String", # The contact group name set by the group owner or a system provided name

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

447

# for system groups.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

448

"memberResourceNames": [ # Output only. The list of contact person resource names that are members of the contact

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

449

# group. The field is not populated for LIST requests and can only be updated

450

# through the

451

# [ModifyContactGroupMembers](/people/api/rest/v1/contactgroups/members/modify).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

452

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

453

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

454

"formattedName": "A String", # Output only. The name translated and formatted in the viewer's account locale

455

# or the `Accept-Language` HTTP header locale for system groups names.

456

# Group names set by the owner are the same as name.

457

"resourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

458

# string, in the form of `contactGroups/{contact_group_id}`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

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 Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

461

# [`ListContactGroups`](/people/api/rest/v1/contactgroups/list) requests

462

# that include a sync token.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

463

"updateTime": "A String", # Output only. The time the group was last updated.

Bu Sun Kim