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

2016-02-19 16:02:29 -0800

[diff] [blame]

76

<h2>Instance Methods</h2>

77

Bu Sun Kim

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

[diff] [blame^]

78

<code><a href="#list">list(resourceName, sortOrder=None, syncToken=None, pageToken=None, personFields=None, pageSize=None, requestMask_includeField=None, requestSyncToken=None, x__xgafv=None)</a></code></p>

Sai Cheemalapati

c30d2b5

2017-03-13 12:12:03 -0400

[diff] [blame]

79

<p class="firstline">Provides a list of the authenticated user's contacts merged with any</p>

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

80

81

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

82

<p class="firstline">Retrieves the next page of results.</p>

83

<h3>Method Details</h3>

84

Bu Sun Kim

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

[diff] [blame^]

85

<code class="details" id="list">list(resourceName, sortOrder=None, syncToken=None, pageToken=None, personFields=None, pageSize=None, requestMask_includeField=None, requestSyncToken=None, x__xgafv=None)</code>

86

<pre>Provides a list of the authenticated user's contacts merged with any

Bu Sun Kim

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

[diff] [blame]

87

connected profiles.

Dan O'Meara

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

[diff] [blame]

88

Bu Sun Kim

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

[diff] [blame^]

89

The request throws a 400 error if 'personFields' is not specified.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

90

91

Args:

Dan O'Meara

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

[diff] [blame]

92

resourceName: string, Required. The resource name to return connections for. Only `people/me` is valid. (required)

Bu Sun Kim

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

[diff] [blame^]

93

sortOrder: string, Optional. The order in which the connections should be sorted. Defaults to

94

`LAST_MODIFIED_ASCENDING`.

95

syncToken: string, Optional. A sync token, received from a previous `ListConnections` call.

96

Provide this to retrieve only the resources changed since the last request.

97

Sync requests that specify `sync_token` have an additional rate limit.

98

99

When syncing, all other parameters provided to `ListConnections`

100

must match the call that provided the sync token.

Dan O'Meara

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

[diff] [blame]

101

pageToken: string, Optional. A page token, received from a previous `ListConnections` call.

102

Provide this to retrieve the subsequent page.

103

104

When paginating, all other parameters provided to `ListConnections`

105

must match the call that provided the page token.

Dan O'Meara

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

[diff] [blame]

106

personFields: string, Required. A field mask to restrict which fields on each person are returned. Multiple

107

fields can be specified by separating them with commas. Valid values are:

Bu Sun Kim

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

[diff] [blame]

* addresses

* ageRanges

* biographies

* birthdays

Bu Sun Kim

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

[diff] [blame]

* coverPhotos

* emailAddresses

* events

* genders

* imClients

* interests

* locales

* memberships

* metadata

* names

* nicknames

* occupations

* organizations

* phoneNumbers

* photos

* relations

Bu Sun Kim

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

[diff] [blame]

129

* residences

130

* sipAddresses

131

* skills

Bu Sun Kim

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

[diff] [blame]

132

* urls

133

* userDefined

Bu Sun Kim

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

[diff] [blame^]

134

pageSize: integer, Optional. The number of connections to include in the response. Valid values are

135

between 1 and 1000, inclusive. Defaults to 100 if not set or set to 0.

136

requestMask_includeField: string, Required. Comma-separated list of person fields to be included in the response. Each

137

path should start with `person.`: for example, `person.names` or

138

`person.photos`.

Dan O'Meara

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

[diff] [blame]

139

requestSyncToken: boolean, Optional. Whether the response should include `next_sync_token`, which can be used to

140

get all changes since the last request. For subsequent sync requests use

141

the `sync_token` param instead. Initial sync requests that specify

Bu Sun Kim

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

[diff] [blame]

142

`request_sync_token` have an additional rate limit.

Bu Sun Kim

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

[diff] [blame^]

143

x__xgafv: string, V1 error format.

144

Allowed values

145

1 - v1 error format

146

2 - v2 error format

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

147

148

Returns:

149

An object of the form:

150

Bu Sun Kim

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

[diff] [blame^]

151

