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-27 12:20:54 -0700

[diff] [blame^]

78

<code><a href="#list">list(resourceName, pageToken=None, sortOrder=None, personFields=None, syncToken=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-27 12:20:54 -0700

[diff] [blame^]

85

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

Bu Sun Kim

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

[diff] [blame]

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)

Dan O'Meara

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

[diff] [blame]

93

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

94

Provide this to retrieve the subsequent page.

95

96

When paginating, all other parameters provided to `ListConnections`

97

must match the call that provided the page token.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

98

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

99

`LAST_MODIFIED_ASCENDING`.

Dan O'Meara

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

[diff] [blame]

100

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

101

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]

123

* residences

124

* sipAddresses

125

* skills

Bu Sun Kim

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

[diff] [blame]

126

* urls

127

* userDefined

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

128

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

129

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

130

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

131

132

When syncing, all other parameters provided to `ListConnections`

133

must match the call that provided the sync token.

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.

Bu Sun Kim

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

[diff] [blame]

152

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

153

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

154

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

155

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

Bu Sun Kim

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

[diff] [blame]

156

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

Sai Cheemalapati

c30d2b5

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

[diff] [blame]

157

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

158

# authenticated user's contacts and profile data.

159

#

160

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

161

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

162

# `metadata.primary` set to true.

163

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

164

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

165

# are optional.

166

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

167

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

168

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

169

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

170

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

171

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

172

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

173

# code of the address.

174

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

175

# values:

Dan O'Meara

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

[diff] [blame]

176

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

# * `home`

# * `work`

# * `other`

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

181

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

182

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

183

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

184

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

185

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

186

# field.

187

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

Bu Sun Kim

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

[diff] [blame]

188

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

189

#

190

# Metadata about a source of type PROFILE.

191

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

192

"A String",

193

],

194

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

195

},

196

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

197

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

198

#

199

# Last update timestamp of this source.

Bu Sun Kim

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

[diff] [blame]

200

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

Dan O'Meara

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

[diff] [blame]

201

#

202

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

203

# source. Used for web cache validation.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

204

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

Dan O'Meara

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

[diff] [blame]

205

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

206

},

207

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

208

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

209

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

210

# will be automatically constructed from structured values.

Dan O'Meara

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

[diff] [blame]

211

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

212

],

213

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

214

#

215

# The person's age range.

216

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

217

{ # A person's relation to another person.

218

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

219

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

220

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

221

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

222

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

239

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

240

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

241

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

242

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

243

# field.

244

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

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.

Bu Sun Kim

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

[diff] [blame]

252

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

253

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

254

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

255

#

256

# Last update timestamp of this source.

257

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

258

#

259

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

260

# source. Used for web cache validation.

261

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

Bu Sun Kim

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

[diff] [blame]

262

},

263

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

264

},

265

],

266

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

267

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

268

# permitted.

269

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

270

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

271

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

272

# false if the organization is a past organization.

273

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

274

# symbol, abbreviation, or acronym.

275

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

276

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

277

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

278

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

279

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

280

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

281

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

282

# field.

283

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

284

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

285

#

286

# Metadata about a source of type PROFILE.

287

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

288

"A String",

289

],

290

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

291

},

292

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

293

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

294

#

295

# Last update timestamp of this source.

296

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

297

#

298

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

299

# source. Used for web cache validation.

300

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

301

},

302

},

303

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

# predefined values:

#

# * `work`

# * `school`

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

309

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

310

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

311

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

312

#

313

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

314

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

315

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

316

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

317

#

318

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

319

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

320

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

321

# significant.

322

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

323

# month and day.

324

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

325

# a year.

326

},

327

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

328

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

329

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

330

# `google.com`.

331

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

332

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

333

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

334

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

335

#

336

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

337

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

338

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

339

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

340

#

341

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

342

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

343

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

344

# significant.

345

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

346

# month and day.

347

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

# a year.

},

},

],

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

353

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

354

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

355

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

356

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

357

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

358

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

359

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

360

# field.

361

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

362

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

363

#

364

# Metadata about a source of type PROFILE.

365

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

366

"A String",

367

],

368

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

369

},

370

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

371

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

372

#

373

# Last update timestamp of this source.

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

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

379

},

380

},

381

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

382

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

383

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

384

},

385

],

386

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

387

{ # A person's past or current residence.

388

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

389

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

390

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

391

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

392

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

393

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

394

# field.

395

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

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

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

406

#

407

# Last update timestamp of this source.

408

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

409

#

410

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

411

# source. Used for web cache validation.

412

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

413

},

414

},

415

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

416

# false if the residence is a past residence.

417

},

418

],

419

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

420