{ # The response to a request for the authenticated user's connections.

152

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

153

"nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page.

Dan O'Meara

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

[diff] [blame]

154

# If this field is omitted, there are no subsequent pages.

Bu Sun Kim

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

[diff] [blame^]

155

"totalPeople": 42, # **DEPRECATED** (Please use totalItems)

156

# The total number of people in the list without pagination.

157

"connections": [ # The list of people that the requestor is connected to.

Sai Cheemalapati

c30d2b5

2017-03-13 12:12:03 -0400

[diff] [blame]

158

{ # Information about a person merged from various data sources such as the

Bu Sun Kim

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

[diff] [blame^]

159

# authenticated user's contacts and profile data.

Dan O'Meara

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

[diff] [blame]

160

#

Bu Sun Kim

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

[diff] [blame^]

161

# Most fields can have multiple items. The items in a field have no guaranteed

162

# order, but each non-empty field is guaranteed to have exactly one field with

163

# `metadata.primary` set to true.

164

"interests": [ # The person's interests.

165

{ # One of the person's interests.

166

"value": "A String", # The interest; for example, `stargazing`.

167

"metadata": { # Metadata about a field. # Metadata about the interest.

168

"source": { # The source of a field. # The source of the field.

169

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**

170

#

171

# Last update timestamp of this source.

172

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**

173

#

174

# Metadata about a source of type PROFILE.

175

"userTypes": [ # Output only. The user types.

176

"A String",

177

],

178

"objectType": "A String", # Output only. The profile object type.

179

},

180

"type": "A String", # The source type.

181

"id": "A String", # The unique identifier within the source type generated by the server.

182

"etag": "A String", # **Only populated in `person.metadata.sources`.**

183

#

184

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

185

# source. Used for web cache validation.

186

},

187

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A

188

# verified field is typically a name, email address, phone number, or

189

# website that has been confirmed to be owned by the person.

190

"primary": True or False, # True if the field is the primary field; false if the field is a secondary

# field.

},

},

],

"userDefined": [ # The person's user defined data.

196

{ # Arbitrary user data that is populated by the end users.

197

"metadata": { # Metadata about a field. # Metadata about the user defined data.

198

"source": { # The source of a field. # The source of the field.

199

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**

200

#

201

# Last update timestamp of this source.

202

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**

203

#

204

# Metadata about a source of type PROFILE.

205

"userTypes": [ # Output only. The user types.

206

"A String",

207

],

208

"objectType": "A String", # Output only. The profile object type.

209

},

210

"type": "A String", # The source type.

211

"id": "A String", # The unique identifier within the source type generated by the server.

212

"etag": "A String", # **Only populated in `person.metadata.sources`.**

213

#

214

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

215

# source. Used for web cache validation.

216

},

217

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A

218

# verified field is typically a name, email address, phone number, or

219

# website that has been confirmed to be owned by the person.

220

"primary": True or False, # True if the field is the primary field; false if the field is a secondary

221

# field.

222

},

223

"key": "A String", # The end user specified key of the user defined data.

224

"value": "A String", # The end user specified value of the user defined data.

225

},

226

],

227

"sipAddresses": [ # The person's SIP addresses.

228

{ # A person's SIP address. Session Initial Protocol addresses are used for VoIP

229

# communications to make voice or video calls over the internet.

230

"value": "A String", # The SIP address in the

231

# [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI

232

# format.

233

"type": "A String", # The type of the SIP address. The type can be custom or or one of these

# predefined values:

#

# * `home`

# * `work`

# * `mobile`

# * `other`

"metadata": { # Metadata about a field. # Metadata about the SIP address.

241

"source": { # The source of a field. # The source of the field.

242

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**

243

#

244

# Last update timestamp of this source.

245

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**

246

#

247

# Metadata about a source of type PROFILE.

248

"userTypes": [ # Output only. The user types.

249

"A String",

250

],

251

"objectType": "A String", # Output only. The profile object type.

252

},

253

"type": "A String", # The source type.

254

"id": "A String", # The unique identifier within the source type generated by the server.

255

"etag": "A String", # **Only populated in `person.metadata.sources`.**

256

#

257

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

258

# source. Used for web cache validation.

259

},

260

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A

261

# verified field is typically a name, email address, phone number, or

262

# website that has been confirmed to be owned by the person.

263

"primary": True or False, # True if the field is the primary field; false if the field is a secondary

264

# field.

265

},

266

"formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the

267

# viewer's account locale or the `Accept-Language` HTTP header locale.

268

},

269

],

270

"phoneNumbers": [ # The person's phone numbers.

271

{ # A person's phone number.

272

"type": "A String", # The type of the phone number. The type can be custom or one of these

# predefined values:

#

# * `home`

# * `work`

# * `mobile`

# * `homeFax`

# * `workFax`

# * `otherFax`

# * `pager`

# * `workMobile`

# * `workPager`

# * `main`

# * `googleVoice`

# * `other`

"value": "A String", # The phone number.

288

"canonicalForm": "A String", # Output only. The canonicalized [ITU-T

289

# E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf)

290

# form of the phone number.

291

"formattedType": "A String", # Output only. The type of the phone number translated and formatted in the

292

# viewer's account locale or the `Accept-Language` HTTP header locale.

293

"metadata": { # Metadata about a field. # Metadata about the phone number.

294

"source": { # The source of a field. # The source of the field.

295

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**

296

#

297

# Last update timestamp of this source.

298

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**

299

#

300

# Metadata about a source of type PROFILE.

301

"userTypes": [ # Output only. The user types.

302

"A String",

303

],

304

"objectType": "A String", # Output only. The profile object type.

305

},

306

"type": "A String", # The source type.

307

"id": "A String", # The unique identifier within the source type generated by the server.

308

"etag": "A String", # **Only populated in `person.metadata.sources`.**

309

#

310

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

311

# source. Used for web cache validation.

312

},

313

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A

314

# verified field is typically a name, email address, phone number, or

315

# website that has been confirmed to be owned by the person.

316

"primary": True or False, # True if the field is the primary field; false if the field is a secondary

# field.

},

},

],

"occupations": [ # The person's occupations.

322

{ # A person's occupation.

323

"value": "A String", # The occupation; for example, `carpenter`.

324

"metadata": { # Metadata about a field. # Metadata about the occupation.

325

"source": { # The source of a field. # The source of the field.

326

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**

327

#

328

# Last update timestamp of this source.

329

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**

330

#

331

# Metadata about a source of type PROFILE.

332

"userTypes": [ # Output only. The user types.

333

"A String",

334

],

335

"objectType": "A String", # Output only. The profile object type.

336

},

337

"type": "A String", # The source type.

338

"id": "A String", # The unique identifier within the source type generated by the server.

339

"etag": "A String", # **Only populated in `person.metadata.sources`.**

340

#

341

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

342

# source. Used for web cache validation.

343

},

344

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A

345

# verified field is typically a name, email address, phone number, or

346

# website that has been confirmed to be owned by the person.

347

"primary": True or False, # True if the field is the primary field; false if the field is a secondary

# field.

},

},

],

"ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead)

353

#

354

# The person's age range.

355

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

356

# resource. Used for web cache validation.

357

"biographies": [ # The person's biographies.

358

{ # A person's short biography.

359

"metadata": { # Metadata about a field. # Metadata about the biography.

360

"source": { # The source of a field. # The source of the field.

361

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**

362

#

363

# Last update timestamp of this source.

364

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**

365

#

366

# Metadata about a source of type PROFILE.

367

"userTypes": [ # Output only. The user types.

368

"A String",

369

],

370

"objectType": "A String", # Output only. The profile object type.

371

},

372

"type": "A String", # The source type.

373

"id": "A String", # The unique identifier within the source type generated by the server.

374

"etag": "A String", # **Only populated in `person.metadata.sources`.**

375

#

376

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

377

# source. Used for web cache validation.

378

},

379

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A

380

# verified field is typically a name, email address, phone number, or

381

# website that has been confirmed to be owned by the person.

382

"primary": True or False, # True if the field is the primary field; false if the field is a secondary

383

# field.

384

},

385

"contentType": "A String", # The content type of the biography.

386

"value": "A String", # The short biography.

387

},

388

],

389

"locales": [ # The person's locale preferences.

390

{ # A person's locale preference.

391

"metadata": { # Metadata about a field. # Metadata about the locale.

392

"source": { # The source of a field. # The source of the field.

393

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**

394

#

395

# Last update timestamp of this source.

396

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**

397

#

398

# Metadata about a source of type PROFILE.

399

"userTypes": [ # Output only. The user types.

400

"A String",

401

],

402

"objectType": "A String", # Output only. The profile object type.

403

},

404

"type": "A String", # The source type.

405

"id": "A String", # The unique identifier within the source type generated by the server.

406

"etag": "A String", # **Only populated in `person.metadata.sources`.**

407

#

408

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

409

# source. Used for web cache validation.

410

},

411

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A

412

# verified field is typically a name, email address, phone number, or

413

# website that has been confirmed to be owned by the person.

414

"primary": True or False, # True if the field is the primary field; false if the field is a secondary

415

# field.

416

},

417

"value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47)

418

# language tag representing the locale.

419

},

420

],

421

"taglines": [ # Output only. **DEPRECATED**: No data will be returned

422

# The person's taglines.

423

{ # **DEPRECATED**: No data will be returned

424

# A brief one-line description of the person.

425

"metadata": { # Metadata about a field. # Metadata about the tagline.

426

"source": { # The source of a field. # The source of the field.

427

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**

428

#

429

# Last update timestamp of this source.

430

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**

431

#

432

# Metadata about a source of type PROFILE.

433

"userTypes": [ # Output only. The user types.

434

"A String",

435

],

436

"objectType": "A String", # Output only. The profile object type.

437

},

438

"type": "A String", # The source type.

439

"id": "A String", # The unique identifier within the source type generated by the server.

440

"etag": "A String", # **Only populated in `person.metadata.sources`.**

441

#

442

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

443

# source. Used for web cache validation.

444

},

445

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A

446

# verified field is typically a name, email address, phone number, or

447

# website that has been confirmed to be owned by the person.

448

"primary": True or False, # True if the field is the primary field; false if the field is a secondary

449

# field.

450

},

451

"value": "A String", # The tagline.

452

},

453

],

454

"organizations": [ # The person's past or current organizations.

455

{ # A person's past or current organization. Overlapping date ranges are

456

# permitted.

457

"title": "A String", # The person's job title at the organization.

458

"symbol": "A String", # The symbol associated with the organization; for example, a stock ticker

459

# symbol, abbreviation, or acronym.

460

"name": "A String", # The name of the organization.

461

"startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The start date when the person joined the organization.

462

# and time zone are either specified elsewhere or are not significant. The date

463

# is relative to the Proleptic Gregorian Calendar. This can represent:

464

#

465

# * A full date, with non-zero year, month and day values

466

# * A month and day value, with a zero year, e.g. an anniversary

467

# * A year on its own, with zero month and day values

468

# * A year and month value, with a zero day, e.g. a credit card expiration date

469

#

470

# Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.

471

"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without

472

# a year.

473

"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a

474

# month and day.

475

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0

476

# if specifying a year by itself or a year and month where the day is not

477

# significant.

478

},

479

"department": "A String", # The person's department at the organization.

480

"current": True or False, # True if the organization is the person's current organization;

481

# false if the organization is a past organization.

482

"location": "A String", # The location of the organization office the person works at.

483

"domain": "A String", # The domain name associated with the organization; for example,

484

# `google.com`.

485

"metadata": { # Metadata about a field. # Metadata about the organization.

486

"source": { # The source of a field. # The source of the field.

487

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**

488

#

489

# Last update timestamp of this source.

490

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**

491

#

492

# Metadata about a source of type PROFILE.

493

"userTypes": [ # Output only. The user types.

494

"A String",

495

],

496

"objectType": "A String", # Output only. The profile object type.

497

},

498

"type": "A String", # The source type.

499

"id": "A String", # The unique identifier within the source type generated by the server.

500

"etag": "A String", # **Only populated in `person.metadata.sources`.**

501

#

502

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

503

# source. Used for web cache validation.

504

},

505

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A

506

# verified field is typically a name, email address, phone number, or

507

# website that has been confirmed to be owned by the person.

508

"primary": True or False, # True if the field is the primary field; false if the field is a secondary

509

# field.

510

},

511

"jobDescription": "A String", # The person's job description at the organization.

512

"endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The end date when the person left the organization.

513

# and time zone are either specified elsewhere or are not significant. The date

514

# is relative to the Proleptic Gregorian Calendar. This can represent:

515

#

516

# * A full date, with non-zero year, month and day values

517

# * A month and day value, with a zero year, e.g. an anniversary

518

# * A year on its own, with zero month and day values

519

# * A year and month value, with a zero day, e.g. a credit card expiration date

520

#

521

# Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.

522

"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without

523

# a year.

524

"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a

525

# month and day.

526

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0

527

# if specifying a year by itself or a year and month where the day is not

528

# significant.

529

},

530

"phoneticName": "A String", # The phonetic name of the organization.

531

"formattedType": "A String", # Output only. The type of the organization translated and formatted in the

532

# viewer's account locale or the `Accept-Language` HTTP header locale.

533

"type": "A String", # The type of the organization. The type can be custom or one of these

# predefined values:

#

# * `work`

# * `school`

},

],