{ # A person's instant messaging client.

421

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

422

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

423

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

424

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

425

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

426

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

427

# field.

428

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

429

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

430

#

431

# Metadata about a source of type PROFILE.

432

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

433

"A String",

434

],

435

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

436

},

437

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

438

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

439

#

440

# Last update timestamp of this source.

441

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

442

#

443

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

444

# source. Used for web cache validation.

445

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

446

},

447

},

448

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

# predefined values:

#

# * `home`

# * `work`

# * `other`

"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`

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

467

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

468

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

469

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

470

},

471

],

472

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

473

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

474

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

475

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

476

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

477

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

478

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

479

# field.

480

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

481

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

482

#

483

# Metadata about a source of type PROFILE.

484

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

485

"A String",

486

],

487

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

488

},

489

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

490

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

491

#

492

# Last update timestamp of this source.

493

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

494

#

495

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

496

# source. Used for web cache validation.

497

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

498

},

499

},

500

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

501

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

502

},

503

],

504

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

505

# resource. Used for web cache validation.

506

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

507

# The person's bragging rights.

508

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

509

# A person's bragging rights.

510

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

511

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

512

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

513

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

514

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

515

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

516

# field.

517

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

518

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

519

#

520

# Metadata about a source of type PROFILE.

521

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

522

"A String",

523

],

524

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

525

},

526

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

527

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

528

#

529

# Last update timestamp of this source.

530

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

531

#

532

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

533

# source. Used for web cache validation.

534

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

},

},

},

],

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

540

# The person's relationship interests.

541

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

542

# A person's relationship interest .

543

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

544

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

545

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

546

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

547

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

548

# field.

549

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

550

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

551

#

552

# Metadata about a source of type PROFILE.

553

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

554

"A String",

555

],

556

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

557

},

558

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

559

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

560

#

561

# Last update timestamp of this source.

562

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

563

#

564

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

565

# source. Used for web cache validation.

566

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

567

},

568

},

569

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

570

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

571

# Accept-Language HTTP header.

572

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

573

# or one of these predefined values:

#

# * `friend`

# * `date`

# * `relationship`

# * `networking`

},

],

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

582

{ # A person's age range.

583

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

584

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

585

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

586

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

587

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

588

# field.

589

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

590

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

591

#

592

# Metadata about a source of type PROFILE.

593

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

594

"A String",

595

],

596

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

597

},

598

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

599

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

600

#

601

# Last update timestamp of this source.

602

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

603

#

604

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

605

# source. Used for web cache validation.

606

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

607

},

608

},

609

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

610

},

611

],

612

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

613

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

614

# modified.

615

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

616

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

617

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

618

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

619

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

620

# field.

621

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

622

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

623

#

624

# Metadata about a source of type PROFILE.

625

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

626

"A String",

627

],

628

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

629

},

630

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

631

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

632

#

633

# Last update timestamp of this source.

634

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

635

#

636

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

637

# source. Used for web cache validation.

638

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

639

},

640

},

641

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

642

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

643

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

644

# Only contact_group_resource_name can be used for modifying memberships.

645

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

646

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

647

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

648

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

649

},

650

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

651

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

},

},

],

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

656

{ # A person's occupation.

657

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

658

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

659

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

660

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

661

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

662

# field.

663

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

664

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

665

#

666

# Metadata about a source of type PROFILE.

667

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

668

"A String",

669

],

670

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

671

},

672

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

673

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

674

#

675

# Last update timestamp of this source.

676

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

677

#

678

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

679

# source. Used for web cache validation.

680

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

681

},

682

},

683

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

684

},

685

],

686

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

687

{ # A person's associated URLs.

688

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

689

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

690

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

691

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

692

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

693

# field.

694

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

695

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

696

#

697

# Metadata about a source of type PROFILE.

698

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

699

"A String",

700

],

701

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

702

},

703

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

704

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

705

#

706

# Last update timestamp of this source.

707

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

708

#

709

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

710

# source. Used for web cache validation.

711

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

712

},

713

},

714

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

725

# * `other`

726

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

727

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

728

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

729

},

730

],

731

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

732

{ # A skill that the person has.

733

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

734

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

735

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

736

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

737

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

738

# field.

739

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

740

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

741

#

742

# Metadata about a source of type PROFILE.

743

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

744

"A String",

745

],

746

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

747

},

748

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

749

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

750

#

751

# Last update timestamp of this source.

752

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

753

#

754

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

755

# source. Used for web cache validation.

756

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

757

},

758

},

759

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

760

},

761

],

762

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

763