"residences": [ # The person's residences.

541

{ # A person's past or current residence.

542

"metadata": { # Metadata about a field. # Metadata about the residence.

543

"source": { # The source of a field. # The source of the field.

544

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**

545

#

546

# Last update timestamp of this source.

547

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**

548

#

549

# Metadata about a source of type PROFILE.

550

"userTypes": [ # Output only. The user types.

551

"A String",

552

],

553

"objectType": "A String", # Output only. The profile object type.

554

},

555

"type": "A String", # The source type.

556

"id": "A String", # The unique identifier within the source type generated by the server.

557

"etag": "A String", # **Only populated in `person.metadata.sources`.**

558

#

559

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

560

# source. Used for web cache validation.

561

},

562

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A

563

# verified field is typically a name, email address, phone number, or

564

# website that has been confirmed to be owned by the person.

565

"primary": True or False, # True if the field is the primary field; false if the field is a secondary

566

# field.

567

},

568

"current": True or False, # True if the residence is the person's current residence;

569

# false if the residence is a past residence.

570

"value": "A String", # The address of the residence.

571

},

572

],

573

"genders": [ # The person's genders.

574

{ # A person's gender.

575

"formattedValue": "A String", # Output only. The value of the gender translated and formatted in the viewer's account

576

# locale or the `Accept-Language` HTTP header locale. Unspecified or custom

577

# value are not localized.

578

"metadata": { # Metadata about a field. # Metadata about the gender.

579

"source": { # The source of a field. # The source of the field.

580

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**

581

#

582

# Last update timestamp of this source.

583

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**

584

#

585

# Metadata about a source of type PROFILE.

586

"userTypes": [ # Output only. The user types.

587

"A String",

588

],

589

"objectType": "A String", # Output only. The profile object type.

590

},

591

"type": "A String", # The source type.

592

"id": "A String", # The unique identifier within the source type generated by the server.

593

"etag": "A String", # **Only populated in `person.metadata.sources`.**

594

#

595

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

596

# source. Used for web cache validation.

597

},

598

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A

599

# verified field is typically a name, email address, phone number, or

600

# website that has been confirmed to be owned by the person.

601

"primary": True or False, # True if the field is the primary field; false if the field is a secondary

602

# field.

603

},

604

"addressMeAs": "A String", # The type of pronouns that should be used to address the person. The value

605

# can be custom or one of these predefined values:

#

# * `male`

# * `female`

# * `other`

"value": "A String", # The gender for the person. The gender can be custom or one of these

# predefined values:

#

# * `male`

# * `female`

# * `unspecified`

},

],

"relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned

619

# The person's relationship interests.

620

{ # **DEPRECATED**: No data will be returned

621

# A person's relationship interest .

622

"formattedValue": "A String", # Output only. The value of the relationship interest translated and formatted

623

# in the viewer's account locale or the locale specified in the

624

# Accept-Language HTTP header.

625

"metadata": { # Metadata about a field. # Metadata about the relationship interest.

626

"source": { # The source of a field. # The source of the field.

627

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**

628

#

629

# Last update timestamp of this source.

630

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**

631

#

632

# Metadata about a source of type PROFILE.

633

"userTypes": [ # Output only. The user types.

634

"A String",

635

],

636

"objectType": "A String", # Output only. The profile object type.

637

},

638

"type": "A String", # The source type.

639

"id": "A String", # The unique identifier within the source type generated by the server.

640

"etag": "A String", # **Only populated in `person.metadata.sources`.**

641

#

642

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

643

# source. Used for web cache validation.

644

},

645

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A

646

# verified field is typically a name, email address, phone number, or

647

# website that has been confirmed to be owned by the person.

648

"primary": True or False, # True if the field is the primary field; false if the field is a secondary

649

# field.

650

},

651

"value": "A String", # The kind of relationship the person is looking for. The value can be custom

652

# or one of these predefined values:

#

# * `friend`

# * `date`

# * `relationship`

# * `networking`

},

],

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

661

"previousResourceNames": [ # Output only. Any former resource names this person has had. Populated only for

662

# [`connections.list`](/people/api/rest/v1/people.connections/list) requests

663

# that include a sync token.

Dan O'Meara

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

[diff] [blame]

664

#

Bu Sun Kim

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

[diff] [blame^]

665

# The resource name may change when adding or removing fields that link a

666

# contact and profile such as a verified email, verified phone number, or

# profile URL.

"A String",

],

"sources": [ # The sources of data for the person.

671

{ # The source of a field.

672

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**

Dan O'Meara

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

[diff] [blame]

673

#

674

# Last update timestamp of this source.

Bu Sun Kim

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

[diff] [blame^]

675

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**

676

#

677

# Metadata about a source of type PROFILE.

678

"userTypes": [ # Output only. The user types.

679

"A String",

680

],

681

"objectType": "A String", # Output only. The profile object type.

682

},

683

"type": "A String", # The source type.

684

"id": "A String", # The unique identifier within the source type generated by the server.

685

"etag": "A String", # **Only populated in `person.metadata.sources`.**

Dan O'Meara

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

[diff] [blame]

686

#

687

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

688

# source. Used for web cache validation.

Dan O'Meara

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

[diff] [blame]

689

},

Bu Sun Kim

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

[diff] [blame^]

690

],

691

"linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.

692

"A String",

693

],

694

"objectType": "A String", # Output only. **DEPRECATED** (Please use

695

# `person.metadata.sources.profileMetadata.objectType` instead)

Dan O'Meara

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

[diff] [blame]

696

#

Bu Sun Kim

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

[diff] [blame^]

697

# The type of the person object.

698

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

699

# [`connections.list`](/people/api/rest/v1/people.connections/list) requests

700

# that include a sync token.

Dan O'Meara

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

[diff] [blame]

701

},

Bu Sun Kim

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

[diff] [blame^]

702

"memberships": [ # The person's group memberships.

703

{ # A person's membership in a group. Only contact group memberships can be

704

# modified.

705

"metadata": { # Metadata about a field. # Metadata about the membership.

706

"source": { # The source of a field. # The source of the field.

707

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**

708

#

709

# Last update timestamp of this source.

710

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**

711

#

712

# Metadata about a source of type PROFILE.

713

"userTypes": [ # Output only. The user types.

714

"A String",

715

],

716

"objectType": "A String", # Output only. The profile object type.

717

},

718

"type": "A String", # The source type.

719

"id": "A String", # The unique identifier within the source type generated by the server.

720

"etag": "A String", # **Only populated in `person.metadata.sources`.**

721

#

722

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

723

# source. Used for web cache validation.

724

},

725

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A

726

# verified field is typically a name, email address, phone number, or

727

# website that has been confirmed to be owned by the person.

728

"primary": True or False, # True if the field is the primary field; false if the field is a secondary

729

# field.

730

},

731

"contactGroupMembership": { # A Google contact group membership. # The contact group membership.

732

"contactGroupId": "A String", # Output only. The contact group ID for the contact group membership.

733

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

734

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

735

# Only contact_group_resource_name can be used for modifying memberships.

736

# Any contact group membership can be removed, but only user group or

737

# "myContacts" or "starred" system groups memberships can be added. A

738

# contact must always have at least one contact group membership.

739

},

740

"domainMembership": { # A G Suite Domain membership. # Output only. The domain membership.

741

"inViewerDomain": True or False, # True if the person is in the viewer's G Suite domain.

},

},

],

"birthdays": [ # The person's birthdays.

746

{ # A person's birthday. At least one of the `date` and `text` fields are

747

# specified. The `date` and `text` fields typically represent the same

748

# date, but are not guaranteed to.

749

"date": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The date of the birthday.

750

# and time zone are either specified elsewhere or are not significant. The date

751

# is relative to the Proleptic Gregorian Calendar. This can represent:

752

#

753

# * A full date, with non-zero year, month and day values

754

# * A month and day value, with a zero year, e.g. an anniversary

755

# * A year on its own, with zero month and day values

756

# * A year and month value, with a zero day, e.g. a credit card expiration date

757

#

758

# Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.

759

"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without

760

# a year.

761

"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a

762

# month and day.

763

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0

764

# if specifying a year by itself or a year and month where the day is not

765

# significant.

766

},

767

"metadata": { # Metadata about a field. # Metadata about the birthday.

768

"source": { # The source of a field. # The source of the field.

769

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**

770

#

771

# Last update timestamp of this source.

772

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**

773

#

774

# Metadata about a source of type PROFILE.

775

"userTypes": [ # Output only. The user types.

776

"A String",

777

],

778

"objectType": "A String", # Output only. The profile object type.

779

},

780

"type": "A String", # The source type.

781

"id": "A String", # The unique identifier within the source type generated by the server.

782

"etag": "A String", # **Only populated in `person.metadata.sources`.**

783

#

784

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

785

# source. Used for web cache validation.

786

},

787

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A

788

# verified field is typically a name, email address, phone number, or

789

# website that has been confirmed to be owned by the person.

790

"primary": True or False, # True if the field is the primary field; false if the field is a secondary

791

# field.

792

},

793

"text": "A String", # A free-form string representing the user's birthday.

794

},

795

],

796

"imClients": [ # The person's instant messaging clients.

797

{ # A person's instant messaging client.

798

"formattedType": "A String", # Output only. The type of the IM client translated and formatted in the

799

# viewer's account locale or the `Accept-Language` HTTP header locale.

800

"protocol": "A String", # The protocol of the IM client. The protocol can be custom or one of these

# predefined values:

#

# * `aim`

# * `msn`

# * `yahoo`

# * `skype`

# * `qq`

# * `googleTalk`

# * `icq`

# * `jabber`

# * `netMeeting`

"username": "A String", # The user name used in the IM client.

813

"type": "A String", # The type of the IM client. The type can be custom or one of these

# predefined values:

#

# * `home`

# * `work`

# * `other`

"formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account

820

# locale or the `Accept-Language` HTTP header locale.

821

"metadata": { # Metadata about a field. # Metadata about the IM client.

822

"source": { # The source of a field. # The source of the field.

823

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**

824

#

825

# Last update timestamp of this source.

826

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**

827

#

828

# Metadata about a source of type PROFILE.

829

"userTypes": [ # Output only. The user types.

830

"A String",

831

],

832

"objectType": "A String", # Output only. The profile object type.

833

},

834

"type": "A String", # The source type.

835

"id": "A String", # The unique identifier within the source type generated by the server.

836

"etag": "A String", # **Only populated in `person.metadata.sources`.**

837

#

838

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

839

# source. Used for web cache validation.

840

},

841

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A

842

# verified field is typically a name, email address, phone number, or

843

# website that has been confirmed to be owned by the person.

844

"primary": True or False, # True if the field is the primary field; false if the field is a secondary

# field.

},

},

],

"skills": [ # The person's skills.

850

{ # A skill that the person has.

851

"metadata": { # Metadata about a field. # Metadata about the skill.

852

"source": { # The source of a field. # The source of the field.

853

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**

854

#

855

# Last update timestamp of this source.

856

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**

857

#

858

# Metadata about a source of type PROFILE.

859

"userTypes": [ # Output only. The user types.

860

"A String",

861

],

862

"objectType": "A String", # Output only. The profile object type.

863

},

864

"type": "A String", # The source type.

865

"id": "A String", # The unique identifier within the source type generated by the server.

866

"etag": "A String", # **Only populated in `person.metadata.sources`.**

867

#

868

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

869

# source. Used for web cache validation.

870

},

871

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A

872

# verified field is typically a name, email address, phone number, or

873

# website that has been confirmed to be owned by the person.

874

"primary": True or False, # True if the field is the primary field; false if the field is a secondary

875

# field.

876

},

877

"value": "A String", # The skill; for example, `underwater basket weaving`.

878

},

879

],

880

"relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned

881

# The person's relationship statuses.

882