{ # A person's email address.

764

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

# predefined values:

#

# * `home`

# * `work`

# * `other`

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

771

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

772

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

773

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

774

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

775

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

776

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

777

# field.

778

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

779

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

780

#

781

# Metadata about a source of type PROFILE.

782

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

783

"A String",

784

],

785

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

786

},

787

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

788

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

789

#

790

# Last update timestamp of this source.

791

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

792

#

793

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

794

# source. Used for web cache validation.

795

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

796

},

797

},

798

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

799

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

800

},

801

],

802

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

803

# The person's taglines.

804

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

805

# A brief one-line description of the person.

806

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

807

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

808

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

809

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

810

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

811

# field.

812

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

813

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

814

#

815

# Metadata about a source of type PROFILE.

816

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

817

"A String",

818

],

819

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

820

},

821

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

822

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

823

#

824

# Last update timestamp of this source.

825

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

826

#

827

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

828

# source. Used for web cache validation.

829

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

830

},

831

},

832

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

833

},

834

],

835

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

836

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

837

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

838

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

839

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

840

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

841

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

842

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

843

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

844

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

845

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

846

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

847

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

848

# `Accept-Language` HTTP header.

849

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

850

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

851

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

852

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

853

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

854

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

855

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

856

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

857

# field.

858

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

859

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

860

#

861

# Metadata about a source of type PROFILE.

862

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

863

"A String",

864

],

865

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

866

},

867

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

868

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

869

#

870

# Last update timestamp of this source.

871

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

872

#

873

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

874

# source. Used for web cache validation.

875

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

876

},

877

},

878

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

879

},

880

],

881

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

882

{ # A person's short biography.

883

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

884

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

885

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

886

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

887

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

888

# field.

889

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

890

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

891

#

892

# Metadata about a source of type PROFILE.

893

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

894

"A String",

895

],

896

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

897

},

898

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

899

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

900

#

901

# Last update timestamp of this source.

902

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

903

#

904

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

905

# source. Used for web cache validation.

906

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

907

},

908

},

909

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

910

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

911

},

912

],

913

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

914

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

915

# `people/{person_id}`.

916

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

917

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

918

# help others recognize the person.

919

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

920

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

921

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

922

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

923

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

924

# field.

925

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

926

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

927

#

928

# Metadata about a source of type PROFILE.

929

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

930

"A String",

931

],

932

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

933

},

934

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

935

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

936

#

937

# Last update timestamp of this source.

938

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

939

#

940

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

941

# source. Used for web cache validation.

942

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

943

},

944

},

945

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

946

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

947

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

948

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

949

# pixels. Example:

950

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

951

},

952

],

953

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

954

{ # An event related to the person.

955

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

# values:

#

# * `anniversary`

# * `other`

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

961

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

962

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

963

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

964

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

965

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

966

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

967

# field.

968

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

969

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

970

#

971

# Metadata about a source of type PROFILE.

972

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

973

"A String",

974

],

975

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

976

},

977

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

978

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

979

#

980

# Last update timestamp of this source.

981

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

982

#

983

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

984

# source. Used for web cache validation.

985

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

986

},

987

},

988

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

989

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

990

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

991

#

992

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

993

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

994

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

995

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

996

#

997

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

998

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

999

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

1000

# significant.

1001

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

1002

# month and day.

1003

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

# a year.

},

},

],

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

1009

{ # A person's locale preference.

1010

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

1011

# language tag representing the locale.

1012

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

1013

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

1014

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

1015

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

1016

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

1017

# field.

1018

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

1019

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

1020

#

1021

# Metadata about a source of type PROFILE.

1022

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

1023

"A String",

1024

],

1025

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

1026

},

1027

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

1028

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

1029

#

1030

# Last update timestamp of this source.

1031

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

1032

#

1033

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

1034

# source. Used for web cache validation.

1035

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

},

},

},

],

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

1041

{ # A person's phone number.

1042

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

1043

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

1044

# form of the phone number.

1045

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

1046

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

1047

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

1063

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

1064

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

1065

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

1066

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

1067

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

1068

# field.

1069

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

1070

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

1071

#

1072

# Metadata about a source of type PROFILE.

1073

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

1074

"A String",

1075

],

1076

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

1077

},

1078

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

1079

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

1080

#

1081

# Last update timestamp of this source.

1082

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

1083

#

1084

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

1085

# source. Used for web cache validation.

1086

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

},

},

},

],

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

1092

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

1093

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

1094

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

1095

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

1096

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

1097

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

1098

# format.

1099

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

1107

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

1108

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

1109

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

1110

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

1111

# field.

1112

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

1113

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

1114

#

1115

# Metadata about a source of type PROFILE.

1116

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

1117

"A String",

1118

],

1119

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

1120

},

1121

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

1122

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

1123