{ # **DEPRECATED**: No data will be returned

883

# A person's relationship status.

884

"formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in

885

# the viewer's account locale or the `Accept-Language` HTTP header locale.

886

"metadata": { # Metadata about a field. # Metadata about the relationship status.

887

"source": { # The source of a field. # The source of the field.

888

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**

889

#

890

# Last update timestamp of this source.

891

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**

892

#

893

# Metadata about a source of type PROFILE.

894

"userTypes": [ # Output only. The user types.

895

"A String",

896

],

897

"objectType": "A String", # Output only. The profile object type.

898

},

899

"type": "A String", # The source type.

900

"id": "A String", # The unique identifier within the source type generated by the server.

901

"etag": "A String", # **Only populated in `person.metadata.sources`.**

902

#

903

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

904

# source. Used for web cache validation.

905

},

906

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A

907

# verified field is typically a name, email address, phone number, or

908

# website that has been confirmed to be owned by the person.

909

"primary": True or False, # True if the field is the primary field; false if the field is a secondary

910

# field.

911

},

912

"value": "A String", # The relationship status. The value can be custom or one of these

# predefined values:

#

# * `single`

# * `inARelationship`

# * `engaged`

# * `married`

# * `itsComplicated`

# * `openRelationship`

921

# * `widowed`

922

# * `inDomesticPartnership`

# * `inCivilUnion`

},

],

"coverPhotos": [ # Output only. The person's cover photos.

927

{ # A person's cover photo. A large image shown on the person's

928

# profile page that represents who they are or what they care about.

929

"url": "A String", # The URL of the cover photo.

930

"default": True or False, # True if the cover photo is the default cover photo;

931

# false if the cover photo is a user-provided cover photo.

932

"metadata": { # Metadata about a field. # Metadata about the cover photo.

933

"source": { # The source of a field. # The source of the field.

934

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**

935

#

936

# Last update timestamp of this source.

937

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**

938

#

939

# Metadata about a source of type PROFILE.

940

"userTypes": [ # Output only. The user types.

941

"A String",

942

],

943

"objectType": "A String", # Output only. The profile object type.

944

},

945

"type": "A String", # The source type.

946

"id": "A String", # The unique identifier within the source type generated by the server.

947

"etag": "A String", # **Only populated in `person.metadata.sources`.**

948

#

949

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

950

# source. Used for web cache validation.

951

},

952

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A

953

# verified field is typically a name, email address, phone number, or

954

# website that has been confirmed to be owned by the person.

955

"primary": True or False, # True if the field is the primary field; false if the field is a secondary

# field.

},

},

],

"names": [ # The person's names.

961

{ # A person's name. If the name is a mononym, the family name is empty.

962

"middleName": "A String", # The middle name(s).

963

"phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.

964

"displayNameLastFirst": "A String", # Output only. The display name with the last name first formatted according to

965

# the locale specified by the viewer's account or the

966

# `Accept-Language` HTTP header.

967

"honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`

968

"familyName": "A String", # The family name.

969

"phoneticGivenName": "A String", # The given name spelled as it sounds.

970

"metadata": { # Metadata about a field. # Metadata about the name.

971

"source": { # The source of a field. # The source of the field.

972

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**

973

#

974

# Last update timestamp of this source.

975

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**

976

#

977

# Metadata about a source of type PROFILE.

978

"userTypes": [ # Output only. The user types.

979

"A String",

980

],

981

"objectType": "A String", # Output only. The profile object type.

982

},

983

"type": "A String", # The source type.

984

"id": "A String", # The unique identifier within the source type generated by the server.

985

"etag": "A String", # **Only populated in `person.metadata.sources`.**

986

#

987

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

988

# source. Used for web cache validation.

989

},

990

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A

991

# verified field is typically a name, email address, phone number, or

992

# website that has been confirmed to be owned by the person.

993

"primary": True or False, # True if the field is the primary field; false if the field is a secondary

994

# field.

995

},

996

"phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.

997

"displayName": "A String", # Output only. The display name formatted according to the locale specified by

998

# the viewer's account or the `Accept-Language` HTTP header.

999

"phoneticFamilyName": "A String", # The family name spelled as it sounds.

1000

"honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`

1001

"givenName": "A String", # The given name.

1002

"phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.

1003

"phoneticFullName": "A String", # The full name spelled as it sounds.

1004

},

1005

],

1006

"relations": [ # The person's relations.

1007

{ # A person's relation to another person.

1008

"type": "A String", # The person's relation to the other person. The type can be custom or one of

1009

# these predefined values:

#

# * `spouse`

# * `child`

# * `mother`

# * `father`

# * `parent`

# * `brother`

# * `sister`

# * `friend`

# * `relative`

# * `domesticPartner`

# * `manager`

# * `assistant`

# * `referredBy`

# * `partner`

"metadata": { # Metadata about a field. # Metadata about the relation.

1026

"source": { # The source of a field. # The source of the field.

1027

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**

1028

#

1029

# Last update timestamp of this source.

1030

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**

1031

#

1032

# Metadata about a source of type PROFILE.

1033

"userTypes": [ # Output only. The user types.

1034

"A String",

1035

],

1036

"objectType": "A String", # Output only. The profile object type.

1037

},

1038

"type": "A String", # The source type.

1039

"id": "A String", # The unique identifier within the source type generated by the server.

1040

"etag": "A String", # **Only populated in `person.metadata.sources`.**

1041

#

1042

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

1043

# source. Used for web cache validation.

1044

},

1045

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A

1046

# verified field is typically a name, email address, phone number, or

1047

# website that has been confirmed to be owned by the person.

1048

"primary": True or False, # True if the field is the primary field; false if the field is a secondary

1049

# field.

1050

},

1051

"person": "A String", # The name of the other person this relation refers to.

1052

"formattedType": "A String", # Output only. The type of the relation translated and formatted in the viewer's

1053

# account locale or the locale specified in the Accept-Language HTTP header.

1054

},

1055

],

1056

"ageRanges": [ # Output only. The person's age ranges.

1057

{ # A person's age range.

1058

"metadata": { # Metadata about a field. # Metadata about the age range.

1059

"source": { # The source of a field. # The source of the field.

1060

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**

1061

#

1062

# Last update timestamp of this source.

1063

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**

1064

#

1065

# Metadata about a source of type PROFILE.

1066

"userTypes": [ # Output only. The user types.

1067

"A String",

1068

],

1069

"objectType": "A String", # Output only. The profile object type.

1070

},

1071

"type": "A String", # The source type.

1072

"id": "A String", # The unique identifier within the source type generated by the server.

1073

"etag": "A String", # **Only populated in `person.metadata.sources`.**

1074

#

1075

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

1076

# source. Used for web cache validation.

1077

},

1078

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A

1079

# verified field is typically a name, email address, phone number, or

1080

# website that has been confirmed to be owned by the person.

1081

"primary": True or False, # True if the field is the primary field; false if the field is a secondary

1082

# field.

1083

},

1084

"ageRange": "A String", # The age range.

1085

},

1086

],

1087

"braggingRights": [ # **DEPRECATED**: No data will be returned

1088

# The person's bragging rights.

1089

{ # **DEPRECATED**: No data will be returned

1090

# A person's bragging rights.

1091

"value": "A String", # The bragging rights; for example, `climbed mount everest`.

1092

"metadata": { # Metadata about a field. # Metadata about the bragging rights.

1093

"source": { # The source of a field. # The source of the field.

1094

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**

1095

#

1096

# Last update timestamp of this source.

1097

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**

1098

#

1099

# Metadata about a source of type PROFILE.

1100

"userTypes": [ # Output only. The user types.

1101

"A String",

1102

],

1103

"objectType": "A String", # Output only. The profile object type.

1104

},

1105

"type": "A String", # The source type.

1106

"id": "A String", # The unique identifier within the source type generated by the server.

1107

"etag": "A String", # **Only populated in `person.metadata.sources`.**

1108

#

1109

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

1110

# source. Used for web cache validation.

1111

},

1112

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A

1113

# verified field is typically a name, email address, phone number, or

1114

# website that has been confirmed to be owned by the person.

1115

"primary": True or False, # True if the field is the primary field; false if the field is a secondary

# field.

},

},

],

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

1121

# with a max length of 27 characters, in the form of

1122

# `people/{person_id}`.

1123

"photos": [ # Output only. The person's photos.

1124

{ # A person's photo. A picture shown next to the person's name to

1125

# help others recognize the person.

1126

"url": "A String", # The URL of the photo. You can change the desired size by appending a query

1127

# parameter `sz={size}` at the end of the url, where {size} is the size in

1128

# pixels. Example:

1129

# https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50

1130

"default": True or False, # True if the photo is a default photo;

1131

# false if the photo is a user-provided photo.

1132

"metadata": { # Metadata about a field. # Metadata about the photo.

1133

"source": { # The source of a field. # The source of the field.

1134

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**

1135

#

1136

# Last update timestamp of this source.

1137

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**

1138

#

1139

# Metadata about a source of type PROFILE.

1140

"userTypes": [ # Output only. The user types.

1141

"A String",

1142

],

1143

"objectType": "A String", # Output only. The profile object type.

1144

},

1145

"type": "A String", # The source type.

1146

"id": "A String", # The unique identifier within the source type generated by the server.

1147

"etag": "A String", # **Only populated in `person.metadata.sources`.**

1148

#

1149

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

1150

# source. Used for web cache validation.

1151

},

1152

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A

1153

# verified field is typically a name, email address, phone number, or

1154

# website that has been confirmed to be owned by the person.

1155

"primary": True or False, # True if the field is the primary field; false if the field is a secondary

# field.

},

},

],

"addresses": [ # The person's street addresses.

1161

{ # A person's physical address. May be a P.O. box or street address. All fields

1162

# are optional.

1163

"streetAddress": "A String", # The street address.

1164

"formattedValue": "A String", # The unstructured value of the address. If this is not set by the user it

1165

# will be automatically constructed from structured values.

1166

"country": "A String", # The country of the address.

1167

"formattedType": "A String", # Output only. The type of the address translated and formatted in the viewer's

1168

# account locale or the `Accept-Language` HTTP header locale.

1169

"city": "A String", # The city of the address.

1170

"postalCode": "A String", # The postal code of the address.

1171

"extendedAddress": "A String", # The extended address of the address; for example, the apartment number.

1172

"type": "A String", # The type of the address. The type can be custom or one of these predefined

# values:

#

# * `home`

# * `work`

# * `other`

"region": "A String", # The region of the address; for example, the state or province.

1179

"poBox": "A String", # The P.O. box of the address.

1180

"metadata": { # Metadata about a field. # Metadata about the address.

1181

"source": { # The source of a field. # The source of the field.

1182

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**

1183

#

1184

# Last update timestamp of this source.

1185

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**

1186

#

1187

# Metadata about a source of type PROFILE.

1188

"userTypes": [ # Output only. The user types.

1189

"A String",

1190

],

1191

"objectType": "A String", # Output only. The profile object type.

1192

},

1193

"type": "A String", # The source type.

1194

"id": "A String", # The unique identifier within the source type generated by the server.

1195

"etag": "A String", # **Only populated in `person.metadata.sources`.**

1196

#

1197

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

1198

# source. Used for web cache validation.

1199

},

1200

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A

1201

# verified field is typically a name, email address, phone number, or

1202

# website that has been confirmed to be owned by the person.

1203

"primary": True or False, # True if the field is the primary field; false if the field is a secondary

1204

# field.

1205

},

1206

"countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country

1207

# code of the address.

1208

},

1209

],

1210