#

1124

# Last update timestamp of this source.

1125

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

1126

#

1127

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

1128

# source. Used for web cache validation.

1129

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

},

},

},

],

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

1135

{ # One of the person's interests.

1136

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

1137

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

1138

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

1139

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

1140

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

1141

# field.

1142

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

1143

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

1144

#

1145

# Metadata about a source of type PROFILE.

1146

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

1147

"A String",

1148

],

1149

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

1150

},

1151

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

1152

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

1153

#

1154

# Last update timestamp of this source.

1155

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

1156

#

1157

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

1158

# source. Used for web cache validation.

1159

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

1160

},

1161

},

1162

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

1163

},

1164

],

1165

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

1166

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

1167

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

1168

# date, but are not guaranteed to.

1169

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

1170

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

1171

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

1172

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

1173

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

1174

# field.

1175

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

1176

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

1177

#

1178

# Metadata about a source of type PROFILE.

1179

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

1180

"A String",

1181

],

1182

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

1183

},

1184

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

1185

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

1186

#

1187

# Last update timestamp of this source.

1188

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

1189

#

1190

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

1191

# source. Used for web cache validation.

1192

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

1193

},

1194

},

1195

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

1196

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

1197

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

1198

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

1199

#

1200

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

1201

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

1202

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

1203

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

1204

#

1205

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

1206

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

1207

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

1208

# significant.

1209

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

1210

# month and day.

1211

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

# a year.

},

},

],

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

1217

{ # A person's gender.

1218

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

1219

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

1220

# value are not localized.

1221

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

1222

# can be custom or one of these predefined values:

#

# * `male`

# * `female`

# * `other`

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

1228

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

1229

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

1230

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

1231

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

1232

# field.

1233

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

1234

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

1235

#

1236

# Metadata about a source of type PROFILE.

1237

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

1238

"A String",

1239

],

1240

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

1241

},

1242

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

1243

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

1244

#

1245

# Last update timestamp of this source.

1246

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

1247

#

1248

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

1249

# source. Used for web cache validation.

1250

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

1251

},

1252

},

1253

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

# predefined values:

#

# * `male`

# * `female`

# * `unspecified`

},

],

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

1262

{ # A person's nickname.

1263

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

1264

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

1265

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

1266

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

1267

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

1268

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

1269

# field.

1270

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

1271

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

1272

#

1273

# Metadata about a source of type PROFILE.

1274

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

1275

"A String",

1276

],

1277

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

1278

},

1279

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

1280

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

1281

#

1282

# Last update timestamp of this source.

1283

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

1284

#

1285

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

1286

# source. Used for web cache validation.

1287

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

1288

},

1289

},

1290

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

1291

},

1292

],

1293

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

1294

# The person's relationship statuses.

1295

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

1296

# A person's relationship status.

1297

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

1298

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

1299

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

1300

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

1301

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

1302

# field.

1303

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

1304

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

1305

#

1306

# Metadata about a source of type PROFILE.

1307

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

1308

"A String",

1309

],

1310

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

1311

},

1312

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

1313

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

1314

#

1315

# Last update timestamp of this source.

1316

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

1317

#

1318

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

1319

# source. Used for web cache validation.

1320

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

1321

},

1322

},

1323

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

1324

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

1325

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

# predefined values:

#

# * `single`

# * `inARelationship`

# * `engaged`

# * `married`

# * `itsComplicated`

# * `openRelationship`

1334

# * `widowed`

1335

# * `inDomesticPartnership`

# * `inCivilUnion`

},

],

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

1340

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

1341

"A String",

Bu Sun Kim

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

[diff] [blame]

1342

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1343

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

1344

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

1345

#

1346

# The type of the person object.

1347

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

1348

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

1349

# that include a sync token.

1350

#

1351

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

1352

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

# profile URL.

"A String",

],

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

1357

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

1358

# that include a sync token.

1359

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

1360

{ # The source of a field.

1361

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

Bu Sun Kim

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

[diff] [blame]

1362

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1363

# Metadata about a source of type PROFILE.

1364

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

1365

"A String",

1366

],

1367

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

1368

},

1369

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

1370

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

Bu Sun Kim

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

[diff] [blame]

1371

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1372

# Last update timestamp of this source.

1373

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

Bu Sun Kim

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

[diff] [blame]

1374

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1375

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

1376

# source. Used for web cache validation.

1377

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

Bu Sun Kim

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

[diff] [blame]

1378

},

1379

],

1380

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1381

},

Jon Wayne Parrott

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

[diff] [blame]

1382

],

Bu Sun Kim

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

[diff] [blame]

1383

"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]

1384

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

1385

# token.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1386

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

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