"emailAddresses": [ # The person's email addresses.

1211

{ # A person's email address.

1212

"formattedType": "A String", # Output only. The type of the email address translated and formatted in the

1213

# viewer's account locale or the `Accept-Language` HTTP header locale.

1214

"metadata": { # Metadata about a field. # Metadata about the email address.

1215

"source": { # The source of a field. # The source of the field.

1216

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**

1217

#

1218

# Last update timestamp of this source.

1219

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**

1220

#

1221

# Metadata about a source of type PROFILE.

1222

"userTypes": [ # Output only. The user types.

1223

"A String",

1224

],

1225

"objectType": "A String", # Output only. The profile object type.

1226

},

1227

"type": "A String", # The source type.

1228

"id": "A String", # The unique identifier within the source type generated by the server.

1229

"etag": "A String", # **Only populated in `person.metadata.sources`.**

1230

#

1231

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

1232

# source. Used for web cache validation.

1233

},

1234

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A

1235

# verified field is typically a name, email address, phone number, or

1236

# website that has been confirmed to be owned by the person.

1237

"primary": True or False, # True if the field is the primary field; false if the field is a secondary

1238

# field.

1239

},

1240

"value": "A String", # The email address.

1241

"displayName": "A String", # The display name of the email.

1242

"type": "A String", # The type of the email address. The type can be custom or one of these

# predefined values:

#

# * `home`

# * `work`

# * `other`

},

],

"nicknames": [ # The person's nicknames.

1251

{ # A person's nickname.

1252

"metadata": { # Metadata about a field. # Metadata about the nickname.

1253

"source": { # The source of a field. # The source of the field.

1254

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**

1255

#

1256

# Last update timestamp of this source.

1257

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**

1258

#

1259

# Metadata about a source of type PROFILE.

1260

"userTypes": [ # Output only. The user types.

1261

"A String",

1262

],

1263

"objectType": "A String", # Output only. The profile object type.

1264

},

1265

"type": "A String", # The source type.

1266

"id": "A String", # The unique identifier within the source type generated by the server.

1267

"etag": "A String", # **Only populated in `person.metadata.sources`.**

1268

#

1269

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

1270

# source. Used for web cache validation.

1271

},

1272

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A

1273

# verified field is typically a name, email address, phone number, or

1274

# website that has been confirmed to be owned by the person.

1275

"primary": True or False, # True if the field is the primary field; false if the field is a secondary

1276

# field.

1277

},

1278

"type": "A String", # The type of the nickname.

1279

"value": "A String", # The nickname.

1280

},

1281

],

1282

"events": [ # The person's events.

1283

{ # An event related to the person.

1284

"date": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The date of the event.

1285

# and time zone are either specified elsewhere or are not significant. The date

1286

# is relative to the Proleptic Gregorian Calendar. This can represent:

1287

#

1288

# * A full date, with non-zero year, month and day values

1289

# * A month and day value, with a zero year, e.g. an anniversary

1290

# * A year on its own, with zero month and day values

1291

# * A year and month value, with a zero day, e.g. a credit card expiration date

1292

#

1293

# Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.

1294

"year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without

1295

# a year.

1296

"month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a

1297

# month and day.

1298

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0

1299

# if specifying a year by itself or a year and month where the day is not

1300

# significant.

1301

},

1302

"formattedType": "A String", # Output only. The type of the event translated and formatted in the

1303

# viewer's account locale or the `Accept-Language` HTTP header locale.

1304

"metadata": { # Metadata about a field. # Metadata about the event.

1305

"source": { # The source of a field. # The source of the field.

1306

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**

1307

#

1308

# Last update timestamp of this source.

1309

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**

1310

#

1311

# Metadata about a source of type PROFILE.

1312

"userTypes": [ # Output only. The user types.

1313

"A String",

1314

],

1315

"objectType": "A String", # Output only. The profile object type.

1316

},

1317

"type": "A String", # The source type.

1318

"id": "A String", # The unique identifier within the source type generated by the server.

1319

"etag": "A String", # **Only populated in `person.metadata.sources`.**

1320

#

1321

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

1322

# source. Used for web cache validation.

1323

},

1324

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A

1325

# verified field is typically a name, email address, phone number, or

1326

# website that has been confirmed to be owned by the person.

1327

"primary": True or False, # True if the field is the primary field; false if the field is a secondary

1328

# field.

1329

},

1330

"type": "A String", # The type of the event. The type can be custom or one of these predefined

# values:

#

# * `anniversary`

# * `other`

},

],

"urls": [ # The person's associated URLs.

1338

{ # A person's associated URLs.

1339

"type": "A String", # The type of the URL. The type can be custom or one of these predefined

# values:

#

# * `home`

# * `work`

# * `blog`

# * `profile`

# * `homePage`

# * `ftp`

# * `reservations`

# * `appInstallPage`: website for a Google+ application.

1350

# * `other`

1351

"metadata": { # Metadata about a field. # Metadata about the URL.

1352

"source": { # The source of a field. # The source of the field.

1353

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**

1354

#

1355

# Last update timestamp of this source.

1356

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**

1357

#

1358

# Metadata about a source of type PROFILE.

1359

"userTypes": [ # Output only. The user types.

1360

"A String",

1361

],

1362

"objectType": "A String", # Output only. The profile object type.

1363

},

1364

"type": "A String", # The source type.

1365

"id": "A String", # The unique identifier within the source type generated by the server.

1366

"etag": "A String", # **Only populated in `person.metadata.sources`.**

1367

#

1368

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

1369

# source. Used for web cache validation.

1370

},

1371

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A

1372

# verified field is typically a name, email address, phone number, or

1373

# website that has been confirmed to be owned by the person.

1374

"primary": True or False, # True if the field is the primary field; false if the field is a secondary

1375

# field.

1376

},

1377

"formattedType": "A String", # Output only. The type of the URL translated and formatted in the viewer's

1378

# account locale or the `Accept-Language` HTTP header locale.

1379

"value": "A String", # The URL.

1380

},

1381

],

1382

},

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1383

],

Bu Sun Kim

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

[diff] [blame^]

1384

"nextSyncToken": "A String", # A token, which can be sent as `sync_token` to retrieve changes since the

Dan O'Meara

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

[diff] [blame]

1385

# last request. Request must set `request_sync_token` to return the sync

1386

# token.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

}</pre>

</div>

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

1392

<pre>Retrieves the next page of results.

1393

1394

Args:

1395

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

1396

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

1397

1398

Returns:

Bu Sun Kim

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

[diff] [blame^]

1399

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

Jon Wayne Parrott