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

2021-03-31 13:33:30 -0700

[diff] [blame]

85

86

<code><a href="#batchDeleteContacts">batchDeleteContacts(body=None, x__xgafv=None)</a></code></p>

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

87

<p class="firstline">Delete a batch of contacts. Any non-contact data will not be deleted. Limited to 10 parallel requests per user.</p>

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

88

89

<code><a href="#batchUpdateContacts">batchUpdateContacts(body=None, x__xgafv=None)</a></code></p>

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

90

<p class="firstline">Update a batch of contacts and return a map of resource names to PersonResponses for the updated contacts. Limited to 10 parallel requests per user.</p>

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

91

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

92

<code><a href="#close">close()</a></code></p>

93

<p class="firstline">Close httplib2 connections.</p>

94

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

95

<code><a href="#createContact">createContact(body=None, personFields=None, sources=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

96

<p class="firstline">Create a new contact and return the person resource for that contact. The request returns a 400 error if more than one field is specified on a field that is a singleton for contact sources: * biographies * birthdays * genders * names</p>

Bu Sun Kim

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

[diff] [blame]

97

98

<code><a href="#deleteContact">deleteContact(resourceName, x__xgafv=None)</a></code></p>

99

<p class="firstline">Delete a contact person. Any non-contact data will not be deleted.</p>

100

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

101

<code><a href="#deleteContactPhoto">deleteContactPhoto(resourceName, personFields=None, sources=None, x__xgafv=None)</a></code></p>

Dan O'Meara

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

[diff] [blame]

102

<p class="firstline">Delete a contact's photo.</p>

103

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

104

<code><a href="#get">get(resourceName, personFields=None, requestMask_includeField=None, sources=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

105

<p class="firstline">Provides information about a person by specifying a resource name. Use `people/me` to indicate the authenticated user. The request returns a 400 error if 'personFields' is not specified.</p>

Jon Wayne Parrott

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

[diff] [blame]

106

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

107

<code><a href="#getBatchGet">getBatchGet(personFields=None, requestMask_includeField=None, resourceNames=None, sources=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

108

<p class="firstline">Provides information about a list of specific people by specifying a list of requested resource names. Use `people/me` to indicate the authenticated user. The request returns a 400 error if 'personFields' is not specified.</p>

Bu Sun Kim

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

[diff] [blame]

109

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

110

<code><a href="#listDirectoryPeople">listDirectoryPeople(mergeSources=None, pageSize=None, pageToken=None, readMask=None, requestSyncToken=None, sources=None, syncToken=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

111

<p class="firstline">Provides a list of domain profiles and domain contacts in the authenticated user's domain directory.</p>

112

113

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

114

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

115

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

116

<code><a href="#searchContacts">searchContacts(pageSize=None, query=None, readMask=None, sources=None, x__xgafv=None)</a></code></p>

117

<p class="firstline">Provides a list of contacts in the authenticated user's grouped contacts that matches the search query. The query matches on a contact's `names`, `nickNames`, `emailAddresses`, `phoneNumbers`, and `organizations` fields that are from the CONTACT" source.</p>

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

118

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

119

<code><a href="#searchDirectoryPeople">searchDirectoryPeople(mergeSources=None, pageSize=None, pageToken=None, query=None, readMask=None, sources=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

120

<p class="firstline">Provides a list of domain profiles and domain contacts in the authenticated user's domain directory that match the search query.</p>

121

122

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

123

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

124

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

125

<code><a href="#updateContact">updateContact(resourceName, body=None, personFields=None, sources=None, updatePersonFields=None, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

126

<p class="firstline">Update contact data for an existing contact person. Any non-contact data will not be modified. Any non-contact data in the person to update will be ignored. All fields specified in the `update_mask` will be replaced. The server returns a 400 error if `person.metadata.sources` is not specified for the contact to be updated or if there is no contact source. The server returns a 400 error with reason `"failedPrecondition"` if `person.metadata.sources.etag` is different than the contact's etag, which indicates the contact has changed since its data was read. Clients should get the latest person and merge their updates into the latest person. The server returns a 400 error if `memberships` are being updated and there are no contact group memberships specified on the person. The server returns a 400 error if more than one field is specified on a field that is a singleton for contact sources: * biographies * birthdays * genders * names</p>

Dan O'Meara

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

[diff] [blame]

127

128

<code><a href="#updateContactPhoto">updateContactPhoto(resourceName, body=None, x__xgafv=None)</a></code></p>

129

<p class="firstline">Update a contact's photo.</p>

Jon Wayne Parrott

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

[diff] [blame]

130

<h3>Method Details</h3>

131

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

132

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

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

133

<pre>Create a batch of new contacts and return the PersonResponses for the newly created contacts. Limited to 10 parallel requests per user.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

134

135

Args:

136

body: object, The request body.

137

The object takes the form of:

138

139

{ # A request to create a batch of contacts.

140

"contacts": [ # Required. The contact to create. Allows up to 200 contacts in a single request.

141

{ # A wrapper that contains the person data to populate a newly created source.

142

"contactPerson": { # Information about a person merged from various data sources such as the authenticated user's contacts and profile data. Most fields can have multiple items. The items in a field have no guaranteed order, but each non-empty field is guaranteed to have exactly one field with `metadata.primary` set to true. # Required. The person data to populate a newly created source.

143

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

144

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

145

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

146

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

147

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

148

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

149

"formattedType": "A String", # Output only. The type of the address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

150

"formattedValue": "A String", # The unstructured value of the address. If this is not set by the user it will be automatically constructed from structured values.

151

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

152

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

153

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

154

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

155

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

156

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

157

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

158

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

"A String",

],

},

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

163

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

164

},

165

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

166

},

167

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

168

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

169

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

170

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

171

"type": "A String", # The type of the address. The type can be custom or one of these predefined values: * `home` * `work` * `other`

172

},

173

],

174

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

175

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

176

{ # A person's age range.

177

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

178

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

179

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

180

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

181

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

182

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

183

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

184

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

185

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

"A String",

],

},

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

190

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

191

},

192

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

},

},

],

"biographies": [ # The person's biographies. This field is a singleton for contact sources.

197

{ # A person's short biography.

198

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

199

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

200

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

201

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

202

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

203

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

204

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

205

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

206

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

"A String",

],

},

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

211

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

212

},

213

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

214

},

215

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

216

},

217

],

218

"birthdays": [ # The person's birthdays. This field is a singleton for contact sources.

219

{ # A person's birthday. At least one of the `date` and `text` fields are specified. The `date` and `text` fields typically represent the same date, but are not guaranteed to.

220

"date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The date of the birthday.

221

"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

222

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

223

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

224

},

225

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

226

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

227

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

228

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

229

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

230

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

231

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

232

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

"A String",

],

},

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

237

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

238

},

239

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

240

},

241

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

242

},

243

],

244

"braggingRights": [ # **DEPRECATED**: No data will be returned The person's bragging rights.

245

{ # **DEPRECATED**: No data will be returned A person's bragging rights.

246

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

247

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

248

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

249

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

250

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

251

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

252

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

253

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

"A String",

],

},

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

258

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

259

},

260

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

261

},

262

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

263

},

264

],

265

"calendarUrls": [ # The person's calendar URLs.

266

{ # A person's calendar URL.

267

"formattedType": "A String", # Output only. The type of the calendar URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

268

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

269

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

270

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

271

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

272

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

273

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

274

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

275

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

"A String",

],

},

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

280

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

281

},

282

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

283

},

284

"type": "A String", # The type of the calendar URL. The type can be custom or one of these predefined values: * `home` * `freeBusy` * `work`

285

"url": "A String", # The calendar URL.

286

},

287

],

288

"clientData": [ # The person's client data.

289

{ # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.

290

"key": "A String", # The client specified key of the client data.

291

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

292

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

293

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

294

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

295

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

296

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

297

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

298

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

"A String",

],

},

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

303

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

304

},

305

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

306

},

307

"value": "A String", # The client specified value of the client data.

308

},

309

],

310

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

311

{ # A person's cover photo. A large image shown on the person's profile page that represents who they are or what they care about.

312

"default": True or False, # True if the cover photo is the default cover photo; false if the cover photo is a user-provided cover photo.

313

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

314

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

315

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

316

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

317

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

318

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

319

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

320

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

"A String",

],

},

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

325

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

326

},

327

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

328

},

329

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

330

},

331

],

332

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

333

{ # A person's email address.

334

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

335

"formattedType": "A String", # Output only. The type of the email address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

336

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

337

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

338

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

339

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

340

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

341

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

342

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

343

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

"A String",

],

},

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

348

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

349

},

350

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

351

},

352

"type": "A String", # The type of the email address. The type can be custom or one of these predefined values: * `home` * `work` * `other`

353

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

354

},

355

],

356

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

357

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

358

{ # An event related to the person.

359

"date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The date of the event.

360

"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

361

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

362

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

363

},

364

"formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

365

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

366

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

367

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

368

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

369

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

370

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

371

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

372

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

"A String",

],

},

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

377

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

378

},

379

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

380

},

381

"type": "A String", # The type of the event. The type can be custom or one of these predefined values: * `anniversary` * `other`

382

},

383

],

384

"externalIds": [ # The person's external IDs.

385

{ # An identifier from an external entity related to the person.

386

"formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

387

"metadata": { # Metadata about a field. # Metadata about the external ID.

388

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

389

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

390

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

391

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

392

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

393

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

394

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

"A String",

],

},

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

399

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

400

},

401

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

402

},

403

"type": "A String", # The type of the external ID. The type can be custom or one of these predefined values: * `account` * `customer` * `loginId` * `network` * `organization`

404

"value": "A String", # The value of the external ID.

405

},

406

],

407

"fileAses": [ # The person's file-ases.

408

{ # The name that should be used to sort the person in a list.

409

"metadata": { # Metadata about a field. # Metadata about the file-as.

410

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

411

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

412

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

413

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

414

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

415

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

416

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

"A String",

],

},

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

421

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

422

},

423

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

424

},

425

"value": "A String", # The file-as value

426

},

427

],

428

"genders": [ # The person's genders. This field is a singleton for contact sources.

429

{ # A person's gender.

430

"addressMeAs": "A String", # The type of pronouns that should be used to address the person. The value can be custom or one of these predefined values: * `male` * `female` * `other`

431

"formattedValue": "A String", # Output only. The value of the gender translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. Unspecified or custom value are not localized.

432

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

433

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

434

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

435

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

436

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

437

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

438

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

439

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

"A String",

],

},

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

444

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

445

},

446

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

447

},

448

"value": "A String", # The gender for the person. The gender can be custom or one of these predefined values: * `male` * `female` * `unspecified`

449

},

450

],

451

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

452

{ # A person's instant messaging client.

453

"formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

454

"formattedType": "A String", # Output only. The type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

455

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

456

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

457

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

458

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

459

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

460

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

461

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

462

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

"A String",

],

},

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

467

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

468

},

469

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

470

},

471

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

472

"type": "A String", # The type of the IM client. The type can be custom or one of these predefined values: * `home` * `work` * `other`

473

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

474

},

475

],

476

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

477

{ # One of the person's interests.

478

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

479

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

480

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

481

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

482

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

483

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

484

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

485

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

"A String",

],

},

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

490

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

491

},

492

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

493

},

494

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

495

},

496

],

497

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

498

{ # A person's locale preference.

499

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

500

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

501

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

502

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

503

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

504

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

505

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

506

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

"A String",

],

},

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

511

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

512

},

513

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

514

},

515

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

516

},

517

],

518

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

519

{ # A person's location.

520

"buildingId": "A String", # The building identifier.

521

"current": True or False, # Whether the location is the current location.

522

"deskCode": "A String", # The individual desk location.

523

"floor": "A String", # The floor name or number.

524

"floorSection": "A String", # The floor section in `floor_name`.

525

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

526

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

527

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

528

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

529

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

530

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

531

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

532

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

"A String",

],

},

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

537

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

538

},

539

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

540

},

541

"type": "A String", # The type of the location. The type can be custom or one of these predefined values: * `desk` * `grewUp`

542

"value": "A String", # The free-form value of the location.

543

},

544

],

545

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

546

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

547

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

548

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

549

"contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`. Only contact_group_resource_name can be used for modifying memberships. Any contact group membership can be removed, but only user group or "myContacts" or "starred" system groups memberships can be added. A contact must always have at least one contact group membership.

550

},

551

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

552

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

553

},

554

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

555

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

556

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

557

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

558

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

559

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

560

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

561

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

"A String",

],

},

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

566

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

567

},

568

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

},

},

],

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

573

"deleted": True or False, # Output only. True if the person resource has been deleted. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token.

574

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

575

"A String",

576

],

577

"objectType": "A String", # Output only. **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object.

578

"previousResourceNames": [ # Output only. Any former resource names this person has had. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token. The resource name may change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or profile URL.

579

"A String",

580

],

581

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

582

{ # The source of a field.

583

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

584

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

585

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

586

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

587

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

"A String",

],

},

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

592

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

},

],

},

"miscKeywords": [ # The person's miscellaneous keywords.

597

{ # A person's miscellaneous keyword.

598

"formattedType": "A String", # Output only. The type of the miscellaneous keyword translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

599

"metadata": { # Metadata about a field. # Metadata about the miscellaneous keyword.

600

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

601

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

602

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

603

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

604

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

605

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

606

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

"A String",

],

},

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

611

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

612

},

613

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

614

},

615

"type": "A String", # The miscellaneous keyword type.

616

"value": "A String", # The value of the miscellaneous keyword.

617

},

618

],

619

"names": [ # The person's names. This field is a singleton for contact sources.

620

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

621

"displayName": "A String", # Output only. The display name formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.

622

"displayNameLastFirst": "A String", # Output only. The display name with the last name first formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.

623

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

624

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

625

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

626

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

627

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

628

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

629

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

630

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

631

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

632

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

633

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

634

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

"A String",

],

},

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

639

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

640

},

641

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

642

},

643

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

644

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

645

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

646

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

647

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

648

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

649

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

650

"unstructuredName": "A String", # The free form name value.

651

},

652

],

653

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

654

{ # A person's nickname.

655

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

656

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

657

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

658

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

659

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

660

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

661

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

662

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

"A String",

],

},

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

667

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

668

},

669

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

670

},

671

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

672

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

673

},

674

],

675

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

676

{ # A person's occupation.

677

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

678

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

679

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

680

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

681

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

682

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

683

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

684

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

"A String",

],

},

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

689

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

690

},

691

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

692

},

693

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

694

},

695

],

696

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

697

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

698

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

699

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

700

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

701

"endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The end date when the person left the organization.

702

"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

703

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

704

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

705

},

706

"formattedType": "A String", # Output only. The type of the organization translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

707

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

708

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

709

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

710

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

711

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

712

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

713

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

714

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

715

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

716

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

"A String",

],

},

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

721

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

722

},

723

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

724

},

725

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

726

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

727

"startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The start date when the person joined the organization.

728

"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

729

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

730

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

731

},

732

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

733

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

734

"type": "A String", # The type of the organization. The type can be custom or one of these predefined values: * `work` * `school`

735

},

736

],

737

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

738

{ # A person's phone number.

739

"canonicalForm": "A String", # Output only. The canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number.

740

"formattedType": "A String", # Output only. The type of the phone number translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

741

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

742

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

743

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

744

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

745

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

746

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

747

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

748

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

"A String",

],

},

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

753

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

754

},

755

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

756

},

757

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

758

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

759

},

760

],

761

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

762

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

763

"default": True or False, # True if the photo is a default photo; false if the photo is a user-provided photo.

764

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

765

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

766

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

767

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

768

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

769

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

770

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

771

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

"A String",

],

},

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

776

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

777

},

778

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

779

},

780

"url": "A String", # The URL of the photo. You can change the desired size by appending a query parameter `sz={size}` at the end of the url, where {size} is the size in pixels. Example: https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50

781

},

782

],

783

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

784

{ # A person's relation to another person.

785

"formattedType": "A String", # Output only. The type of the relation translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.

786

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

787

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

788

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

789

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

790

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

791

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

792

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

793

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

"A String",

],

},

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

798

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

799

},

800

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

801

},

802

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

803

"type": "A String", # The person's relation to the other person. The type can be custom or one of these predefined values: * `spouse` * `child` * `mother` * `father` * `parent` * `brother` * `sister` * `friend` * `relative` * `domesticPartner` * `manager` * `assistant` * `referredBy` * `partner`

804

},

805

],

806

"relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship interests.

807

{ # **DEPRECATED**: No data will be returned A person's relationship interest .

808

"formattedValue": "A String", # Output only. The value of the relationship interest translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.

809

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

810

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

811

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

812

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

813

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

814

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

815

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

816

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

"A String",

],

},

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

821

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

822

},

823

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

824

},

825

"value": "A String", # The kind of relationship the person is looking for. The value can be custom or one of these predefined values: * `friend` * `date` * `relationship` * `networking`

826

},

827

],

828

"relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship statuses.

829

{ # **DEPRECATED**: No data will be returned A person's relationship status.

830

"formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

831

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

832

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

833

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

834

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

835

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

836

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

837

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

838

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

"A String",

],

},

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

843

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

844

},

845

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

846

},

847

"value": "A String", # The relationship status. The value can be custom or one of these predefined values: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion`

848

},

849

],

850

"residences": [ # **DEPRECATED**: (Please use `person.locations` instead) The person's residences.

851

{ # **DEPRECATED**: Please use `person.locations` instead. A person's past or current residence.

852

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

853

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

854

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

855

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

856

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

857

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

858

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

859

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

860

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

"A String",

],

},

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

865

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

866

},

867

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

868

},

869

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

870

},

871

],

872

"resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters, in the form of `people/{person_id}`.

873

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

874

{ # A person's SIP address. Session Initial Protocol addresses are used for VoIP communications to make voice or video calls over the internet.

875

"formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

876

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

877

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

878

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

879

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

880

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

881

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

882

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

883

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

"A String",

],

},

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

888

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

889

},

890

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

891

},

892

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

893

"value": "A String", # The SIP address in the [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI format.

894

},

895

],

896

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

897

{ # A skill that the person has.

898

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

899

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

900

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

901

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

902

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

903

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

904

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

905

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

"A String",

],

},

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

910

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

911

},

912

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

913

},

914

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

915

},

916

],

917

"taglines": [ # Output only. **DEPRECATED**: No data will be returned The person's taglines.

918

{ # **DEPRECATED**: No data will be returned A brief one-line description of the person.

919

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

920

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

921

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

922

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

923

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

924

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

925

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

926

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

"A String",

],

},

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

931

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

932

},

933

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

934

},

935

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

936

},

937

],

938

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

939

{ # A person's associated URLs.

940

"formattedType": "A String", # Output only. The type of the URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

941

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

942

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

943

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

944

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

945

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

946

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

947

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

948

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

"A String",

],

},

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

953

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

954

},

955

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

956

},

957

"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 Currents application. * `other`

958

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

959

},

960

],

961

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

962

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

963

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

964

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

965

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

966

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

967

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

968

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

969

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

970

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

971

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

"A String",

],

},

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

976

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

977

},

978

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

979

},

980

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

},

],

},

},

],

"readMask": "A String", # Required. A field mask to restrict which fields on each person are returned in the response. Multiple fields can be specified by separating them with commas. If read mask is left empty, the post-mutate-get is skipped and no data will be returned in the response. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined

987

"sources": [ # Optional. A mask of what source types to return in the post mutate read. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.

"A String",

],

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

999

1000

{ # The response to a request to create a batch of contacts.

1001

"createdPeople": [ # The contacts that were created, unless the request `read_mask` is empty.

1002

{ # The response for a single person

1003

"httpStatusCode": 42, # **DEPRECATED** (Please use status instead) [HTTP 1.1 status code] (http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html).

1004

"person": { # Information about a person merged from various data sources such as the authenticated user's contacts and profile data. Most fields can have multiple items. The items in a field have no guaranteed order, but each non-empty field is guaranteed to have exactly one field with `metadata.primary` set to true. # The person.

1005

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

1006

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

1007

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

1008

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

1009

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

1010

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

1011

"formattedType": "A String", # Output only. The type of the address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

1012

"formattedValue": "A String", # The unstructured value of the address. If this is not set by the user it will be automatically constructed from structured values.

1013

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

1014

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

1015

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

1016

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

1017

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

1018

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

1019

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

1020

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

"A String",

],

},

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

1025

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

1026

},

1027

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

1028

},

1029

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

1030

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

1031

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

1032

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

1033

"type": "A String", # The type of the address. The type can be custom or one of these predefined values: * `home` * `work` * `other`

1034

},

1035

],

1036

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

1037

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

1038

{ # A person's age range.

1039

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

1040

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

1041

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

1042

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

1043

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

1044

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

1045

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

1046

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

1047

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

"A String",

],

},

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

1052

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

1053

},

1054

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

},

},

],

"biographies": [ # The person's biographies. This field is a singleton for contact sources.

1059

{ # A person's short biography.

1060

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

1061

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

1062

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

1063

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

1064

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

1065

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

1066

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

1067

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

1068

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

"A String",

],

},

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

1073

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

1074

},

1075

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

1076

},

1077

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

1078

},

1079

],

1080

"birthdays": [ # The person's birthdays. This field is a singleton for contact sources.

1081

{ # A person's birthday. At least one of the `date` and `text` fields are specified. The `date` and `text` fields typically represent the same date, but are not guaranteed to.

1082

"date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The date of the birthday.

1083

"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

1084

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

1085

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

1086

},

1087

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

1088

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

1089

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

1090

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

1091

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

1092

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

1093

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

1094

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

"A String",

],

},

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

1099

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

1100

},

1101

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

1102

},

1103

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

1104

},

1105

],

1106

"braggingRights": [ # **DEPRECATED**: No data will be returned The person's bragging rights.

1107

{ # **DEPRECATED**: No data will be returned A person's bragging rights.

1108

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

1109

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

1110

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

1111

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

1112

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

1113

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

1114

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

1115

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

"A String",

],

},

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

1120

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

1121

},

1122

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

1123

},

1124

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

1125

},

1126

],

1127

"calendarUrls": [ # The person's calendar URLs.

1128

{ # A person's calendar URL.

1129

"formattedType": "A String", # Output only. The type of the calendar URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

1130

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

1131

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

1132

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

1133

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

1134

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

1135

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

1136

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

1137

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

"A String",

],

},

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

1142

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

1143

},

1144

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

1145

},

1146

"type": "A String", # The type of the calendar URL. The type can be custom or one of these predefined values: * `home` * `freeBusy` * `work`

1147

"url": "A String", # The calendar URL.

1148

},

1149

],

1150

"clientData": [ # The person's client data.

1151

{ # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.

1152

"key": "A String", # The client specified key of the client data.

1153

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

1154

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

1155

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

1156

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

1157

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

1158

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

1159

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

1160

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

"A String",

],

},

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

1165

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

1166

},

1167

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

1168

},

1169

"value": "A String", # The client specified value of the client data.

1170

},

1171

],

1172

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

1173

{ # A person's cover photo. A large image shown on the person's profile page that represents who they are or what they care about.

1174

"default": True or False, # True if the cover photo is the default cover photo; false if the cover photo is a user-provided cover photo.

1175

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

1176

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

1177

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

1178

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

1179

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

1180

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

1181

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

1182

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

"A String",

],

},

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

1187

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

1188

},

1189

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

1190

},

1191

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

1192

},

1193

],

1194

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

1195

{ # A person's email address.

1196

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

1197

"formattedType": "A String", # Output only. The type of the email address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

1198

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

1199

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

1200

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

1201

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

1202

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

1203

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

1204

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

1205

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

"A String",

],

},

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

1210

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

1211

},

1212

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

1213

},

1214

"type": "A String", # The type of the email address. The type can be custom or one of these predefined values: * `home` * `work` * `other`

1215

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

1216

},

1217

],

1218

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

1219

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

1220

{ # An event related to the person.

1221

"date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The date of the event.

1222

"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

1223

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

1224

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

1225

},

1226

"formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

1227

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

1228

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

1229

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

1230

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

1231

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

1232

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

1233

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

1234

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

"A String",

],

},

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

1239

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

1240

},

1241

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

1242

},

1243

"type": "A String", # The type of the event. The type can be custom or one of these predefined values: * `anniversary` * `other`

1244

},

1245

],

1246

"externalIds": [ # The person's external IDs.

1247

{ # An identifier from an external entity related to the person.

1248

"formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

1249

"metadata": { # Metadata about a field. # Metadata about the external ID.

1250

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

1251

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

1252

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

1253

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

1254

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

1255

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

1256

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

"A String",

],

},

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

1261

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

1262

},

1263

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

1264

},

1265

"type": "A String", # The type of the external ID. The type can be custom or one of these predefined values: * `account` * `customer` * `loginId` * `network` * `organization`

1266

"value": "A String", # The value of the external ID.

1267

},

1268

],

1269

"fileAses": [ # The person's file-ases.

1270

{ # The name that should be used to sort the person in a list.

1271

"metadata": { # Metadata about a field. # Metadata about the file-as.

1272

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

1273

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

1274

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

1275

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

1276

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

1277

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

1278

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

"A String",

],

},

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

1283

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

1284

},

1285

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

1286

},

1287

"value": "A String", # The file-as value

1288

},

1289

],

1290

"genders": [ # The person's genders. This field is a singleton for contact sources.

1291

{ # A person's gender.

1292

"addressMeAs": "A String", # The type of pronouns that should be used to address the person. The value can be custom or one of these predefined values: * `male` * `female` * `other`

1293

"formattedValue": "A String", # Output only. The value of the gender translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. Unspecified or custom value are not localized.

1294

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

1295

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

1296

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

1297

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

1298

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

1299

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

1300

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

1301

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

"A String",

],

},

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

1306

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

1307

},

1308

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

1309

},

1310

"value": "A String", # The gender for the person. The gender can be custom or one of these predefined values: * `male` * `female` * `unspecified`

1311

},

1312

],

1313

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

1314

{ # A person's instant messaging client.

1315

"formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

1316

"formattedType": "A String", # Output only. The type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

1317

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

1318

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

1319

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

1320

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

1321

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

1322

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

1323

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

1324

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

"A String",

],

},

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

1329

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

1330

},

1331

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

1332

},

1333

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

1334

"type": "A String", # The type of the IM client. The type can be custom or one of these predefined values: * `home` * `work` * `other`

1335

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

1336

},

1337

],

1338

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

1339

{ # One of the person's interests.

1340

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

1341

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

1342

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

1343

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

1344

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

1345

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

1346

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

1347

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

"A String",

],

},

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

1352

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

1353

},

1354

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

1355

},

1356

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

1357

},

1358

],

1359

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

1360

{ # A person's locale preference.

1361

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

1362

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

1363

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

1364

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

1365

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

1366

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

1367

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

1368

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

"A String",

],

},

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

1373

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

1374

},

1375

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

1376

},

1377

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

1378

},

1379

],

1380

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

1381

{ # A person's location.

1382

"buildingId": "A String", # The building identifier.

1383

"current": True or False, # Whether the location is the current location.

1384

"deskCode": "A String", # The individual desk location.

1385

"floor": "A String", # The floor name or number.

1386

"floorSection": "A String", # The floor section in `floor_name`.

1387

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

1388

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

1389

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

1390

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

1391

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

1392

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

1393

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

1394

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

"A String",

],

},

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

1399

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

1400

},

1401

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

1402

},

1403

"type": "A String", # The type of the location. The type can be custom or one of these predefined values: * `desk` * `grewUp`

1404

"value": "A String", # The free-form value of the location.

1405

},

1406

],

1407

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

1408

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

1409

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

1410

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

1411

"contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`. Only contact_group_resource_name can be used for modifying memberships. Any contact group membership can be removed, but only user group or "myContacts" or "starred" system groups memberships can be added. A contact must always have at least one contact group membership.

1412

},

1413

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

1414

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

1415

},

1416

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

1417

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

1418

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

1419

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

1420

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

1421

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

1422

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

1423

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

"A String",

],

},

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

1428

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

1429

},

1430

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

},

},

],

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

1435

"deleted": True or False, # Output only. True if the person resource has been deleted. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token.

1436

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

1437

"A String",

1438

],

1439

"objectType": "A String", # Output only. **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object.

1440

"previousResourceNames": [ # Output only. Any former resource names this person has had. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token. The resource name may change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or profile URL.

1441

"A String",

1442

],

1443

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

1444

{ # The source of a field.

1445

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

1446

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

1447

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

1448

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

1449

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

"A String",

],

},

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

1454

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

},

],

},

"miscKeywords": [ # The person's miscellaneous keywords.

1459

{ # A person's miscellaneous keyword.

1460

"formattedType": "A String", # Output only. The type of the miscellaneous keyword translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

1461

"metadata": { # Metadata about a field. # Metadata about the miscellaneous keyword.

1462

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

1463

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

1464

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

1465

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

1466

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

1467

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

1468

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

"A String",

],

},

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

1473

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

1474

},

1475

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

1476

},

1477

"type": "A String", # The miscellaneous keyword type.

1478

"value": "A String", # The value of the miscellaneous keyword.

1479

},

1480

],

1481

"names": [ # The person's names. This field is a singleton for contact sources.

1482

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

1483

"displayName": "A String", # Output only. The display name formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.

1484

"displayNameLastFirst": "A String", # Output only. The display name with the last name first formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.

1485

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

1486

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

1487

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

1488

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

1489

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

1490

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

1491

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

1492

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

1493

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

1494

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

1495

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

1496

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

"A String",

],

},

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

1501

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

1502

},

1503

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

1504

},

1505

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

1506

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

1507

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

1508

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

1509

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

1510

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

1511

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

1512

"unstructuredName": "A String", # The free form name value.

1513

},

1514

],

1515

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

1516

{ # A person's nickname.

1517

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

1518

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

1519

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

1520

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

1521

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

1522

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

1523

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

1524

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

"A String",

],

},

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

1529

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

1530

},

1531

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

1532

},

1533

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

1534

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

1535

},

1536

],

1537

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

1538

{ # A person's occupation.

1539

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

1540

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

1541

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

1542

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

1543

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

1544

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

1545

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

1546

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

"A String",

],

},

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

1551

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

1552

},

1553

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

1554

},

1555

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

1556

},

1557

],

1558

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

1559

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

1560

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

1561

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

1562

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

1563

"endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The end date when the person left the organization.

1564

"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

1565

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

1566

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

1567

},

1568

"formattedType": "A String", # Output only. The type of the organization translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

1569

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

1570

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

1571

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

1572

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

1573

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

1574

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

1575

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

1576

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

1577

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

1578

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

"A String",

],

},

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

1583

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

1584

},

1585

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

1586

},

1587

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

1588

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

1589

"startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The start date when the person joined the organization.

1590

"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

1591

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

1592

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

1593

},

1594

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

1595

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

1596

"type": "A String", # The type of the organization. The type can be custom or one of these predefined values: * `work` * `school`

1597

},

1598

],

1599

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

1600

{ # A person's phone number.

1601

"canonicalForm": "A String", # Output only. The canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number.

1602

"formattedType": "A String", # Output only. The type of the phone number translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

1603

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

1604

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

1605

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

1606

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

1607

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

1608

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

1609

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

1610

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

"A String",

],

},

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

1615

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

1616

},

1617

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

1618

},

1619

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

1620

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

1621

},

1622

],

1623

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

1624

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

1625

"default": True or False, # True if the photo is a default photo; false if the photo is a user-provided photo.

1626

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

1627

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

1628

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

1629

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

1630

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

1631

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

1632

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

1633

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

"A String",

],

},

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

1638

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

1639

},

1640

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

1641

},

1642

"url": "A String", # The URL of the photo. You can change the desired size by appending a query parameter `sz={size}` at the end of the url, where {size} is the size in pixels. Example: https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50

1643

},

1644

],

1645

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

1646

{ # A person's relation to another person.

1647

"formattedType": "A String", # Output only. The type of the relation translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.

1648

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

1649

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

1650

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

1651

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

1652

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

1653

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

1654

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

1655

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

"A String",

],

},

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

1660

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

1661

},

1662

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

1663

},

1664

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

1665

"type": "A String", # The person's relation to the other person. The type can be custom or one of these predefined values: * `spouse` * `child` * `mother` * `father` * `parent` * `brother` * `sister` * `friend` * `relative` * `domesticPartner` * `manager` * `assistant` * `referredBy` * `partner`

1666

},

1667

],

1668

"relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship interests.

1669

{ # **DEPRECATED**: No data will be returned A person's relationship interest .

1670

"formattedValue": "A String", # Output only. The value of the relationship interest translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.

1671

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

1672

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

1673

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

1674

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

1675

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

1676

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

1677

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

1678

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

"A String",

],

},

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

1683

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

1684

},

1685

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

1686

},

1687

"value": "A String", # The kind of relationship the person is looking for. The value can be custom or one of these predefined values: * `friend` * `date` * `relationship` * `networking`

1688

},

1689

],

1690

"relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship statuses.

1691

{ # **DEPRECATED**: No data will be returned A person's relationship status.

1692

"formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

1693

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

1694

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

1695

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

1696

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

1697

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

1698

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

1699

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

1700

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

"A String",

],

},

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

1705

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

1706

},

1707

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

1708

},

1709

"value": "A String", # The relationship status. The value can be custom or one of these predefined values: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion`

1710

},

1711

],

1712

"residences": [ # **DEPRECATED**: (Please use `person.locations` instead) The person's residences.

1713

{ # **DEPRECATED**: Please use `person.locations` instead. A person's past or current residence.

1714

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

1715

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

1716

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

1717

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

1718

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

1719

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

1720

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

1721

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

1722

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

"A String",

],

},

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

1727

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

1728

},

1729

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

1730

},

1731

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

1732

},

1733

],

1734

"resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters, in the form of `people/{person_id}`.

1735

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

1736

{ # A person's SIP address. Session Initial Protocol addresses are used for VoIP communications to make voice or video calls over the internet.

1737

"formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

1738

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

1739

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

1740

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

1741

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

1742

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

1743

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

1744

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

1745

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

"A String",

],

},

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

1750

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

1751

},

1752

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

1753

},

1754

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

1755

"value": "A String", # The SIP address in the [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI format.

1756

},

1757

],

1758

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

1759

{ # A skill that the person has.

1760

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

1761

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

1762

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

1763

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

1764

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

1765

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

1766

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

1767

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

"A String",

],

},

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

1772

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

1773

},

1774

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

1775

},

1776

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

1777

},

1778

],

1779

"taglines": [ # Output only. **DEPRECATED**: No data will be returned The person's taglines.

1780

{ # **DEPRECATED**: No data will be returned A brief one-line description of the person.

1781

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

1782

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

1783

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

1784

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

1785

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

1786

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

1787

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

1788

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

"A String",

],

},

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

1793

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

1794

},

1795

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

1796

},

1797

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

1798

},

1799

],

1800

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

1801

{ # A person's associated URLs.

1802

"formattedType": "A String", # Output only. The type of the URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

1803

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

1804

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

1805

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

1806

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

1807

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

1808

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

1809

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

1810

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

"A String",

],

},

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

1815

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

1816

},

1817

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

1818

},

1819

"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 Currents application. * `other`

1820

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

1821

},

1822

],

1823

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

1824

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

1825

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

1826

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

1827

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

1828

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

1829

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

1830

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

1831

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

1832

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

1833

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

"A String",

],

},

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

1838

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

1839

},

1840

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

1841

},

1842

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

},

],

},

"requestedResourceName": "A String", # The original requested resource name. May be different than the resource name on the returned person. The resource name can change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or a profile URL.

1847

"status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The status of the response.

1848

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

1849

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

1850

{

1851

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

1852

},

1853

],

1854

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

},

},

],

}</pre>

</div>

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

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

1863

<pre>Delete a batch of contacts. Any non-contact data will not be deleted. Limited to 10 parallel requests per user.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1864

1865

Args:

1866

body: object, The request body.

1867

The object takes the form of:

1868

1869

{ # A request to delete a batch of existing contacts.

1870

"resourceNames": [ # Required. The resource names of the contact to delete. It's repeatable. Allows up to 500 resource names in a single request.

"A String",

],

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1882

1883

{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.

}</pre>

</div>

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

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

1889

<pre>Update a batch of contacts and return a map of resource names to PersonResponses for the updated contacts. Limited to 10 parallel requests per user.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1890

1891

Args:

1892

body: object, The request body.

1893

The object takes the form of:

1894

1895

{ # A request to update a batch of contacts.

1896

"contacts": { # Required. A map of resource names to the person data to be updated. Allows up to 200 contacts in a single request.

1897

"a_key": { # Information about a person merged from various data sources such as the authenticated user's contacts and profile data. Most fields can have multiple items. The items in a field have no guaranteed order, but each non-empty field is guaranteed to have exactly one field with `metadata.primary` set to true.

1898

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

1899

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

1900

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

1901

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

1902

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

1903

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

1904

"formattedType": "A String", # Output only. The type of the address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

1905

"formattedValue": "A String", # The unstructured value of the address. If this is not set by the user it will be automatically constructed from structured values.

1906

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

1907

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

1908

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

1909

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

1910

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

1911

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

1912

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

1913

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

"A String",

],

},

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

1918

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

1919

},

1920

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

1921

},

1922

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

1923

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

1924

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

1925

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

1926

"type": "A String", # The type of the address. The type can be custom or one of these predefined values: * `home` * `work` * `other`

1927

},

1928

],

1929

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

1930

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

1931

{ # A person's age range.

1932

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

1933

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

1934

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

1935

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

1936

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

1937

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

1938

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

1939

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

1940

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

"A String",

],

},

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

1945

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

1946

},

1947

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

},

},

],

"biographies": [ # The person's biographies. This field is a singleton for contact sources.

1952

{ # A person's short biography.

1953

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

1954

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

1955

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

1956

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

1957

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

1958

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

1959

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

1960

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

1961

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

"A String",

],

},

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

1966

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

1967

},

1968

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

1969

},

1970

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

1971

},

1972

],

1973

"birthdays": [ # The person's birthdays. This field is a singleton for contact sources.

1974

{ # A person's birthday. At least one of the `date` and `text` fields are specified. The `date` and `text` fields typically represent the same date, but are not guaranteed to.

1975

"date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The date of the birthday.

1976

"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

1977

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

1978

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

1979

},

1980

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

1981

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

1982

"source": { # The source of a field. # The source of the field.

1983

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

1984

"id": "A String", # The unique identifier within the source type generated by the server.

1985

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

1986

"objectType": "A String", # Output only. The profile object type.

1987

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

1992

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

1993

},

1994

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

1995

},

1996

"text": "A String", # A free-form string representing the user's birthday.

1997

},

1998

],

1999

"braggingRights": [ # **DEPRECATED**: No data will be returned The person's bragging rights.

2000

{ # **DEPRECATED**: No data will be returned A person's bragging rights.

2001

"metadata": { # Metadata about a field. # Metadata about the bragging rights.

2002

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

2003

"source": { # The source of a field. # The source of the field.

2004

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

2005

"id": "A String", # The unique identifier within the source type generated by the server.

2006

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

2007

"objectType": "A String", # Output only. The profile object type.

2008

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

2013

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

2014

},

2015

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

2016

},

2017

"value": "A String", # The bragging rights; for example, `climbed mount everest`.

2018

},

2019

],

2020

"calendarUrls": [ # The person's calendar URLs.

2021

{ # A person's calendar URL.

2022

"formattedType": "A String", # Output only. The type of the calendar URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

2023

"metadata": { # Metadata about a field. # Metadata about the calendar URL.

2024

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

2025

"source": { # The source of a field. # The source of the field.

2026

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

2027

"id": "A String", # The unique identifier within the source type generated by the server.

2028

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

2029

"objectType": "A String", # Output only. The profile object type.

2030

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

2035

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

2036

},

2037

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

2038

},

2039

"type": "A String", # The type of the calendar URL. The type can be custom or one of these predefined values: * `home` * `freeBusy` * `work`

2040

"url": "A String", # The calendar URL.

2041

},

2042

],

2043

"clientData": [ # The person's client data.

2044

{ # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.

2045

"key": "A String", # The client specified key of the client data.

2046

"metadata": { # Metadata about a field. # Metadata about the client data.

2047

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

2048

"source": { # The source of a field. # The source of the field.

2049

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

2050

"id": "A String", # The unique identifier within the source type generated by the server.

2051

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

2052

"objectType": "A String", # Output only. The profile object type.

2053

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

2058

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

2059

},

2060

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

2061

},

2062

"value": "A String", # The client specified value of the client data.

2063

},

2064

],

2065

"coverPhotos": [ # Output only. The person's cover photos.

2066

{ # A person's cover photo. A large image shown on the person's profile page that represents who they are or what they care about.

2067

"default": True or False, # True if the cover photo is the default cover photo; false if the cover photo is a user-provided cover photo.

2068

"metadata": { # Metadata about a field. # Metadata about the cover photo.

2069

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

2070

"source": { # The source of a field. # The source of the field.

2071

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

2072

"id": "A String", # The unique identifier within the source type generated by the server.

2073

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

2074

"objectType": "A String", # Output only. The profile object type.

2075

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

2080

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

2081

},

2082

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

2083

},

2084

"url": "A String", # The URL of the cover photo.

2085

},

2086

],

2087

"emailAddresses": [ # The person's email addresses.

2088

{ # A person's email address.

2089

"displayName": "A String", # The display name of the email.

2090

"formattedType": "A String", # Output only. The type of the email address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

2091

"metadata": { # Metadata about a field. # Metadata about the email address.

2092

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

2093

"source": { # The source of a field. # The source of the field.

2094

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

2095

"id": "A String", # The unique identifier within the source type generated by the server.

2096

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

2097

"objectType": "A String", # Output only. The profile object type.

2098

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

2103

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

2104

},

2105

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

2106

},

2107

"type": "A String", # The type of the email address. The type can be custom or one of these predefined values: * `home` * `work` * `other`

2108

"value": "A String", # The email address.

2109

},

2110

],

2111

"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.

2112

"events": [ # The person's events.

2113

{ # An event related to the person.

2114

"date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The date of the event.

2115

"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

2116

"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

2117

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

2118

},

2119

"formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

2120

"metadata": { # Metadata about a field. # Metadata about the event.

2121

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

2122

"source": { # The source of a field. # The source of the field.

2123

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

2124

"id": "A String", # The unique identifier within the source type generated by the server.

2125

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

2126

"objectType": "A String", # Output only. The profile object type.

2127

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

2132

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

2133

},

2134

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

2135

},

2136

"type": "A String", # The type of the event. The type can be custom or one of these predefined values: * `anniversary` * `other`

2137

},

2138

],

2139

"externalIds": [ # The person's external IDs.

2140

{ # An identifier from an external entity related to the person.

2141

"formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

2142

"metadata": { # Metadata about a field. # Metadata about the external ID.

2143

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

2144

"source": { # The source of a field. # The source of the field.

2145

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

2146

"id": "A String", # The unique identifier within the source type generated by the server.

2147

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

2148

"objectType": "A String", # Output only. The profile object type.

2149

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

2154

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

2155

},

2156

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

2157

},

2158

"type": "A String", # The type of the external ID. The type can be custom or one of these predefined values: * `account` * `customer` * `loginId` * `network` * `organization`

2159

"value": "A String", # The value of the external ID.

2160

},

2161

],

2162

"fileAses": [ # The person's file-ases.

2163

{ # The name that should be used to sort the person in a list.

2164

"metadata": { # Metadata about a field. # Metadata about the file-as.

2165

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

2166

"source": { # The source of a field. # The source of the field.

2167

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

2168

"id": "A String", # The unique identifier within the source type generated by the server.

2169

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

2170

"objectType": "A String", # Output only. The profile object type.

2171

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

2176

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

2177

},

2178

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

2179

},

2180

"value": "A String", # The file-as value

2181

},

2182

],

2183

"genders": [ # The person's genders. This field is a singleton for contact sources.

2184

{ # A person's gender.

2185

"addressMeAs": "A String", # The type of pronouns that should be used to address the person. The value can be custom or one of these predefined values: * `male` * `female` * `other`

2186

"formattedValue": "A String", # Output only. The value of the gender translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. Unspecified or custom value are not localized.

2187

"metadata": { # Metadata about a field. # Metadata about the gender.

2188

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

2189

"source": { # The source of a field. # The source of the field.

2190

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

2191

"id": "A String", # The unique identifier within the source type generated by the server.

2192

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

2193

"objectType": "A String", # Output only. The profile object type.

2194

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

2199

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

2200

},

2201

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

2202

},

2203

"value": "A String", # The gender for the person. The gender can be custom or one of these predefined values: * `male` * `female` * `unspecified`

2204

},

2205

],

2206

"imClients": [ # The person's instant messaging clients.

2207

{ # A person's instant messaging client.

2208

"formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

2209

"formattedType": "A String", # Output only. The type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

2210

"metadata": { # Metadata about a field. # Metadata about the IM client.

2211

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

2212

"source": { # The source of a field. # The source of the field.

2213

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

2214

"id": "A String", # The unique identifier within the source type generated by the server.

2215

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

2216

"objectType": "A String", # Output only. The profile object type.

2217

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

2222

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

2223

},

2224

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

2225

},

2226

"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`

2227

"type": "A String", # The type of the IM client. The type can be custom or one of these predefined values: * `home` * `work` * `other`

2228

"username": "A String", # The user name used in the IM client.

2229

},

2230

],

2231

"interests": [ # The person's interests.

2232

{ # One of the person's interests.

2233

"metadata": { # Metadata about a field. # Metadata about the interest.

2234

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

2235

"source": { # The source of a field. # The source of the field.

2236

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

2237

"id": "A String", # The unique identifier within the source type generated by the server.

2238

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

2239

"objectType": "A String", # Output only. The profile object type.

2240

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

2245

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

2246

},

2247

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

2248

},

2249

"value": "A String", # The interest; for example, `stargazing`.

2250

},

2251

],

2252

"locales": [ # The person's locale preferences.

2253

{ # A person's locale preference.

2254

"metadata": { # Metadata about a field. # Metadata about the locale.

2255

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

2256

"source": { # The source of a field. # The source of the field.

2257

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

2258

"id": "A String", # The unique identifier within the source type generated by the server.

2259

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

2260

"objectType": "A String", # Output only. The profile object type.

2261

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

2266

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

2267

},

2268

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

2269

},

2270

"value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag representing the locale.

2271

},

2272

],

2273

"locations": [ # The person's locations.

2274

{ # A person's location.

2275

"buildingId": "A String", # The building identifier.

2276

"current": True or False, # Whether the location is the current location.

2277

"deskCode": "A String", # The individual desk location.

2278

"floor": "A String", # The floor name or number.

2279

"floorSection": "A String", # The floor section in `floor_name`.

2280

"metadata": { # Metadata about a field. # Metadata about the location.

2281

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

2282

"source": { # The source of a field. # The source of the field.

2283

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

2284

"id": "A String", # The unique identifier within the source type generated by the server.

2285

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

2286

"objectType": "A String", # Output only. The profile object type.

2287

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

2292

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

2293

},

2294

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

2295

},

2296

"type": "A String", # The type of the location. The type can be custom or one of these predefined values: * `desk` * `grewUp`

2297

"value": "A String", # The free-form value of the location.

2298

},

2299

],

2300

"memberships": [ # The person's group memberships.

2301

{ # A person's membership in a group. Only contact group memberships can be modified.

2302

"contactGroupMembership": { # A Google contact group membership. # The contact group membership.

2303

"contactGroupId": "A String", # Output only. The contact group ID for the contact group membership.

2304

"contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`. Only contact_group_resource_name can be used for modifying memberships. Any contact group membership can be removed, but only user group or "myContacts" or "starred" system groups memberships can be added. A contact must always have at least one contact group membership.

2305

},

2306

"domainMembership": { # A G Suite Domain membership. # Output only. The domain membership.

2307

"inViewerDomain": True or False, # True if the person is in the viewer's G Suite domain.

2308

},

2309

"metadata": { # Metadata about a field. # Metadata about the membership.

2310

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

2311

"source": { # The source of a field. # The source of the field.

2312

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

2313

"id": "A String", # The unique identifier within the source type generated by the server.

2314

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

2315

"objectType": "A String", # Output only. The profile object type.

2316

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

2321

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

2322

},

2323

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

},

},

],

"metadata": { # The metadata about a person. # Output only. Metadata about the person.

2328

"deleted": True or False, # Output only. True if the person resource has been deleted. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token.

2329

"linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.

2330

"A String",

2331

],

2332

"objectType": "A String", # Output only. **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object.

2333

"previousResourceNames": [ # Output only. Any former resource names this person has had. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token. The resource name may change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or profile URL.

2334

"A String",

2335

],

2336

"sources": [ # The sources of data for the person.

2337

{ # The source of a field.

2338

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

2339

"id": "A String", # The unique identifier within the source type generated by the server.

2340

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

2341

"objectType": "A String", # Output only. The profile object type.

2342

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

2347

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

},

],

},

"miscKeywords": [ # The person's miscellaneous keywords.

2352

{ # A person's miscellaneous keyword.

2353

"formattedType": "A String", # Output only. The type of the miscellaneous keyword translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

2354

"metadata": { # Metadata about a field. # Metadata about the miscellaneous keyword.

2355

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

2356

"source": { # The source of a field. # The source of the field.

2357

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

2358

"id": "A String", # The unique identifier within the source type generated by the server.

2359

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

2360

"objectType": "A String", # Output only. The profile object type.

2361

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

2366

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

2367

},

2368

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

2369

},

2370

"type": "A String", # The miscellaneous keyword type.

2371

"value": "A String", # The value of the miscellaneous keyword.

2372

},

2373

],

2374

"names": [ # The person's names. This field is a singleton for contact sources.

2375

{ # A person's name. If the name is a mononym, the family name is empty.

2376

"displayName": "A String", # Output only. The display name formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.

2377

"displayNameLastFirst": "A String", # Output only. The display name with the last name first formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.

2378

"familyName": "A String", # The family name.

2379

"givenName": "A String", # The given name.

2380

"honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`

2381

"honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`

2382

"metadata": { # Metadata about a field. # Metadata about the name.

2383

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

2384

"source": { # The source of a field. # The source of the field.

2385

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

2386

"id": "A String", # The unique identifier within the source type generated by the server.

2387

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

2388

"objectType": "A String", # Output only. The profile object type.

2389

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

2394

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

2395

},

2396

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

2397

},

2398

"middleName": "A String", # The middle name(s).

2399

"phoneticFamilyName": "A String", # The family name spelled as it sounds.

2400

"phoneticFullName": "A String", # The full name spelled as it sounds.

2401

"phoneticGivenName": "A String", # The given name spelled as it sounds.

2402

"phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.

2403

"phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.

2404

"phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.

2405

"unstructuredName": "A String", # The free form name value.

2406

},

2407

],

2408

"nicknames": [ # The person's nicknames.

2409

{ # A person's nickname.

2410

"metadata": { # Metadata about a field. # Metadata about the nickname.

2411

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

2412

"source": { # The source of a field. # The source of the field.

2413

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

2414

"id": "A String", # The unique identifier within the source type generated by the server.

2415

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

2416

"objectType": "A String", # Output only. The profile object type.

2417

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

2422

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

2423

},

2424

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

2425

},

2426

"type": "A String", # The type of the nickname.

2427

"value": "A String", # The nickname.

2428

},

2429

],

2430

"occupations": [ # The person's occupations.

2431

{ # A person's occupation.

2432

"metadata": { # Metadata about a field. # Metadata about the occupation.

2433

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

2434

"source": { # The source of a field. # The source of the field.

2435

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

2436

"id": "A String", # The unique identifier within the source type generated by the server.

2437

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

2438

"objectType": "A String", # Output only. The profile object type.

2439

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

2444

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

2445

},

2446

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

2447

},

2448

"value": "A String", # The occupation; for example, `carpenter`.

2449

},

2450

],

2451

"organizations": [ # The person's past or current organizations.

2452

{ # A person's past or current organization. Overlapping date ranges are permitted.

2453

"current": True or False, # True if the organization is the person's current organization; false if the organization is a past organization.

2454

"department": "A String", # The person's department at the organization.

2455

"domain": "A String", # The domain name associated with the organization; for example, `google.com`.

2456

"endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The end date when the person left the organization.

2457

"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

2458

"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

2459

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

2460

},

2461

"formattedType": "A String", # Output only. The type of the organization translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

2462

"jobDescription": "A String", # The person's job description at the organization.

2463

"location": "A String", # The location of the organization office the person works at.

2464

"metadata": { # Metadata about a field. # Metadata about the organization.

2465

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

2466

"source": { # The source of a field. # The source of the field.

2467

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

2468

"id": "A String", # The unique identifier within the source type generated by the server.

2469

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

2470

"objectType": "A String", # Output only. The profile object type.

2471

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

2476

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

2477

},

2478

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

2479

},

2480

"name": "A String", # The name of the organization.

2481

"phoneticName": "A String", # The phonetic name of the organization.

2482

"startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The start date when the person joined the organization.

2483

"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

2484

"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

2485

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

2486

},

2487

"symbol": "A String", # The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym.

2488

"title": "A String", # The person's job title at the organization.

2489

"type": "A String", # The type of the organization. The type can be custom or one of these predefined values: * `work` * `school`

2490

},

2491

],

2492

"phoneNumbers": [ # The person's phone numbers.

2493

{ # A person's phone number.

2494

"canonicalForm": "A String", # Output only. The canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number.

2495

"formattedType": "A String", # Output only. The type of the phone number translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

2496

"metadata": { # Metadata about a field. # Metadata about the phone number.

2497

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

2498

"source": { # The source of a field. # The source of the field.

2499

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

2500

"id": "A String", # The unique identifier within the source type generated by the server.

2501

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

2502

"objectType": "A String", # Output only. The profile object type.

2503

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

2508

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

2509

},

2510

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

2511

},

2512

"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`

2513

"value": "A String", # The phone number.

2514

},

2515

],

2516

"photos": [ # Output only. The person's photos.

2517

{ # A person's photo. A picture shown next to the person's name to help others recognize the person.

2518

"default": True or False, # True if the photo is a default photo; false if the photo is a user-provided photo.

2519

"metadata": { # Metadata about a field. # Metadata about the photo.

2520

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

2521

"source": { # The source of a field. # The source of the field.

2522

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

2523

"id": "A String", # The unique identifier within the source type generated by the server.

2524

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

2525

"objectType": "A String", # Output only. The profile object type.

2526

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

2531

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

2532

},

2533

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

2534

},

2535

"url": "A String", # The URL of the photo. You can change the desired size by appending a query parameter `sz={size}` at the end of the url, where {size} is the size in pixels. Example: https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50

2536

},

2537

],

2538

"relations": [ # The person's relations.

2539

{ # A person's relation to another person.

2540

"formattedType": "A String", # Output only. The type of the relation translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.

2541

"metadata": { # Metadata about a field. # Metadata about the relation.

2542

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

2543

"source": { # The source of a field. # The source of the field.

2544

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

2545

"id": "A String", # The unique identifier within the source type generated by the server.

2546

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

2547

"objectType": "A String", # Output only. The profile object type.

2548

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

2553

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

2554

},

2555

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

2556

},

2557

"person": "A String", # The name of the other person this relation refers to.

2558

"type": "A String", # The person's relation to the other person. The type can be custom or one of these predefined values: * `spouse` * `child` * `mother` * `father` * `parent` * `brother` * `sister` * `friend` * `relative` * `domesticPartner` * `manager` * `assistant` * `referredBy` * `partner`

2559

},

2560

],

2561

"relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship interests.

2562

{ # **DEPRECATED**: No data will be returned A person's relationship interest .

2563

"formattedValue": "A String", # Output only. The value of the relationship interest translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.

2564

"metadata": { # Metadata about a field. # Metadata about the relationship interest.

2565

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

2566

"source": { # The source of a field. # The source of the field.

2567

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

2568

"id": "A String", # The unique identifier within the source type generated by the server.

2569

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

2570

"objectType": "A String", # Output only. The profile object type.

2571

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

2576

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

2577

},

2578

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

2579

},

2580

"value": "A String", # The kind of relationship the person is looking for. The value can be custom or one of these predefined values: * `friend` * `date` * `relationship` * `networking`

2581

},

2582

],

2583

"relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship statuses.

2584

{ # **DEPRECATED**: No data will be returned A person's relationship status.

2585

"formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

2586

"metadata": { # Metadata about a field. # Metadata about the relationship status.

2587

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

2588

"source": { # The source of a field. # The source of the field.

2589

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

2590

"id": "A String", # The unique identifier within the source type generated by the server.

2591

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

2592

"objectType": "A String", # Output only. The profile object type.

2593

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

2598

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

2599

},

2600

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

2601

},

2602

"value": "A String", # The relationship status. The value can be custom or one of these predefined values: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion`

2603

},

2604

],

2605

"residences": [ # **DEPRECATED**: (Please use `person.locations` instead) The person's residences.

2606

{ # **DEPRECATED**: Please use `person.locations` instead. A person's past or current residence.

2607

"current": True or False, # True if the residence is the person's current residence; false if the residence is a past residence.

2608

"metadata": { # Metadata about a field. # Metadata about the residence.

2609

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

2610

"source": { # The source of a field. # The source of the field.

2611

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

2612

"id": "A String", # The unique identifier within the source type generated by the server.

2613

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

2614

"objectType": "A String", # Output only. The profile object type.

2615

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

2620

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

2621

},

2622

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

2623

},

2624

"value": "A String", # The address of the residence.

2625

},

2626

],

2627

"resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters, in the form of `people/{person_id}`.

2628

"sipAddresses": [ # The person's SIP addresses.

2629

{ # A person's SIP address. Session Initial Protocol addresses are used for VoIP communications to make voice or video calls over the internet.

2630

"formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

2631

"metadata": { # Metadata about a field. # Metadata about the SIP address.

2632

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

2633

"source": { # The source of a field. # The source of the field.

2634

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

2635

"id": "A String", # The unique identifier within the source type generated by the server.

2636

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

2637

"objectType": "A String", # Output only. The profile object type.

2638

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

2643

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

2644

},

2645

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

2646

},

2647

"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`

2648

"value": "A String", # The SIP address in the [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI format.

2649

},

2650

],

2651

"skills": [ # The person's skills.

2652

{ # A skill that the person has.

2653

"metadata": { # Metadata about a field. # Metadata about the skill.

2654

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

2655

"source": { # The source of a field. # The source of the field.

2656

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

2657

"id": "A String", # The unique identifier within the source type generated by the server.

2658

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

2659

"objectType": "A String", # Output only. The profile object type.

2660

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

2665

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

2666

},

2667

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

2668

},

2669

"value": "A String", # The skill; for example, `underwater basket weaving`.

2670

},

2671

],

2672

"taglines": [ # Output only. **DEPRECATED**: No data will be returned The person's taglines.

2673

{ # **DEPRECATED**: No data will be returned A brief one-line description of the person.

2674

"metadata": { # Metadata about a field. # Metadata about the tagline.

2675

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

2676

"source": { # The source of a field. # The source of the field.

2677

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

2678

"id": "A String", # The unique identifier within the source type generated by the server.

2679

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

2680

"objectType": "A String", # Output only. The profile object type.

2681

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

2686

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

2687

},

2688

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

2689

},

2690

"value": "A String", # The tagline.

2691

},

2692

],

2693

"urls": [ # The person's associated URLs.

2694

{ # A person's associated URLs.

2695

"formattedType": "A String", # Output only. The type of the URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

2696

"metadata": { # Metadata about a field. # Metadata about the URL.

2697

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

2698

"source": { # The source of a field. # The source of the field.

2699

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

2700

"id": "A String", # The unique identifier within the source type generated by the server.

2701

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

2702

"objectType": "A String", # Output only. The profile object type.

2703

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

2708

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

2709

},

2710

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

2711

},

2712

"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 Currents application. * `other`

2713

"value": "A String", # The URL.

2714

},

2715

],

2716

"userDefined": [ # The person's user defined data.

2717

{ # Arbitrary user data that is populated by the end users.

2718

"key": "A String", # The end user specified key of the user defined data.

2719

"metadata": { # Metadata about a field. # Metadata about the user defined data.

2720

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

2721

"source": { # The source of a field. # The source of the field.

2722

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

2723

"id": "A String", # The unique identifier within the source type generated by the server.

2724

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

2725

"objectType": "A String", # Output only. The profile object type.

2726

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

2731

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

2732

},

2733

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

2734

},

2735

"value": "A String", # The end user specified value of the user defined data.

},

],

},

},

"readMask": "A String", # Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. If read mask is left empty, the post-mutate-get is skipped and no data will be returned in the response. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined

2741

"sources": [ # Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.

2742

"A String",

2743

],

2744

"updateMask": "A String", # Required. A field mask to restrict which fields on the person are updated. Multiple fields can be specified by separating them with commas. All specified fields will be replaced, or cleared if left empty for each person. Valid values are: * addresses * biographies * birthdays * calendarUrls * clientData * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * relations * sipAddresses * urls * userDefined

2745

}

2746

2747

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2754

2755

{ # The response to a request to create a batch of contacts.

2756

"updateResult": { # A map of resource names to the contacts that were updated, unless the request `read_mask` is empty.

2757

"a_key": { # The response for a single person

2758

"httpStatusCode": 42, # **DEPRECATED** (Please use status instead) [HTTP 1.1 status code] (http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html).

2759

"person": { # Information about a person merged from various data sources such as the authenticated user's contacts and profile data. Most fields can have multiple items. The items in a field have no guaranteed order, but each non-empty field is guaranteed to have exactly one field with `metadata.primary` set to true. # The person.

2760

"addresses": [ # The person's street addresses.

2761

{ # A person's physical address. May be a P.O. box or street address. All fields are optional.

2762

"city": "A String", # The city of the address.

2763

"country": "A String", # The country of the address.

2764

"countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address.

2765

"extendedAddress": "A String", # The extended address of the address; for example, the apartment number.

2766

"formattedType": "A String", # Output only. The type of the address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

2767

"formattedValue": "A String", # The unstructured value of the address. If this is not set by the user it will be automatically constructed from structured values.

2768

"metadata": { # Metadata about a field. # Metadata about the address.

2769

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

2770

"source": { # The source of a field. # The source of the field.

2771

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

2772

"id": "A String", # The unique identifier within the source type generated by the server.

2773

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

2774

"objectType": "A String", # Output only. The profile object type.

2775

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

2780

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

2781

},

2782

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

2783

},

2784

"poBox": "A String", # The P.O. box of the address.

2785

"postalCode": "A String", # The postal code of the address.

2786

"region": "A String", # The region of the address; for example, the state or province.

2787

"streetAddress": "A String", # The street address.

2788

"type": "A String", # The type of the address. The type can be custom or one of these predefined values: * `home` * `work` * `other`

2789

},

2790

],

2791

"ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead) The person's age range.

2792

"ageRanges": [ # Output only. The person's age ranges.

2793

{ # A person's age range.

2794

"ageRange": "A String", # The age range.

2795

"metadata": { # Metadata about a field. # Metadata about the age range.

2796

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

2797

"source": { # The source of a field. # The source of the field.

2798

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

2799

"id": "A String", # The unique identifier within the source type generated by the server.

2800

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

2801

"objectType": "A String", # Output only. The profile object type.

2802

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

2807

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

2808

},

2809

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

},

},

],

"biographies": [ # The person's biographies. This field is a singleton for contact sources.

2814

{ # A person's short biography.

2815

"contentType": "A String", # The content type of the biography.

2816

"metadata": { # Metadata about a field. # Metadata about the biography.

2817

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

2818

"source": { # The source of a field. # The source of the field.

2819

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

2820

"id": "A String", # The unique identifier within the source type generated by the server.

2821

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

2822

"objectType": "A String", # Output only. The profile object type.

2823

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

2828

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

2829

},

2830

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

2831

},

2832

"value": "A String", # The short biography.

2833

},

2834

],

2835

"birthdays": [ # The person's birthdays. This field is a singleton for contact sources.

2836

{ # A person's birthday. At least one of the `date` and `text` fields are specified. The `date` and `text` fields typically represent the same date, but are not guaranteed to.

2837

"date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The date of the birthday.

2838

"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

2839

"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

2840

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

2841

},

2842

"metadata": { # Metadata about a field. # Metadata about the birthday.

2843

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

2844

"source": { # The source of a field. # The source of the field.

2845

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

2846

"id": "A String", # The unique identifier within the source type generated by the server.

2847

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

2848

"objectType": "A String", # Output only. The profile object type.

2849

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

2854

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

2855

},

2856

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

2857

},

2858

"text": "A String", # A free-form string representing the user's birthday.

2859

},

2860

],

2861

"braggingRights": [ # **DEPRECATED**: No data will be returned The person's bragging rights.

2862

{ # **DEPRECATED**: No data will be returned A person's bragging rights.

2863

"metadata": { # Metadata about a field. # Metadata about the bragging rights.

2864

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

2865

"source": { # The source of a field. # The source of the field.

2866

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

2867

"id": "A String", # The unique identifier within the source type generated by the server.

2868

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

2869

"objectType": "A String", # Output only. The profile object type.

2870

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

2875

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

2876

},

2877

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

2878

},

2879

"value": "A String", # The bragging rights; for example, `climbed mount everest`.

2880

},

2881

],

2882

"calendarUrls": [ # The person's calendar URLs.

2883

{ # A person's calendar URL.

2884

"formattedType": "A String", # Output only. The type of the calendar URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

2885

"metadata": { # Metadata about a field. # Metadata about the calendar URL.

2886

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

2887

"source": { # The source of a field. # The source of the field.

2888

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

2889

"id": "A String", # The unique identifier within the source type generated by the server.

2890

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

2891

"objectType": "A String", # Output only. The profile object type.

2892

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

2897

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

2898

},

2899

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

2900

},

2901

"type": "A String", # The type of the calendar URL. The type can be custom or one of these predefined values: * `home` * `freeBusy` * `work`

2902

"url": "A String", # The calendar URL.

2903

},

2904

],

2905

"clientData": [ # The person's client data.

2906

{ # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.

2907

"key": "A String", # The client specified key of the client data.

2908

"metadata": { # Metadata about a field. # Metadata about the client data.

2909

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

2910

"source": { # The source of a field. # The source of the field.

2911

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

2912

"id": "A String", # The unique identifier within the source type generated by the server.

2913

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

2914

"objectType": "A String", # Output only. The profile object type.

2915

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

2920

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

2921

},

2922

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

2923

},

2924

"value": "A String", # The client specified value of the client data.

2925

},

2926

],

2927

"coverPhotos": [ # Output only. The person's cover photos.

2928

{ # A person's cover photo. A large image shown on the person's profile page that represents who they are or what they care about.

2929

"default": True or False, # True if the cover photo is the default cover photo; false if the cover photo is a user-provided cover photo.

2930

"metadata": { # Metadata about a field. # Metadata about the cover photo.

2931

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

2932

"source": { # The source of a field. # The source of the field.

2933

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

2934

"id": "A String", # The unique identifier within the source type generated by the server.

2935

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

2936

"objectType": "A String", # Output only. The profile object type.

2937

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

2942

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

2943

},

2944

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

2945

},

2946

"url": "A String", # The URL of the cover photo.

2947

},

2948

],

2949

"emailAddresses": [ # The person's email addresses.

2950

{ # A person's email address.

2951

"displayName": "A String", # The display name of the email.

2952

"formattedType": "A String", # Output only. The type of the email address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

2953

"metadata": { # Metadata about a field. # Metadata about the email address.

2954

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

2955

"source": { # The source of a field. # The source of the field.

2956

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

2957

"id": "A String", # The unique identifier within the source type generated by the server.

2958

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

2959

"objectType": "A String", # Output only. The profile object type.

2960

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

2965

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

2966

},

2967

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

2968

},

2969

"type": "A String", # The type of the email address. The type can be custom or one of these predefined values: * `home` * `work` * `other`

2970

"value": "A String", # The email address.

2971

},

2972

],

2973

"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.

2974

"events": [ # The person's events.

2975

{ # An event related to the person.

2976

"date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The date of the event.

2977

"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

2978

"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

2979

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

2980

},

2981

"formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

2982

"metadata": { # Metadata about a field. # Metadata about the event.

2983

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

2984

"source": { # The source of a field. # The source of the field.

2985

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

2986

"id": "A String", # The unique identifier within the source type generated by the server.

2987

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

2988

"objectType": "A String", # Output only. The profile object type.

2989

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

2994

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

2995

},

2996

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

2997

},

2998

"type": "A String", # The type of the event. The type can be custom or one of these predefined values: * `anniversary` * `other`

2999

},

3000

],

3001

"externalIds": [ # The person's external IDs.

3002

{ # An identifier from an external entity related to the person.

3003

"formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

3004

"metadata": { # Metadata about a field. # Metadata about the external ID.

3005

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

3006

"source": { # The source of a field. # The source of the field.

3007

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

3008

"id": "A String", # The unique identifier within the source type generated by the server.

3009

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

3010

"objectType": "A String", # Output only. The profile object type.

3011

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

3016

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

3017

},

3018

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

3019

},

3020

"type": "A String", # The type of the external ID. The type can be custom or one of these predefined values: * `account` * `customer` * `loginId` * `network` * `organization`

3021

"value": "A String", # The value of the external ID.

3022

},

3023

],

3024

"fileAses": [ # The person's file-ases.

3025

{ # The name that should be used to sort the person in a list.

3026

"metadata": { # Metadata about a field. # Metadata about the file-as.

3027

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

3028

"source": { # The source of a field. # The source of the field.

3029

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

3030

"id": "A String", # The unique identifier within the source type generated by the server.

3031

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

3032

"objectType": "A String", # Output only. The profile object type.

3033

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

3038

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

3039

},

3040

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

3041

},

3042

"value": "A String", # The file-as value

3043

},

3044

],

3045

"genders": [ # The person's genders. This field is a singleton for contact sources.

3046

{ # A person's gender.

3047

"addressMeAs": "A String", # The type of pronouns that should be used to address the person. The value can be custom or one of these predefined values: * `male` * `female` * `other`

3048

"formattedValue": "A String", # Output only. The value of the gender translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. Unspecified or custom value are not localized.

3049

"metadata": { # Metadata about a field. # Metadata about the gender.

3050

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

3051

"source": { # The source of a field. # The source of the field.

3052

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

3053

"id": "A String", # The unique identifier within the source type generated by the server.

3054

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

3055

"objectType": "A String", # Output only. The profile object type.

3056

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

3061

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

3062

},

3063

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

3064

},

3065

"value": "A String", # The gender for the person. The gender can be custom or one of these predefined values: * `male` * `female` * `unspecified`

3066

},

3067

],

3068

"imClients": [ # The person's instant messaging clients.

3069

{ # A person's instant messaging client.

3070

"formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

3071

"formattedType": "A String", # Output only. The type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

3072

"metadata": { # Metadata about a field. # Metadata about the IM client.

3073

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

3074

"source": { # The source of a field. # The source of the field.

3075

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

3076

"id": "A String", # The unique identifier within the source type generated by the server.

3077

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

3078

"objectType": "A String", # Output only. The profile object type.

3079

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

3084

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

3085

},

3086

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

3087

},

3088

"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`

3089

"type": "A String", # The type of the IM client. The type can be custom or one of these predefined values: * `home` * `work` * `other`

3090

"username": "A String", # The user name used in the IM client.

3091

},

3092

],

3093

"interests": [ # The person's interests.

3094

{ # One of the person's interests.

3095

"metadata": { # Metadata about a field. # Metadata about the interest.

3096

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

3097

"source": { # The source of a field. # The source of the field.

3098

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

3099

"id": "A String", # The unique identifier within the source type generated by the server.

3100

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

3101

"objectType": "A String", # Output only. The profile object type.

3102

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

3107

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

3108

},

3109

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

3110

},

3111

"value": "A String", # The interest; for example, `stargazing`.

3112

},

3113

],

3114

"locales": [ # The person's locale preferences.

3115

{ # A person's locale preference.

3116

"metadata": { # Metadata about a field. # Metadata about the locale.

3117

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

3118

"source": { # The source of a field. # The source of the field.

3119

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

3120

"id": "A String", # The unique identifier within the source type generated by the server.

3121

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

3122

"objectType": "A String", # Output only. The profile object type.

3123

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

3128

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

3129

},

3130

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

3131

},

3132

"value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag representing the locale.

3133

},

3134

],

3135

"locations": [ # The person's locations.

3136

{ # A person's location.

3137

"buildingId": "A String", # The building identifier.

3138

"current": True or False, # Whether the location is the current location.

3139

"deskCode": "A String", # The individual desk location.

3140

"floor": "A String", # The floor name or number.

3141

"floorSection": "A String", # The floor section in `floor_name`.

3142

"metadata": { # Metadata about a field. # Metadata about the location.

3143

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

3144

"source": { # The source of a field. # The source of the field.

3145

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

3146

"id": "A String", # The unique identifier within the source type generated by the server.

3147

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

3148

"objectType": "A String", # Output only. The profile object type.

3149

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

3154

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

3155

},

3156

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

3157

},

3158

"type": "A String", # The type of the location. The type can be custom or one of these predefined values: * `desk` * `grewUp`

3159

"value": "A String", # The free-form value of the location.

3160

},

3161

],

3162

"memberships": [ # The person's group memberships.

3163

{ # A person's membership in a group. Only contact group memberships can be modified.

3164

"contactGroupMembership": { # A Google contact group membership. # The contact group membership.

3165

"contactGroupId": "A String", # Output only. The contact group ID for the contact group membership.

3166

"contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`. Only contact_group_resource_name can be used for modifying memberships. Any contact group membership can be removed, but only user group or "myContacts" or "starred" system groups memberships can be added. A contact must always have at least one contact group membership.

3167

},

3168

"domainMembership": { # A G Suite Domain membership. # Output only. The domain membership.

3169

"inViewerDomain": True or False, # True if the person is in the viewer's G Suite domain.

3170

},

3171

"metadata": { # Metadata about a field. # Metadata about the membership.

3172

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

3173

"source": { # The source of a field. # The source of the field.

3174

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

3175

"id": "A String", # The unique identifier within the source type generated by the server.

3176

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

3177

"objectType": "A String", # Output only. The profile object type.

3178

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

3183

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

3184

},

3185

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

},

},

],

"metadata": { # The metadata about a person. # Output only. Metadata about the person.

3190

"deleted": True or False, # Output only. True if the person resource has been deleted. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token.

3191

"linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.

3192

"A String",

3193

],

3194

"objectType": "A String", # Output only. **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object.

3195

"previousResourceNames": [ # Output only. Any former resource names this person has had. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token. The resource name may change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or profile URL.

3196

"A String",

3197

],

3198

"sources": [ # The sources of data for the person.

3199

{ # The source of a field.

3200

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

3201

"id": "A String", # The unique identifier within the source type generated by the server.

3202

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

3203

"objectType": "A String", # Output only. The profile object type.

3204

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

3209

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

},

],

},

"miscKeywords": [ # The person's miscellaneous keywords.

3214

{ # A person's miscellaneous keyword.

3215

"formattedType": "A String", # Output only. The type of the miscellaneous keyword translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

3216

"metadata": { # Metadata about a field. # Metadata about the miscellaneous keyword.

3217

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

3218

"source": { # The source of a field. # The source of the field.

3219

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

3220

"id": "A String", # The unique identifier within the source type generated by the server.

3221

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

3222

"objectType": "A String", # Output only. The profile object type.

3223

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

3228

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

3229

},

3230

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

3231

},

3232

"type": "A String", # The miscellaneous keyword type.

3233

"value": "A String", # The value of the miscellaneous keyword.

3234

},

3235

],

3236

"names": [ # The person's names. This field is a singleton for contact sources.

3237

{ # A person's name. If the name is a mononym, the family name is empty.

3238

"displayName": "A String", # Output only. The display name formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.

3239

"displayNameLastFirst": "A String", # Output only. The display name with the last name first formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.

3240

"familyName": "A String", # The family name.

3241

"givenName": "A String", # The given name.

3242

"honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`

3243

"honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`

3244

"metadata": { # Metadata about a field. # Metadata about the name.

3245

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

3246

"source": { # The source of a field. # The source of the field.

3247

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

3248

"id": "A String", # The unique identifier within the source type generated by the server.

3249

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

3250

"objectType": "A String", # Output only. The profile object type.

3251

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

3256

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

3257

},

3258

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

3259

},

3260

"middleName": "A String", # The middle name(s).

3261

"phoneticFamilyName": "A String", # The family name spelled as it sounds.

3262

"phoneticFullName": "A String", # The full name spelled as it sounds.

3263

"phoneticGivenName": "A String", # The given name spelled as it sounds.

3264

"phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.

3265

"phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.

3266

"phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.

3267

"unstructuredName": "A String", # The free form name value.

3268

},

3269

],

3270

"nicknames": [ # The person's nicknames.

3271

{ # A person's nickname.

3272

"metadata": { # Metadata about a field. # Metadata about the nickname.

3273

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

3274

"source": { # The source of a field. # The source of the field.

3275

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

3276

"id": "A String", # The unique identifier within the source type generated by the server.

3277

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

3278

"objectType": "A String", # Output only. The profile object type.

3279

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

3284

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

3285

},

3286

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

3287

},

3288

"type": "A String", # The type of the nickname.

3289

"value": "A String", # The nickname.

3290

},

3291

],

3292

"occupations": [ # The person's occupations.

3293

{ # A person's occupation.

3294

"metadata": { # Metadata about a field. # Metadata about the occupation.

3295

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

3296

"source": { # The source of a field. # The source of the field.

3297

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

3298

"id": "A String", # The unique identifier within the source type generated by the server.

3299

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

3300

"objectType": "A String", # Output only. The profile object type.

3301

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

3306

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

3307

},

3308

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

3309

},

3310

"value": "A String", # The occupation; for example, `carpenter`.

3311

},

3312

],

3313

"organizations": [ # The person's past or current organizations.

3314

{ # A person's past or current organization. Overlapping date ranges are permitted.

3315

"current": True or False, # True if the organization is the person's current organization; false if the organization is a past organization.

3316

"department": "A String", # The person's department at the organization.

3317

"domain": "A String", # The domain name associated with the organization; for example, `google.com`.

3318

"endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The end date when the person left the organization.

3319

"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

3320

"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

3321

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

3322

},

3323

"formattedType": "A String", # Output only. The type of the organization translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

3324

"jobDescription": "A String", # The person's job description at the organization.

3325

"location": "A String", # The location of the organization office the person works at.

3326

"metadata": { # Metadata about a field. # Metadata about the organization.

3327

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

3328

"source": { # The source of a field. # The source of the field.

3329

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

3330

"id": "A String", # The unique identifier within the source type generated by the server.

3331

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

3332

"objectType": "A String", # Output only. The profile object type.

3333

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

3338

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

3339

},

3340

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

3341

},

3342

"name": "A String", # The name of the organization.

3343

"phoneticName": "A String", # The phonetic name of the organization.

3344

"startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The start date when the person joined the organization.

3345

"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

3346

"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

3347

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

3348

},

3349

"symbol": "A String", # The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym.

3350

"title": "A String", # The person's job title at the organization.

3351

"type": "A String", # The type of the organization. The type can be custom or one of these predefined values: * `work` * `school`

3352

},

3353

],

3354

"phoneNumbers": [ # The person's phone numbers.

3355

{ # A person's phone number.

3356

"canonicalForm": "A String", # Output only. The canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number.

3357

"formattedType": "A String", # Output only. The type of the phone number translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

3358

"metadata": { # Metadata about a field. # Metadata about the phone number.

3359

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

3360

"source": { # The source of a field. # The source of the field.

3361

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

3362

"id": "A String", # The unique identifier within the source type generated by the server.

3363

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

3364

"objectType": "A String", # Output only. The profile object type.

3365

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

3370

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

3371

},

3372

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

3373

},

3374

"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`

3375

"value": "A String", # The phone number.

3376

},

3377

],

3378

"photos": [ # Output only. The person's photos.

3379

{ # A person's photo. A picture shown next to the person's name to help others recognize the person.

3380

"default": True or False, # True if the photo is a default photo; false if the photo is a user-provided photo.

3381

"metadata": { # Metadata about a field. # Metadata about the photo.

3382

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

3383

"source": { # The source of a field. # The source of the field.

3384

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

3385

"id": "A String", # The unique identifier within the source type generated by the server.

3386

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

3387

"objectType": "A String", # Output only. The profile object type.

3388

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

3393

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

3394

},

3395

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

3396

},

3397

"url": "A String", # The URL of the photo. You can change the desired size by appending a query parameter `sz={size}` at the end of the url, where {size} is the size in pixels. Example: https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50

3398

},

3399

],

3400

"relations": [ # The person's relations.

3401

{ # A person's relation to another person.

3402

"formattedType": "A String", # Output only. The type of the relation translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.

3403

"metadata": { # Metadata about a field. # Metadata about the relation.

3404

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

3405

"source": { # The source of a field. # The source of the field.

3406

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

3407

"id": "A String", # The unique identifier within the source type generated by the server.

3408

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

3409

"objectType": "A String", # Output only. The profile object type.

3410

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

3415

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

3416

},

3417

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

3418

},

3419

"person": "A String", # The name of the other person this relation refers to.

3420

"type": "A String", # The person's relation to the other person. The type can be custom or one of these predefined values: * `spouse` * `child` * `mother` * `father` * `parent` * `brother` * `sister` * `friend` * `relative` * `domesticPartner` * `manager` * `assistant` * `referredBy` * `partner`

3421

},

3422

],

3423

"relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship interests.

3424

{ # **DEPRECATED**: No data will be returned A person's relationship interest .

3425

"formattedValue": "A String", # Output only. The value of the relationship interest translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.

3426

"metadata": { # Metadata about a field. # Metadata about the relationship interest.

3427

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

3428

"source": { # The source of a field. # The source of the field.

3429

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

3430

"id": "A String", # The unique identifier within the source type generated by the server.

3431

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

3432

"objectType": "A String", # Output only. The profile object type.

3433

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

3438

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

3439

},

3440

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

3441

},

3442

"value": "A String", # The kind of relationship the person is looking for. The value can be custom or one of these predefined values: * `friend` * `date` * `relationship` * `networking`

3443

},

3444

],

3445

"relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship statuses.

3446

{ # **DEPRECATED**: No data will be returned A person's relationship status.

3447

"formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

3448

"metadata": { # Metadata about a field. # Metadata about the relationship status.

3449

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

3450

"source": { # The source of a field. # The source of the field.

3451

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

3452

"id": "A String", # The unique identifier within the source type generated by the server.

3453

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

3454

"objectType": "A String", # Output only. The profile object type.

3455

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

3460

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

3461

},

3462

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

3463

},

3464

"value": "A String", # The relationship status. The value can be custom or one of these predefined values: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion`

3465

},

3466

],

3467

"residences": [ # **DEPRECATED**: (Please use `person.locations` instead) The person's residences.

3468

{ # **DEPRECATED**: Please use `person.locations` instead. A person's past or current residence.

3469

"current": True or False, # True if the residence is the person's current residence; false if the residence is a past residence.

3470

"metadata": { # Metadata about a field. # Metadata about the residence.

3471

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

3472

"source": { # The source of a field. # The source of the field.

3473

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

3474

"id": "A String", # The unique identifier within the source type generated by the server.

3475

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

3476

"objectType": "A String", # Output only. The profile object type.

3477

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

3482

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

3483

},

3484

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

3485

},

3486

"value": "A String", # The address of the residence.

3487

},

3488

],

3489

"resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters, in the form of `people/{person_id}`.

3490

"sipAddresses": [ # The person's SIP addresses.

3491

{ # A person's SIP address. Session Initial Protocol addresses are used for VoIP communications to make voice or video calls over the internet.

3492

"formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

3493

"metadata": { # Metadata about a field. # Metadata about the SIP address.

3494

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

3495

"source": { # The source of a field. # The source of the field.

3496

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

3497

"id": "A String", # The unique identifier within the source type generated by the server.

3498

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

3499

"objectType": "A String", # Output only. The profile object type.

3500

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

3505

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

3506

},

3507

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

3508

},

3509

"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`

3510

"value": "A String", # The SIP address in the [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI format.

3511

},

3512

],

3513

"skills": [ # The person's skills.

3514

{ # A skill that the person has.

3515

"metadata": { # Metadata about a field. # Metadata about the skill.

3516

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

3517

"source": { # The source of a field. # The source of the field.

3518

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

3519

"id": "A String", # The unique identifier within the source type generated by the server.

3520

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

3521

"objectType": "A String", # Output only. The profile object type.

3522

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

3527

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

3528

},

3529

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

3530

},

3531

"value": "A String", # The skill; for example, `underwater basket weaving`.

3532

},

3533

],

3534

"taglines": [ # Output only. **DEPRECATED**: No data will be returned The person's taglines.

3535

{ # **DEPRECATED**: No data will be returned A brief one-line description of the person.

3536

"metadata": { # Metadata about a field. # Metadata about the tagline.

3537

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

3538

"source": { # The source of a field. # The source of the field.

3539

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

3540

"id": "A String", # The unique identifier within the source type generated by the server.

3541

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

3542

"objectType": "A String", # Output only. The profile object type.

3543

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

3548

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

3549

},

3550

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

3551

},

3552

"value": "A String", # The tagline.

3553

},

3554

],

3555

"urls": [ # The person's associated URLs.

3556

{ # A person's associated URLs.

3557

"formattedType": "A String", # Output only. The type of the URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

3558

"metadata": { # Metadata about a field. # Metadata about the URL.

3559

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

3560

"source": { # The source of a field. # The source of the field.

3561

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

3562

"id": "A String", # The unique identifier within the source type generated by the server.

3563

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

3564

"objectType": "A String", # Output only. The profile object type.

3565

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

3570

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

3571

},

3572

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

3573

},

3574

"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 Currents application. * `other`

3575

"value": "A String", # The URL.

3576

},

3577

],

3578

"userDefined": [ # The person's user defined data.

3579

{ # Arbitrary user data that is populated by the end users.

3580

"key": "A String", # The end user specified key of the user defined data.

3581

"metadata": { # Metadata about a field. # Metadata about the user defined data.

3582

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

3583

"source": { # The source of a field. # The source of the field.

3584

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

3585

"id": "A String", # The unique identifier within the source type generated by the server.

3586

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

3587

"objectType": "A String", # Output only. The profile object type.

3588

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

3593

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

3594

},

3595

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

3596

},

3597

"value": "A String", # The end user specified value of the user defined data.

},

],

},

"requestedResourceName": "A String", # The original requested resource name. May be different than the resource name on the returned person. The resource name can change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or a profile URL.

3602

"status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The status of the response.

3603

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

3604

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

3605

{

3606

"a_key": "", # Properties of the object. Contains field @type with type URL.

3607

},

3608

],

3609

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

},

},

},

}</pre>

</div>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3617

<code class="details" id="close">close()</code>

3618

<pre>Close httplib2 connections.</pre>

</div>

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3622

<code class="details" id="createContact">createContact(body=None, personFields=None, sources=None, x__xgafv=None)</code>

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3623

<pre>Create a new contact and return the person resource for that contact. The request returns a 400 error if more than one field is specified on a field that is a singleton for contact sources: * biographies * birthdays * genders * names

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

3624

3625

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3626

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3627

The object takes the form of:

Sai Cheemalapati

c30d2b5

2017-03-13 12:12:03 -0400

[diff] [blame]

3628

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3629

{ # Information about a person merged from various data sources such as the authenticated user's contacts and profile data. Most fields can have multiple items. The items in a field have no guaranteed order, but each non-empty field is guaranteed to have exactly one field with `metadata.primary` set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3630

"addresses": [ # The person's street addresses.

3631

{ # A person's physical address. May be a P.O. box or street address. All fields are optional.

3632

"city": "A String", # The city of the address.

3633

"country": "A String", # The country of the address.

3634

"countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address.

3635

"extendedAddress": "A String", # The extended address of the address; for example, the apartment number.

3636

"formattedType": "A String", # Output only. The type of the address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

3637

"formattedValue": "A String", # The unstructured value of the address. If this is not set by the user it will be automatically constructed from structured values.

3638

"metadata": { # Metadata about a field. # Metadata about the address.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3639

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3640

"source": { # The source of a field. # The source of the field.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3641

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3642

"id": "A String", # The unique identifier within the source type generated by the server.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3643

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3644

"objectType": "A String", # Output only. The profile object type.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3645

"userTypes": [ # Output only. The user types.

3646

"A String",

3647

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3648

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3649

"type": "A String", # The source type.

3650

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3651

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3652

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3653

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3654

"poBox": "A String", # The P.O. box of the address.

3655

"postalCode": "A String", # The postal code of the address.

3656

"region": "A String", # The region of the address; for example, the state or province.

3657

"streetAddress": "A String", # The street address.

3658

"type": "A String", # The type of the address. The type can be custom or one of these predefined values: * `home` * `work` * `other`

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3659

},

3660

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3661

"ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead) The person's age range.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3662

"ageRanges": [ # Output only. The person's age ranges.

3663

{ # A person's age range.

3664

"ageRange": "A String", # The age range.

3665

"metadata": { # Metadata about a field. # Metadata about the age range.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3666

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3667

"source": { # The source of a field. # The source of the field.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3668

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3669

"id": "A String", # The unique identifier within the source type generated by the server.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3670

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3671

"objectType": "A String", # Output only. The profile object type.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3672

"userTypes": [ # Output only. The user types.

3673

"A String",

3674

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3675

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3676

"type": "A String", # The source type.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3677

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

3678

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3679

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

3680

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3681

},

3682

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3683

"biographies": [ # The person's biographies. This field is a singleton for contact sources.

3684

{ # A person's short biography.

3685

"contentType": "A String", # The content type of the biography.

3686

"metadata": { # Metadata about a field. # Metadata about the biography.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3687

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3688

"source": { # The source of a field. # The source of the field.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3689

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3690

"id": "A String", # The unique identifier within the source type generated by the server.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3691

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3692

"objectType": "A String", # Output only. The profile object type.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3693

"userTypes": [ # Output only. The user types.

3694

"A String",

3695

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3696

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3697

"type": "A String", # The source type.

3698

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3699

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3700

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3701

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3702

"value": "A String", # The short biography.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3703

},

3704

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3705

"birthdays": [ # The person's birthdays. This field is a singleton for contact sources.

3706

{ # A person's birthday. At least one of the `date` and `text` fields are specified. The `date` and `text` fields typically represent the same date, but are not guaranteed to.

3707

"date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The date of the birthday.

3708

"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

3709

"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

3710

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

3711

},

3712

"metadata": { # Metadata about a field. # Metadata about the birthday.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3713

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3714

"source": { # The source of a field. # The source of the field.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3715

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3716

"id": "A String", # The unique identifier within the source type generated by the server.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3717

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3718

"objectType": "A String", # Output only. The profile object type.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3719

"userTypes": [ # Output only. The user types.

3720

"A String",

3721

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3722

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3723

"type": "A String", # The source type.

3724

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3725

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3726

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3727

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3728

"text": "A String", # A free-form string representing the user's birthday.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3729

},

3730

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3731

"braggingRights": [ # **DEPRECATED**: No data will be returned The person's bragging rights.

3732

{ # **DEPRECATED**: No data will be returned A person's bragging rights.

3733

"metadata": { # Metadata about a field. # Metadata about the bragging rights.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3734

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3735

"source": { # The source of a field. # The source of the field.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3736

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3737

"id": "A String", # The unique identifier within the source type generated by the server.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3738

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3739

"objectType": "A String", # Output only. The profile object type.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3740

"userTypes": [ # Output only. The user types.

3741

"A String",

3742

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3743

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3744

"type": "A String", # The source type.

3745

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3746

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3747

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3748

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3749

"value": "A String", # The bragging rights; for example, `climbed mount everest`.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

3750

},

3751

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3752

"calendarUrls": [ # The person's calendar URLs.

3753

{ # A person's calendar URL.

3754

"formattedType": "A String", # Output only. The type of the calendar URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

3755

"metadata": { # Metadata about a field. # Metadata about the calendar URL.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3756

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

3757

"source": { # The source of a field. # The source of the field.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3758

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3759

"id": "A String", # The unique identifier within the source type generated by the server.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

3760

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3761

"objectType": "A String", # Output only. The profile object type.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

3762

"userTypes": [ # Output only. The user types.

3763

"A String",

3764

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

3765

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3766

"type": "A String", # The source type.

3767

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

3768

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3769

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3770

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3771

"type": "A String", # The type of the calendar URL. The type can be custom or one of these predefined values: * `home` * `freeBusy` * `work`

3772

"url": "A String", # The calendar URL.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3773

},

3774

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3775

"clientData": [ # The person's client data.

3776

{ # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.

3777

"key": "A String", # The client specified key of the client data.

3778

"metadata": { # Metadata about a field. # Metadata about the client data.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3779

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3780

"source": { # The source of a field. # The source of the field.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3781

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

3782

"id": "A String", # The unique identifier within the source type generated by the server.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3783

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

3784

"objectType": "A String", # Output only. The profile object type.

3785

"userTypes": [ # Output only. The user types.

3786

"A String",

3787

],

3788

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3789

"type": "A String", # The source type.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3790

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3791

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3792

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3793

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3794

"value": "A String", # The client specified value of the client data.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

3795

},

3796

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3797

"coverPhotos": [ # Output only. The person's cover photos.

3798

{ # A person's cover photo. A large image shown on the person's profile page that represents who they are or what they care about.

3799

"default": True or False, # True if the cover photo is the default cover photo; false if the cover photo is a user-provided cover photo.

3800

"metadata": { # Metadata about a field. # Metadata about the cover photo.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3801

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

3802

"source": { # The source of a field. # The source of the field.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3803

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3804

"id": "A String", # The unique identifier within the source type generated by the server.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

3805

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

3806

"objectType": "A String", # Output only. The profile object type.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

3807

"userTypes": [ # Output only. The user types.

3808

"A String",

3809

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

3810

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3811

"type": "A String", # The source type.

3812

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

3813

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3814

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

3815

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

3816

"url": "A String", # The URL of the cover photo.

3817

},

3818

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3819

"emailAddresses": [ # The person's email addresses.

3820

{ # A person's email address.

3821

"displayName": "A String", # The display name of the email.

3822

"formattedType": "A String", # Output only. The type of the email address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

3823

"metadata": { # Metadata about a field. # Metadata about the email address.

3824

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

3825

"source": { # The source of a field. # The source of the field.

3826

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

3827

"id": "A String", # The unique identifier within the source type generated by the server.

3828

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

3829

"objectType": "A String", # Output only. The profile object type.

3830

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

3835

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

3836

},

3837

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

3838

},

3839

"type": "A String", # The type of the email address. The type can be custom or one of these predefined values: * `home` * `work` * `other`

3840

"value": "A String", # The email address.

3841

},

3842

],

3843

"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.

3844

"events": [ # The person's events.

3845

{ # An event related to the person.

3846

"date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The date of the event.

3847

"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

3848

"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

3849

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

3850

},

3851

"formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

3852

"metadata": { # Metadata about a field. # Metadata about the event.

3853

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

3854

"source": { # The source of a field. # The source of the field.

3855

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

3856

"id": "A String", # The unique identifier within the source type generated by the server.

3857

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

3858

"objectType": "A String", # Output only. The profile object type.

3859

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

3864

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

3865

},

3866

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

3867

},

3868

"type": "A String", # The type of the event. The type can be custom or one of these predefined values: * `anniversary` * `other`

3869

},

3870

],

3871

"externalIds": [ # The person's external IDs.

3872

{ # An identifier from an external entity related to the person.

3873

"formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

3874

"metadata": { # Metadata about a field. # Metadata about the external ID.

3875

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

3876

"source": { # The source of a field. # The source of the field.

3877

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

3878

"id": "A String", # The unique identifier within the source type generated by the server.

3879

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

3880

"objectType": "A String", # Output only. The profile object type.

3881

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

3886

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

3887

},

3888

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

3889

},

3890

"type": "A String", # The type of the external ID. The type can be custom or one of these predefined values: * `account` * `customer` * `loginId` * `network` * `organization`

3891

"value": "A String", # The value of the external ID.

3892

},

3893

],

3894

"fileAses": [ # The person's file-ases.

3895

{ # The name that should be used to sort the person in a list.

3896

"metadata": { # Metadata about a field. # Metadata about the file-as.

3897

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

3898

"source": { # The source of a field. # The source of the field.

3899

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

3900

"id": "A String", # The unique identifier within the source type generated by the server.

3901

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

3902

"objectType": "A String", # Output only. The profile object type.

3903

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

3908

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

3909

},

3910

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

3911

},

3912

"value": "A String", # The file-as value

3913

},

3914

],

3915

"genders": [ # The person's genders. This field is a singleton for contact sources.

3916

{ # A person's gender.

3917

"addressMeAs": "A String", # The type of pronouns that should be used to address the person. The value can be custom or one of these predefined values: * `male` * `female` * `other`

3918

"formattedValue": "A String", # Output only. The value of the gender translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. Unspecified or custom value are not localized.

3919

"metadata": { # Metadata about a field. # Metadata about the gender.

3920

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

3921

"source": { # The source of a field. # The source of the field.

3922

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

3923

"id": "A String", # The unique identifier within the source type generated by the server.

3924

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

3925

"objectType": "A String", # Output only. The profile object type.

3926

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

3931

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

3932

},

3933

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

3934

},

3935

"value": "A String", # The gender for the person. The gender can be custom or one of these predefined values: * `male` * `female` * `unspecified`

3936

},

3937

],

3938

"imClients": [ # The person's instant messaging clients.

3939

{ # A person's instant messaging client.

3940

"formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

3941

"formattedType": "A String", # Output only. The type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

3942

"metadata": { # Metadata about a field. # Metadata about the IM client.

3943

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

3944

"source": { # The source of a field. # The source of the field.

3945

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

3946

"id": "A String", # The unique identifier within the source type generated by the server.

3947

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

3948

"objectType": "A String", # Output only. The profile object type.

3949

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

3954

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

3955

},

3956

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

3957

},

3958

"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`

3959

"type": "A String", # The type of the IM client. The type can be custom or one of these predefined values: * `home` * `work` * `other`

3960

"username": "A String", # The user name used in the IM client.

3961

},

3962

],

3963

"interests": [ # The person's interests.

3964

{ # One of the person's interests.

3965

"metadata": { # Metadata about a field. # Metadata about the interest.

3966

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

3967

"source": { # The source of a field. # The source of the field.

3968

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

3969

"id": "A String", # The unique identifier within the source type generated by the server.

3970

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

3971

"objectType": "A String", # Output only. The profile object type.

3972

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

3977

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

3978

},

3979

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

3980

},

3981

"value": "A String", # The interest; for example, `stargazing`.

3982

},

3983

],

3984

"locales": [ # The person's locale preferences.

3985

{ # A person's locale preference.

3986

"metadata": { # Metadata about a field. # Metadata about the locale.

3987

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

3988

"source": { # The source of a field. # The source of the field.

3989

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

3990

"id": "A String", # The unique identifier within the source type generated by the server.

3991

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

3992

"objectType": "A String", # Output only. The profile object type.

3993

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

3998

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

3999

},

4000

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

4001

},

4002

"value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag representing the locale.

4003

},

4004

],

4005

"locations": [ # The person's locations.

4006

{ # A person's location.

4007

"buildingId": "A String", # The building identifier.

4008

"current": True or False, # Whether the location is the current location.

4009

"deskCode": "A String", # The individual desk location.

4010

"floor": "A String", # The floor name or number.

4011

"floorSection": "A String", # The floor section in `floor_name`.

4012

"metadata": { # Metadata about a field. # Metadata about the location.

4013

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

4014

"source": { # The source of a field. # The source of the field.

4015

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

4016

"id": "A String", # The unique identifier within the source type generated by the server.

4017

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

4018

"objectType": "A String", # Output only. The profile object type.

4019

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

4024

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

4025

},

4026

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

4027

},

4028

"type": "A String", # The type of the location. The type can be custom or one of these predefined values: * `desk` * `grewUp`

4029

"value": "A String", # The free-form value of the location.

4030

},

4031

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

4032

"memberships": [ # The person's group memberships.

4033

{ # A person's membership in a group. Only contact group memberships can be modified.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4034

"contactGroupMembership": { # A Google contact group membership. # The contact group membership.

4035

"contactGroupId": "A String", # Output only. The contact group ID for the contact group membership.

4036

"contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`. Only contact_group_resource_name can be used for modifying memberships. Any contact group membership can be removed, but only user group or "myContacts" or "starred" system groups memberships can be added. A contact must always have at least one contact group membership.

4037

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

4038

"domainMembership": { # A G Suite Domain membership. # Output only. The domain membership.

4039

"inViewerDomain": True or False, # True if the person is in the viewer's G Suite domain.

4040

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

4041

"metadata": { # Metadata about a field. # Metadata about the membership.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4042

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

4043

"source": { # The source of a field. # The source of the field.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4044

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

4045

"id": "A String", # The unique identifier within the source type generated by the server.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

4046

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4047

"objectType": "A String", # Output only. The profile object type.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

4048

"userTypes": [ # Output only. The user types.

4049

"A String",

4050

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

4051

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

4052

"type": "A String", # The source type.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4053

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4054

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4055

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4056

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4057

},

4058

],

4059

"metadata": { # The metadata about a person. # Output only. Metadata about the person.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4060

"deleted": True or False, # Output only. True if the person resource has been deleted. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token.

4061

"linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.

4062

"A String",

4063

],

4064

"objectType": "A String", # Output only. **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4065

"previousResourceNames": [ # Output only. Any former resource names this person has had. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token. The resource name may change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or profile URL.

4066

"A String",

4067

],

4068

"sources": [ # The sources of data for the person.

4069

{ # The source of a field.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4070

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

4071

"id": "A String", # The unique identifier within the source type generated by the server.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4072

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

4073

"objectType": "A String", # Output only. The profile object type.

4074

"userTypes": [ # Output only. The user types.

4075

"A String",

4076

],

4077

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4078

"type": "A String", # The source type.

4079

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4080

},

4081

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4082

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4083

"miscKeywords": [ # The person's miscellaneous keywords.

4084

{ # A person's miscellaneous keyword.

4085

"formattedType": "A String", # Output only. The type of the miscellaneous keyword translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

4086

"metadata": { # Metadata about a field. # Metadata about the miscellaneous keyword.

4087

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

4088

"source": { # The source of a field. # The source of the field.

4089

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

4090

"id": "A String", # The unique identifier within the source type generated by the server.

4091

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

4092

"objectType": "A String", # Output only. The profile object type.

4093

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

4098

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

4099

},

4100

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

4101

},

4102

"type": "A String", # The miscellaneous keyword type.

4103

"value": "A String", # The value of the miscellaneous keyword.

4104

},

4105

],

4106

"names": [ # The person's names. This field is a singleton for contact sources.

4107

{ # A person's name. If the name is a mononym, the family name is empty.

4108

"displayName": "A String", # Output only. The display name formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.

4109

"displayNameLastFirst": "A String", # Output only. The display name with the last name first formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.

4110

"familyName": "A String", # The family name.

4111

"givenName": "A String", # The given name.

4112

"honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`

4113

"honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`

4114

"metadata": { # Metadata about a field. # Metadata about the name.

4115

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

4116

"source": { # The source of a field. # The source of the field.

4117

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

4118

"id": "A String", # The unique identifier within the source type generated by the server.

4119

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

4120

"objectType": "A String", # Output only. The profile object type.

4121

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

4126

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

4127

},

4128

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

4129

},

4130

"middleName": "A String", # The middle name(s).

4131

"phoneticFamilyName": "A String", # The family name spelled as it sounds.

4132

"phoneticFullName": "A String", # The full name spelled as it sounds.

4133

"phoneticGivenName": "A String", # The given name spelled as it sounds.

4134

"phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.

4135

"phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.

4136

"phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.

4137

"unstructuredName": "A String", # The free form name value.

4138

},

4139

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4140

"nicknames": [ # The person's nicknames.

4141

{ # A person's nickname.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4142

"metadata": { # Metadata about a field. # Metadata about the nickname.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4143

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

4144

"source": { # The source of a field. # The source of the field.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4145

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

4146

"id": "A String", # The unique identifier within the source type generated by the server.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4147

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

4148

"objectType": "A String", # Output only. The profile object type.

4149

"userTypes": [ # Output only. The user types.

4150

"A String",

4151

],

4152

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4153

"type": "A String", # The source type.

4154

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4155

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4156

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4157

},

4158

"type": "A String", # The type of the nickname.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4159

"value": "A String", # The nickname.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4160

},

4161

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4162

"occupations": [ # The person's occupations.

4163

{ # A person's occupation.

4164

"metadata": { # Metadata about a field. # Metadata about the occupation.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4165

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

4166

"source": { # The source of a field. # The source of the field.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4167

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

4168

"id": "A String", # The unique identifier within the source type generated by the server.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4169

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

4170

"objectType": "A String", # Output only. The profile object type.

4171

"userTypes": [ # Output only. The user types.

4172

"A String",

4173

],

4174

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4175

"type": "A String", # The source type.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4176

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4177

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4178

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4179

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4180

"value": "A String", # The occupation; for example, `carpenter`.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4181

},

4182

],

4183

"organizations": [ # The person's past or current organizations.

4184

{ # A person's past or current organization. Overlapping date ranges are permitted.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4185

"current": True or False, # True if the organization is the person's current organization; false if the organization is a past organization.

4186

"department": "A String", # The person's department at the organization.

4187

"domain": "A String", # The domain name associated with the organization; for example, `google.com`.

4188

"endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The end date when the person left the organization.

4189

"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

4190

"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

4191

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

4192

},

4193

"formattedType": "A String", # Output only. The type of the organization translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

4194

"jobDescription": "A String", # The person's job description at the organization.

4195

"location": "A String", # The location of the organization office the person works at.

4196

"metadata": { # Metadata about a field. # Metadata about the organization.

4197

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

4198

"source": { # The source of a field. # The source of the field.

4199

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

4200

"id": "A String", # The unique identifier within the source type generated by the server.

4201

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

4202

"objectType": "A String", # Output only. The profile object type.

4203

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

4208

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

4209

},

4210

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

4211

},

4212

"name": "A String", # The name of the organization.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4213

"phoneticName": "A String", # The phonetic name of the organization.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4214

"startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The start date when the person joined the organization.

4215

"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

4216

"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

4217

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

4218

},

4219

"symbol": "A String", # The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4220

"title": "A String", # The person's job title at the organization.

4221

"type": "A String", # The type of the organization. The type can be custom or one of these predefined values: * `work` * `school`

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4222

},

4223

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4224

"phoneNumbers": [ # The person's phone numbers.

4225

{ # A person's phone number.

4226

"canonicalForm": "A String", # Output only. The canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number.

4227

"formattedType": "A String", # Output only. The type of the phone number translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

4228

"metadata": { # Metadata about a field. # Metadata about the phone number.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4229

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

4230

"source": { # The source of a field. # The source of the field.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4231

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

4232

"id": "A String", # The unique identifier within the source type generated by the server.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4233

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

4234

"objectType": "A String", # Output only. The profile object type.

4235

"userTypes": [ # Output only. The user types.

4236

"A String",

4237

],

4238

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4239

"type": "A String", # The source type.

4240

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4241

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4242

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4243

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4244

"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`

4245

"value": "A String", # The phone number.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4246

},

4247

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4248

"photos": [ # Output only. The person's photos.

4249

{ # A person's photo. A picture shown next to the person's name to help others recognize the person.

4250

"default": True or False, # True if the photo is a default photo; false if the photo is a user-provided photo.

4251

"metadata": { # Metadata about a field. # Metadata about the photo.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4252

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

4253

"source": { # The source of a field. # The source of the field.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4254

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

4255

"id": "A String", # The unique identifier within the source type generated by the server.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4256

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

4257

"objectType": "A String", # Output only. The profile object type.

4258

"userTypes": [ # Output only. The user types.

4259

"A String",

4260

],

4261

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4262

"type": "A String", # The source type.

4263

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4264

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4265

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4266

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4267

"url": "A String", # The URL of the photo. You can change the desired size by appending a query parameter `sz={size}` at the end of the url, where {size} is the size in pixels. Example: https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50

4268

},

4269

],

4270

"relations": [ # The person's relations.

4271

{ # A person's relation to another person.

4272

"formattedType": "A String", # Output only. The type of the relation translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.

4273

"metadata": { # Metadata about a field. # Metadata about the relation.

4274

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

4275

"source": { # The source of a field. # The source of the field.

4276

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

4277

"id": "A String", # The unique identifier within the source type generated by the server.

4278

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

4279

"objectType": "A String", # Output only. The profile object type.

4280

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

4285

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

4286

},

4287

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

4288

},

4289

"person": "A String", # The name of the other person this relation refers to.

4290

"type": "A String", # The person's relation to the other person. The type can be custom or one of these predefined values: * `spouse` * `child` * `mother` * `father` * `parent` * `brother` * `sister` * `friend` * `relative` * `domesticPartner` * `manager` * `assistant` * `referredBy` * `partner`

4291

},

4292

],

4293

"relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship interests.

4294

{ # **DEPRECATED**: No data will be returned A person's relationship interest .

4295

"formattedValue": "A String", # Output only. The value of the relationship interest translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.

4296

"metadata": { # Metadata about a field. # Metadata about the relationship interest.

4297

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

4298

"source": { # The source of a field. # The source of the field.

4299

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

4300

"id": "A String", # The unique identifier within the source type generated by the server.

4301

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

4302

"objectType": "A String", # Output only. The profile object type.

4303

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

4308

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

4309

},

4310

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

4311

},

4312

"value": "A String", # The kind of relationship the person is looking for. The value can be custom or one of these predefined values: * `friend` * `date` * `relationship` * `networking`

4313

},

4314

],

4315

"relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship statuses.

4316

{ # **DEPRECATED**: No data will be returned A person's relationship status.

4317

"formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

4318

"metadata": { # Metadata about a field. # Metadata about the relationship status.

4319

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

4320

"source": { # The source of a field. # The source of the field.

4321

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

4322

"id": "A String", # The unique identifier within the source type generated by the server.

4323

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

4324

"objectType": "A String", # Output only. The profile object type.

4325

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

4330

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

4331

},

4332

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

4333

},

4334

"value": "A String", # The relationship status. The value can be custom or one of these predefined values: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion`

4335

},

4336

],

4337

"residences": [ # **DEPRECATED**: (Please use `person.locations` instead) The person's residences.

4338

{ # **DEPRECATED**: Please use `person.locations` instead. A person's past or current residence.

4339

"current": True or False, # True if the residence is the person's current residence; false if the residence is a past residence.

4340

"metadata": { # Metadata about a field. # Metadata about the residence.

4341

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

4342

"source": { # The source of a field. # The source of the field.

4343

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

4344

"id": "A String", # The unique identifier within the source type generated by the server.

4345

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

4346

"objectType": "A String", # Output only. The profile object type.

4347

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

4352

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

4353

},

4354

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

4355

},

4356

"value": "A String", # The address of the residence.

4357

},

4358

],

4359

"resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters, in the form of `people/{person_id}`.

4360

"sipAddresses": [ # The person's SIP addresses.

4361

{ # A person's SIP address. Session Initial Protocol addresses are used for VoIP communications to make voice or video calls over the internet.

4362

"formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

4363

"metadata": { # Metadata about a field. # Metadata about the SIP address.

4364

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

4365

"source": { # The source of a field. # The source of the field.

4366

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

4367

"id": "A String", # The unique identifier within the source type generated by the server.

4368

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

4369

"objectType": "A String", # Output only. The profile object type.

4370

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

4375

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

4376

},

4377

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

4378

},

4379

"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`

4380

"value": "A String", # The SIP address in the [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI format.

4381

},

4382

],

4383

"skills": [ # The person's skills.

4384

{ # A skill that the person has.

4385

"metadata": { # Metadata about a field. # Metadata about the skill.

4386

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

4387

"source": { # The source of a field. # The source of the field.

4388

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

4389

"id": "A String", # The unique identifier within the source type generated by the server.

4390

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

4391

"objectType": "A String", # Output only. The profile object type.

4392

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

4397

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

4398

},

4399

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

4400

},

4401

"value": "A String", # The skill; for example, `underwater basket weaving`.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4402

},

4403

],

4404

"taglines": [ # Output only. **DEPRECATED**: No data will be returned The person's taglines.

4405

{ # **DEPRECATED**: No data will be returned A brief one-line description of the person.

4406

"metadata": { # Metadata about a field. # Metadata about the tagline.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4407

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

4408

"source": { # The source of a field. # The source of the field.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4409

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

4410

"id": "A String", # The unique identifier within the source type generated by the server.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4411

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

4412

"objectType": "A String", # Output only. The profile object type.

4413

"userTypes": [ # Output only. The user types.

4414

"A String",

4415

],

4416

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4417

"type": "A String", # The source type.

4418

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4419

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4420

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4421

},

4422

"value": "A String", # The tagline.

4423

},

4424

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4425

"urls": [ # The person's associated URLs.

4426

{ # A person's associated URLs.

4427

"formattedType": "A String", # Output only. The type of the URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

4428

"metadata": { # Metadata about a field. # Metadata about the URL.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4429

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

4430

"source": { # The source of a field. # The source of the field.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4431

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

4432

"id": "A String", # The unique identifier within the source type generated by the server.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4433

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

4434

"objectType": "A String", # Output only. The profile object type.

4435

"userTypes": [ # Output only. The user types.

4436

"A String",

4437

],

4438

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4439

"type": "A String", # The source type.

4440

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4441

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4442

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4443

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4444

"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 Currents application. * `other`

4445

"value": "A String", # The URL.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4446

},

4447

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4448

"userDefined": [ # The person's user defined data.

4449

{ # Arbitrary user data that is populated by the end users.

4450

"key": "A String", # The end user specified key of the user defined data.

4451

"metadata": { # Metadata about a field. # Metadata about the user defined data.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4452

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

4453

"source": { # The source of a field. # The source of the field.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4454

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

4455

"id": "A String", # The unique identifier within the source type generated by the server.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4456

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

4457

"objectType": "A String", # Output only. The profile object type.

4458

"userTypes": [ # Output only. The user types.

4459

"A String",

4460

],

4461

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4462

"type": "A String", # The source type.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4463

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4464

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4465

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4466

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4467

"value": "A String", # The end user specified value of the user defined data.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

4468

},

4469

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4470

}

4471

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4472

personFields: string, Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Defaults to all fields if not set. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

4473

sources: string, Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set. (repeated)

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4474

Allowed values

4475

READ_SOURCE_TYPE_UNSPECIFIED - Unspecified.

4476

READ_SOURCE_TYPE_PROFILE - Returns SourceType.ACCOUNT, SourceType.DOMAIN_PROFILE, and SourceType.PROFILE.

4477

READ_SOURCE_TYPE_CONTACT - Returns SourceType.CONTACT.

4478

READ_SOURCE_TYPE_DOMAIN_CONTACT - Returns SourceType.DOMAIN_CONTACT.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

4479

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

4486

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4487

{ # Information about a person merged from various data sources such as the authenticated user's contacts and profile data. Most fields can have multiple items. The items in a field have no guaranteed order, but each non-empty field is guaranteed to have exactly one field with `metadata.primary` set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4488

"addresses": [ # The person's street addresses.

4489

{ # A person's physical address. May be a P.O. box or street address. All fields are optional.

4490

"city": "A String", # The city of the address.

4491

"country": "A String", # The country of the address.

4492

"countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address.

4493

"extendedAddress": "A String", # The extended address of the address; for example, the apartment number.

4494

"formattedType": "A String", # Output only. The type of the address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

4495

"formattedValue": "A String", # The unstructured value of the address. If this is not set by the user it will be automatically constructed from structured values.

4496

"metadata": { # Metadata about a field. # Metadata about the address.

4497

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

4498

"source": { # The source of a field. # The source of the field.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4499

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

4500

"id": "A String", # The unique identifier within the source type generated by the server.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4501

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

4502

"objectType": "A String", # Output only. The profile object type.

4503

"userTypes": [ # Output only. The user types.

4504

"A String",

4505

],

4506

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4507

"type": "A String", # The source type.

4508

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4509

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4510

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

4511

},

4512

"poBox": "A String", # The P.O. box of the address.

4513

"postalCode": "A String", # The postal code of the address.

4514

"region": "A String", # The region of the address; for example, the state or province.

4515

"streetAddress": "A String", # The street address.

4516

"type": "A String", # The type of the address. The type can be custom or one of these predefined values: * `home` * `work` * `other`

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4517

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4518

],

4519

"ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead) The person's age range.

4520

"ageRanges": [ # Output only. The person's age ranges.

4521

{ # A person's age range.

4522

"ageRange": "A String", # The age range.

4523

"metadata": { # Metadata about a field. # Metadata about the age range.

4524

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

4525

"source": { # The source of a field. # The source of the field.

4526

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

4527

"id": "A String", # The unique identifier within the source type generated by the server.

4528

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

4529

"objectType": "A String", # Output only. The profile object type.

4530

"userTypes": [ # Output only. The user types.

4531

"A String",

4532

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4533

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4534

"type": "A String", # The source type.

4535

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4536

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4537

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

},

},

],

"biographies": [ # The person's biographies. This field is a singleton for contact sources.

4542

{ # A person's short biography.

4543

"contentType": "A String", # The content type of the biography.

4544

"metadata": { # Metadata about a field. # Metadata about the biography.

4545

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

4546

"source": { # The source of a field. # The source of the field.

4547

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

4548

"id": "A String", # The unique identifier within the source type generated by the server.

4549

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

4550

"objectType": "A String", # Output only. The profile object type.

4551

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

4556

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

4557

},

4558

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

4559

},

4560

"value": "A String", # The short biography.

4561

},

4562

],

4563

"birthdays": [ # The person's birthdays. This field is a singleton for contact sources.

4564

{ # A person's birthday. At least one of the `date` and `text` fields are specified. The `date` and `text` fields typically represent the same date, but are not guaranteed to.

4565

"date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The date of the birthday.

4566

"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

4567

"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

4568

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

4569

},

4570

"metadata": { # Metadata about a field. # Metadata about the birthday.

4571

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

4572

"source": { # The source of a field. # The source of the field.

4573

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

4574

"id": "A String", # The unique identifier within the source type generated by the server.

4575

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

4576

"objectType": "A String", # Output only. The profile object type.

4577

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

4582

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

4583

},

4584

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

4585

},

4586

"text": "A String", # A free-form string representing the user's birthday.

4587

},

4588

],

4589

"braggingRights": [ # **DEPRECATED**: No data will be returned The person's bragging rights.

4590

{ # **DEPRECATED**: No data will be returned A person's bragging rights.

4591

"metadata": { # Metadata about a field. # Metadata about the bragging rights.

4592

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

4593

"source": { # The source of a field. # The source of the field.

4594

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

4595

"id": "A String", # The unique identifier within the source type generated by the server.

4596

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

4597

"objectType": "A String", # Output only. The profile object type.

4598

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

4603

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

4604

},

4605

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

4606

},

4607

"value": "A String", # The bragging rights; for example, `climbed mount everest`.

4608

},

4609

],

4610

"calendarUrls": [ # The person's calendar URLs.

4611

{ # A person's calendar URL.

4612

"formattedType": "A String", # Output only. The type of the calendar URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

4613

"metadata": { # Metadata about a field. # Metadata about the calendar URL.

4614

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

4615

"source": { # The source of a field. # The source of the field.

4616

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

4617

"id": "A String", # The unique identifier within the source type generated by the server.

4618

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

4619

"objectType": "A String", # Output only. The profile object type.

4620

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

4625

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

4626

},

4627

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

4628

},

4629

"type": "A String", # The type of the calendar URL. The type can be custom or one of these predefined values: * `home` * `freeBusy` * `work`

4630

"url": "A String", # The calendar URL.

4631

},

4632

],

4633

"clientData": [ # The person's client data.

4634

{ # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.

4635

"key": "A String", # The client specified key of the client data.

4636

"metadata": { # Metadata about a field. # Metadata about the client data.

4637

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

4638

"source": { # The source of a field. # The source of the field.

4639

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

4640

"id": "A String", # The unique identifier within the source type generated by the server.

4641

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

4642

"objectType": "A String", # Output only. The profile object type.

4643

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

4648

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

4649

},

4650

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

4651

},

4652

"value": "A String", # The client specified value of the client data.

4653

},

4654

],

4655

"coverPhotos": [ # Output only. The person's cover photos.

4656

{ # A person's cover photo. A large image shown on the person's profile page that represents who they are or what they care about.

4657

"default": True or False, # True if the cover photo is the default cover photo; false if the cover photo is a user-provided cover photo.

4658

"metadata": { # Metadata about a field. # Metadata about the cover photo.

4659

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

4660

"source": { # The source of a field. # The source of the field.

4661

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

4662

"id": "A String", # The unique identifier within the source type generated by the server.

4663

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

4664

"objectType": "A String", # Output only. The profile object type.

4665

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

4670

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

4671

},

4672

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

4673

},

4674

"url": "A String", # The URL of the cover photo.

4675

},

4676

],

4677

"emailAddresses": [ # The person's email addresses.

4678

{ # A person's email address.

4679

"displayName": "A String", # The display name of the email.

4680

"formattedType": "A String", # Output only. The type of the email address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

4681

"metadata": { # Metadata about a field. # Metadata about the email address.

4682

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

4683

"source": { # The source of a field. # The source of the field.

4684

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

4685

"id": "A String", # The unique identifier within the source type generated by the server.

4686

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

4687

"objectType": "A String", # Output only. The profile object type.

4688

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

4693

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

4694

},

4695

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

4696

},

4697

"type": "A String", # The type of the email address. The type can be custom or one of these predefined values: * `home` * `work` * `other`

4698

"value": "A String", # The email address.

4699

},

4700

],

4701

"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.

4702

"events": [ # The person's events.

4703

{ # An event related to the person.

4704

"date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The date of the event.

4705

"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

4706

"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

4707

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

4708

},

4709

"formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

4710

"metadata": { # Metadata about a field. # Metadata about the event.

4711

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

4712

"source": { # The source of a field. # The source of the field.

4713

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

4714

"id": "A String", # The unique identifier within the source type generated by the server.

4715

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

4716

"objectType": "A String", # Output only. The profile object type.

4717

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

4722

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

4723

},

4724

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

4725

},

4726

"type": "A String", # The type of the event. The type can be custom or one of these predefined values: * `anniversary` * `other`

4727

},

4728

],

4729

"externalIds": [ # The person's external IDs.

4730

{ # An identifier from an external entity related to the person.

4731

"formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

4732

"metadata": { # Metadata about a field. # Metadata about the external ID.

4733

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

4734

"source": { # The source of a field. # The source of the field.

4735

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

4736

"id": "A String", # The unique identifier within the source type generated by the server.

4737

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

4738

"objectType": "A String", # Output only. The profile object type.

4739

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

4744

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

4745

},

4746

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

4747

},

4748

"type": "A String", # The type of the external ID. The type can be custom or one of these predefined values: * `account` * `customer` * `loginId` * `network` * `organization`

4749

"value": "A String", # The value of the external ID.

4750

},

4751

],

4752

"fileAses": [ # The person's file-ases.

4753

{ # The name that should be used to sort the person in a list.

4754

"metadata": { # Metadata about a field. # Metadata about the file-as.

4755

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

4756

"source": { # The source of a field. # The source of the field.

4757

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

4758

"id": "A String", # The unique identifier within the source type generated by the server.

4759

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

4760

"objectType": "A String", # Output only. The profile object type.

4761

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

4766

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

4767

},

4768

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

4769

},

4770

"value": "A String", # The file-as value

4771

},

4772

],

4773

"genders": [ # The person's genders. This field is a singleton for contact sources.

4774

{ # A person's gender.

4775

"addressMeAs": "A String", # The type of pronouns that should be used to address the person. The value can be custom or one of these predefined values: * `male` * `female` * `other`

4776

"formattedValue": "A String", # Output only. The value of the gender translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. Unspecified or custom value are not localized.

4777

"metadata": { # Metadata about a field. # Metadata about the gender.

4778

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

4779

"source": { # The source of a field. # The source of the field.

4780

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

4781

"id": "A String", # The unique identifier within the source type generated by the server.

4782

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

4783

"objectType": "A String", # Output only. The profile object type.

4784

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

4789

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

4790

},

4791

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

4792

},

4793

"value": "A String", # The gender for the person. The gender can be custom or one of these predefined values: * `male` * `female` * `unspecified`

4794

},

4795

],

4796

"imClients": [ # The person's instant messaging clients.

4797

{ # A person's instant messaging client.

4798

"formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

4799

"formattedType": "A String", # Output only. The type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

4800

"metadata": { # Metadata about a field. # Metadata about the IM client.

4801

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

4802

"source": { # The source of a field. # The source of the field.

4803

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

4804

"id": "A String", # The unique identifier within the source type generated by the server.

4805

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

4806

"objectType": "A String", # Output only. The profile object type.

4807

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

4812

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

4813

},

4814

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

4815

},

4816

"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`

4817

"type": "A String", # The type of the IM client. The type can be custom or one of these predefined values: * `home` * `work` * `other`

4818

"username": "A String", # The user name used in the IM client.

4819

},

4820

],

4821

"interests": [ # The person's interests.

4822

{ # One of the person's interests.

4823

"metadata": { # Metadata about a field. # Metadata about the interest.

4824

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

4825

"source": { # The source of a field. # The source of the field.

4826

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

4827

"id": "A String", # The unique identifier within the source type generated by the server.

4828

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

4829

"objectType": "A String", # Output only. The profile object type.

4830

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

4835

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

4836

},

4837

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

4838

},

4839

"value": "A String", # The interest; for example, `stargazing`.

4840

},

4841

],

4842

"locales": [ # The person's locale preferences.

4843

{ # A person's locale preference.

4844

"metadata": { # Metadata about a field. # Metadata about the locale.

4845

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

4846

"source": { # The source of a field. # The source of the field.

4847

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

4848

"id": "A String", # The unique identifier within the source type generated by the server.

4849

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

4850

"objectType": "A String", # Output only. The profile object type.

4851

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

4856

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

4857

},

4858

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

4859

},

4860

"value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag representing the locale.

4861

},

4862

],

4863

"locations": [ # The person's locations.

4864

{ # A person's location.

4865

"buildingId": "A String", # The building identifier.

4866

"current": True or False, # Whether the location is the current location.

4867

"deskCode": "A String", # The individual desk location.

4868

"floor": "A String", # The floor name or number.

4869

"floorSection": "A String", # The floor section in `floor_name`.

4870

"metadata": { # Metadata about a field. # Metadata about the location.

4871

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

4872

"source": { # The source of a field. # The source of the field.

4873

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

4874

"id": "A String", # The unique identifier within the source type generated by the server.

4875

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

4876

"objectType": "A String", # Output only. The profile object type.

4877

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

4882

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

4883

},

4884

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

4885

},

4886

"type": "A String", # The type of the location. The type can be custom or one of these predefined values: * `desk` * `grewUp`

4887

"value": "A String", # The free-form value of the location.

4888

},

4889

],

4890

"memberships": [ # The person's group memberships.

4891

{ # A person's membership in a group. Only contact group memberships can be modified.

4892

"contactGroupMembership": { # A Google contact group membership. # The contact group membership.

4893

"contactGroupId": "A String", # Output only. The contact group ID for the contact group membership.

4894

"contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`. Only contact_group_resource_name can be used for modifying memberships. Any contact group membership can be removed, but only user group or "myContacts" or "starred" system groups memberships can be added. A contact must always have at least one contact group membership.

4895

},

4896

"domainMembership": { # A G Suite Domain membership. # Output only. The domain membership.

4897

"inViewerDomain": True or False, # True if the person is in the viewer's G Suite domain.

4898

},

4899

"metadata": { # Metadata about a field. # Metadata about the membership.

4900

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

4901

"source": { # The source of a field. # The source of the field.

4902

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

4903

"id": "A String", # The unique identifier within the source type generated by the server.

4904

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

4905

"objectType": "A String", # Output only. The profile object type.

4906

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

4911

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

4912

},

4913

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

},

},

],

"metadata": { # The metadata about a person. # Output only. Metadata about the person.

4918

"deleted": True or False, # Output only. True if the person resource has been deleted. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token.

4919

"linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.

4920

"A String",

4921

],

4922

"objectType": "A String", # Output only. **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object.

4923

"previousResourceNames": [ # Output only. Any former resource names this person has had. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token. The resource name may change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or profile URL.

4924

"A String",

4925

],

4926

"sources": [ # The sources of data for the person.

4927

{ # The source of a field.

4928

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

4929

"id": "A String", # The unique identifier within the source type generated by the server.

4930

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

4931

"objectType": "A String", # Output only. The profile object type.

4932

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

4937

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4938

},

4939

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4940

},

4941

"miscKeywords": [ # The person's miscellaneous keywords.

4942

{ # A person's miscellaneous keyword.

4943

"formattedType": "A String", # Output only. The type of the miscellaneous keyword translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

4944

"metadata": { # Metadata about a field. # Metadata about the miscellaneous keyword.

4945

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

4946

"source": { # The source of a field. # The source of the field.

4947

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

4948

"id": "A String", # The unique identifier within the source type generated by the server.

4949

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

4950

"objectType": "A String", # Output only. The profile object type.

4951

"userTypes": [ # Output only. The user types.

4952

"A String",

4953

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4954

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4955

"type": "A String", # The source type.

4956

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4957

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4958

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4959

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4960

"type": "A String", # The miscellaneous keyword type.

4961

"value": "A String", # The value of the miscellaneous keyword.

4962

},

4963

],

4964

"names": [ # The person's names. This field is a singleton for contact sources.

4965

{ # A person's name. If the name is a mononym, the family name is empty.

4966

"displayName": "A String", # Output only. The display name formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.

4967

"displayNameLastFirst": "A String", # Output only. The display name with the last name first formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.

4968

"familyName": "A String", # The family name.

4969

"givenName": "A String", # The given name.

4970

"honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`

4971

"honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`

4972

"metadata": { # Metadata about a field. # Metadata about the name.

4973

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

4974

"source": { # The source of a field. # The source of the field.

4975

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

4976

"id": "A String", # The unique identifier within the source type generated by the server.

4977

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

4978

"objectType": "A String", # Output only. The profile object type.

4979

"userTypes": [ # Output only. The user types.

4980

"A String",

4981

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4982

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4983

"type": "A String", # The source type.

4984

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4985

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4986

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

4987

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4988

"middleName": "A String", # The middle name(s).

4989

"phoneticFamilyName": "A String", # The family name spelled as it sounds.

4990

"phoneticFullName": "A String", # The full name spelled as it sounds.

4991

"phoneticGivenName": "A String", # The given name spelled as it sounds.

4992

"phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.

4993

"phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.

4994

"phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.

4995

"unstructuredName": "A String", # The free form name value.

4996

},

4997

],

4998

"nicknames": [ # The person's nicknames.

4999

{ # A person's nickname.

5000

"metadata": { # Metadata about a field. # Metadata about the nickname.

5001

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

5002

"source": { # The source of a field. # The source of the field.

5003

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

5004

"id": "A String", # The unique identifier within the source type generated by the server.

5005

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

5006

"objectType": "A String", # Output only. The profile object type.

5007

"userTypes": [ # Output only. The user types.

5008

"A String",

5009

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5010

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5011

"type": "A String", # The source type.

5012

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5013

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5014

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5015

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5016

"type": "A String", # The type of the nickname.

5017

"value": "A String", # The nickname.

5018

},

5019

],

5020

"occupations": [ # The person's occupations.

5021

{ # A person's occupation.

5022

"metadata": { # Metadata about a field. # Metadata about the occupation.

5023

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

5024

"source": { # The source of a field. # The source of the field.

5025

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

5026

"id": "A String", # The unique identifier within the source type generated by the server.

5027

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

5028

"objectType": "A String", # Output only. The profile object type.

5029

"userTypes": [ # Output only. The user types.

5030

"A String",

5031

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5032

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5033

"type": "A String", # The source type.

5034

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5035

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5036

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5037

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5038

"value": "A String", # The occupation; for example, `carpenter`.

5039

},

5040

],

5041

"organizations": [ # The person's past or current organizations.

5042

{ # A person's past or current organization. Overlapping date ranges are permitted.

5043

"current": True or False, # True if the organization is the person's current organization; false if the organization is a past organization.

5044

"department": "A String", # The person's department at the organization.

5045

"domain": "A String", # The domain name associated with the organization; for example, `google.com`.

5046

"endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The end date when the person left the organization.

5047

"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

5048

"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

5049

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

5050

},

5051

"formattedType": "A String", # Output only. The type of the organization translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

5052

"jobDescription": "A String", # The person's job description at the organization.

5053

"location": "A String", # The location of the organization office the person works at.

5054

"metadata": { # Metadata about a field. # Metadata about the organization.

5055

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

5056

"source": { # The source of a field. # The source of the field.

5057

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

5058

"id": "A String", # The unique identifier within the source type generated by the server.

5059

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

5060

"objectType": "A String", # Output only. The profile object type.

5061

"userTypes": [ # Output only. The user types.

5062

"A String",

5063

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5064

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5065

"type": "A String", # The source type.

5066

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5067

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5068

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5069

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5070

"name": "A String", # The name of the organization.

5071

"phoneticName": "A String", # The phonetic name of the organization.

5072

"startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The start date when the person joined the organization.

5073

"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

5074

"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

5075

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

5076

},

5077

"symbol": "A String", # The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym.

5078

"title": "A String", # The person's job title at the organization.

5079

"type": "A String", # The type of the organization. The type can be custom or one of these predefined values: * `work` * `school`

5080

},

5081

],

5082

"phoneNumbers": [ # The person's phone numbers.

5083

{ # A person's phone number.

5084

"canonicalForm": "A String", # Output only. The canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number.

5085

"formattedType": "A String", # Output only. The type of the phone number translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

5086

"metadata": { # Metadata about a field. # Metadata about the phone number.

5087

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

5088

"source": { # The source of a field. # The source of the field.

5089

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

5090

"id": "A String", # The unique identifier within the source type generated by the server.

5091

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

5092

"objectType": "A String", # Output only. The profile object type.

5093

"userTypes": [ # Output only. The user types.

5094

"A String",

5095

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5096

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5097

"type": "A String", # The source type.

5098

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5099

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5100

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5101

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5102

"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`

5103

"value": "A String", # The phone number.

5104

},

5105

],

5106

"photos": [ # Output only. The person's photos.

5107

{ # A person's photo. A picture shown next to the person's name to help others recognize the person.

5108

"default": True or False, # True if the photo is a default photo; false if the photo is a user-provided photo.

5109

"metadata": { # Metadata about a field. # Metadata about the photo.

5110

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

5111

"source": { # The source of a field. # The source of the field.

5112

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

5113

"id": "A String", # The unique identifier within the source type generated by the server.

5114

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

5115

"objectType": "A String", # Output only. The profile object type.

5116

"userTypes": [ # Output only. The user types.

5117

"A String",

5118

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5119

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5120

"type": "A String", # The source type.

5121

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5122

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5123

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5124

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5125

"url": "A String", # The URL of the photo. You can change the desired size by appending a query parameter `sz={size}` at the end of the url, where {size} is the size in pixels. Example: https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50

5126

},

5127

],

5128

"relations": [ # The person's relations.

5129

{ # A person's relation to another person.

5130

"formattedType": "A String", # Output only. The type of the relation translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.

5131

"metadata": { # Metadata about a field. # Metadata about the relation.

5132

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

5133

"source": { # The source of a field. # The source of the field.

5134

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

5135

"id": "A String", # The unique identifier within the source type generated by the server.

5136

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

5137

"objectType": "A String", # Output only. The profile object type.

5138

"userTypes": [ # Output only. The user types.

5139

"A String",

5140

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5141

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5142

"type": "A String", # The source type.

5143

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5144

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5145

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5146

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5147

"person": "A String", # The name of the other person this relation refers to.

5148

"type": "A String", # The person's relation to the other person. The type can be custom or one of these predefined values: * `spouse` * `child` * `mother` * `father` * `parent` * `brother` * `sister` * `friend` * `relative` * `domesticPartner` * `manager` * `assistant` * `referredBy` * `partner`

5149

},

5150

],

5151

"relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship interests.

5152

{ # **DEPRECATED**: No data will be returned A person's relationship interest .

5153

"formattedValue": "A String", # Output only. The value of the relationship interest translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.

5154

"metadata": { # Metadata about a field. # Metadata about the relationship interest.

5155

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

5156

"source": { # The source of a field. # The source of the field.

5157

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

5158

"id": "A String", # The unique identifier within the source type generated by the server.

5159

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

5160

"objectType": "A String", # Output only. The profile object type.

5161

"userTypes": [ # Output only. The user types.

5162

"A String",

5163

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5164

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5165

"type": "A String", # The source type.

5166

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5167

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5168

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5169

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5170

"value": "A String", # The kind of relationship the person is looking for. The value can be custom or one of these predefined values: * `friend` * `date` * `relationship` * `networking`

5171

},

5172

],

5173

"relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship statuses.

5174

{ # **DEPRECATED**: No data will be returned A person's relationship status.

5175

"formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

5176

"metadata": { # Metadata about a field. # Metadata about the relationship status.

5177

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

5178

"source": { # The source of a field. # The source of the field.

5179

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

5180

"id": "A String", # The unique identifier within the source type generated by the server.

5181

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

5182

"objectType": "A String", # Output only. The profile object type.

5183

"userTypes": [ # Output only. The user types.

5184

"A String",

5185

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5186

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5187

"type": "A String", # The source type.

5188

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5189

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5190

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5191

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5192

"value": "A String", # The relationship status. The value can be custom or one of these predefined values: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion`

5193

},

5194

],

5195

"residences": [ # **DEPRECATED**: (Please use `person.locations` instead) The person's residences.

5196

{ # **DEPRECATED**: Please use `person.locations` instead. A person's past or current residence.

5197

"current": True or False, # True if the residence is the person's current residence; false if the residence is a past residence.

5198

"metadata": { # Metadata about a field. # Metadata about the residence.

5199

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

5200

"source": { # The source of a field. # The source of the field.

5201

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

5202

"id": "A String", # The unique identifier within the source type generated by the server.

5203

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

5204

"objectType": "A String", # Output only. The profile object type.

5205

"userTypes": [ # Output only. The user types.

5206

"A String",

5207

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5208

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5209

"type": "A String", # The source type.

5210

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5211

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5212

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5213

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5214

"value": "A String", # The address of the residence.

5215

},

5216

],

5217

"resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters, in the form of `people/{person_id}`.

5218

"sipAddresses": [ # The person's SIP addresses.

5219

{ # A person's SIP address. Session Initial Protocol addresses are used for VoIP communications to make voice or video calls over the internet.

5220

"formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

5221

"metadata": { # Metadata about a field. # Metadata about the SIP address.

5222

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

5223

"source": { # The source of a field. # The source of the field.

5224

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

5225

"id": "A String", # The unique identifier within the source type generated by the server.

5226

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

5227

"objectType": "A String", # Output only. The profile object type.

5228

"userTypes": [ # Output only. The user types.

5229

"A String",

5230

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5231

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5232

"type": "A String", # The source type.

5233

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5234

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5235

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5236

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5237

"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`

5238

"value": "A String", # The SIP address in the [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI format.

5239

},

5240

],

5241

"skills": [ # The person's skills.

5242

{ # A skill that the person has.

5243

"metadata": { # Metadata about a field. # Metadata about the skill.

5244

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

5245

"source": { # The source of a field. # The source of the field.

5246

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

5247

"id": "A String", # The unique identifier within the source type generated by the server.

5248

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

5249

"objectType": "A String", # Output only. The profile object type.

5250

"userTypes": [ # Output only. The user types.

5251

"A String",

5252

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5253

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5254

"type": "A String", # The source type.

5255

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5256

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5257

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5258

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5259

"value": "A String", # The skill; for example, `underwater basket weaving`.

5260

},

5261

],

5262

"taglines": [ # Output only. **DEPRECATED**: No data will be returned The person's taglines.

5263

{ # **DEPRECATED**: No data will be returned A brief one-line description of the person.

5264

"metadata": { # Metadata about a field. # Metadata about the tagline.

5265

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

5266

"source": { # The source of a field. # The source of the field.

5267

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

5268

"id": "A String", # The unique identifier within the source type generated by the server.

5269

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

5270

"objectType": "A String", # Output only. The profile object type.

5271

"userTypes": [ # Output only. The user types.

5272

"A String",

5273

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5274

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5275

"type": "A String", # The source type.

5276

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5277

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5278

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

5279

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5280

"value": "A String", # The tagline.

5281

},

5282

],

5283

"urls": [ # The person's associated URLs.

5284

{ # A person's associated URLs.

5285

"formattedType": "A String", # Output only. The type of the URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

5286

"metadata": { # Metadata about a field. # Metadata about the URL.

5287

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

5288

"source": { # The source of a field. # The source of the field.

5289

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

5290

"id": "A String", # The unique identifier within the source type generated by the server.

5291

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

5292

"objectType": "A String", # Output only. The profile object type.

5293

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

5298

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

5299

},

5300

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

5301

},

5302

"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 Currents application. * `other`

5303

"value": "A String", # The URL.

5304

},

5305

],

5306

"userDefined": [ # The person's user defined data.

5307

{ # Arbitrary user data that is populated by the end users.

5308

"key": "A String", # The end user specified key of the user defined data.

5309

"metadata": { # Metadata about a field. # Metadata about the user defined data.

5310

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

5311

"source": { # The source of a field. # The source of the field.

5312

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

5313

"id": "A String", # The unique identifier within the source type generated by the server.

5314

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

5315

"objectType": "A String", # Output only. The profile object type.

5316

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

5321

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

5322

},

5323

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

5324

},

5325

"value": "A String", # The end user specified value of the user defined data.

5326

},

5327

],

5328

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

<code class="details" id="deleteContact">deleteContact(resourceName, x__xgafv=None)</code>

5333

<pre>Delete a contact person. Any non-contact data will not be deleted.

5334

5335

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5336

resourceName: string, Required. The resource name of the contact to delete. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5337

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

5344

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

5345

{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5346

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5350

<code class="details" id="deleteContactPhoto">deleteContactPhoto(resourceName, personFields=None, sources=None, x__xgafv=None)</code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5351

<pre>Delete a contact's photo.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5352

5353

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5354

resourceName: string, Required. The resource name of the contact whose photo will be deleted. (required)

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5355

personFields: string, Optional. A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Defaults to empty if not set, which will skip the post mutate get. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

5356

sources: string, Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set. (repeated)

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

5357

Allowed values

5358

READ_SOURCE_TYPE_UNSPECIFIED - Unspecified.

5359

READ_SOURCE_TYPE_PROFILE - Returns SourceType.ACCOUNT, SourceType.DOMAIN_PROFILE, and SourceType.PROFILE.

5360

READ_SOURCE_TYPE_CONTACT - Returns SourceType.CONTACT.

5361

READ_SOURCE_TYPE_DOMAIN_CONTACT - Returns SourceType.DOMAIN_CONTACT.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5362

x__xgafv: string, V1 error format.

5363

Allowed values

5364

1 - v1 error format

5365

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5366

5367

Returns:

5368

An object of the form:

5369

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

5370

{ # The response for deleting a contact's photo.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5371

"person": { # Information about a person merged from various data sources such as the authenticated user's contacts and profile data. Most fields can have multiple items. The items in a field have no guaranteed order, but each non-empty field is guaranteed to have exactly one field with `metadata.primary` set to true. # The updated person, if person_fields is set in the DeleteContactPhotoRequest; otherwise this will be unset.

5372

"addresses": [ # The person's street addresses.

5373

{ # A person's physical address. May be a P.O. box or street address. All fields are optional.

5374

"city": "A String", # The city of the address.

5375

"country": "A String", # The country of the address.

5376

"countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address.

5377

"extendedAddress": "A String", # The extended address of the address; for example, the apartment number.

5378

"formattedType": "A String", # Output only. The type of the address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

5379

"formattedValue": "A String", # The unstructured value of the address. If this is not set by the user it will be automatically constructed from structured values.

5380

"metadata": { # Metadata about a field. # Metadata about the address.

5381

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

5382

"source": { # The source of a field. # The source of the field.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5383

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

5384

"id": "A String", # The unique identifier within the source type generated by the server.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5385

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

5386

"objectType": "A String", # Output only. The profile object type.

5387

"userTypes": [ # Output only. The user types.

5388

"A String",

5389

],

5390

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5391

"type": "A String", # The source type.

5392

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5393

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5394

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

5395

},

5396

"poBox": "A String", # The P.O. box of the address.

5397

"postalCode": "A String", # The postal code of the address.

5398

"region": "A String", # The region of the address; for example, the state or province.

5399

"streetAddress": "A String", # The street address.

5400

"type": "A String", # The type of the address. The type can be custom or one of these predefined values: * `home` * `work` * `other`

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5401

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5402

],

5403

"ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead) The person's age range.

5404

"ageRanges": [ # Output only. The person's age ranges.

5405

{ # A person's age range.

5406

"ageRange": "A String", # The age range.

5407

"metadata": { # Metadata about a field. # Metadata about the age range.

5408

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

5409

"source": { # The source of a field. # The source of the field.

5410

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

5411

"id": "A String", # The unique identifier within the source type generated by the server.

5412

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

5413

"objectType": "A String", # Output only. The profile object type.

5414

"userTypes": [ # Output only. The user types.

5415

"A String",

5416

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5417

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5418

"type": "A String", # The source type.

5419

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5420

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5421

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5422

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5423

},

5424

],

5425

"biographies": [ # The person's biographies. This field is a singleton for contact sources.

5426

{ # A person's short biography.

5427

"contentType": "A String", # The content type of the biography.

5428

"metadata": { # Metadata about a field. # Metadata about the biography.

5429

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

5430

"source": { # The source of a field. # The source of the field.

5431

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

5432

"id": "A String", # The unique identifier within the source type generated by the server.

5433

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

5434

"objectType": "A String", # Output only. The profile object type.

5435

"userTypes": [ # Output only. The user types.

5436

"A String",

5437

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5438

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5439

"type": "A String", # The source type.

5440

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5441

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5442

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5443

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5444

"value": "A String", # The short biography.

5445

},

5446

],

5447

"birthdays": [ # The person's birthdays. This field is a singleton for contact sources.

5448

{ # A person's birthday. At least one of the `date` and `text` fields are specified. The `date` and `text` fields typically represent the same date, but are not guaranteed to.

5449

"date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The date of the birthday.

5450

"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

5451

"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

5452

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5453

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5454

"metadata": { # Metadata about a field. # Metadata about the birthday.

5455

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

5456

"source": { # The source of a field. # The source of the field.

5457

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

5458

"id": "A String", # The unique identifier within the source type generated by the server.

5459

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

5460

"objectType": "A String", # Output only. The profile object type.

5461

"userTypes": [ # Output only. The user types.

5462

"A String",

5463

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5464

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5465

"type": "A String", # The source type.

5466

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5467

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5468

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5469

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5470

"text": "A String", # A free-form string representing the user's birthday.

5471

},

5472

],

5473

"braggingRights": [ # **DEPRECATED**: No data will be returned The person's bragging rights.

5474

{ # **DEPRECATED**: No data will be returned A person's bragging rights.

5475

"metadata": { # Metadata about a field. # Metadata about the bragging rights.

5476

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

5477

"source": { # The source of a field. # The source of the field.

5478

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

5479

"id": "A String", # The unique identifier within the source type generated by the server.

5480

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

5481

"objectType": "A String", # Output only. The profile object type.

5482

"userTypes": [ # Output only. The user types.

5483

"A String",

5484

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5485

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5486

"type": "A String", # The source type.

5487

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5488

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5489

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5490

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5491

"value": "A String", # The bragging rights; for example, `climbed mount everest`.

5492

},

5493

],

5494

"calendarUrls": [ # The person's calendar URLs.

5495

{ # A person's calendar URL.

5496

"formattedType": "A String", # Output only. The type of the calendar URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

5497

"metadata": { # Metadata about a field. # Metadata about the calendar URL.

5498

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

5499

"source": { # The source of a field. # The source of the field.

5500

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

5501

"id": "A String", # The unique identifier within the source type generated by the server.

5502

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

5503

"objectType": "A String", # Output only. The profile object type.

5504

"userTypes": [ # Output only. The user types.

5505

"A String",

5506

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5507

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5508

"type": "A String", # The source type.

5509

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5510

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5511

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5512

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5513

"type": "A String", # The type of the calendar URL. The type can be custom or one of these predefined values: * `home` * `freeBusy` * `work`

5514

"url": "A String", # The calendar URL.

5515

},

5516

],

5517

"clientData": [ # The person's client data.

5518

{ # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.

5519

"key": "A String", # The client specified key of the client data.

5520

"metadata": { # Metadata about a field. # Metadata about the client data.

5521

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

5522

"source": { # The source of a field. # The source of the field.

5523

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

5524

"id": "A String", # The unique identifier within the source type generated by the server.

5525

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

5526

"objectType": "A String", # Output only. The profile object type.

5527

"userTypes": [ # Output only. The user types.

5528

"A String",

5529

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5530

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5531

"type": "A String", # The source type.

5532

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5533

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5534

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5535

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5536

"value": "A String", # The client specified value of the client data.

5537

},

5538

],

5539

"coverPhotos": [ # Output only. The person's cover photos.

5540

{ # A person's cover photo. A large image shown on the person's profile page that represents who they are or what they care about.

5541

"default": True or False, # True if the cover photo is the default cover photo; false if the cover photo is a user-provided cover photo.

5542

"metadata": { # Metadata about a field. # Metadata about the cover photo.

5543

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

5544

"source": { # The source of a field. # The source of the field.

5545

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

5546

"id": "A String", # The unique identifier within the source type generated by the server.

5547

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

5548

"objectType": "A String", # Output only. The profile object type.

5549

"userTypes": [ # Output only. The user types.

5550

"A String",

5551

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5552

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5553

"type": "A String", # The source type.

5554

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5555

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5556

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5557

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5558

"url": "A String", # The URL of the cover photo.

5559

},

5560

],

5561

"emailAddresses": [ # The person's email addresses.

5562

{ # A person's email address.

5563

"displayName": "A String", # The display name of the email.

5564

"formattedType": "A String", # Output only. The type of the email address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

5565

"metadata": { # Metadata about a field. # Metadata about the email address.

5566

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

5567

"source": { # The source of a field. # The source of the field.

5568

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

5569

"id": "A String", # The unique identifier within the source type generated by the server.

5570

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

5571

"objectType": "A String", # Output only. The profile object type.

5572

"userTypes": [ # Output only. The user types.

5573

"A String",

5574

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5575

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5576

"type": "A String", # The source type.

5577

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5578

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5579

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5580

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5581

"type": "A String", # The type of the email address. The type can be custom or one of these predefined values: * `home` * `work` * `other`

5582

"value": "A String", # The email address.

5583

},

5584

],

5585

"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.

5586

"events": [ # The person's events.

5587

{ # An event related to the person.

5588

"date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The date of the event.

5589

"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

5590

"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

5591

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5592

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5593

"formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

5594

"metadata": { # Metadata about a field. # Metadata about the event.

5595

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

5596

"source": { # The source of a field. # The source of the field.

5597

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

5598

"id": "A String", # The unique identifier within the source type generated by the server.

5599

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

5600

"objectType": "A String", # Output only. The profile object type.

5601

"userTypes": [ # Output only. The user types.

5602

"A String",

5603

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5604

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5605

"type": "A String", # The source type.

5606

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5607

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5608

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5609

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5610

"type": "A String", # The type of the event. The type can be custom or one of these predefined values: * `anniversary` * `other`

5611

},

5612

],

5613

"externalIds": [ # The person's external IDs.

5614

{ # An identifier from an external entity related to the person.

5615

"formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

5616

"metadata": { # Metadata about a field. # Metadata about the external ID.

5617

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

5618

"source": { # The source of a field. # The source of the field.

5619

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

5620

"id": "A String", # The unique identifier within the source type generated by the server.

5621

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

5622

"objectType": "A String", # Output only. The profile object type.

5623

"userTypes": [ # Output only. The user types.

5624

"A String",

5625

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5626

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5627

"type": "A String", # The source type.

5628

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5629

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5630

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5631

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5632

"type": "A String", # The type of the external ID. The type can be custom or one of these predefined values: * `account` * `customer` * `loginId` * `network` * `organization`

5633

"value": "A String", # The value of the external ID.

5634

},

5635

],

5636

"fileAses": [ # The person's file-ases.

5637

{ # The name that should be used to sort the person in a list.

5638

"metadata": { # Metadata about a field. # Metadata about the file-as.

5639

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

5640

"source": { # The source of a field. # The source of the field.

5641

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

5642

"id": "A String", # The unique identifier within the source type generated by the server.

5643

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

5644

"objectType": "A String", # Output only. The profile object type.

5645

"userTypes": [ # Output only. The user types.

5646

"A String",

5647

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5648

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5649

"type": "A String", # The source type.

5650

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5651

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5652

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5653

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5654

"value": "A String", # The file-as value

5655

},

5656

],

5657

"genders": [ # The person's genders. This field is a singleton for contact sources.

5658

{ # A person's gender.

5659

"addressMeAs": "A String", # The type of pronouns that should be used to address the person. The value can be custom or one of these predefined values: * `male` * `female` * `other`

5660

"formattedValue": "A String", # Output only. The value of the gender translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. Unspecified or custom value are not localized.

5661

"metadata": { # Metadata about a field. # Metadata about the gender.

5662

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

5663

"source": { # The source of a field. # The source of the field.

5664

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

5665

"id": "A String", # The unique identifier within the source type generated by the server.

5666

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

5667

"objectType": "A String", # Output only. The profile object type.

5668

"userTypes": [ # Output only. The user types.

5669

"A String",

5670

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5671

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5672

"type": "A String", # The source type.

5673

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5674

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5675

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5676

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5677

"value": "A String", # The gender for the person. The gender can be custom or one of these predefined values: * `male` * `female` * `unspecified`

5678

},

5679

],

5680

"imClients": [ # The person's instant messaging clients.

5681

{ # A person's instant messaging client.

5682

"formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

5683

"formattedType": "A String", # Output only. The type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

5684

"metadata": { # Metadata about a field. # Metadata about the IM client.

5685

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

5686

"source": { # The source of a field. # The source of the field.

5687

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

5688

"id": "A String", # The unique identifier within the source type generated by the server.

5689

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

5690

"objectType": "A String", # Output only. The profile object type.

5691

"userTypes": [ # Output only. The user types.

5692

"A String",

5693

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5694

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5695

"type": "A String", # The source type.

5696

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

5697

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5698

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

5699

},

5700

"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`

5701

"type": "A String", # The type of the IM client. The type can be custom or one of these predefined values: * `home` * `work` * `other`

5702

"username": "A String", # The user name used in the IM client.

5703

},

5704

],

5705

"interests": [ # The person's interests.

5706

{ # One of the person's interests.

5707

"metadata": { # Metadata about a field. # Metadata about the interest.

5708

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

5709

"source": { # The source of a field. # The source of the field.

5710

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

5711

"id": "A String", # The unique identifier within the source type generated by the server.

5712

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

5713

"objectType": "A String", # Output only. The profile object type.

5714

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

5719

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

5720

},

5721

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

5722

},

5723

"value": "A String", # The interest; for example, `stargazing`.

5724

},

5725

],

5726

"locales": [ # The person's locale preferences.

5727

{ # A person's locale preference.

5728

"metadata": { # Metadata about a field. # Metadata about the locale.

5729

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

5730

"source": { # The source of a field. # The source of the field.

5731

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

5732

"id": "A String", # The unique identifier within the source type generated by the server.

5733

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

5734

"objectType": "A String", # Output only. The profile object type.

5735

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

5740

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

5741

},

5742

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

5743

},

5744

"value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag representing the locale.

5745

},

5746

],

5747

"locations": [ # The person's locations.

5748

{ # A person's location.

5749

"buildingId": "A String", # The building identifier.

5750

"current": True or False, # Whether the location is the current location.

5751

"deskCode": "A String", # The individual desk location.

5752

"floor": "A String", # The floor name or number.

5753

"floorSection": "A String", # The floor section in `floor_name`.

5754

"metadata": { # Metadata about a field. # Metadata about the location.

5755

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

5756

"source": { # The source of a field. # The source of the field.

5757

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

5758

"id": "A String", # The unique identifier within the source type generated by the server.

5759

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

5760

"objectType": "A String", # Output only. The profile object type.

5761

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

5766

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

5767

},

5768

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

5769

},

5770

"type": "A String", # The type of the location. The type can be custom or one of these predefined values: * `desk` * `grewUp`

5771

"value": "A String", # The free-form value of the location.

5772

},

5773

],

5774

"memberships": [ # The person's group memberships.

5775

{ # A person's membership in a group. Only contact group memberships can be modified.

5776

"contactGroupMembership": { # A Google contact group membership. # The contact group membership.

5777

"contactGroupId": "A String", # Output only. The contact group ID for the contact group membership.

5778

"contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`. Only contact_group_resource_name can be used for modifying memberships. Any contact group membership can be removed, but only user group or "myContacts" or "starred" system groups memberships can be added. A contact must always have at least one contact group membership.

5779

},

5780

"domainMembership": { # A G Suite Domain membership. # Output only. The domain membership.

5781

"inViewerDomain": True or False, # True if the person is in the viewer's G Suite domain.

5782

},

5783

"metadata": { # Metadata about a field. # Metadata about the membership.

5784

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

5785

"source": { # The source of a field. # The source of the field.

5786

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

5787

"id": "A String", # The unique identifier within the source type generated by the server.

5788

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

5789

"objectType": "A String", # Output only. The profile object type.

5790

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

5795

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

5796

},

5797

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

},

},

],

"metadata": { # The metadata about a person. # Output only. Metadata about the person.

5802

"deleted": True or False, # Output only. True if the person resource has been deleted. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token.

5803

"linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.

5804

"A String",

5805

],

5806

"objectType": "A String", # Output only. **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object.

5807

"previousResourceNames": [ # Output only. Any former resource names this person has had. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token. The resource name may change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or profile URL.

5808

"A String",

5809

],

5810

"sources": [ # The sources of data for the person.

5811

{ # The source of a field.

5812

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

5813

"id": "A String", # The unique identifier within the source type generated by the server.

5814

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

5815

"objectType": "A String", # Output only. The profile object type.

5816

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

5821

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

5822

},

5823

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

5824

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5825

"miscKeywords": [ # The person's miscellaneous keywords.

5826

{ # A person's miscellaneous keyword.

5827

"formattedType": "A String", # Output only. The type of the miscellaneous keyword translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

5828

"metadata": { # Metadata about a field. # Metadata about the miscellaneous keyword.

5829

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

5830

"source": { # The source of a field. # The source of the field.

5831

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

5832

"id": "A String", # The unique identifier within the source type generated by the server.

5833

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

5834

"objectType": "A String", # Output only. The profile object type.

5835

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

5840

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

5841

},

5842

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

5843

},

5844

"type": "A String", # The miscellaneous keyword type.

5845

"value": "A String", # The value of the miscellaneous keyword.

5846

},

5847

],

5848

"names": [ # The person's names. This field is a singleton for contact sources.

5849

{ # A person's name. If the name is a mononym, the family name is empty.

5850

"displayName": "A String", # Output only. The display name formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.

5851

"displayNameLastFirst": "A String", # Output only. The display name with the last name first formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.

5852

"familyName": "A String", # The family name.

5853

"givenName": "A String", # The given name.

5854

"honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`

5855

"honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`

5856

"metadata": { # Metadata about a field. # Metadata about the name.

5857

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

5858

"source": { # The source of a field. # The source of the field.

5859

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

5860

"id": "A String", # The unique identifier within the source type generated by the server.

5861

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

5862

"objectType": "A String", # Output only. The profile object type.

5863

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

5868

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

5869

},

5870

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

5871

},

5872

"middleName": "A String", # The middle name(s).

5873

"phoneticFamilyName": "A String", # The family name spelled as it sounds.

5874

"phoneticFullName": "A String", # The full name spelled as it sounds.

5875

"phoneticGivenName": "A String", # The given name spelled as it sounds.

5876

"phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.

5877

"phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.

5878

"phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.

5879

"unstructuredName": "A String", # The free form name value.

5880

},

5881

],

5882

"nicknames": [ # The person's nicknames.

5883

{ # A person's nickname.

5884

"metadata": { # Metadata about a field. # Metadata about the nickname.

5885

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

5886

"source": { # The source of a field. # The source of the field.

5887

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

5888

"id": "A String", # The unique identifier within the source type generated by the server.

5889

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

5890

"objectType": "A String", # Output only. The profile object type.

5891

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

5896

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

5897

},

5898

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

5899

},

5900

"type": "A String", # The type of the nickname.

5901

"value": "A String", # The nickname.

5902

},

5903

],

5904

"occupations": [ # The person's occupations.

5905

{ # A person's occupation.

5906

"metadata": { # Metadata about a field. # Metadata about the occupation.

5907

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

5908

"source": { # The source of a field. # The source of the field.

5909

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

5910

"id": "A String", # The unique identifier within the source type generated by the server.

5911

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

5912

"objectType": "A String", # Output only. The profile object type.

5913

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

5918

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

5919

},

5920

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

5921

},

5922

"value": "A String", # The occupation; for example, `carpenter`.

5923

},

5924

],

5925

"organizations": [ # The person's past or current organizations.

5926

{ # A person's past or current organization. Overlapping date ranges are permitted.

5927

"current": True or False, # True if the organization is the person's current organization; false if the organization is a past organization.

5928

"department": "A String", # The person's department at the organization.

5929

"domain": "A String", # The domain name associated with the organization; for example, `google.com`.

5930

"endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The end date when the person left the organization.

5931

"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

5932

"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

5933

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

5934

},

5935

"formattedType": "A String", # Output only. The type of the organization translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

5936

"jobDescription": "A String", # The person's job description at the organization.

5937

"location": "A String", # The location of the organization office the person works at.

5938

"metadata": { # Metadata about a field. # Metadata about the organization.

5939

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

5940

"source": { # The source of a field. # The source of the field.

5941

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

5942

"id": "A String", # The unique identifier within the source type generated by the server.

5943

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

5944

"objectType": "A String", # Output only. The profile object type.

5945

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

5950

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

5951

},

5952

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

5953

},

5954

"name": "A String", # The name of the organization.

5955

"phoneticName": "A String", # The phonetic name of the organization.

5956

"startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The start date when the person joined the organization.

5957

"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

5958

"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

5959

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

5960

},

5961

"symbol": "A String", # The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym.

5962

"title": "A String", # The person's job title at the organization.

5963

"type": "A String", # The type of the organization. The type can be custom or one of these predefined values: * `work` * `school`

5964

},

5965

],

5966

"phoneNumbers": [ # The person's phone numbers.

5967

{ # A person's phone number.

5968

"canonicalForm": "A String", # Output only. The canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number.

5969

"formattedType": "A String", # Output only. The type of the phone number translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

5970

"metadata": { # Metadata about a field. # Metadata about the phone number.

5971

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

5972

"source": { # The source of a field. # The source of the field.

5973

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

5974

"id": "A String", # The unique identifier within the source type generated by the server.

5975

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

5976

"objectType": "A String", # Output only. The profile object type.

5977

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

5982

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

5983

},

5984

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

5985

},

5986

"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`

5987

"value": "A String", # The phone number.

5988

},

5989

],

5990

"photos": [ # Output only. The person's photos.

5991

{ # A person's photo. A picture shown next to the person's name to help others recognize the person.

5992

"default": True or False, # True if the photo is a default photo; false if the photo is a user-provided photo.

5993

"metadata": { # Metadata about a field. # Metadata about the photo.

5994

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

5995

"source": { # The source of a field. # The source of the field.

5996

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

5997

"id": "A String", # The unique identifier within the source type generated by the server.

5998

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

5999

"objectType": "A String", # Output only. The profile object type.

6000

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

6005

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

6006

},

6007

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

6008

},

6009

"url": "A String", # The URL of the photo. You can change the desired size by appending a query parameter `sz={size}` at the end of the url, where {size} is the size in pixels. Example: https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50

6010

},

6011

],

6012

"relations": [ # The person's relations.

6013

{ # A person's relation to another person.

6014

"formattedType": "A String", # Output only. The type of the relation translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.

6015

"metadata": { # Metadata about a field. # Metadata about the relation.

6016

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

6017

"source": { # The source of a field. # The source of the field.

6018

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

6019

"id": "A String", # The unique identifier within the source type generated by the server.

6020

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

6021

"objectType": "A String", # Output only. The profile object type.

6022

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

6027

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

6028

},

6029

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

6030

},

6031

"person": "A String", # The name of the other person this relation refers to.

6032

"type": "A String", # The person's relation to the other person. The type can be custom or one of these predefined values: * `spouse` * `child` * `mother` * `father` * `parent` * `brother` * `sister` * `friend` * `relative` * `domesticPartner` * `manager` * `assistant` * `referredBy` * `partner`

6033

},

6034

],

6035

"relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship interests.

6036

{ # **DEPRECATED**: No data will be returned A person's relationship interest .

6037

"formattedValue": "A String", # Output only. The value of the relationship interest translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.

6038

"metadata": { # Metadata about a field. # Metadata about the relationship interest.

6039

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

6040

"source": { # The source of a field. # The source of the field.

6041

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

6042

"id": "A String", # The unique identifier within the source type generated by the server.

6043

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

6044

"objectType": "A String", # Output only. The profile object type.

6045

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

6050

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

6051

},

6052

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

6053

},

6054

"value": "A String", # The kind of relationship the person is looking for. The value can be custom or one of these predefined values: * `friend` * `date` * `relationship` * `networking`

6055

},

6056

],

6057

"relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship statuses.

6058

{ # **DEPRECATED**: No data will be returned A person's relationship status.

6059

"formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

6060

"metadata": { # Metadata about a field. # Metadata about the relationship status.

6061

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

6062

"source": { # The source of a field. # The source of the field.

6063

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

6064

"id": "A String", # The unique identifier within the source type generated by the server.

6065

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

6066

"objectType": "A String", # Output only. The profile object type.

6067

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

6072

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

6073

},

6074

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

6075

},

6076

"value": "A String", # The relationship status. The value can be custom or one of these predefined values: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion`

6077

},

6078

],

6079

"residences": [ # **DEPRECATED**: (Please use `person.locations` instead) The person's residences.

6080

{ # **DEPRECATED**: Please use `person.locations` instead. A person's past or current residence.

6081

"current": True or False, # True if the residence is the person's current residence; false if the residence is a past residence.

6082

"metadata": { # Metadata about a field. # Metadata about the residence.

6083

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

6084

"source": { # The source of a field. # The source of the field.

6085

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

6086

"id": "A String", # The unique identifier within the source type generated by the server.

6087

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

6088

"objectType": "A String", # Output only. The profile object type.

6089

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

6094

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

6095

},

6096

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

6097

},

6098

"value": "A String", # The address of the residence.

6099

},

6100

],

6101

"resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters, in the form of `people/{person_id}`.

6102

"sipAddresses": [ # The person's SIP addresses.

6103

{ # A person's SIP address. Session Initial Protocol addresses are used for VoIP communications to make voice or video calls over the internet.

6104

"formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

6105

"metadata": { # Metadata about a field. # Metadata about the SIP address.

6106

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

6107

"source": { # The source of a field. # The source of the field.

6108

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

6109

"id": "A String", # The unique identifier within the source type generated by the server.

6110

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

6111

"objectType": "A String", # Output only. The profile object type.

6112

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

6117

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

6118

},

6119

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

6120

},

6121

"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`

6122

"value": "A String", # The SIP address in the [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI format.

6123

},

6124

],

6125

"skills": [ # The person's skills.

6126

{ # A skill that the person has.

6127

"metadata": { # Metadata about a field. # Metadata about the skill.

6128

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

6129

"source": { # The source of a field. # The source of the field.

6130

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

6131

"id": "A String", # The unique identifier within the source type generated by the server.

6132

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

6133

"objectType": "A String", # Output only. The profile object type.

6134

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

6139

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

6140

},

6141

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

6142

},

6143

"value": "A String", # The skill; for example, `underwater basket weaving`.

6144

},

6145

],

6146

"taglines": [ # Output only. **DEPRECATED**: No data will be returned The person's taglines.

6147

{ # **DEPRECATED**: No data will be returned A brief one-line description of the person.

6148

"metadata": { # Metadata about a field. # Metadata about the tagline.

6149

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

6150

"source": { # The source of a field. # The source of the field.

6151

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

6152

"id": "A String", # The unique identifier within the source type generated by the server.

6153

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

6154

"objectType": "A String", # Output only. The profile object type.

6155

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

6160

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

6161

},

6162

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

6163

},

6164

"value": "A String", # The tagline.

6165

},

6166

],

6167

"urls": [ # The person's associated URLs.

6168

{ # A person's associated URLs.

6169

"formattedType": "A String", # Output only. The type of the URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

6170

"metadata": { # Metadata about a field. # Metadata about the URL.

6171

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

6172

"source": { # The source of a field. # The source of the field.

6173

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

6174

"id": "A String", # The unique identifier within the source type generated by the server.

6175

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

6176

"objectType": "A String", # Output only. The profile object type.

6177

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

6182

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

6183

},

6184

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

6185

},

6186

"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 Currents application. * `other`

6187

"value": "A String", # The URL.

6188

},

6189

],

6190

"userDefined": [ # The person's user defined data.

6191

{ # Arbitrary user data that is populated by the end users.

6192

"key": "A String", # The end user specified key of the user defined data.

6193

"metadata": { # Metadata about a field. # Metadata about the user defined data.

6194

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

6195

"source": { # The source of a field. # The source of the field.

6196

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

6197

"id": "A String", # The unique identifier within the source type generated by the server.

6198

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

6199

"objectType": "A String", # Output only. The profile object type.

6200

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

6205

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

6206

},

6207

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

6208

},

6209

"value": "A String", # The end user specified value of the user defined data.

},

],

},

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6217

<code class="details" id="get">get(resourceName, personFields=None, requestMask_includeField=None, sources=None, x__xgafv=None)</code>

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

6218

<pre>Provides information about a person by specifying a resource name. Use `people/me` to indicate the authenticated user. The request returns a 400 error if 'personFields' is not specified.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6219

6220

Args:

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

6221

resourceName: string, Required. The resource name of the person to provide information about. - To get information about the authenticated user, specify `people/me`. - To get information about a google account, specify `people/{account_id}`. - To get information about a contact, specify the resource name that identifies the contact as returned by [`people.connections.list`](/people/api/rest/v1/people.connections/list). (required)

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

6222

personFields: string, Required. A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6223

requestMask_includeField: string, Required. Comma-separated list of person fields to be included in the response. Each path should start with `person.`: for example, `person.names` or `person.photos`.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

6224

sources: string, Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_PROFILE and READ_SOURCE_TYPE_CONTACT if not set. (repeated)

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

6225

Allowed values

6226

READ_SOURCE_TYPE_UNSPECIFIED - Unspecified.

6227

READ_SOURCE_TYPE_PROFILE - Returns SourceType.ACCOUNT, SourceType.DOMAIN_PROFILE, and SourceType.PROFILE.

6228

READ_SOURCE_TYPE_CONTACT - Returns SourceType.CONTACT.

6229

READ_SOURCE_TYPE_DOMAIN_CONTACT - Returns SourceType.DOMAIN_CONTACT.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6230

x__xgafv: string, V1 error format.

6231

Allowed values

6232

1 - v1 error format

6233

2 - v2 error format

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

6234

6235

Returns:

6236

An object of the form:

6237

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

6238

{ # Information about a person merged from various data sources such as the authenticated user's contacts and profile data. Most fields can have multiple items. The items in a field have no guaranteed order, but each non-empty field is guaranteed to have exactly one field with `metadata.primary` set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6239

"addresses": [ # The person's street addresses.

6240

{ # A person's physical address. May be a P.O. box or street address. All fields are optional.

6241

"city": "A String", # The city of the address.

6242

"country": "A String", # The country of the address.

6243

"countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address.

6244

"extendedAddress": "A String", # The extended address of the address; for example, the apartment number.

6245

"formattedType": "A String", # Output only. The type of the address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

6246

"formattedValue": "A String", # The unstructured value of the address. If this is not set by the user it will be automatically constructed from structured values.

6247

"metadata": { # Metadata about a field. # Metadata about the address.

6248

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

6249

"source": { # The source of a field. # The source of the field.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

6250

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

6251

"id": "A String", # The unique identifier within the source type generated by the server.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

6252

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

6253

"objectType": "A String", # Output only. The profile object type.

6254

"userTypes": [ # Output only. The user types.

6255

"A String",

6256

],

6257

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6258

"type": "A String", # The source type.

6259

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

6260

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6261

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

6262

},

6263

"poBox": "A String", # The P.O. box of the address.

6264

"postalCode": "A String", # The postal code of the address.

6265

"region": "A String", # The region of the address; for example, the state or province.

6266

"streetAddress": "A String", # The street address.

6267

"type": "A String", # The type of the address. The type can be custom or one of these predefined values: * `home` * `work` * `other`

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

6268

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6269

],

6270

"ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead) The person's age range.

6271

"ageRanges": [ # Output only. The person's age ranges.

6272

{ # A person's age range.

6273

"ageRange": "A String", # The age range.

6274

"metadata": { # Metadata about a field. # Metadata about the age range.

6275

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

6276

"source": { # The source of a field. # The source of the field.

6277

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

6278

"id": "A String", # The unique identifier within the source type generated by the server.

6279

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

6280

"objectType": "A String", # Output only. The profile object type.

6281

"userTypes": [ # Output only. The user types.

6282

"A String",

6283

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

6284

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6285

"type": "A String", # The source type.

6286

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

6287

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6288

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

},

},

],

"biographies": [ # The person's biographies. This field is a singleton for contact sources.

6293

{ # A person's short biography.

6294

"contentType": "A String", # The content type of the biography.

6295

"metadata": { # Metadata about a field. # Metadata about the biography.

6296

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

6297

"source": { # The source of a field. # The source of the field.

6298

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

6299

"id": "A String", # The unique identifier within the source type generated by the server.

6300

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

6301

"objectType": "A String", # Output only. The profile object type.

6302

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

6307

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

6308

},

6309

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

6310

},

6311

"value": "A String", # The short biography.

6312

},

6313

],

6314

"birthdays": [ # The person's birthdays. This field is a singleton for contact sources.

6315

{ # A person's birthday. At least one of the `date` and `text` fields are specified. The `date` and `text` fields typically represent the same date, but are not guaranteed to.

6316

"date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The date of the birthday.

6317

"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

6318

"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

6319

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

6320

},

6321

"metadata": { # Metadata about a field. # Metadata about the birthday.

6322

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

6323

"source": { # The source of a field. # The source of the field.

6324

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

6325

"id": "A String", # The unique identifier within the source type generated by the server.

6326

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

6327

"objectType": "A String", # Output only. The profile object type.

6328

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

6333

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

6334

},

6335

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

6336

},

6337

"text": "A String", # A free-form string representing the user's birthday.

6338

},

6339

],

6340

"braggingRights": [ # **DEPRECATED**: No data will be returned The person's bragging rights.

6341

{ # **DEPRECATED**: No data will be returned A person's bragging rights.

6342

"metadata": { # Metadata about a field. # Metadata about the bragging rights.

6343

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

6344

"source": { # The source of a field. # The source of the field.

6345

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

6346

"id": "A String", # The unique identifier within the source type generated by the server.

6347

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

6348

"objectType": "A String", # Output only. The profile object type.

6349

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

6354

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

6355

},

6356

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

6357

},

6358

"value": "A String", # The bragging rights; for example, `climbed mount everest`.

6359

},

6360

],

6361

"calendarUrls": [ # The person's calendar URLs.

6362

{ # A person's calendar URL.

6363

"formattedType": "A String", # Output only. The type of the calendar URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

6364

"metadata": { # Metadata about a field. # Metadata about the calendar URL.

6365

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

6366

"source": { # The source of a field. # The source of the field.

6367

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

6368

"id": "A String", # The unique identifier within the source type generated by the server.

6369

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

6370

"objectType": "A String", # Output only. The profile object type.

6371

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

6376

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

6377

},

6378

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

6379

},

6380

"type": "A String", # The type of the calendar URL. The type can be custom or one of these predefined values: * `home` * `freeBusy` * `work`

6381

"url": "A String", # The calendar URL.

6382

},

6383

],

6384

"clientData": [ # The person's client data.

6385

{ # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.

6386

"key": "A String", # The client specified key of the client data.

6387

"metadata": { # Metadata about a field. # Metadata about the client data.

6388

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

6389

"source": { # The source of a field. # The source of the field.

6390

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

6391

"id": "A String", # The unique identifier within the source type generated by the server.

6392

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

6393

"objectType": "A String", # Output only. The profile object type.

6394

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

6399

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

6400

},

6401

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

6402

},

6403

"value": "A String", # The client specified value of the client data.

6404

},

6405

],

6406

"coverPhotos": [ # Output only. The person's cover photos.

6407

{ # A person's cover photo. A large image shown on the person's profile page that represents who they are or what they care about.

6408

"default": True or False, # True if the cover photo is the default cover photo; false if the cover photo is a user-provided cover photo.

6409

"metadata": { # Metadata about a field. # Metadata about the cover photo.

6410

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

6411

"source": { # The source of a field. # The source of the field.

6412

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

6413

"id": "A String", # The unique identifier within the source type generated by the server.

6414

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

6415

"objectType": "A String", # Output only. The profile object type.

6416

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

6421

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

6422

},

6423

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

6424

},

6425

"url": "A String", # The URL of the cover photo.

6426

},

6427

],

6428

"emailAddresses": [ # The person's email addresses.

6429

{ # A person's email address.

6430

"displayName": "A String", # The display name of the email.

6431

"formattedType": "A String", # Output only. The type of the email address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

6432

"metadata": { # Metadata about a field. # Metadata about the email address.

6433

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

6434

"source": { # The source of a field. # The source of the field.

6435

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

6436

"id": "A String", # The unique identifier within the source type generated by the server.

6437

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

6438

"objectType": "A String", # Output only. The profile object type.

6439

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

6444

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

6445

},

6446

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

6447

},

6448

"type": "A String", # The type of the email address. The type can be custom or one of these predefined values: * `home` * `work` * `other`

6449

"value": "A String", # The email address.

6450

},

6451

],

6452

"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.

6453

"events": [ # The person's events.

6454

{ # An event related to the person.

6455

"date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The date of the event.

6456

"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

6457

"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

6458

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

6459

},

6460

"formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

6461

"metadata": { # Metadata about a field. # Metadata about the event.

6462

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

6463

"source": { # The source of a field. # The source of the field.

6464

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

6465

"id": "A String", # The unique identifier within the source type generated by the server.

6466

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

6467

"objectType": "A String", # Output only. The profile object type.

6468

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

6473

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

6474

},

6475

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

6476

},

6477

"type": "A String", # The type of the event. The type can be custom or one of these predefined values: * `anniversary` * `other`

6478

},

6479

],

6480

"externalIds": [ # The person's external IDs.

6481

{ # An identifier from an external entity related to the person.

6482

"formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

6483

"metadata": { # Metadata about a field. # Metadata about the external ID.

6484

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

6485

"source": { # The source of a field. # The source of the field.

6486

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

6487

"id": "A String", # The unique identifier within the source type generated by the server.

6488

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

6489

"objectType": "A String", # Output only. The profile object type.

6490

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

6495

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

6496

},

6497

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

6498

},

6499

"type": "A String", # The type of the external ID. The type can be custom or one of these predefined values: * `account` * `customer` * `loginId` * `network` * `organization`

6500

"value": "A String", # The value of the external ID.

6501

},

6502

],

6503

"fileAses": [ # The person's file-ases.

6504

{ # The name that should be used to sort the person in a list.

6505

"metadata": { # Metadata about a field. # Metadata about the file-as.

6506

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

6507

"source": { # The source of a field. # The source of the field.

6508

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

6509

"id": "A String", # The unique identifier within the source type generated by the server.

6510

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

6511

"objectType": "A String", # Output only. The profile object type.

6512

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

6517

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

6518

},

6519

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

6520

},

6521

"value": "A String", # The file-as value

6522

},

6523

],

6524

"genders": [ # The person's genders. This field is a singleton for contact sources.

6525

{ # A person's gender.

6526

"addressMeAs": "A String", # The type of pronouns that should be used to address the person. The value can be custom or one of these predefined values: * `male` * `female` * `other`

6527

"formattedValue": "A String", # Output only. The value of the gender translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. Unspecified or custom value are not localized.

6528

"metadata": { # Metadata about a field. # Metadata about the gender.

6529

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

6530

"source": { # The source of a field. # The source of the field.

6531

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

6532

"id": "A String", # The unique identifier within the source type generated by the server.

6533

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

6534

"objectType": "A String", # Output only. The profile object type.

6535

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

6540

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

6541

},

6542

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

6543

},

6544

"value": "A String", # The gender for the person. The gender can be custom or one of these predefined values: * `male` * `female` * `unspecified`

6545

},

6546

],

6547

"imClients": [ # The person's instant messaging clients.

6548

{ # A person's instant messaging client.

6549

"formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

6550

"formattedType": "A String", # Output only. The type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

6551

"metadata": { # Metadata about a field. # Metadata about the IM client.

6552

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

6553

"source": { # The source of a field. # The source of the field.

6554

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

6555

"id": "A String", # The unique identifier within the source type generated by the server.

6556

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

6557

"objectType": "A String", # Output only. The profile object type.

6558

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

6563

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

6564

},

6565

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

6566

},

6567

"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`

6568

"type": "A String", # The type of the IM client. The type can be custom or one of these predefined values: * `home` * `work` * `other`

6569

"username": "A String", # The user name used in the IM client.

6570

},

6571

],

6572

"interests": [ # The person's interests.

6573

{ # One of the person's interests.

6574

"metadata": { # Metadata about a field. # Metadata about the interest.

6575

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

6576

"source": { # The source of a field. # The source of the field.

6577

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

6578

"id": "A String", # The unique identifier within the source type generated by the server.

6579

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

6580

"objectType": "A String", # Output only. The profile object type.

6581

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

6586

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

6587

},

6588

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

6589

},

6590

"value": "A String", # The interest; for example, `stargazing`.

6591

},

6592

],

6593

"locales": [ # The person's locale preferences.

6594

{ # A person's locale preference.

6595

"metadata": { # Metadata about a field. # Metadata about the locale.

6596

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

6597

"source": { # The source of a field. # The source of the field.

6598

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

6599

"id": "A String", # The unique identifier within the source type generated by the server.

6600

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

6601

"objectType": "A String", # Output only. The profile object type.

6602

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

6607

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

6608

},

6609

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

6610

},

6611

"value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag representing the locale.

6612

},

6613

],

6614

"locations": [ # The person's locations.

6615

{ # A person's location.

6616

"buildingId": "A String", # The building identifier.

6617

"current": True or False, # Whether the location is the current location.

6618

"deskCode": "A String", # The individual desk location.

6619

"floor": "A String", # The floor name or number.

6620

"floorSection": "A String", # The floor section in `floor_name`.

6621

"metadata": { # Metadata about a field. # Metadata about the location.

6622

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

6623

"source": { # The source of a field. # The source of the field.

6624

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

6625

"id": "A String", # The unique identifier within the source type generated by the server.

6626

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

6627

"objectType": "A String", # Output only. The profile object type.

6628

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

6633

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

6634

},

6635

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

6636

},

6637

"type": "A String", # The type of the location. The type can be custom or one of these predefined values: * `desk` * `grewUp`

6638

"value": "A String", # The free-form value of the location.

6639

},

6640

],

6641

"memberships": [ # The person's group memberships.

6642

{ # A person's membership in a group. Only contact group memberships can be modified.

6643

"contactGroupMembership": { # A Google contact group membership. # The contact group membership.

6644

"contactGroupId": "A String", # Output only. The contact group ID for the contact group membership.

6645

"contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`. Only contact_group_resource_name can be used for modifying memberships. Any contact group membership can be removed, but only user group or "myContacts" or "starred" system groups memberships can be added. A contact must always have at least one contact group membership.

6646

},

6647

"domainMembership": { # A G Suite Domain membership. # Output only. The domain membership.

6648

"inViewerDomain": True or False, # True if the person is in the viewer's G Suite domain.

6649

},

6650

"metadata": { # Metadata about a field. # Metadata about the membership.

6651

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

6652

"source": { # The source of a field. # The source of the field.

6653

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

6654

"id": "A String", # The unique identifier within the source type generated by the server.

6655

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

6656

"objectType": "A String", # Output only. The profile object type.

6657

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

6662

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

6663

},

6664

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

},

},

],

"metadata": { # The metadata about a person. # Output only. Metadata about the person.

6669

"deleted": True or False, # Output only. True if the person resource has been deleted. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token.

6670

"linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.

6671

"A String",

6672

],

6673

"objectType": "A String", # Output only. **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object.

6674

"previousResourceNames": [ # Output only. Any former resource names this person has had. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token. The resource name may change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or profile URL.

6675

"A String",

6676

],

6677

"sources": [ # The sources of data for the person.

6678

{ # The source of a field.

6679

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

6680

"id": "A String", # The unique identifier within the source type generated by the server.

6681

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

6682

"objectType": "A String", # Output only. The profile object type.

6683

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

6688

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

6689

},

6690

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6691

},

6692

"miscKeywords": [ # The person's miscellaneous keywords.

6693

{ # A person's miscellaneous keyword.

6694

"formattedType": "A String", # Output only. The type of the miscellaneous keyword translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

6695

"metadata": { # Metadata about a field. # Metadata about the miscellaneous keyword.

6696

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

6697

"source": { # The source of a field. # The source of the field.

6698

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

6699

"id": "A String", # The unique identifier within the source type generated by the server.

6700

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

6701

"objectType": "A String", # Output only. The profile object type.

6702

"userTypes": [ # Output only. The user types.

6703

"A String",

6704

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

6705

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6706

"type": "A String", # The source type.

6707

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

6708

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6709

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

6710

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6711

"type": "A String", # The miscellaneous keyword type.

6712

"value": "A String", # The value of the miscellaneous keyword.

6713

},

6714

],

6715

"names": [ # The person's names. This field is a singleton for contact sources.

6716

{ # A person's name. If the name is a mononym, the family name is empty.

6717

"displayName": "A String", # Output only. The display name formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.

6718

"displayNameLastFirst": "A String", # Output only. The display name with the last name first formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.

6719

"familyName": "A String", # The family name.

6720

"givenName": "A String", # The given name.

6721

"honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`

6722

"honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`

6723

"metadata": { # Metadata about a field. # Metadata about the name.

6724

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

6725

"source": { # The source of a field. # The source of the field.

6726

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

6727

"id": "A String", # The unique identifier within the source type generated by the server.

6728

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

6729

"objectType": "A String", # Output only. The profile object type.

6730

"userTypes": [ # Output only. The user types.

6731

"A String",

6732

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

6733

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6734

"type": "A String", # The source type.

6735

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

6736

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6737

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

6738

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6739

"middleName": "A String", # The middle name(s).

6740

"phoneticFamilyName": "A String", # The family name spelled as it sounds.

6741

"phoneticFullName": "A String", # The full name spelled as it sounds.

6742

"phoneticGivenName": "A String", # The given name spelled as it sounds.

6743

"phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.

6744

"phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.

6745

"phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.

6746

"unstructuredName": "A String", # The free form name value.

6747

},

6748

],

6749

"nicknames": [ # The person's nicknames.

6750

{ # A person's nickname.

6751

"metadata": { # Metadata about a field. # Metadata about the nickname.

6752

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

6753

"source": { # The source of a field. # The source of the field.

6754

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

6755

"id": "A String", # The unique identifier within the source type generated by the server.

6756

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

6757

"objectType": "A String", # Output only. The profile object type.

6758

"userTypes": [ # Output only. The user types.

6759

"A String",

6760

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

6761

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6762

"type": "A String", # The source type.

6763

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

6764

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6765

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

6766

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6767

"type": "A String", # The type of the nickname.

6768

"value": "A String", # The nickname.

6769

},

6770

],

6771

"occupations": [ # The person's occupations.

6772

{ # A person's occupation.

6773

"metadata": { # Metadata about a field. # Metadata about the occupation.

6774

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

6775

"source": { # The source of a field. # The source of the field.

6776

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

6777

"id": "A String", # The unique identifier within the source type generated by the server.

6778

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

6779

"objectType": "A String", # Output only. The profile object type.

6780

"userTypes": [ # Output only. The user types.

6781

"A String",

6782

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

6783

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6784

"type": "A String", # The source type.

6785

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

6786

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6787

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

6788

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6789

"value": "A String", # The occupation; for example, `carpenter`.

6790

},

6791

],

6792

"organizations": [ # The person's past or current organizations.

6793

{ # A person's past or current organization. Overlapping date ranges are permitted.

6794

"current": True or False, # True if the organization is the person's current organization; false if the organization is a past organization.

6795

"department": "A String", # The person's department at the organization.

6796

"domain": "A String", # The domain name associated with the organization; for example, `google.com`.

6797

"endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The end date when the person left the organization.

6798

"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

6799

"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

6800

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

6801

},

6802

"formattedType": "A String", # Output only. The type of the organization translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

6803

"jobDescription": "A String", # The person's job description at the organization.

6804

"location": "A String", # The location of the organization office the person works at.

6805

"metadata": { # Metadata about a field. # Metadata about the organization.

6806

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

6807

"source": { # The source of a field. # The source of the field.

6808

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

6809

"id": "A String", # The unique identifier within the source type generated by the server.

6810

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

6811

"objectType": "A String", # Output only. The profile object type.

6812

"userTypes": [ # Output only. The user types.

6813

"A String",

6814

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

6815

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6816

"type": "A String", # The source type.

6817

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

6818

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6819

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

6820

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6821

"name": "A String", # The name of the organization.

6822

"phoneticName": "A String", # The phonetic name of the organization.

6823

"startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The start date when the person joined the organization.

6824

"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

6825

"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

6826

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

6827

},

6828

"symbol": "A String", # The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym.

6829

"title": "A String", # The person's job title at the organization.

6830

"type": "A String", # The type of the organization. The type can be custom or one of these predefined values: * `work` * `school`

6831

},

6832

],

6833

"phoneNumbers": [ # The person's phone numbers.

6834

{ # A person's phone number.

6835

"canonicalForm": "A String", # Output only. The canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number.

6836

"formattedType": "A String", # Output only. The type of the phone number translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

6837

"metadata": { # Metadata about a field. # Metadata about the phone number.

6838

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

6839

"source": { # The source of a field. # The source of the field.

6840

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

6841

"id": "A String", # The unique identifier within the source type generated by the server.

6842

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

6843

"objectType": "A String", # Output only. The profile object type.

6844

"userTypes": [ # Output only. The user types.

6845

"A String",

6846

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

6847

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6848

"type": "A String", # The source type.

6849

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

6850

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6851

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

6852

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6853

"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`

6854

"value": "A String", # The phone number.

6855

},

6856

],

6857

"photos": [ # Output only. The person's photos.

6858

{ # A person's photo. A picture shown next to the person's name to help others recognize the person.

6859

"default": True or False, # True if the photo is a default photo; false if the photo is a user-provided photo.

6860

"metadata": { # Metadata about a field. # Metadata about the photo.

6861

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

6862

"source": { # The source of a field. # The source of the field.

6863

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

6864

"id": "A String", # The unique identifier within the source type generated by the server.

6865

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

6866

"objectType": "A String", # Output only. The profile object type.

6867

"userTypes": [ # Output only. The user types.

6868

"A String",

6869

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

6870

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6871

"type": "A String", # The source type.

6872

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

6873

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6874

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

6875

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6876

"url": "A String", # The URL of the photo. You can change the desired size by appending a query parameter `sz={size}` at the end of the url, where {size} is the size in pixels. Example: https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50

6877

},

6878

],

6879

"relations": [ # The person's relations.

6880

{ # A person's relation to another person.

6881

"formattedType": "A String", # Output only. The type of the relation translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.

6882

"metadata": { # Metadata about a field. # Metadata about the relation.

6883

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

6884

"source": { # The source of a field. # The source of the field.

6885

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

6886

"id": "A String", # The unique identifier within the source type generated by the server.

6887

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

6888

"objectType": "A String", # Output only. The profile object type.

6889

"userTypes": [ # Output only. The user types.

6890

"A String",

6891

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

6892

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6893

"type": "A String", # The source type.

6894

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

6895

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6896

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

6897

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6898

"person": "A String", # The name of the other person this relation refers to.

6899

"type": "A String", # The person's relation to the other person. The type can be custom or one of these predefined values: * `spouse` * `child` * `mother` * `father` * `parent` * `brother` * `sister` * `friend` * `relative` * `domesticPartner` * `manager` * `assistant` * `referredBy` * `partner`

6900

},

6901

],

6902

"relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship interests.

6903

{ # **DEPRECATED**: No data will be returned A person's relationship interest .

6904

"formattedValue": "A String", # Output only. The value of the relationship interest translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.

6905

"metadata": { # Metadata about a field. # Metadata about the relationship interest.

6906

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

6907

"source": { # The source of a field. # The source of the field.

6908

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

6909

"id": "A String", # The unique identifier within the source type generated by the server.

6910

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

6911

"objectType": "A String", # Output only. The profile object type.

6912

"userTypes": [ # Output only. The user types.

6913

"A String",

6914

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

6915

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6916

"type": "A String", # The source type.

6917

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

6918

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6919

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

6920

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6921

"value": "A String", # The kind of relationship the person is looking for. The value can be custom or one of these predefined values: * `friend` * `date` * `relationship` * `networking`

6922

},

6923

],

6924

"relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship statuses.

6925

{ # **DEPRECATED**: No data will be returned A person's relationship status.

6926

"formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

6927

"metadata": { # Metadata about a field. # Metadata about the relationship status.

6928

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

6929

"source": { # The source of a field. # The source of the field.

6930

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

6931

"id": "A String", # The unique identifier within the source type generated by the server.

6932

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

6933

"objectType": "A String", # Output only. The profile object type.

6934

"userTypes": [ # Output only. The user types.

6935

"A String",

6936

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

6937

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6938

"type": "A String", # The source type.

6939

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

6940

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6941

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

6942

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6943

"value": "A String", # The relationship status. The value can be custom or one of these predefined values: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion`

6944

},

6945

],

6946

"residences": [ # **DEPRECATED**: (Please use `person.locations` instead) The person's residences.

6947

{ # **DEPRECATED**: Please use `person.locations` instead. A person's past or current residence.

6948

"current": True or False, # True if the residence is the person's current residence; false if the residence is a past residence.

6949

"metadata": { # Metadata about a field. # Metadata about the residence.

6950

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

6951

"source": { # The source of a field. # The source of the field.

6952

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

6953

"id": "A String", # The unique identifier within the source type generated by the server.

6954

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

6955

"objectType": "A String", # Output only. The profile object type.

6956

"userTypes": [ # Output only. The user types.

6957

"A String",

6958

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

6959

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6960

"type": "A String", # The source type.

6961

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

6962

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6963

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

6964

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6965

"value": "A String", # The address of the residence.

6966

},

6967

],

6968

"resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters, in the form of `people/{person_id}`.

6969

"sipAddresses": [ # The person's SIP addresses.

6970

{ # A person's SIP address. Session Initial Protocol addresses are used for VoIP communications to make voice or video calls over the internet.

6971

"formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

6972

"metadata": { # Metadata about a field. # Metadata about the SIP address.

6973

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

6974

"source": { # The source of a field. # The source of the field.

6975

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

6976

"id": "A String", # The unique identifier within the source type generated by the server.

6977

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

6978

"objectType": "A String", # Output only. The profile object type.

6979

"userTypes": [ # Output only. The user types.

6980

"A String",

6981

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

6982

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6983

"type": "A String", # The source type.

6984

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

6985

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6986

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

6987

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6988

"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`

6989

"value": "A String", # The SIP address in the [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI format.

6990

},

6991

],

6992

"skills": [ # The person's skills.

6993

{ # A skill that the person has.

6994

"metadata": { # Metadata about a field. # Metadata about the skill.

6995

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

6996

"source": { # The source of a field. # The source of the field.

6997

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

6998

"id": "A String", # The unique identifier within the source type generated by the server.

6999

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

7000

"objectType": "A String", # Output only. The profile object type.

7001

"userTypes": [ # Output only. The user types.

7002

"A String",

7003

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

7004

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7005

"type": "A String", # The source type.

7006

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

7007

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7008

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

7009

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7010

"value": "A String", # The skill; for example, `underwater basket weaving`.

7011

},

7012

],

7013

"taglines": [ # Output only. **DEPRECATED**: No data will be returned The person's taglines.

7014

{ # **DEPRECATED**: No data will be returned A brief one-line description of the person.

7015

"metadata": { # Metadata about a field. # Metadata about the tagline.

7016

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

7017

"source": { # The source of a field. # The source of the field.

7018

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

7019

"id": "A String", # The unique identifier within the source type generated by the server.

7020

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

7021

"objectType": "A String", # Output only. The profile object type.

7022

"userTypes": [ # Output only. The user types.

7023

"A String",

7024

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

7025

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7026

"type": "A String", # The source type.

7027

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

7028

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7029

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

7030

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7031

"value": "A String", # The tagline.

7032

},

7033

],

7034

"urls": [ # The person's associated URLs.

7035

{ # A person's associated URLs.

7036

"formattedType": "A String", # Output only. The type of the URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

7037

"metadata": { # Metadata about a field. # Metadata about the URL.

7038

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

7039

"source": { # The source of a field. # The source of the field.

7040

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

7041

"id": "A String", # The unique identifier within the source type generated by the server.

7042

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

7043

"objectType": "A String", # Output only. The profile object type.

7044

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

7049

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

7050

},

7051

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

7052

},

7053

"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 Currents application. * `other`

7054

"value": "A String", # The URL.

7055

},

7056

],

7057

"userDefined": [ # The person's user defined data.

7058

{ # Arbitrary user data that is populated by the end users.

7059

"key": "A String", # The end user specified key of the user defined data.

7060

"metadata": { # Metadata about a field. # Metadata about the user defined data.

7061

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

7062

"source": { # The source of a field. # The source of the field.

7063

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

7064

"id": "A String", # The unique identifier within the source type generated by the server.

7065

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

7066

"objectType": "A String", # Output only. The profile object type.

7067

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

7072

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

7073

},

7074

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

7075

},

7076

"value": "A String", # The end user specified value of the user defined data.

7077

},

7078

],

7079

}</pre>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7080

</div>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7081

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7082

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

7083

<code class="details" id="getBatchGet">getBatchGet(personFields=None, requestMask_includeField=None, resourceNames=None, sources=None, x__xgafv=None)</code>

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

7084

<pre>Provides information about a list of specific people by specifying a list of requested resource names. Use `people/me` to indicate the authenticated user. The request returns a 400 error if 'personFields' is not specified.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7085

7086

Args:

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame]

7087

personFields: string, Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

7088

requestMask_includeField: string, Required. Comma-separated list of person fields to be included in the response. Each path should start with `person.`: for example, `person.names` or `person.photos`.

yoshi-code-bot

50e1b7a

2021-06-03 00:48:27 -0700

[diff] [blame]

7089

resourceNames: string, Required. The resource names of the people to provide information about. It's repeatable. The URL query parameter should be resourceNames=<name1>&resourceNames=<name2>&... - To get information about the authenticated user, specify `people/me`. - To get information about a google account, specify `people/{account_id}`. - To get information about a contact, specify the resource name that identifies the contact as returned by [`people.connections.list`](/people/api/rest/v1/people.connections/list). There is a maximum of 200 resource names. (repeated)

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

7090

sources: string, Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set. (repeated)

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

7091

Allowed values

7092

READ_SOURCE_TYPE_UNSPECIFIED - Unspecified.

7093

READ_SOURCE_TYPE_PROFILE - Returns SourceType.ACCOUNT, SourceType.DOMAIN_PROFILE, and SourceType.PROFILE.

7094

READ_SOURCE_TYPE_CONTACT - Returns SourceType.CONTACT.

7095

READ_SOURCE_TYPE_DOMAIN_CONTACT - Returns SourceType.DOMAIN_CONTACT.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7096

x__xgafv: string, V1 error format.

7097

Allowed values

7098

1 - v1 error format

7099

2 - v2 error format

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7100

7101

Returns:

7102

An object of the form:

7103

7104

{ # The response to a get request for a list of people by resource name.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7105

"responses": [ # The response for each requested resource name.

7106

{ # The response for a single person

7107

"httpStatusCode": 42, # **DEPRECATED** (Please use status instead) [HTTP 1.1 status code] (http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html).

7108

"person": { # Information about a person merged from various data sources such as the authenticated user's contacts and profile data. Most fields can have multiple items. The items in a field have no guaranteed order, but each non-empty field is guaranteed to have exactly one field with `metadata.primary` set to true. # The person.

7109

"addresses": [ # The person's street addresses.

7110

{ # A person's physical address. May be a P.O. box or street address. All fields are optional.

7111

"city": "A String", # The city of the address.

7112

"country": "A String", # The country of the address.

7113

"countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address.

7114

"extendedAddress": "A String", # The extended address of the address; for example, the apartment number.

7115

"formattedType": "A String", # Output only. The type of the address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

7116

"formattedValue": "A String", # The unstructured value of the address. If this is not set by the user it will be automatically constructed from structured values.

7117

"metadata": { # Metadata about a field. # Metadata about the address.

7118

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

7119

"source": { # The source of a field. # The source of the field.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

7120

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

7121

"id": "A String", # The unique identifier within the source type generated by the server.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

7122

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

7123

"objectType": "A String", # Output only. The profile object type.

7124

"userTypes": [ # Output only. The user types.

7125

"A String",

7126

],

7127

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7128

"type": "A String", # The source type.

7129

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

7130

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7131

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

7132

},

7133

"poBox": "A String", # The P.O. box of the address.

7134

"postalCode": "A String", # The postal code of the address.

7135

"region": "A String", # The region of the address; for example, the state or province.

7136

"streetAddress": "A String", # The street address.

7137

"type": "A String", # The type of the address. The type can be custom or one of these predefined values: * `home` * `work` * `other`

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

7138

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7139

],

7140

"ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead) The person's age range.

7141

"ageRanges": [ # Output only. The person's age ranges.

7142

{ # A person's age range.

7143

"ageRange": "A String", # The age range.

7144

"metadata": { # Metadata about a field. # Metadata about the age range.

7145

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

7146

"source": { # The source of a field. # The source of the field.

7147

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

7148

"id": "A String", # The unique identifier within the source type generated by the server.

7149

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

7150

"objectType": "A String", # Output only. The profile object type.

7151

"userTypes": [ # Output only. The user types.

7152

"A String",

7153

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

7154

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7155

"type": "A String", # The source type.

7156

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

7157

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7158

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

7159

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7160

},

7161

],

7162

"biographies": [ # The person's biographies. This field is a singleton for contact sources.

7163

{ # A person's short biography.

7164

"contentType": "A String", # The content type of the biography.

7165

"metadata": { # Metadata about a field. # Metadata about the biography.

7166

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

7167

"source": { # The source of a field. # The source of the field.

7168

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

7169

"id": "A String", # The unique identifier within the source type generated by the server.

7170

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

7171

"objectType": "A String", # Output only. The profile object type.

7172

"userTypes": [ # Output only. The user types.

7173

"A String",

7174

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

7175

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7176

"type": "A String", # The source type.

7177

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

7178

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7179

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

7180

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7181

"value": "A String", # The short biography.

7182

},

7183

],

7184

"birthdays": [ # The person's birthdays. This field is a singleton for contact sources.

7185

{ # A person's birthday. At least one of the `date` and `text` fields are specified. The `date` and `text` fields typically represent the same date, but are not guaranteed to.

7186

"date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The date of the birthday.

7187

"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

7188

"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

7189

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

7190

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7191

"metadata": { # Metadata about a field. # Metadata about the birthday.

7192

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

7193

"source": { # The source of a field. # The source of the field.

7194

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

7195

"id": "A String", # The unique identifier within the source type generated by the server.

7196

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

7197

"objectType": "A String", # Output only. The profile object type.

7198

"userTypes": [ # Output only. The user types.

7199

"A String",

7200

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

7201

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7202

"type": "A String", # The source type.

7203

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

7204

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7205

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

7206

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7207

"text": "A String", # A free-form string representing the user's birthday.

7208

},

7209

],

7210

"braggingRights": [ # **DEPRECATED**: No data will be returned The person's bragging rights.

7211

{ # **DEPRECATED**: No data will be returned A person's bragging rights.

7212

"metadata": { # Metadata about a field. # Metadata about the bragging rights.

7213

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

7214

"source": { # The source of a field. # The source of the field.

7215

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

7216

"id": "A String", # The unique identifier within the source type generated by the server.

7217

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

7218

"objectType": "A String", # Output only. The profile object type.

7219

"userTypes": [ # Output only. The user types.

7220

"A String",

7221

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

7222

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7223

"type": "A String", # The source type.

7224

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

7225

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7226

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

7227

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7228

"value": "A String", # The bragging rights; for example, `climbed mount everest`.

7229

},

7230

],

7231

"calendarUrls": [ # The person's calendar URLs.

7232

{ # A person's calendar URL.

7233

"formattedType": "A String", # Output only. The type of the calendar URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

7234

"metadata": { # Metadata about a field. # Metadata about the calendar URL.

7235

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

7236

"source": { # The source of a field. # The source of the field.

7237

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

7238

"id": "A String", # The unique identifier within the source type generated by the server.

7239

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

7240

"objectType": "A String", # Output only. The profile object type.

7241

"userTypes": [ # Output only. The user types.

7242

"A String",

7243

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

7244

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7245

"type": "A String", # The source type.

7246

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

7247

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7248

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

7249

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7250

"type": "A String", # The type of the calendar URL. The type can be custom or one of these predefined values: * `home` * `freeBusy` * `work`

7251

"url": "A String", # The calendar URL.

7252

},

7253

],

7254

"clientData": [ # The person's client data.

7255

{ # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.

7256

"key": "A String", # The client specified key of the client data.

7257

"metadata": { # Metadata about a field. # Metadata about the client data.

7258

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

7259

"source": { # The source of a field. # The source of the field.

7260

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

7261

"id": "A String", # The unique identifier within the source type generated by the server.

7262

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

7263

"objectType": "A String", # Output only. The profile object type.

7264

"userTypes": [ # Output only. The user types.

7265

"A String",

7266

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

7267

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7268

"type": "A String", # The source type.

7269

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

7270

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7271

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

7272

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7273

"value": "A String", # The client specified value of the client data.

7274

},

7275

],

7276

"coverPhotos": [ # Output only. The person's cover photos.

7277

{ # A person's cover photo. A large image shown on the person's profile page that represents who they are or what they care about.

7278

"default": True or False, # True if the cover photo is the default cover photo; false if the cover photo is a user-provided cover photo.

7279

"metadata": { # Metadata about a field. # Metadata about the cover photo.

7280

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

7281

"source": { # The source of a field. # The source of the field.

7282

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

7283

"id": "A String", # The unique identifier within the source type generated by the server.

7284

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

7285

"objectType": "A String", # Output only. The profile object type.

7286

"userTypes": [ # Output only. The user types.

7287

"A String",

7288

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

7289

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7290

"type": "A String", # The source type.

7291

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

7292

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7293

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

7294

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7295

"url": "A String", # The URL of the cover photo.

7296

},

7297

],

7298

"emailAddresses": [ # The person's email addresses.

7299

{ # A person's email address.

7300

"displayName": "A String", # The display name of the email.

7301

"formattedType": "A String", # Output only. The type of the email address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

7302

"metadata": { # Metadata about a field. # Metadata about the email address.

7303

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

7304

"source": { # The source of a field. # The source of the field.

7305

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

7306

"id": "A String", # The unique identifier within the source type generated by the server.

7307

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

7308

"objectType": "A String", # Output only. The profile object type.

7309

"userTypes": [ # Output only. The user types.

7310

"A String",

7311

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

7312

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7313

"type": "A String", # The source type.

7314

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

7315

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7316

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

7317

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7318

"type": "A String", # The type of the email address. The type can be custom or one of these predefined values: * `home` * `work` * `other`

7319

"value": "A String", # The email address.

7320

},

7321

],

7322

"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.

7323

"events": [ # The person's events.

7324

{ # An event related to the person.

7325

"date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The date of the event.

7326

"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

7327

"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

7328

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

7329

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7330

"formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

7331

"metadata": { # Metadata about a field. # Metadata about the event.

7332

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

7333

"source": { # The source of a field. # The source of the field.

7334

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

7335

"id": "A String", # The unique identifier within the source type generated by the server.

7336

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

7337

"objectType": "A String", # Output only. The profile object type.

7338

"userTypes": [ # Output only. The user types.

7339

"A String",

7340

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

7341

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7342

"type": "A String", # The source type.

7343

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

7344

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7345

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

7346

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7347

"type": "A String", # The type of the event. The type can be custom or one of these predefined values: * `anniversary` * `other`

7348

},

7349

],

7350

"externalIds": [ # The person's external IDs.

7351

{ # An identifier from an external entity related to the person.

7352

"formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

7353

"metadata": { # Metadata about a field. # Metadata about the external ID.

7354

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

7355

"source": { # The source of a field. # The source of the field.

7356

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

7357

"id": "A String", # The unique identifier within the source type generated by the server.

7358

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

7359

"objectType": "A String", # Output only. The profile object type.

7360

"userTypes": [ # Output only. The user types.

7361

"A String",

7362

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

7363

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7364

"type": "A String", # The source type.

7365

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

7366

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7367

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

7368

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7369

"type": "A String", # The type of the external ID. The type can be custom or one of these predefined values: * `account` * `customer` * `loginId` * `network` * `organization`

7370

"value": "A String", # The value of the external ID.

7371

},

7372

],

7373

"fileAses": [ # The person's file-ases.

7374

{ # The name that should be used to sort the person in a list.

7375

"metadata": { # Metadata about a field. # Metadata about the file-as.

7376

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

7377

"source": { # The source of a field. # The source of the field.

7378

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

7379

"id": "A String", # The unique identifier within the source type generated by the server.

7380

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

7381

"objectType": "A String", # Output only. The profile object type.

7382

"userTypes": [ # Output only. The user types.

7383

"A String",

7384

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

7385

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7386

"type": "A String", # The source type.

7387

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

7388

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7389

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

7390

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7391

"value": "A String", # The file-as value

7392

},

7393

],

7394

"genders": [ # The person's genders. This field is a singleton for contact sources.

7395

{ # A person's gender.

7396

"addressMeAs": "A String", # The type of pronouns that should be used to address the person. The value can be custom or one of these predefined values: * `male` * `female` * `other`

7397

"formattedValue": "A String", # Output only. The value of the gender translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. Unspecified or custom value are not localized.

7398

"metadata": { # Metadata about a field. # Metadata about the gender.

7399

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

7400

"source": { # The source of a field. # The source of the field.

7401

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

7402

"id": "A String", # The unique identifier within the source type generated by the server.

7403

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

7404

"objectType": "A String", # Output only. The profile object type.

7405

"userTypes": [ # Output only. The user types.

7406

"A String",

7407

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

7408

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7409

"type": "A String", # The source type.

7410

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

7411

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7412

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

7413

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7414

"value": "A String", # The gender for the person. The gender can be custom or one of these predefined values: * `male` * `female` * `unspecified`

7415

},

7416

],

7417

"imClients": [ # The person's instant messaging clients.

7418

{ # A person's instant messaging client.

7419

"formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

7420

"formattedType": "A String", # Output only. The type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

7421

"metadata": { # Metadata about a field. # Metadata about the IM client.

7422

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

7423

"source": { # The source of a field. # The source of the field.

7424

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

7425

"id": "A String", # The unique identifier within the source type generated by the server.

7426

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

7427

"objectType": "A String", # Output only. The profile object type.

7428

"userTypes": [ # Output only. The user types.

7429

"A String",

7430

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

7431

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7432

"type": "A String", # The source type.

7433

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

7434

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7435

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

7436

},

7437

"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`

7438

"type": "A String", # The type of the IM client. The type can be custom or one of these predefined values: * `home` * `work` * `other`

7439

"username": "A String", # The user name used in the IM client.

7440

},

7441

],

7442

"interests": [ # The person's interests.

7443

{ # One of the person's interests.

7444

"metadata": { # Metadata about a field. # Metadata about the interest.

7445

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

7446

"source": { # The source of a field. # The source of the field.

7447

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

7448

"id": "A String", # The unique identifier within the source type generated by the server.

7449

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

7450

"objectType": "A String", # Output only. The profile object type.

7451

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

7456

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

7457

},

7458

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

7459

},

7460

"value": "A String", # The interest; for example, `stargazing`.

7461

},

7462

],

7463

"locales": [ # The person's locale preferences.

7464

{ # A person's locale preference.

7465

"metadata": { # Metadata about a field. # Metadata about the locale.

7466

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

7467

"source": { # The source of a field. # The source of the field.

7468

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

7469

"id": "A String", # The unique identifier within the source type generated by the server.

7470

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

7471

"objectType": "A String", # Output only. The profile object type.

7472

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

7477

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

7478

},

7479

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

7480

},

7481

"value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag representing the locale.

7482

},

7483

],

7484

"locations": [ # The person's locations.

7485

{ # A person's location.

7486

"buildingId": "A String", # The building identifier.

7487

"current": True or False, # Whether the location is the current location.

7488

"deskCode": "A String", # The individual desk location.

7489

"floor": "A String", # The floor name or number.

7490

"floorSection": "A String", # The floor section in `floor_name`.

7491

"metadata": { # Metadata about a field. # Metadata about the location.

7492

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

7493

"source": { # The source of a field. # The source of the field.

7494

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

7495

"id": "A String", # The unique identifier within the source type generated by the server.

7496

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

7497

"objectType": "A String", # Output only. The profile object type.

7498

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

7503

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

7504

},

7505

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

7506

},

7507

"type": "A String", # The type of the location. The type can be custom or one of these predefined values: * `desk` * `grewUp`

7508

"value": "A String", # The free-form value of the location.

7509

},

7510

],

7511

"memberships": [ # The person's group memberships.

7512

{ # A person's membership in a group. Only contact group memberships can be modified.

7513

"contactGroupMembership": { # A Google contact group membership. # The contact group membership.

7514

"contactGroupId": "A String", # Output only. The contact group ID for the contact group membership.

7515

"contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`. Only contact_group_resource_name can be used for modifying memberships. Any contact group membership can be removed, but only user group or "myContacts" or "starred" system groups memberships can be added. A contact must always have at least one contact group membership.

7516

},

7517

"domainMembership": { # A G Suite Domain membership. # Output only. The domain membership.

7518

"inViewerDomain": True or False, # True if the person is in the viewer's G Suite domain.

7519

},

7520

"metadata": { # Metadata about a field. # Metadata about the membership.

7521

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

7522

"source": { # The source of a field. # The source of the field.

7523

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

7524

"id": "A String", # The unique identifier within the source type generated by the server.

7525

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

7526

"objectType": "A String", # Output only. The profile object type.

7527

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

7532

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

7533

},

7534

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

},

},

],

"metadata": { # The metadata about a person. # Output only. Metadata about the person.

7539

"deleted": True or False, # Output only. True if the person resource has been deleted. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token.

7540

"linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.

7541

"A String",

7542

],

7543

"objectType": "A String", # Output only. **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object.

7544

"previousResourceNames": [ # Output only. Any former resource names this person has had. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token. The resource name may change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or profile URL.

7545

"A String",

7546

],

7547

"sources": [ # The sources of data for the person.

7548

{ # The source of a field.

7549

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

7550

"id": "A String", # The unique identifier within the source type generated by the server.

7551

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

7552

"objectType": "A String", # Output only. The profile object type.

7553

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

7558

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

7559

},

7560

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

7561

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7562

"miscKeywords": [ # The person's miscellaneous keywords.

7563

{ # A person's miscellaneous keyword.

7564

"formattedType": "A String", # Output only. The type of the miscellaneous keyword translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

7565

"metadata": { # Metadata about a field. # Metadata about the miscellaneous keyword.

7566

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

7567

"source": { # The source of a field. # The source of the field.

7568

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

7569

"id": "A String", # The unique identifier within the source type generated by the server.

7570

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

7571

"objectType": "A String", # Output only. The profile object type.

7572

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

7577

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

7578

},

7579

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

7580

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7581

"type": "A String", # The miscellaneous keyword type.

7582

"value": "A String", # The value of the miscellaneous keyword.

7583

},

7584

],

7585

"names": [ # The person's names. This field is a singleton for contact sources.

7586

{ # A person's name. If the name is a mononym, the family name is empty.

7587

"displayName": "A String", # Output only. The display name formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.

7588

"displayNameLastFirst": "A String", # Output only. The display name with the last name first formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.

7589

"familyName": "A String", # The family name.

7590

"givenName": "A String", # The given name.

7591

"honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`

7592

"honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`

7593

"metadata": { # Metadata about a field. # Metadata about the name.

7594

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

7595

"source": { # The source of a field. # The source of the field.

7596

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

7597

"id": "A String", # The unique identifier within the source type generated by the server.

7598

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

7599

"objectType": "A String", # Output only. The profile object type.

7600

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

7605

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

7606

},

7607

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

7608

},

7609

"middleName": "A String", # The middle name(s).

7610

"phoneticFamilyName": "A String", # The family name spelled as it sounds.

7611

"phoneticFullName": "A String", # The full name spelled as it sounds.

7612

"phoneticGivenName": "A String", # The given name spelled as it sounds.

7613

"phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.

7614

"phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.

7615

"phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.

7616

"unstructuredName": "A String", # The free form name value.

7617

},

7618

],

7619

"nicknames": [ # The person's nicknames.

7620

{ # A person's nickname.

7621

"metadata": { # Metadata about a field. # Metadata about the nickname.

7622

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

7623

"source": { # The source of a field. # The source of the field.

7624

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

7625

"id": "A String", # The unique identifier within the source type generated by the server.

7626

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

7627

"objectType": "A String", # Output only. The profile object type.

7628

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

7633

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

7634

},

7635

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

7636

},

7637

"type": "A String", # The type of the nickname.

7638

"value": "A String", # The nickname.

7639

},

7640

],

7641

"occupations": [ # The person's occupations.

7642

{ # A person's occupation.

7643

"metadata": { # Metadata about a field. # Metadata about the occupation.

7644

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

7645

"source": { # The source of a field. # The source of the field.

7646

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

7647

"id": "A String", # The unique identifier within the source type generated by the server.

7648

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

7649

"objectType": "A String", # Output only. The profile object type.

7650

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

7655

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

7656

},

7657

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

7658

},

7659

"value": "A String", # The occupation; for example, `carpenter`.

7660

},

7661

],

7662

"organizations": [ # The person's past or current organizations.

7663

{ # A person's past or current organization. Overlapping date ranges are permitted.

7664

"current": True or False, # True if the organization is the person's current organization; false if the organization is a past organization.

7665

"department": "A String", # The person's department at the organization.

7666

"domain": "A String", # The domain name associated with the organization; for example, `google.com`.

7667

"endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The end date when the person left the organization.

7668

"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

7669

"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

7670

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

7671

},

7672

"formattedType": "A String", # Output only. The type of the organization translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

7673

"jobDescription": "A String", # The person's job description at the organization.

7674

"location": "A String", # The location of the organization office the person works at.

7675

"metadata": { # Metadata about a field. # Metadata about the organization.

7676

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

7677

"source": { # The source of a field. # The source of the field.

7678

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

7679

"id": "A String", # The unique identifier within the source type generated by the server.

7680

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

7681

"objectType": "A String", # Output only. The profile object type.

7682

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

7687

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

7688

},

7689

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

7690

},

7691

"name": "A String", # The name of the organization.

7692

"phoneticName": "A String", # The phonetic name of the organization.

7693

"startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The start date when the person joined the organization.

7694

"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

7695

"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

7696

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

7697

},

7698

"symbol": "A String", # The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym.

7699

"title": "A String", # The person's job title at the organization.

7700

"type": "A String", # The type of the organization. The type can be custom or one of these predefined values: * `work` * `school`

7701

},

7702

],

7703

"phoneNumbers": [ # The person's phone numbers.

7704

{ # A person's phone number.

7705

"canonicalForm": "A String", # Output only. The canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number.

7706

"formattedType": "A String", # Output only. The type of the phone number translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

7707

"metadata": { # Metadata about a field. # Metadata about the phone number.

7708

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

7709

"source": { # The source of a field. # The source of the field.

7710

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

7711

"id": "A String", # The unique identifier within the source type generated by the server.

7712

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

7713

"objectType": "A String", # Output only. The profile object type.

7714

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

7719

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

7720

},

7721

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

7722

},

7723

"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`

7724

"value": "A String", # The phone number.

7725

},

7726

],

7727

"photos": [ # Output only. The person's photos.

7728

{ # A person's photo. A picture shown next to the person's name to help others recognize the person.

7729

"default": True or False, # True if the photo is a default photo; false if the photo is a user-provided photo.

7730

"metadata": { # Metadata about a field. # Metadata about the photo.

7731

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

7732

"source": { # The source of a field. # The source of the field.

7733

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

7734

"id": "A String", # The unique identifier within the source type generated by the server.

7735

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

7736

"objectType": "A String", # Output only. The profile object type.

7737

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

7742

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

7743

},

7744

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

7745

},

7746

"url": "A String", # The URL of the photo. You can change the desired size by appending a query parameter `sz={size}` at the end of the url, where {size} is the size in pixels. Example: https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50

7747

},

7748

],

7749

"relations": [ # The person's relations.

7750

{ # A person's relation to another person.

7751

"formattedType": "A String", # Output only. The type of the relation translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.

7752

"metadata": { # Metadata about a field. # Metadata about the relation.

7753

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

7754

"source": { # The source of a field. # The source of the field.

7755

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

7756

"id": "A String", # The unique identifier within the source type generated by the server.

7757

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

7758

"objectType": "A String", # Output only. The profile object type.

7759

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

7764

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

7765

},

7766

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

7767

},

7768

"person": "A String", # The name of the other person this relation refers to.

7769

"type": "A String", # The person's relation to the other person. The type can be custom or one of these predefined values: * `spouse` * `child` * `mother` * `father` * `parent` * `brother` * `sister` * `friend` * `relative` * `domesticPartner` * `manager` * `assistant` * `referredBy` * `partner`

7770

},

7771

],

7772

"relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship interests.

7773

{ # **DEPRECATED**: No data will be returned A person's relationship interest .

7774

"formattedValue": "A String", # Output only. The value of the relationship interest translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.

7775

"metadata": { # Metadata about a field. # Metadata about the relationship interest.

7776

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

7777

"source": { # The source of a field. # The source of the field.

7778

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

7779

"id": "A String", # The unique identifier within the source type generated by the server.

7780

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

7781

"objectType": "A String", # Output only. The profile object type.

7782

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

7787

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

7788

},

7789

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

7790

},

7791

"value": "A String", # The kind of relationship the person is looking for. The value can be custom or one of these predefined values: * `friend` * `date` * `relationship` * `networking`

7792

},

7793

],

7794

"relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship statuses.

7795

{ # **DEPRECATED**: No data will be returned A person's relationship status.

7796

"formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

7797

"metadata": { # Metadata about a field. # Metadata about the relationship status.

7798

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

7799

"source": { # The source of a field. # The source of the field.

7800

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

7801

"id": "A String", # The unique identifier within the source type generated by the server.

7802

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

7803

"objectType": "A String", # Output only. The profile object type.

7804

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

7809

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

7810

},

7811

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

7812

},

7813

"value": "A String", # The relationship status. The value can be custom or one of these predefined values: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion`

7814

},

7815

],

7816

"residences": [ # **DEPRECATED**: (Please use `person.locations` instead) The person's residences.

7817

{ # **DEPRECATED**: Please use `person.locations` instead. A person's past or current residence.

7818

"current": True or False, # True if the residence is the person's current residence; false if the residence is a past residence.

7819

"metadata": { # Metadata about a field. # Metadata about the residence.

7820

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

7821

"source": { # The source of a field. # The source of the field.

7822

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

7823

"id": "A String", # The unique identifier within the source type generated by the server.

7824

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

7825

"objectType": "A String", # Output only. The profile object type.

7826

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

7831

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

7832

},

7833

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

7834

},

7835

"value": "A String", # The address of the residence.

7836

},

7837

],

7838

"resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters, in the form of `people/{person_id}`.

7839

"sipAddresses": [ # The person's SIP addresses.

7840

{ # A person's SIP address. Session Initial Protocol addresses are used for VoIP communications to make voice or video calls over the internet.

7841

"formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

7842

"metadata": { # Metadata about a field. # Metadata about the SIP address.

7843

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

7844

"source": { # The source of a field. # The source of the field.

7845

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

7846

"id": "A String", # The unique identifier within the source type generated by the server.

7847

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

7848

"objectType": "A String", # Output only. The profile object type.

7849

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

7854

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

7855

},

7856

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

7857

},

7858

"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`

7859

"value": "A String", # The SIP address in the [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI format.

7860

},

7861

],

7862

"skills": [ # The person's skills.

7863

{ # A skill that the person has.

7864

"metadata": { # Metadata about a field. # Metadata about the skill.

7865

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

7866

"source": { # The source of a field. # The source of the field.

7867

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

7868

"id": "A String", # The unique identifier within the source type generated by the server.

7869

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

7870

"objectType": "A String", # Output only. The profile object type.

7871

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

7876

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

7877

},

7878

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

7879

},

7880

"value": "A String", # The skill; for example, `underwater basket weaving`.

7881

},

7882

],

7883

"taglines": [ # Output only. **DEPRECATED**: No data will be returned The person's taglines.

7884

{ # **DEPRECATED**: No data will be returned A brief one-line description of the person.

7885

"metadata": { # Metadata about a field. # Metadata about the tagline.

7886

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

7887

"source": { # The source of a field. # The source of the field.

7888

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

7889

"id": "A String", # The unique identifier within the source type generated by the server.

7890

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

7891

"objectType": "A String", # Output only. The profile object type.

7892

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

7897

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

7898

},

7899

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

7900

},

7901

"value": "A String", # The tagline.

7902

},

7903

],

7904

"urls": [ # The person's associated URLs.

7905

{ # A person's associated URLs.

7906

"formattedType": "A String", # Output only. The type of the URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

7907

"metadata": { # Metadata about a field. # Metadata about the URL.

7908

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

7909

"source": { # The source of a field. # The source of the field.

7910

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

7911

"id": "A String", # The unique identifier within the source type generated by the server.

7912

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

7913

"objectType": "A String", # Output only. The profile object type.

7914

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

7919

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

7920

},

7921

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

7922

},

7923

"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 Currents application. * `other`

7924

"value": "A String", # The URL.

7925

},

7926

],

7927

"userDefined": [ # The person's user defined data.

7928

{ # Arbitrary user data that is populated by the end users.

7929

"key": "A String", # The end user specified key of the user defined data.

7930

"metadata": { # Metadata about a field. # Metadata about the user defined data.

7931

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

7932

"source": { # The source of a field. # The source of the field.

7933

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

7934

"id": "A String", # The unique identifier within the source type generated by the server.

7935

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

7936

"objectType": "A String", # Output only. The profile object type.

7937

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

7942

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

7943

},

7944

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

7945

},

7946

"value": "A String", # The end user specified value of the user defined data.

7947

},

7948

],

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7949

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7950

"requestedResourceName": "A String", # The original requested resource name. May be different than the resource name on the returned person. The resource name can change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or a profile URL.

7951

"status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The status of the response.

7952

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

7953

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

7954

{

7955

"a_key": "", # Properties of the object. Contains field @type with type URL.

7956

},

7957

],

7958

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

},

},

],

}</pre>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

</div>

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7966

<code class="details" id="listDirectoryPeople">listDirectoryPeople(mergeSources=None, pageSize=None, pageToken=None, readMask=None, requestSyncToken=None, sources=None, syncToken=None, x__xgafv=None)</code>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

7967

<pre>Provides a list of domain profiles and domain contacts in the authenticated user's domain directory.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7968

7969

Args:

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7970

mergeSources: string, Optional. Additional data to merge into the directory sources if they are connected through verified join keys such as email addresses or phone numbers. (repeated)

7971

Allowed values

7972

DIRECTORY_MERGE_SOURCE_TYPE_UNSPECIFIED - Unspecified.

7973

DIRECTORY_MERGE_SOURCE_TYPE_CONTACT - User owned contact.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

7974

pageSize: integer, Optional. The number of people to include in the response. Valid values are between 1 and 1000, inclusive. Defaults to 100 if not set or set to 0.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7975

pageToken: string, Optional. A page token, received from a previous `ListDirectoryPeople` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDirectoryPeople` must match the call that provided the page token.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

7976

readMask: string, Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined

7977

requestSyncToken: boolean, Optional. Whether the response should include `next_sync_token`, which can be used to get all changes since the last request. For subsequent sync requests use the `sync_token` param instead.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

7978

sources: string, Required. Directory sources to return. (repeated)

7979

Allowed values

7980

DIRECTORY_SOURCE_TYPE_UNSPECIFIED - Unspecified.

7981

DIRECTORY_SOURCE_TYPE_DOMAIN_CONTACT - G Suite domain shared contact.

7982

DIRECTORY_SOURCE_TYPE_DOMAIN_PROFILE - G Suite domain profile.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7983

syncToken: string, Optional. A sync token, received from a previous `ListDirectoryPeople` call. Provide this to retrieve only the resources changed since the last request. When syncing, all other parameters provided to `ListDirectoryPeople` must match the call that provided the sync token.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7984

x__xgafv: string, V1 error format.

7985

Allowed values

7986

1 - v1 error format

7987

2 - v2 error format

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7988

7989

Returns:

7990

An object of the form:

7991

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

7992

{ # The response to a request for the authenticated user's domain directory.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7993

"nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.

7994

"nextSyncToken": "A String", # A token, which can be sent as `sync_token` to retrieve changes since the last request. Request must set `request_sync_token` to return the sync token.

7995

"people": [ # The list of people in the domain directory.

7996

{ # Information about a person merged from various data sources such as the authenticated user's contacts and profile data. Most fields can have multiple items. The items in a field have no guaranteed order, but each non-empty field is guaranteed to have exactly one field with `metadata.primary` set to true.

7997

"addresses": [ # The person's street addresses.

7998

{ # A person's physical address. May be a P.O. box or street address. All fields are optional.

7999

"city": "A String", # The city of the address.

8000

"country": "A String", # The country of the address.

8001

"countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address.

8002

"extendedAddress": "A String", # The extended address of the address; for example, the apartment number.

8003

"formattedType": "A String", # Output only. The type of the address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

8004

"formattedValue": "A String", # The unstructured value of the address. If this is not set by the user it will be automatically constructed from structured values.

8005

"metadata": { # Metadata about a field. # Metadata about the address.

8006

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

8007

"source": { # The source of a field. # The source of the field.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

8008

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

8009

"id": "A String", # The unique identifier within the source type generated by the server.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

8010

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

8011

"objectType": "A String", # Output only. The profile object type.

8012

"userTypes": [ # Output only. The user types.

8013

"A String",

8014

],

8015

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

8016

"type": "A String", # The source type.

8017

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

8018

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

8019

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

8020

},

8021

"poBox": "A String", # The P.O. box of the address.

8022

"postalCode": "A String", # The postal code of the address.

8023

"region": "A String", # The region of the address; for example, the state or province.

8024

"streetAddress": "A String", # The street address.

8025

"type": "A String", # The type of the address. The type can be custom or one of these predefined values: * `home` * `work` * `other`

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

8026

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

8027

],

8028

"ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead) The person's age range.

8029

"ageRanges": [ # Output only. The person's age ranges.

8030

{ # A person's age range.

8031

"ageRange": "A String", # The age range.

8032

"metadata": { # Metadata about a field. # Metadata about the age range.

8033

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

8034

"source": { # The source of a field. # The source of the field.

8035

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

8036

"id": "A String", # The unique identifier within the source type generated by the server.

8037

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

8038

"objectType": "A String", # Output only. The profile object type.

8039

"userTypes": [ # Output only. The user types.

8040

"A String",

8041

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

8042

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

8043

"type": "A String", # The source type.

8044

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

8045

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

8046

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

8047

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

8048

},

8049

],

8050

"biographies": [ # The person's biographies. This field is a singleton for contact sources.

8051

{ # A person's short biography.

8052

"contentType": "A String", # The content type of the biography.

8053

"metadata": { # Metadata about a field. # Metadata about the biography.

8054

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

8055

"source": { # The source of a field. # The source of the field.

8056

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

8057

"id": "A String", # The unique identifier within the source type generated by the server.

8058

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

8059

"objectType": "A String", # Output only. The profile object type.

8060

"userTypes": [ # Output only. The user types.

8061

"A String",

8062

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

8063

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

8064

"type": "A String", # The source type.

8065

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

8066

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

8067

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

8068

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

8069

"value": "A String", # The short biography.

8070

},

8071

],

8072

"birthdays": [ # The person's birthdays. This field is a singleton for contact sources.

8073

{ # A person's birthday. At least one of the `date` and `text` fields are specified. The `date` and `text` fields typically represent the same date, but are not guaranteed to.

8074

"date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The date of the birthday.

8075

"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

8076

"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

8077

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

8078

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

8079

"metadata": { # Metadata about a field. # Metadata about the birthday.

8080

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

8081

"source": { # The source of a field. # The source of the field.

8082

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

8083

"id": "A String", # The unique identifier within the source type generated by the server.

8084

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

8085

"objectType": "A String", # Output only. The profile object type.

8086

"userTypes": [ # Output only. The user types.

8087

"A String",

8088

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

8089

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

8090

"type": "A String", # The source type.

8091

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

8092

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

8093

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

8094

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

8095

"text": "A String", # A free-form string representing the user's birthday.

8096

},

8097

],

8098

"braggingRights": [ # **DEPRECATED**: No data will be returned The person's bragging rights.

8099

{ # **DEPRECATED**: No data will be returned A person's bragging rights.

8100

"metadata": { # Metadata about a field. # Metadata about the bragging rights.

8101

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

8102

"source": { # The source of a field. # The source of the field.

8103

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

8104

"id": "A String", # The unique identifier within the source type generated by the server.

8105

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

8106

"objectType": "A String", # Output only. The profile object type.

8107

"userTypes": [ # Output only. The user types.

8108

"A String",

8109

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

8110

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

8111

"type": "A String", # The source type.

8112

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

8113

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

8114

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

8115

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

8116

"value": "A String", # The bragging rights; for example, `climbed mount everest`.

8117

},

8118

],

8119

"calendarUrls": [ # The person's calendar URLs.

8120

{ # A person's calendar URL.

8121

"formattedType": "A String", # Output only. The type of the calendar URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

8122

"metadata": { # Metadata about a field. # Metadata about the calendar URL.

8123

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

8124

"source": { # The source of a field. # The source of the field.

8125

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

8126

"id": "A String", # The unique identifier within the source type generated by the server.

8127

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

8128

"objectType": "A String", # Output only. The profile object type.

8129

"userTypes": [ # Output only. The user types.

8130

"A String",

8131

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

8132

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

8133

"type": "A String", # The source type.

8134

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

8135

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

8136

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

8137

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

8138

"type": "A String", # The type of the calendar URL. The type can be custom or one of these predefined values: * `home` * `freeBusy` * `work`

8139

"url": "A String", # The calendar URL.

8140

},

8141

],

8142

"clientData": [ # The person's client data.

8143

{ # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.

8144

"key": "A String", # The client specified key of the client data.

8145

"metadata": { # Metadata about a field. # Metadata about the client data.

8146

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

8147

"source": { # The source of a field. # The source of the field.

8148

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

8149

"id": "A String", # The unique identifier within the source type generated by the server.

8150

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

8151

"objectType": "A String", # Output only. The profile object type.

8152

"userTypes": [ # Output only. The user types.

8153

"A String",

8154

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

8155

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

8156

"type": "A String", # The source type.

8157

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

8158

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

8159

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

8160

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

8161

"value": "A String", # The client specified value of the client data.

8162

},

8163

],

8164

"coverPhotos": [ # Output only. The person's cover photos.

8165

{ # A person's cover photo. A large image shown on the person's profile page that represents who they are or what they care about.

8166

"default": True or False, # True if the cover photo is the default cover photo; false if the cover photo is a user-provided cover photo.

8167

"metadata": { # Metadata about a field. # Metadata about the cover photo.

8168

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

8169

"source": { # The source of a field. # The source of the field.

8170

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

8171

"id": "A String", # The unique identifier within the source type generated by the server.

8172

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

8173

"objectType": "A String", # Output only. The profile object type.

8174

"userTypes": [ # Output only. The user types.

8175

"A String",

8176

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

8177

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

8178

"type": "A String", # The source type.

8179

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

8180

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

8181

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

8182

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

8183

"url": "A String", # The URL of the cover photo.

8184

},

8185

],

8186

"emailAddresses": [ # The person's email addresses.

8187

{ # A person's email address.

8188

"displayName": "A String", # The display name of the email.

8189

"formattedType": "A String", # Output only. The type of the email address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

8190

"metadata": { # Metadata about a field. # Metadata about the email address.

8191

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

8192

"source": { # The source of a field. # The source of the field.

8193

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

8194

"id": "A String", # The unique identifier within the source type generated by the server.

8195

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

8196

"objectType": "A String", # Output only. The profile object type.

8197

"userTypes": [ # Output only. The user types.

8198

"A String",

8199

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

8200

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

8201

"type": "A String", # The source type.

8202

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

8203

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

8204

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

8205

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

8206

"type": "A String", # The type of the email address. The type can be custom or one of these predefined values: * `home` * `work` * `other`

8207

"value": "A String", # The email address.

8208

},

8209

],

8210

"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.

8211

"events": [ # The person's events.

8212

{ # An event related to the person.

8213

"date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The date of the event.

8214

"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

8215

"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

8216

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

8217

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

8218

"formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

8219

"metadata": { # Metadata about a field. # Metadata about the event.

8220

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

8221

"source": { # The source of a field. # The source of the field.

8222

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

8223

"id": "A String", # The unique identifier within the source type generated by the server.

8224

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

8225

"objectType": "A String", # Output only. The profile object type.

8226

"userTypes": [ # Output only. The user types.

8227

"A String",

8228

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

8229

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

8230

"type": "A String", # The source type.

8231

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

8232

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

8233

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

8234

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

8235

"type": "A String", # The type of the event. The type can be custom or one of these predefined values: * `anniversary` * `other`

8236

},

8237

],

8238

"externalIds": [ # The person's external IDs.

8239

{ # An identifier from an external entity related to the person.

8240

"formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

8241

"metadata": { # Metadata about a field. # Metadata about the external ID.

8242

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

8243

"source": { # The source of a field. # The source of the field.

8244

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

8245

"id": "A String", # The unique identifier within the source type generated by the server.

8246

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

8247

"objectType": "A String", # Output only. The profile object type.

8248

"userTypes": [ # Output only. The user types.

8249

"A String",

8250

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

8251

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

8252

"type": "A String", # The source type.

8253

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

8254

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

8255

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

8256

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

8257

"type": "A String", # The type of the external ID. The type can be custom or one of these predefined values: * `account` * `customer` * `loginId` * `network` * `organization`

8258

"value": "A String", # The value of the external ID.

8259

},

8260

],

8261

"fileAses": [ # The person's file-ases.

8262

{ # The name that should be used to sort the person in a list.

8263

"metadata": { # Metadata about a field. # Metadata about the file-as.

8264

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

8265

"source": { # The source of a field. # The source of the field.

8266

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

8267

"id": "A String", # The unique identifier within the source type generated by the server.

8268

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

8269

"objectType": "A String", # Output only. The profile object type.

8270

"userTypes": [ # Output only. The user types.

8271

"A String",

8272

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

8273

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

8274

"type": "A String", # The source type.

8275

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

8276

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

8277

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

8278

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

8279

"value": "A String", # The file-as value

8280

},

8281

],

8282

"genders": [ # The person's genders. This field is a singleton for contact sources.

8283

{ # A person's gender.

8284

"addressMeAs": "A String", # The type of pronouns that should be used to address the person. The value can be custom or one of these predefined values: * `male` * `female` * `other`

8285

"formattedValue": "A String", # Output only. The value of the gender translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. Unspecified or custom value are not localized.

8286

"metadata": { # Metadata about a field. # Metadata about the gender.

8287

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

8288

"source": { # The source of a field. # The source of the field.

8289

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

8290

"id": "A String", # The unique identifier within the source type generated by the server.

8291

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

8292

"objectType": "A String", # Output only. The profile object type.

8293

"userTypes": [ # Output only. The user types.

8294

"A String",

8295

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

8296

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

8297

"type": "A String", # The source type.

8298

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

8299

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

8300

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

8301

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

8302

"value": "A String", # The gender for the person. The gender can be custom or one of these predefined values: * `male` * `female` * `unspecified`

8303

},

8304

],

8305

"imClients": [ # The person's instant messaging clients.

8306

{ # A person's instant messaging client.

8307

"formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

8308

"formattedType": "A String", # Output only. The type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

8309

"metadata": { # Metadata about a field. # Metadata about the IM client.

8310

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

8311

"source": { # The source of a field. # The source of the field.

8312

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

8313

"id": "A String", # The unique identifier within the source type generated by the server.

8314

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

8315

"objectType": "A String", # Output only. The profile object type.

8316

"userTypes": [ # Output only. The user types.

8317

"A String",

8318

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

8319

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

8320

"type": "A String", # The source type.

8321

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

8322

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

8323

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

8324

},

8325

"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`

8326

"type": "A String", # The type of the IM client. The type can be custom or one of these predefined values: * `home` * `work` * `other`

8327

"username": "A String", # The user name used in the IM client.

8328

},

8329

],

8330

"interests": [ # The person's interests.

8331

{ # One of the person's interests.

8332

"metadata": { # Metadata about a field. # Metadata about the interest.

8333

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

8334

"source": { # The source of a field. # The source of the field.

8335

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

8336

"id": "A String", # The unique identifier within the source type generated by the server.

8337

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

8338

"objectType": "A String", # Output only. The profile object type.

8339

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

8344

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

8345

},

8346

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

8347

},

8348

"value": "A String", # The interest; for example, `stargazing`.

8349

},

8350

],

8351

"locales": [ # The person's locale preferences.

8352

{ # A person's locale preference.

8353

"metadata": { # Metadata about a field. # Metadata about the locale.

8354

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

8355

"source": { # The source of a field. # The source of the field.

8356

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

8357

"id": "A String", # The unique identifier within the source type generated by the server.

8358

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

8359

"objectType": "A String", # Output only. The profile object type.

8360

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

8365

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

8366

},

8367

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

8368

},

8369

"value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag representing the locale.

8370

},

8371

],

8372

"locations": [ # The person's locations.

8373

{ # A person's location.

8374

"buildingId": "A String", # The building identifier.

8375

"current": True or False, # Whether the location is the current location.

8376

"deskCode": "A String", # The individual desk location.

8377

"floor": "A String", # The floor name or number.

8378

"floorSection": "A String", # The floor section in `floor_name`.

8379

"metadata": { # Metadata about a field. # Metadata about the location.

8380

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

8381

"source": { # The source of a field. # The source of the field.

8382

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

8383

"id": "A String", # The unique identifier within the source type generated by the server.

8384

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

8385

"objectType": "A String", # Output only. The profile object type.

8386

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

8391

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

8392

},

8393

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

8394

},

8395

"type": "A String", # The type of the location. The type can be custom or one of these predefined values: * `desk` * `grewUp`

8396

"value": "A String", # The free-form value of the location.

8397

},

8398

],

8399

"memberships": [ # The person's group memberships.

8400

{ # A person's membership in a group. Only contact group memberships can be modified.

8401

"contactGroupMembership": { # A Google contact group membership. # The contact group membership.

8402

"contactGroupId": "A String", # Output only. The contact group ID for the contact group membership.

8403

"contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`. Only contact_group_resource_name can be used for modifying memberships. Any contact group membership can be removed, but only user group or "myContacts" or "starred" system groups memberships can be added. A contact must always have at least one contact group membership.

8404

},

8405

"domainMembership": { # A G Suite Domain membership. # Output only. The domain membership.

8406

"inViewerDomain": True or False, # True if the person is in the viewer's G Suite domain.

8407

},

8408

"metadata": { # Metadata about a field. # Metadata about the membership.

8409

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

8410

"source": { # The source of a field. # The source of the field.

8411

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

8412

"id": "A String", # The unique identifier within the source type generated by the server.

8413

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

8414

"objectType": "A String", # Output only. The profile object type.

8415

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

8420

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

8421

},

8422

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

},

},

],

"metadata": { # The metadata about a person. # Output only. Metadata about the person.

8427

"deleted": True or False, # Output only. True if the person resource has been deleted. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token.

8428

"linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.

8429

"A String",

8430

],

8431

"objectType": "A String", # Output only. **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object.

8432

"previousResourceNames": [ # Output only. Any former resource names this person has had. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token. The resource name may change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or profile URL.

8433

"A String",

8434

],

8435

"sources": [ # The sources of data for the person.

8436

{ # The source of a field.

8437

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

8438

"id": "A String", # The unique identifier within the source type generated by the server.

8439

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

8440

"objectType": "A String", # Output only. The profile object type.

8441

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

8446

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

8447

},

8448

],

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

8449

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

8450

"miscKeywords": [ # The person's miscellaneous keywords.

8451

{ # A person's miscellaneous keyword.

8452

"formattedType": "A String", # Output only. The type of the miscellaneous keyword translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

8453

"metadata": { # Metadata about a field. # Metadata about the miscellaneous keyword.

8454

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

8455

"source": { # The source of a field. # The source of the field.

8456

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

8457

"id": "A String", # The unique identifier within the source type generated by the server.

8458

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

8459

"objectType": "A String", # Output only. The profile object type.

8460

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

8465

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

8466

},

8467

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

8468

},

8469

"type": "A String", # The miscellaneous keyword type.

8470

"value": "A String", # The value of the miscellaneous keyword.

8471

},

8472

],

8473

"names": [ # The person's names. This field is a singleton for contact sources.

8474

{ # A person's name. If the name is a mononym, the family name is empty.

8475

"displayName": "A String", # Output only. The display name formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.

8476

"displayNameLastFirst": "A String", # Output only. The display name with the last name first formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.

8477

"familyName": "A String", # The family name.

8478

"givenName": "A String", # The given name.

8479

"honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`

8480

"honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`

8481

"metadata": { # Metadata about a field. # Metadata about the name.

8482

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

8483

"source": { # The source of a field. # The source of the field.

8484

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

8485

"id": "A String", # The unique identifier within the source type generated by the server.

8486

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

8487

"objectType": "A String", # Output only. The profile object type.

8488

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

8493

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

8494

},

8495

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

8496

},

8497

"middleName": "A String", # The middle name(s).

8498

"phoneticFamilyName": "A String", # The family name spelled as it sounds.

8499

"phoneticFullName": "A String", # The full name spelled as it sounds.

8500

"phoneticGivenName": "A String", # The given name spelled as it sounds.

8501

"phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.

8502

"phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.

8503

"phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.

8504

"unstructuredName": "A String", # The free form name value.

8505

},

8506

],

8507

"nicknames": [ # The person's nicknames.

8508

{ # A person's nickname.

8509

"metadata": { # Metadata about a field. # Metadata about the nickname.

8510

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

8511

"source": { # The source of a field. # The source of the field.

8512

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

8513

"id": "A String", # The unique identifier within the source type generated by the server.

8514

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

8515

"objectType": "A String", # Output only. The profile object type.

8516

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

8521

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

8522

},

8523

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

8524

},

8525

"type": "A String", # The type of the nickname.

8526

"value": "A String", # The nickname.

8527

},

8528

],

8529

"occupations": [ # The person's occupations.

8530

{ # A person's occupation.

8531

"metadata": { # Metadata about a field. # Metadata about the occupation.

8532

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

8533

"source": { # The source of a field. # The source of the field.

8534

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

8535

"id": "A String", # The unique identifier within the source type generated by the server.

8536

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

8537

"objectType": "A String", # Output only. The profile object type.

8538

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

8543

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

8544

},

8545

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

8546

},

8547

"value": "A String", # The occupation; for example, `carpenter`.

8548

},

8549

],

8550

"organizations": [ # The person's past or current organizations.

8551

{ # A person's past or current organization. Overlapping date ranges are permitted.

8552

"current": True or False, # True if the organization is the person's current organization; false if the organization is a past organization.

8553

"department": "A String", # The person's department at the organization.

8554

"domain": "A String", # The domain name associated with the organization; for example, `google.com`.

8555

"endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The end date when the person left the organization.

8556

"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

8557

"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

8558

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

8559

},

8560

"formattedType": "A String", # Output only. The type of the organization translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

8561

"jobDescription": "A String", # The person's job description at the organization.

8562

"location": "A String", # The location of the organization office the person works at.

8563

"metadata": { # Metadata about a field. # Metadata about the organization.

8564

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

8565

"source": { # The source of a field. # The source of the field.

8566

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

8567

"id": "A String", # The unique identifier within the source type generated by the server.

8568

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

8569

"objectType": "A String", # Output only. The profile object type.

8570

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

8575

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

8576

},

8577

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

8578

},

8579

"name": "A String", # The name of the organization.

8580

"phoneticName": "A String", # The phonetic name of the organization.

8581

"startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The start date when the person joined the organization.

8582

"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

8583

"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

8584

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

8585

},

8586

"symbol": "A String", # The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym.

8587

"title": "A String", # The person's job title at the organization.

8588

"type": "A String", # The type of the organization. The type can be custom or one of these predefined values: * `work` * `school`

8589

},

8590

],

8591

"phoneNumbers": [ # The person's phone numbers.

8592

{ # A person's phone number.

8593

"canonicalForm": "A String", # Output only. The canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number.

8594

"formattedType": "A String", # Output only. The type of the phone number translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

8595

"metadata": { # Metadata about a field. # Metadata about the phone number.

8596

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

8597

"source": { # The source of a field. # The source of the field.

8598

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

8599

"id": "A String", # The unique identifier within the source type generated by the server.

8600

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

8601

"objectType": "A String", # Output only. The profile object type.

8602

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

8607

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

8608

},

8609

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

8610

},

8611

"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`

8612

"value": "A String", # The phone number.

8613

},

8614

],

8615

"photos": [ # Output only. The person's photos.

8616

{ # A person's photo. A picture shown next to the person's name to help others recognize the person.

8617

"default": True or False, # True if the photo is a default photo; false if the photo is a user-provided photo.

8618

"metadata": { # Metadata about a field. # Metadata about the photo.

8619

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

8620

"source": { # The source of a field. # The source of the field.

8621

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

8622

"id": "A String", # The unique identifier within the source type generated by the server.

8623

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

8624

"objectType": "A String", # Output only. The profile object type.

8625

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

8630

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

8631

},

8632

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

8633

},

8634

"url": "A String", # The URL of the photo. You can change the desired size by appending a query parameter `sz={size}` at the end of the url, where {size} is the size in pixels. Example: https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50

8635

},

8636

],

8637

"relations": [ # The person's relations.

8638

{ # A person's relation to another person.

8639

"formattedType": "A String", # Output only. The type of the relation translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.

8640

"metadata": { # Metadata about a field. # Metadata about the relation.

8641

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

8642

"source": { # The source of a field. # The source of the field.

8643

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

8644

"id": "A String", # The unique identifier within the source type generated by the server.

8645

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

8646

"objectType": "A String", # Output only. The profile object type.

8647

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

8652

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

8653

},

8654

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

8655

},

8656

"person": "A String", # The name of the other person this relation refers to.

8657

"type": "A String", # The person's relation to the other person. The type can be custom or one of these predefined values: * `spouse` * `child` * `mother` * `father` * `parent` * `brother` * `sister` * `friend` * `relative` * `domesticPartner` * `manager` * `assistant` * `referredBy` * `partner`

8658

},

8659

],

8660

"relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship interests.

8661

{ # **DEPRECATED**: No data will be returned A person's relationship interest .

8662

"formattedValue": "A String", # Output only. The value of the relationship interest translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.

8663

"metadata": { # Metadata about a field. # Metadata about the relationship interest.

8664

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

8665

"source": { # The source of a field. # The source of the field.

8666

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

8667

"id": "A String", # The unique identifier within the source type generated by the server.

8668

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

8669

"objectType": "A String", # Output only. The profile object type.

8670

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

8675

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

8676

},

8677

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

8678

},

8679

"value": "A String", # The kind of relationship the person is looking for. The value can be custom or one of these predefined values: * `friend` * `date` * `relationship` * `networking`

8680

},

8681

],

8682

"relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship statuses.

8683

{ # **DEPRECATED**: No data will be returned A person's relationship status.

8684

"formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

8685

"metadata": { # Metadata about a field. # Metadata about the relationship status.

8686

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

8687

"source": { # The source of a field. # The source of the field.

8688

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

8689

"id": "A String", # The unique identifier within the source type generated by the server.

8690

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

8691

"objectType": "A String", # Output only. The profile object type.

8692

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

8697

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

8698

},

8699

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

8700

},

8701

"value": "A String", # The relationship status. The value can be custom or one of these predefined values: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion`

8702

},

8703

],

8704

"residences": [ # **DEPRECATED**: (Please use `person.locations` instead) The person's residences.

8705

{ # **DEPRECATED**: Please use `person.locations` instead. A person's past or current residence.

8706

"current": True or False, # True if the residence is the person's current residence; false if the residence is a past residence.

8707

"metadata": { # Metadata about a field. # Metadata about the residence.

8708

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

8709

"source": { # The source of a field. # The source of the field.

8710

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

8711

"id": "A String", # The unique identifier within the source type generated by the server.

8712

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

8713

"objectType": "A String", # Output only. The profile object type.

8714

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

8719

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

8720

},

8721

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

8722

},

8723

"value": "A String", # The address of the residence.

8724

},

8725

],

8726

"resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters, in the form of `people/{person_id}`.

8727

"sipAddresses": [ # The person's SIP addresses.

8728

{ # A person's SIP address. Session Initial Protocol addresses are used for VoIP communications to make voice or video calls over the internet.

8729

"formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

8730

"metadata": { # Metadata about a field. # Metadata about the SIP address.

8731

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

8732

"source": { # The source of a field. # The source of the field.

8733

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

8734

"id": "A String", # The unique identifier within the source type generated by the server.

8735

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

8736

"objectType": "A String", # Output only. The profile object type.

8737

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

8742

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

8743

},

8744

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

8745

},

8746

"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`

8747

"value": "A String", # The SIP address in the [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI format.

8748

},

8749

],

8750

"skills": [ # The person's skills.

8751

{ # A skill that the person has.

8752

"metadata": { # Metadata about a field. # Metadata about the skill.

8753

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

8754

"source": { # The source of a field. # The source of the field.

8755

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

8756

"id": "A String", # The unique identifier within the source type generated by the server.

8757

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

8758

"objectType": "A String", # Output only. The profile object type.

8759

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

8764

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

8765

},

8766

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

8767

},

8768

"value": "A String", # The skill; for example, `underwater basket weaving`.

8769

},

8770

],

8771

"taglines": [ # Output only. **DEPRECATED**: No data will be returned The person's taglines.

8772

{ # **DEPRECATED**: No data will be returned A brief one-line description of the person.

8773

"metadata": { # Metadata about a field. # Metadata about the tagline.

8774

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

8775

"source": { # The source of a field. # The source of the field.

8776

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

8777

"id": "A String", # The unique identifier within the source type generated by the server.

8778

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

8779

"objectType": "A String", # Output only. The profile object type.

8780

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

8785

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

8786

},

8787

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

8788

},

8789

"value": "A String", # The tagline.

8790

},

8791

],

8792

"urls": [ # The person's associated URLs.

8793

{ # A person's associated URLs.

8794

"formattedType": "A String", # Output only. The type of the URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

8795

"metadata": { # Metadata about a field. # Metadata about the URL.

8796

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

8797

"source": { # The source of a field. # The source of the field.

8798

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

8799

"id": "A String", # The unique identifier within the source type generated by the server.

8800

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

8801

"objectType": "A String", # Output only. The profile object type.

8802

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

8807

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

8808

},

8809

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

8810

},

8811

"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 Currents application. * `other`

8812

"value": "A String", # The URL.

8813

},

8814

],

8815

"userDefined": [ # The person's user defined data.

8816

{ # Arbitrary user data that is populated by the end users.

8817

"key": "A String", # The end user specified key of the user defined data.

8818

"metadata": { # Metadata about a field. # Metadata about the user defined data.

8819

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

8820

"source": { # The source of a field. # The source of the field.

8821

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

8822

"id": "A String", # The unique identifier within the source type generated by the server.

8823

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

8824

"objectType": "A String", # Output only. The profile object type.

8825

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

8830

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

8831

},

8832

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

8833

},

8834

"value": "A String", # The end user specified value of the user defined data.

},

],

},

],

}</pre>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

</div>

<code class="details" id="listDirectoryPeople_next">listDirectoryPeople_next(previous_request, previous_response)</code>

8844

<pre>Retrieves the next page of results.

8845

8846

Args:

8847

previous_request: The request for the previous page. (required)

8848

previous_response: The response from the request for the previous page. (required)

8849

8850

Returns:

8851

A request object that you can call 'execute()' on to request the next

8852

page. Returns None if there are no more items in the collection.

</pre>

</div>

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

8857

<code class="details" id="searchContacts">searchContacts(pageSize=None, query=None, readMask=None, sources=None, x__xgafv=None)</code>

8858

<pre>Provides a list of contacts in the authenticated user's grouped contacts that matches the search query. The query matches on a contact's `names`, `nickNames`, `emailAddresses`, `phoneNumbers`, and `organizations` fields that are from the CONTACT" source.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

8859

8860

Args:

yoshi-code-bot

3dd1527

2021-04-21 15:07:48 -0700

[diff] [blame]

8861

pageSize: integer, Optional. The number of results to return. Defaults to 10 if field is not set, or set to 0. Values greater than 10 will be capped to 10.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

8862

query: string, Required. The plain-text query for the request. The query is used to match prefix phrases of the fields on a person. For example, a person with name "foo name" matches queries such as "f", "fo", "foo", "foo n", "nam", etc., but not "oo n".

8863

readMask: string, Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

8864

sources: string, Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT if not set. (repeated)

8865

Allowed values

8866

READ_SOURCE_TYPE_UNSPECIFIED - Unspecified.

8867

READ_SOURCE_TYPE_PROFILE - Returns SourceType.ACCOUNT, SourceType.DOMAIN_PROFILE, and SourceType.PROFILE.

8868

READ_SOURCE_TYPE_CONTACT - Returns SourceType.CONTACT.

8869

READ_SOURCE_TYPE_DOMAIN_CONTACT - Returns SourceType.DOMAIN_CONTACT.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

8870

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

8877

8878

{ # The response to a search request for the authenticated user, given a query.

8879

"results": [ # The results of the request.

8880

{ # A result of a search query.

8881

"person": { # Information about a person merged from various data sources such as the authenticated user's contacts and profile data. Most fields can have multiple items. The items in a field have no guaranteed order, but each non-empty field is guaranteed to have exactly one field with `metadata.primary` set to true. # The matched Person.

8882

"addresses": [ # The person's street addresses.

8883

{ # A person's physical address. May be a P.O. box or street address. All fields are optional.

8884

"city": "A String", # The city of the address.

8885

"country": "A String", # The country of the address.

8886

"countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address.

8887

"extendedAddress": "A String", # The extended address of the address; for example, the apartment number.

8888

"formattedType": "A String", # Output only. The type of the address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

8889

"formattedValue": "A String", # The unstructured value of the address. If this is not set by the user it will be automatically constructed from structured values.

8890

"metadata": { # Metadata about a field. # Metadata about the address.

8891

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

8892

"source": { # The source of a field. # The source of the field.

8893

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

8894

"id": "A String", # The unique identifier within the source type generated by the server.

8895

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

8896

"objectType": "A String", # Output only. The profile object type.

8897

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

8902

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

8903

},

8904

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

8905

},

8906

"poBox": "A String", # The P.O. box of the address.

8907

"postalCode": "A String", # The postal code of the address.

8908

"region": "A String", # The region of the address; for example, the state or province.

8909

"streetAddress": "A String", # The street address.

8910

"type": "A String", # The type of the address. The type can be custom or one of these predefined values: * `home` * `work` * `other`

8911

},

8912

],

8913

"ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead) The person's age range.

8914

"ageRanges": [ # Output only. The person's age ranges.

8915

{ # A person's age range.

8916

"ageRange": "A String", # The age range.

8917

"metadata": { # Metadata about a field. # Metadata about the age range.

8918

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

8919

"source": { # The source of a field. # The source of the field.

8920

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

8921

"id": "A String", # The unique identifier within the source type generated by the server.

8922

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

8923

"objectType": "A String", # Output only. The profile object type.

8924

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

8929

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

8930

},

8931

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

},

},

],

"biographies": [ # The person's biographies. This field is a singleton for contact sources.

8936

{ # A person's short biography.

8937

"contentType": "A String", # The content type of the biography.

8938

"metadata": { # Metadata about a field. # Metadata about the biography.

8939

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

8940

"source": { # The source of a field. # The source of the field.

8941

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

8942

"id": "A String", # The unique identifier within the source type generated by the server.

8943

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

8944

"objectType": "A String", # Output only. The profile object type.

8945

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

8950

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

8951

},

8952

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

8953

},

8954

"value": "A String", # The short biography.

8955

},

8956

],

8957

"birthdays": [ # The person's birthdays. This field is a singleton for contact sources.

8958

{ # A person's birthday. At least one of the `date` and `text` fields are specified. The `date` and `text` fields typically represent the same date, but are not guaranteed to.

8959

"date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The date of the birthday.

8960

"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

8961

"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

8962

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

8963

},

8964

"metadata": { # Metadata about a field. # Metadata about the birthday.

8965

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

8966

"source": { # The source of a field. # The source of the field.

8967

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

8968

"id": "A String", # The unique identifier within the source type generated by the server.

8969

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

8970

"objectType": "A String", # Output only. The profile object type.

8971

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

8976

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

8977

},

8978

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

8979

},

8980

"text": "A String", # A free-form string representing the user's birthday.

8981

},

8982

],

8983

"braggingRights": [ # **DEPRECATED**: No data will be returned The person's bragging rights.

8984

{ # **DEPRECATED**: No data will be returned A person's bragging rights.

8985

"metadata": { # Metadata about a field. # Metadata about the bragging rights.

8986

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

8987

"source": { # The source of a field. # The source of the field.

8988

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

8989

"id": "A String", # The unique identifier within the source type generated by the server.

8990

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

8991

"objectType": "A String", # Output only. The profile object type.

8992

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

8997

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

8998

},

8999

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

9000

},

9001

"value": "A String", # The bragging rights; for example, `climbed mount everest`.

9002

},

9003

],

9004

"calendarUrls": [ # The person's calendar URLs.

9005

{ # A person's calendar URL.

9006

"formattedType": "A String", # Output only. The type of the calendar URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

9007

"metadata": { # Metadata about a field. # Metadata about the calendar URL.

9008

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

9009

"source": { # The source of a field. # The source of the field.

9010

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

9011

"id": "A String", # The unique identifier within the source type generated by the server.

9012

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

9013

"objectType": "A String", # Output only. The profile object type.

9014

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

9019

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

9020

},

9021

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

9022

},

9023

"type": "A String", # The type of the calendar URL. The type can be custom or one of these predefined values: * `home` * `freeBusy` * `work`

9024

"url": "A String", # The calendar URL.

9025

},

9026

],

9027

"clientData": [ # The person's client data.

9028

{ # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.

9029

"key": "A String", # The client specified key of the client data.

9030

"metadata": { # Metadata about a field. # Metadata about the client data.

9031

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

9032

"source": { # The source of a field. # The source of the field.

9033

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

9034

"id": "A String", # The unique identifier within the source type generated by the server.

9035

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

9036

"objectType": "A String", # Output only. The profile object type.

9037

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

9042

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

9043

},

9044

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

9045

},

9046

"value": "A String", # The client specified value of the client data.

9047

},

9048

],

9049

"coverPhotos": [ # Output only. The person's cover photos.

9050

{ # A person's cover photo. A large image shown on the person's profile page that represents who they are or what they care about.

9051

"default": True or False, # True if the cover photo is the default cover photo; false if the cover photo is a user-provided cover photo.

9052

"metadata": { # Metadata about a field. # Metadata about the cover photo.

9053

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

9054

"source": { # The source of a field. # The source of the field.

9055

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

9056

"id": "A String", # The unique identifier within the source type generated by the server.

9057

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

9058

"objectType": "A String", # Output only. The profile object type.

9059

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

9064

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

9065

},

9066

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

9067

},

9068

"url": "A String", # The URL of the cover photo.

9069

},

9070

],

9071

"emailAddresses": [ # The person's email addresses.

9072

{ # A person's email address.

9073

"displayName": "A String", # The display name of the email.

9074

"formattedType": "A String", # Output only. The type of the email address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

9075

"metadata": { # Metadata about a field. # Metadata about the email address.

9076

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

9077

"source": { # The source of a field. # The source of the field.

9078

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

9079

"id": "A String", # The unique identifier within the source type generated by the server.

9080

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

9081

"objectType": "A String", # Output only. The profile object type.

9082

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

9087

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

9088

},

9089

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

9090

},

9091

"type": "A String", # The type of the email address. The type can be custom or one of these predefined values: * `home` * `work` * `other`

9092

"value": "A String", # The email address.

9093

},

9094

],

9095

"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.

9096

"events": [ # The person's events.

9097

{ # An event related to the person.

9098

"date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The date of the event.

9099

"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

9100

"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

9101

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

9102

},

9103

"formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

9104

"metadata": { # Metadata about a field. # Metadata about the event.

9105

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

9106

"source": { # The source of a field. # The source of the field.

9107

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

9108

"id": "A String", # The unique identifier within the source type generated by the server.

9109

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

9110

"objectType": "A String", # Output only. The profile object type.

9111

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

9116

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

9117

},

9118

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

9119

},

9120

"type": "A String", # The type of the event. The type can be custom or one of these predefined values: * `anniversary` * `other`

9121

},

9122

],

9123

"externalIds": [ # The person's external IDs.

9124

{ # An identifier from an external entity related to the person.

9125

"formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

9126

"metadata": { # Metadata about a field. # Metadata about the external ID.

9127

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

9128

"source": { # The source of a field. # The source of the field.

9129

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

9130

"id": "A String", # The unique identifier within the source type generated by the server.

9131

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

9132

"objectType": "A String", # Output only. The profile object type.

9133

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

9138

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

9139

},

9140

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

9141

},

9142

"type": "A String", # The type of the external ID. The type can be custom or one of these predefined values: * `account` * `customer` * `loginId` * `network` * `organization`

9143

"value": "A String", # The value of the external ID.

9144

},

9145

],

9146

"fileAses": [ # The person's file-ases.

9147

{ # The name that should be used to sort the person in a list.

9148

"metadata": { # Metadata about a field. # Metadata about the file-as.

9149

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

9150

"source": { # The source of a field. # The source of the field.

9151

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

9152

"id": "A String", # The unique identifier within the source type generated by the server.

9153

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

9154

"objectType": "A String", # Output only. The profile object type.

9155

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

9160

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

9161

},

9162

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

9163

},

9164

"value": "A String", # The file-as value

9165

},

9166

],

9167

"genders": [ # The person's genders. This field is a singleton for contact sources.

9168

{ # A person's gender.

9169

"addressMeAs": "A String", # The type of pronouns that should be used to address the person. The value can be custom or one of these predefined values: * `male` * `female` * `other`

9170

"formattedValue": "A String", # Output only. The value of the gender translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. Unspecified or custom value are not localized.

9171

"metadata": { # Metadata about a field. # Metadata about the gender.

9172

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

9173

"source": { # The source of a field. # The source of the field.

9174

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

9175

"id": "A String", # The unique identifier within the source type generated by the server.

9176

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

9177

"objectType": "A String", # Output only. The profile object type.

9178

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

9183

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

9184

},

9185

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

9186

},

9187

"value": "A String", # The gender for the person. The gender can be custom or one of these predefined values: * `male` * `female` * `unspecified`

9188

},

9189

],

9190

"imClients": [ # The person's instant messaging clients.

9191

{ # A person's instant messaging client.

9192

"formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

9193

"formattedType": "A String", # Output only. The type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

9194

"metadata": { # Metadata about a field. # Metadata about the IM client.

9195

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

9196

"source": { # The source of a field. # The source of the field.

9197

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

9198

"id": "A String", # The unique identifier within the source type generated by the server.

9199

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

9200

"objectType": "A String", # Output only. The profile object type.

9201

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

9206

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

9207

},

9208

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

9209

},

9210

"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`

9211

"type": "A String", # The type of the IM client. The type can be custom or one of these predefined values: * `home` * `work` * `other`

9212

"username": "A String", # The user name used in the IM client.

9213

},

9214

],

9215

"interests": [ # The person's interests.

9216

{ # One of the person's interests.

9217

"metadata": { # Metadata about a field. # Metadata about the interest.

9218

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

9219

"source": { # The source of a field. # The source of the field.

9220

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

9221

"id": "A String", # The unique identifier within the source type generated by the server.

9222

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

9223

"objectType": "A String", # Output only. The profile object type.

9224

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

9229

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

9230

},

9231

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

9232

},

9233

"value": "A String", # The interest; for example, `stargazing`.

9234

},

9235

],

9236

"locales": [ # The person's locale preferences.

9237

{ # A person's locale preference.

9238

"metadata": { # Metadata about a field. # Metadata about the locale.

9239

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

9240

"source": { # The source of a field. # The source of the field.

9241

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

9242

"id": "A String", # The unique identifier within the source type generated by the server.

9243

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

9244

"objectType": "A String", # Output only. The profile object type.

9245

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

9250

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

9251

},

9252

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

9253

},

9254

"value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag representing the locale.

9255

},

9256

],

9257

"locations": [ # The person's locations.

9258

{ # A person's location.

9259

"buildingId": "A String", # The building identifier.

9260

"current": True or False, # Whether the location is the current location.

9261

"deskCode": "A String", # The individual desk location.

9262

"floor": "A String", # The floor name or number.

9263

"floorSection": "A String", # The floor section in `floor_name`.

9264

"metadata": { # Metadata about a field. # Metadata about the location.

9265

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

9266

"source": { # The source of a field. # The source of the field.

9267

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

9268

"id": "A String", # The unique identifier within the source type generated by the server.

9269

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

9270

"objectType": "A String", # Output only. The profile object type.

9271

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

9276

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

9277

},

9278

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

9279

},

9280

"type": "A String", # The type of the location. The type can be custom or one of these predefined values: * `desk` * `grewUp`

9281

"value": "A String", # The free-form value of the location.

9282

},

9283

],

9284

"memberships": [ # The person's group memberships.

9285

{ # A person's membership in a group. Only contact group memberships can be modified.

9286

"contactGroupMembership": { # A Google contact group membership. # The contact group membership.

9287

"contactGroupId": "A String", # Output only. The contact group ID for the contact group membership.

9288

"contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`. Only contact_group_resource_name can be used for modifying memberships. Any contact group membership can be removed, but only user group or "myContacts" or "starred" system groups memberships can be added. A contact must always have at least one contact group membership.

9289

},

9290

"domainMembership": { # A G Suite Domain membership. # Output only. The domain membership.

9291

"inViewerDomain": True or False, # True if the person is in the viewer's G Suite domain.

9292

},

9293

"metadata": { # Metadata about a field. # Metadata about the membership.

9294

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

9295

"source": { # The source of a field. # The source of the field.

9296

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

9297

"id": "A String", # The unique identifier within the source type generated by the server.

9298

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

9299

"objectType": "A String", # Output only. The profile object type.

9300

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

9305

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

9306

},

9307

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

},

},

],

"metadata": { # The metadata about a person. # Output only. Metadata about the person.

9312

"deleted": True or False, # Output only. True if the person resource has been deleted. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token.

9313

"linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.

9314

"A String",

9315

],

9316

"objectType": "A String", # Output only. **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object.

9317

"previousResourceNames": [ # Output only. Any former resource names this person has had. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token. The resource name may change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or profile URL.

9318

"A String",

9319

],

9320

"sources": [ # The sources of data for the person.

9321

{ # The source of a field.

9322

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

9323

"id": "A String", # The unique identifier within the source type generated by the server.

9324

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

9325

"objectType": "A String", # Output only. The profile object type.

9326

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

9331

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

},

],

},

"miscKeywords": [ # The person's miscellaneous keywords.

9336

{ # A person's miscellaneous keyword.

9337

"formattedType": "A String", # Output only. The type of the miscellaneous keyword translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

9338

"metadata": { # Metadata about a field. # Metadata about the miscellaneous keyword.

9339

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

9340

"source": { # The source of a field. # The source of the field.

9341

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

9342

"id": "A String", # The unique identifier within the source type generated by the server.

9343

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

9344

"objectType": "A String", # Output only. The profile object type.

9345

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

9350

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

9351

},

9352

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

9353

},

9354

"type": "A String", # The miscellaneous keyword type.

9355

"value": "A String", # The value of the miscellaneous keyword.

9356

},

9357

],

9358

"names": [ # The person's names. This field is a singleton for contact sources.

9359

{ # A person's name. If the name is a mononym, the family name is empty.

9360

"displayName": "A String", # Output only. The display name formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.

9361

"displayNameLastFirst": "A String", # Output only. The display name with the last name first formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.

9362

"familyName": "A String", # The family name.

9363

"givenName": "A String", # The given name.

9364

"honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`

9365

"honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`

9366

"metadata": { # Metadata about a field. # Metadata about the name.

9367

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

9368

"source": { # The source of a field. # The source of the field.

9369

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

9370

"id": "A String", # The unique identifier within the source type generated by the server.

9371

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

9372

"objectType": "A String", # Output only. The profile object type.

9373

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

9378

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

9379

},

9380

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

9381

},

9382

"middleName": "A String", # The middle name(s).

9383

"phoneticFamilyName": "A String", # The family name spelled as it sounds.

9384

"phoneticFullName": "A String", # The full name spelled as it sounds.

9385

"phoneticGivenName": "A String", # The given name spelled as it sounds.

9386

"phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.

9387

"phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.

9388

"phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.

9389

"unstructuredName": "A String", # The free form name value.

9390

},

9391

],

9392

"nicknames": [ # The person's nicknames.

9393

{ # A person's nickname.

9394

"metadata": { # Metadata about a field. # Metadata about the nickname.

9395

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

9396

"source": { # The source of a field. # The source of the field.

9397

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

9398

"id": "A String", # The unique identifier within the source type generated by the server.

9399

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

9400

"objectType": "A String", # Output only. The profile object type.

9401

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

9406

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

9407

},

9408

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

9409

},

9410

"type": "A String", # The type of the nickname.

9411

"value": "A String", # The nickname.

9412

},

9413

],

9414

"occupations": [ # The person's occupations.

9415

{ # A person's occupation.

9416

"metadata": { # Metadata about a field. # Metadata about the occupation.

9417

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

9418

"source": { # The source of a field. # The source of the field.

9419

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

9420

"id": "A String", # The unique identifier within the source type generated by the server.

9421

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

9422

"objectType": "A String", # Output only. The profile object type.

9423

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

9428

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

9429

},

9430

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

9431

},

9432

"value": "A String", # The occupation; for example, `carpenter`.

9433

},

9434

],

9435

"organizations": [ # The person's past or current organizations.

9436

{ # A person's past or current organization. Overlapping date ranges are permitted.

9437

"current": True or False, # True if the organization is the person's current organization; false if the organization is a past organization.

9438

"department": "A String", # The person's department at the organization.

9439

"domain": "A String", # The domain name associated with the organization; for example, `google.com`.

9440

"endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The end date when the person left the organization.

9441

"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

9442

"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

9443

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

9444

},

9445

"formattedType": "A String", # Output only. The type of the organization translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

9446

"jobDescription": "A String", # The person's job description at the organization.

9447

"location": "A String", # The location of the organization office the person works at.

9448

"metadata": { # Metadata about a field. # Metadata about the organization.

9449

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

9450

"source": { # The source of a field. # The source of the field.

9451

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

9452

"id": "A String", # The unique identifier within the source type generated by the server.

9453

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

9454

"objectType": "A String", # Output only. The profile object type.

9455

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

9460

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

9461

},

9462

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

9463

},

9464

"name": "A String", # The name of the organization.

9465

"phoneticName": "A String", # The phonetic name of the organization.

9466

"startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The start date when the person joined the organization.

9467

"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

9468

"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

9469

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

9470

},

9471

"symbol": "A String", # The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym.

9472

"title": "A String", # The person's job title at the organization.

9473

"type": "A String", # The type of the organization. The type can be custom or one of these predefined values: * `work` * `school`

9474

},

9475

],

9476

"phoneNumbers": [ # The person's phone numbers.

9477

{ # A person's phone number.

9478

"canonicalForm": "A String", # Output only. The canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number.

9479

"formattedType": "A String", # Output only. The type of the phone number translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

9480

"metadata": { # Metadata about a field. # Metadata about the phone number.

9481

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

9482

"source": { # The source of a field. # The source of the field.

9483

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

9484

"id": "A String", # The unique identifier within the source type generated by the server.

9485

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

9486

"objectType": "A String", # Output only. The profile object type.

9487

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

9492

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

9493

},

9494

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

9495

},

9496

"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`

9497

"value": "A String", # The phone number.

9498

},

9499

],

9500

"photos": [ # Output only. The person's photos.

9501

{ # A person's photo. A picture shown next to the person's name to help others recognize the person.

9502

"default": True or False, # True if the photo is a default photo; false if the photo is a user-provided photo.

9503

"metadata": { # Metadata about a field. # Metadata about the photo.

9504

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

9505

"source": { # The source of a field. # The source of the field.

9506

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

9507

"id": "A String", # The unique identifier within the source type generated by the server.

9508

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

9509

"objectType": "A String", # Output only. The profile object type.

9510

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

9515

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

9516

},

9517

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

9518

},

9519

"url": "A String", # The URL of the photo. You can change the desired size by appending a query parameter `sz={size}` at the end of the url, where {size} is the size in pixels. Example: https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50

9520

},

9521

],

9522

"relations": [ # The person's relations.

9523

{ # A person's relation to another person.

9524

"formattedType": "A String", # Output only. The type of the relation translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.

9525

"metadata": { # Metadata about a field. # Metadata about the relation.

9526

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

9527

"source": { # The source of a field. # The source of the field.

9528

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

9529

"id": "A String", # The unique identifier within the source type generated by the server.

9530

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

9531

"objectType": "A String", # Output only. The profile object type.

9532

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

9537

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

9538

},

9539

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

9540

},

9541

"person": "A String", # The name of the other person this relation refers to.

9542

"type": "A String", # The person's relation to the other person. The type can be custom or one of these predefined values: * `spouse` * `child` * `mother` * `father` * `parent` * `brother` * `sister` * `friend` * `relative` * `domesticPartner` * `manager` * `assistant` * `referredBy` * `partner`

9543

},

9544

],

9545

"relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship interests.

9546

{ # **DEPRECATED**: No data will be returned A person's relationship interest .

9547

"formattedValue": "A String", # Output only. The value of the relationship interest translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.

9548

"metadata": { # Metadata about a field. # Metadata about the relationship interest.

9549

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

9550

"source": { # The source of a field. # The source of the field.

9551

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

9552

"id": "A String", # The unique identifier within the source type generated by the server.

9553

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

9554

"objectType": "A String", # Output only. The profile object type.

9555

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

9560

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

9561

},

9562

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

9563

},

9564

"value": "A String", # The kind of relationship the person is looking for. The value can be custom or one of these predefined values: * `friend` * `date` * `relationship` * `networking`

9565

},

9566

],

9567

"relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship statuses.

9568

{ # **DEPRECATED**: No data will be returned A person's relationship status.

9569

"formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

9570

"metadata": { # Metadata about a field. # Metadata about the relationship status.

9571

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

9572

"source": { # The source of a field. # The source of the field.

9573

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

9574

"id": "A String", # The unique identifier within the source type generated by the server.

9575

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

9576

"objectType": "A String", # Output only. The profile object type.

9577

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

9582

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

9583

},

9584

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

9585

},

9586

"value": "A String", # The relationship status. The value can be custom or one of these predefined values: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion`

9587

},

9588

],

9589

"residences": [ # **DEPRECATED**: (Please use `person.locations` instead) The person's residences.

9590

{ # **DEPRECATED**: Please use `person.locations` instead. A person's past or current residence.

9591

"current": True or False, # True if the residence is the person's current residence; false if the residence is a past residence.

9592

"metadata": { # Metadata about a field. # Metadata about the residence.

9593

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

9594

"source": { # The source of a field. # The source of the field.

9595

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

9596

"id": "A String", # The unique identifier within the source type generated by the server.

9597

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

9598

"objectType": "A String", # Output only. The profile object type.

9599

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

9604

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

9605

},

9606

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

9607

},

9608

"value": "A String", # The address of the residence.

9609

},

9610

],

9611

"resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters, in the form of `people/{person_id}`.

9612

"sipAddresses": [ # The person's SIP addresses.

9613

{ # A person's SIP address. Session Initial Protocol addresses are used for VoIP communications to make voice or video calls over the internet.

9614

"formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

9615

"metadata": { # Metadata about a field. # Metadata about the SIP address.

9616

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

9617

"source": { # The source of a field. # The source of the field.

9618

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

9619

"id": "A String", # The unique identifier within the source type generated by the server.

9620

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

9621

"objectType": "A String", # Output only. The profile object type.

9622

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

9627

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

9628

},

9629

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

9630

},

9631

"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`

9632

"value": "A String", # The SIP address in the [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI format.

9633

},

9634

],

9635

"skills": [ # The person's skills.

9636

{ # A skill that the person has.

9637

"metadata": { # Metadata about a field. # Metadata about the skill.

9638

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

9639

"source": { # The source of a field. # The source of the field.

9640

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

9641

"id": "A String", # The unique identifier within the source type generated by the server.

9642

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

9643

"objectType": "A String", # Output only. The profile object type.

9644

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

9649

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

9650

},

9651

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

9652

},

9653

"value": "A String", # The skill; for example, `underwater basket weaving`.

9654

},

9655

],

9656

"taglines": [ # Output only. **DEPRECATED**: No data will be returned The person's taglines.

9657

{ # **DEPRECATED**: No data will be returned A brief one-line description of the person.

9658

"metadata": { # Metadata about a field. # Metadata about the tagline.

9659

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

9660

"source": { # The source of a field. # The source of the field.

9661

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

9662

"id": "A String", # The unique identifier within the source type generated by the server.

9663

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

9664

"objectType": "A String", # Output only. The profile object type.

9665

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

9670

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

9671

},

9672

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

9673

},

9674

"value": "A String", # The tagline.

9675

},

9676

],

9677

"urls": [ # The person's associated URLs.

9678

{ # A person's associated URLs.

9679

"formattedType": "A String", # Output only. The type of the URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

9680

"metadata": { # Metadata about a field. # Metadata about the URL.

9681

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

9682

"source": { # The source of a field. # The source of the field.

9683

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

9684

"id": "A String", # The unique identifier within the source type generated by the server.

9685

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

9686

"objectType": "A String", # Output only. The profile object type.

9687

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

9692

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

9693

},

9694

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

9695

},

9696

"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 Currents application. * `other`

9697

"value": "A String", # The URL.

9698

},

9699

],

9700

"userDefined": [ # The person's user defined data.

9701

{ # Arbitrary user data that is populated by the end users.

9702

"key": "A String", # The end user specified key of the user defined data.

9703

"metadata": { # Metadata about a field. # Metadata about the user defined data.

9704

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

9705

"source": { # The source of a field. # The source of the field.

9706

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

9707

"id": "A String", # The unique identifier within the source type generated by the server.

9708

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

9709

"objectType": "A String", # Output only. The profile object type.

9710

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

9715

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

9716

},

9717

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

9718

},

9719

"value": "A String", # The end user specified value of the user defined data.

},

],

},

},

],

}</pre>

</div>

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

9729

<code class="details" id="searchDirectoryPeople">searchDirectoryPeople(mergeSources=None, pageSize=None, pageToken=None, query=None, readMask=None, sources=None, x__xgafv=None)</code>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

9730

<pre>Provides a list of domain profiles and domain contacts in the authenticated user's domain directory that match the search query.

9731

9732

Args:

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

9733

mergeSources: string, Optional. Additional data to merge into the directory sources if they are connected through verified join keys such as email addresses or phone numbers. (repeated)

9734

Allowed values

9735

DIRECTORY_MERGE_SOURCE_TYPE_UNSPECIFIED - Unspecified.

9736

DIRECTORY_MERGE_SOURCE_TYPE_CONTACT - User owned contact.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

9737

pageSize: integer, Optional. The number of people to include in the response. Valid values are between 1 and 500, inclusive. Defaults to 100 if not set or set to 0.

9738

pageToken: string, Optional. A page token, received from a previous `SearchDirectoryPeople` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchDirectoryPeople` must match the call that provided the page token.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

9739

query: string, Required. Prefix query that matches fields in the person. Does NOT use the read_mask for determining what fields to match.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

9740

readMask: string, Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

9741

sources: string, Required. Directory sources to return. (repeated)

9742

Allowed values

9743

DIRECTORY_SOURCE_TYPE_UNSPECIFIED - Unspecified.

9744

DIRECTORY_SOURCE_TYPE_DOMAIN_CONTACT - G Suite domain shared contact.

9745

DIRECTORY_SOURCE_TYPE_DOMAIN_PROFILE - G Suite domain profile.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

9746

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

9753

9754

{ # The response to a request for people in the authenticated user's domain directory that match the specified query.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

9755

"nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.

9756

"people": [ # The list of people in the domain directory that match the query.

9757

{ # Information about a person merged from various data sources such as the authenticated user's contacts and profile data. Most fields can have multiple items. The items in a field have no guaranteed order, but each non-empty field is guaranteed to have exactly one field with `metadata.primary` set to true.

9758

"addresses": [ # The person's street addresses.

9759

{ # A person's physical address. May be a P.O. box or street address. All fields are optional.

9760

"city": "A String", # The city of the address.

9761

"country": "A String", # The country of the address.

9762

"countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address.

9763

"extendedAddress": "A String", # The extended address of the address; for example, the apartment number.

9764

"formattedType": "A String", # Output only. The type of the address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

9765

"formattedValue": "A String", # The unstructured value of the address. If this is not set by the user it will be automatically constructed from structured values.

9766

"metadata": { # Metadata about a field. # Metadata about the address.

9767

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

9768

"source": { # The source of a field. # The source of the field.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

9769

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

9770

"id": "A String", # The unique identifier within the source type generated by the server.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

9771

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

9772

"objectType": "A String", # Output only. The profile object type.

9773

"userTypes": [ # Output only. The user types.

9774

"A String",

9775

],

9776

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

9777

"type": "A String", # The source type.

9778

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

9779

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

9780

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

9781

},

9782

"poBox": "A String", # The P.O. box of the address.

9783

"postalCode": "A String", # The postal code of the address.

9784

"region": "A String", # The region of the address; for example, the state or province.

9785

"streetAddress": "A String", # The street address.

9786

"type": "A String", # The type of the address. The type can be custom or one of these predefined values: * `home` * `work` * `other`

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

9787

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

9788

],

9789

"ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead) The person's age range.

9790

"ageRanges": [ # Output only. The person's age ranges.

9791

{ # A person's age range.

9792

"ageRange": "A String", # The age range.

9793

"metadata": { # Metadata about a field. # Metadata about the age range.

9794

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

9795

"source": { # The source of a field. # The source of the field.

9796

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

9797

"id": "A String", # The unique identifier within the source type generated by the server.

9798

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

9799

"objectType": "A String", # Output only. The profile object type.

9800

"userTypes": [ # Output only. The user types.

9801

"A String",

9802

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

9803

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

9804

"type": "A String", # The source type.

9805

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

9806

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

9807

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

9808

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

9809

},

9810

],

9811

"biographies": [ # The person's biographies. This field is a singleton for contact sources.

9812

{ # A person's short biography.

9813

"contentType": "A String", # The content type of the biography.

9814

"metadata": { # Metadata about a field. # Metadata about the biography.

9815

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

9816

"source": { # The source of a field. # The source of the field.

9817

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

9818

"id": "A String", # The unique identifier within the source type generated by the server.

9819

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

9820

"objectType": "A String", # Output only. The profile object type.

9821

"userTypes": [ # Output only. The user types.

9822

"A String",

9823

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

9824

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

9825

"type": "A String", # The source type.

9826

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

9827

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

9828

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

9829

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

9830

"value": "A String", # The short biography.

9831

},

9832

],

9833

"birthdays": [ # The person's birthdays. This field is a singleton for contact sources.

9834

{ # A person's birthday. At least one of the `date` and `text` fields are specified. The `date` and `text` fields typically represent the same date, but are not guaranteed to.

9835

"date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The date of the birthday.

9836

"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

9837

"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

9838

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

9839

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

9840

"metadata": { # Metadata about a field. # Metadata about the birthday.

9841

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

9842

"source": { # The source of a field. # The source of the field.

9843

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

9844

"id": "A String", # The unique identifier within the source type generated by the server.

9845

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

9846

"objectType": "A String", # Output only. The profile object type.

9847

"userTypes": [ # Output only. The user types.

9848

"A String",

9849

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

9850

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

9851

"type": "A String", # The source type.

9852

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

9853

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

9854

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

9855

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

9856

"text": "A String", # A free-form string representing the user's birthday.

9857

},

9858

],

9859

"braggingRights": [ # **DEPRECATED**: No data will be returned The person's bragging rights.

9860

{ # **DEPRECATED**: No data will be returned A person's bragging rights.

9861

"metadata": { # Metadata about a field. # Metadata about the bragging rights.

9862

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

9863

"source": { # The source of a field. # The source of the field.

9864

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

9865

"id": "A String", # The unique identifier within the source type generated by the server.

9866

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

9867

"objectType": "A String", # Output only. The profile object type.

9868

"userTypes": [ # Output only. The user types.

9869

"A String",

9870

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

9871

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

9872

"type": "A String", # The source type.

9873

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

9874

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

9875

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

9876

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

9877

"value": "A String", # The bragging rights; for example, `climbed mount everest`.

9878

},

9879

],

9880

"calendarUrls": [ # The person's calendar URLs.

9881

{ # A person's calendar URL.

9882

"formattedType": "A String", # Output only. The type of the calendar URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

9883

"metadata": { # Metadata about a field. # Metadata about the calendar URL.

9884

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

9885

"source": { # The source of a field. # The source of the field.

9886

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

9887

"id": "A String", # The unique identifier within the source type generated by the server.

9888

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

9889

"objectType": "A String", # Output only. The profile object type.

9890

"userTypes": [ # Output only. The user types.

9891

"A String",

9892

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

9893

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

9894

"type": "A String", # The source type.

9895

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

9896

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

9897

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

9898

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

9899

"type": "A String", # The type of the calendar URL. The type can be custom or one of these predefined values: * `home` * `freeBusy` * `work`

9900

"url": "A String", # The calendar URL.

9901

},

9902

],

9903

"clientData": [ # The person's client data.

9904

{ # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.

9905

"key": "A String", # The client specified key of the client data.

9906

"metadata": { # Metadata about a field. # Metadata about the client data.

9907

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

9908

"source": { # The source of a field. # The source of the field.

9909

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

9910

"id": "A String", # The unique identifier within the source type generated by the server.

9911

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

9912

"objectType": "A String", # Output only. The profile object type.

9913

"userTypes": [ # Output only. The user types.

9914

"A String",

9915

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

9916

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

9917

"type": "A String", # The source type.

9918

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

9919

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

9920

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

9921

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

9922

"value": "A String", # The client specified value of the client data.

9923

},

9924

],

9925

"coverPhotos": [ # Output only. The person's cover photos.

9926

{ # A person's cover photo. A large image shown on the person's profile page that represents who they are or what they care about.

9927

"default": True or False, # True if the cover photo is the default cover photo; false if the cover photo is a user-provided cover photo.

9928

"metadata": { # Metadata about a field. # Metadata about the cover photo.

9929

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

9930

"source": { # The source of a field. # The source of the field.

9931

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

9932

"id": "A String", # The unique identifier within the source type generated by the server.

9933

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

9934

"objectType": "A String", # Output only. The profile object type.

9935

"userTypes": [ # Output only. The user types.

9936

"A String",

9937

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

9938

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

9939

"type": "A String", # The source type.

9940

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

9941

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

9942

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

9943

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

9944

"url": "A String", # The URL of the cover photo.

9945

},

9946

],

9947

"emailAddresses": [ # The person's email addresses.

9948

{ # A person's email address.

9949

"displayName": "A String", # The display name of the email.

9950

"formattedType": "A String", # Output only. The type of the email address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

9951

"metadata": { # Metadata about a field. # Metadata about the email address.

9952

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

9953

"source": { # The source of a field. # The source of the field.

9954

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

9955

"id": "A String", # The unique identifier within the source type generated by the server.

9956

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

9957

"objectType": "A String", # Output only. The profile object type.

9958

"userTypes": [ # Output only. The user types.

9959

"A String",

9960

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

9961

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

9962

"type": "A String", # The source type.

9963

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

9964

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

9965

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

9966

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

9967

"type": "A String", # The type of the email address. The type can be custom or one of these predefined values: * `home` * `work` * `other`

9968

"value": "A String", # The email address.

9969

},

9970

],

9971

"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.

9972

"events": [ # The person's events.

9973

{ # An event related to the person.

9974

"date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The date of the event.

9975

"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

9976

"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

9977

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

9978

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

9979

"formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

9980

"metadata": { # Metadata about a field. # Metadata about the event.

9981

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

9982

"source": { # The source of a field. # The source of the field.

9983

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

9984

"id": "A String", # The unique identifier within the source type generated by the server.

9985

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

9986

"objectType": "A String", # Output only. The profile object type.

9987

"userTypes": [ # Output only. The user types.

9988

"A String",

9989

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

9990

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

9991

"type": "A String", # The source type.

9992

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

9993

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

9994

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

9995

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

9996

"type": "A String", # The type of the event. The type can be custom or one of these predefined values: * `anniversary` * `other`

9997

},

9998

],

9999

"externalIds": [ # The person's external IDs.

10000

{ # An identifier from an external entity related to the person.

10001

"formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

10002

"metadata": { # Metadata about a field. # Metadata about the external ID.

10003

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

10004

"source": { # The source of a field. # The source of the field.

10005

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

10006

"id": "A String", # The unique identifier within the source type generated by the server.

10007

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

10008

"objectType": "A String", # Output only. The profile object type.

10009

"userTypes": [ # Output only. The user types.

10010

"A String",

10011

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

10012

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

10013

"type": "A String", # The source type.

10014

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

10015

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

10016

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

10017

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

10018

"type": "A String", # The type of the external ID. The type can be custom or one of these predefined values: * `account` * `customer` * `loginId` * `network` * `organization`

10019

"value": "A String", # The value of the external ID.

10020

},

10021

],

10022

"fileAses": [ # The person's file-ases.

10023

{ # The name that should be used to sort the person in a list.

10024

"metadata": { # Metadata about a field. # Metadata about the file-as.

10025

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

10026

"source": { # The source of a field. # The source of the field.

10027

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

10028

"id": "A String", # The unique identifier within the source type generated by the server.

10029

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

10030

"objectType": "A String", # Output only. The profile object type.

10031

"userTypes": [ # Output only. The user types.

10032

"A String",

10033

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

10034

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

10035

"type": "A String", # The source type.

10036

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

10037

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

10038

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

10039

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

10040

"value": "A String", # The file-as value

10041

},

10042

],

10043

"genders": [ # The person's genders. This field is a singleton for contact sources.

10044

{ # A person's gender.

10045

"addressMeAs": "A String", # The type of pronouns that should be used to address the person. The value can be custom or one of these predefined values: * `male` * `female` * `other`

10046

"formattedValue": "A String", # Output only. The value of the gender translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. Unspecified or custom value are not localized.

10047

"metadata": { # Metadata about a field. # Metadata about the gender.

10048

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

10049

"source": { # The source of a field. # The source of the field.

10050

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

10051

"id": "A String", # The unique identifier within the source type generated by the server.

10052

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

10053

"objectType": "A String", # Output only. The profile object type.

10054

"userTypes": [ # Output only. The user types.

10055

"A String",

10056

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

10057

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

10058

"type": "A String", # The source type.

10059

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

10060

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

10061

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

10062

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

10063

"value": "A String", # The gender for the person. The gender can be custom or one of these predefined values: * `male` * `female` * `unspecified`

10064

},

10065

],

10066

"imClients": [ # The person's instant messaging clients.

10067

{ # A person's instant messaging client.

10068

"formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

10069

"formattedType": "A String", # Output only. The type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

10070

"metadata": { # Metadata about a field. # Metadata about the IM client.

10071

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

10072

"source": { # The source of a field. # The source of the field.

10073

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

10074

"id": "A String", # The unique identifier within the source type generated by the server.

10075

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

10076

"objectType": "A String", # Output only. The profile object type.

10077

"userTypes": [ # Output only. The user types.

10078

"A String",

10079

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

10080

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

10081

"type": "A String", # The source type.

10082

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

10083

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

10084

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

10085

},

10086

"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`

10087

"type": "A String", # The type of the IM client. The type can be custom or one of these predefined values: * `home` * `work` * `other`

10088

"username": "A String", # The user name used in the IM client.

10089

},

10090

],

10091

"interests": [ # The person's interests.

10092

{ # One of the person's interests.

10093

"metadata": { # Metadata about a field. # Metadata about the interest.

10094

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

10095

"source": { # The source of a field. # The source of the field.

10096

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

10097

"id": "A String", # The unique identifier within the source type generated by the server.

10098

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

10099

"objectType": "A String", # Output only. The profile object type.

10100

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

10105

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

10106

},

10107

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

10108

},

10109

"value": "A String", # The interest; for example, `stargazing`.

10110

},

10111

],

10112

"locales": [ # The person's locale preferences.

10113

{ # A person's locale preference.

10114

"metadata": { # Metadata about a field. # Metadata about the locale.

10115

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

10116

"source": { # The source of a field. # The source of the field.

10117

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

10118

"id": "A String", # The unique identifier within the source type generated by the server.

10119

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

10120

"objectType": "A String", # Output only. The profile object type.

10121

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

10126

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

10127

},

10128

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

10129

},

10130

"value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag representing the locale.

10131

},

10132

],

10133

"locations": [ # The person's locations.

10134

{ # A person's location.

10135

"buildingId": "A String", # The building identifier.

10136

"current": True or False, # Whether the location is the current location.

10137

"deskCode": "A String", # The individual desk location.

10138

"floor": "A String", # The floor name or number.

10139

"floorSection": "A String", # The floor section in `floor_name`.

10140

"metadata": { # Metadata about a field. # Metadata about the location.

10141

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

10142

"source": { # The source of a field. # The source of the field.

10143

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

10144

"id": "A String", # The unique identifier within the source type generated by the server.

10145

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

10146

"objectType": "A String", # Output only. The profile object type.

10147

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

10152

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

10153

},

10154

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

10155

},

10156

"type": "A String", # The type of the location. The type can be custom or one of these predefined values: * `desk` * `grewUp`

10157

"value": "A String", # The free-form value of the location.

10158

},

10159

],

10160

"memberships": [ # The person's group memberships.

10161

{ # A person's membership in a group. Only contact group memberships can be modified.

10162

"contactGroupMembership": { # A Google contact group membership. # The contact group membership.

10163

"contactGroupId": "A String", # Output only. The contact group ID for the contact group membership.

10164

"contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`. Only contact_group_resource_name can be used for modifying memberships. Any contact group membership can be removed, but only user group or "myContacts" or "starred" system groups memberships can be added. A contact must always have at least one contact group membership.

10165

},

10166

"domainMembership": { # A G Suite Domain membership. # Output only. The domain membership.

10167

"inViewerDomain": True or False, # True if the person is in the viewer's G Suite domain.

10168

},

10169

"metadata": { # Metadata about a field. # Metadata about the membership.

10170

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

10171

"source": { # The source of a field. # The source of the field.

10172

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

10173

"id": "A String", # The unique identifier within the source type generated by the server.

10174

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

10175

"objectType": "A String", # Output only. The profile object type.

10176

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

10181

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

10182

},

10183

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

},

},

],

"metadata": { # The metadata about a person. # Output only. Metadata about the person.

10188

"deleted": True or False, # Output only. True if the person resource has been deleted. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token.

10189

"linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.

10190

"A String",

10191

],

10192

"objectType": "A String", # Output only. **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object.

10193

"previousResourceNames": [ # Output only. Any former resource names this person has had. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token. The resource name may change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or profile URL.

10194

"A String",

10195

],

10196

"sources": [ # The sources of data for the person.

10197

{ # The source of a field.

10198

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

10199

"id": "A String", # The unique identifier within the source type generated by the server.

10200

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

10201

"objectType": "A String", # Output only. The profile object type.

10202

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

10207

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

10208

},

10209

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

10210

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

10211

"miscKeywords": [ # The person's miscellaneous keywords.

10212

{ # A person's miscellaneous keyword.

10213

"formattedType": "A String", # Output only. The type of the miscellaneous keyword translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

10214

"metadata": { # Metadata about a field. # Metadata about the miscellaneous keyword.

10215

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

10216

"source": { # The source of a field. # The source of the field.

10217

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

10218

"id": "A String", # The unique identifier within the source type generated by the server.

10219

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

10220

"objectType": "A String", # Output only. The profile object type.

10221

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

10226

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

10227

},

10228

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

10229

},

10230

"type": "A String", # The miscellaneous keyword type.

10231

"value": "A String", # The value of the miscellaneous keyword.

10232

},

10233

],

10234

"names": [ # The person's names. This field is a singleton for contact sources.

10235

{ # A person's name. If the name is a mononym, the family name is empty.

10236

"displayName": "A String", # Output only. The display name formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.

10237

"displayNameLastFirst": "A String", # Output only. The display name with the last name first formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.

10238

"familyName": "A String", # The family name.

10239

"givenName": "A String", # The given name.

10240

"honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`

10241

"honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`

10242

"metadata": { # Metadata about a field. # Metadata about the name.

10243

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

10244

"source": { # The source of a field. # The source of the field.

10245

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

10246

"id": "A String", # The unique identifier within the source type generated by the server.

10247

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

10248

"objectType": "A String", # Output only. The profile object type.

10249

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

10254

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

10255

},

10256

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

10257

},

10258

"middleName": "A String", # The middle name(s).

10259

"phoneticFamilyName": "A String", # The family name spelled as it sounds.

10260

"phoneticFullName": "A String", # The full name spelled as it sounds.

10261

"phoneticGivenName": "A String", # The given name spelled as it sounds.

10262

"phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.

10263

"phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.

10264

"phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.

10265

"unstructuredName": "A String", # The free form name value.

10266

},

10267

],

10268

"nicknames": [ # The person's nicknames.

10269

{ # A person's nickname.

10270

"metadata": { # Metadata about a field. # Metadata about the nickname.

10271

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

10272

"source": { # The source of a field. # The source of the field.

10273

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

10274

"id": "A String", # The unique identifier within the source type generated by the server.

10275

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

10276

"objectType": "A String", # Output only. The profile object type.

10277

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

10282

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

10283

},

10284

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

10285

},

10286

"type": "A String", # The type of the nickname.

10287

"value": "A String", # The nickname.

10288

},

10289

],

10290

"occupations": [ # The person's occupations.

10291

{ # A person's occupation.

10292

"metadata": { # Metadata about a field. # Metadata about the occupation.

10293

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

10294

"source": { # The source of a field. # The source of the field.

10295

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

10296

"id": "A String", # The unique identifier within the source type generated by the server.

10297

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

10298

"objectType": "A String", # Output only. The profile object type.

10299

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

10304

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

10305

},

10306

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

10307

},

10308

"value": "A String", # The occupation; for example, `carpenter`.

10309

},

10310

],

10311

"organizations": [ # The person's past or current organizations.

10312

{ # A person's past or current organization. Overlapping date ranges are permitted.

10313

"current": True or False, # True if the organization is the person's current organization; false if the organization is a past organization.

10314

"department": "A String", # The person's department at the organization.

10315

"domain": "A String", # The domain name associated with the organization; for example, `google.com`.

10316

"endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The end date when the person left the organization.

10317

"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

10318

"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

10319

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

10320

},

10321

"formattedType": "A String", # Output only. The type of the organization translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

10322

"jobDescription": "A String", # The person's job description at the organization.

10323

"location": "A String", # The location of the organization office the person works at.

10324

"metadata": { # Metadata about a field. # Metadata about the organization.

10325

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

10326

"source": { # The source of a field. # The source of the field.

10327

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

10328

"id": "A String", # The unique identifier within the source type generated by the server.

10329

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

10330

"objectType": "A String", # Output only. The profile object type.

10331

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

10336

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

10337

},

10338

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

10339

},

10340

"name": "A String", # The name of the organization.

10341

"phoneticName": "A String", # The phonetic name of the organization.

10342

"startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The start date when the person joined the organization.

10343

"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

10344

"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

10345

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

10346

},

10347

"symbol": "A String", # The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym.

10348

"title": "A String", # The person's job title at the organization.

10349

"type": "A String", # The type of the organization. The type can be custom or one of these predefined values: * `work` * `school`

10350

},

10351

],

10352

"phoneNumbers": [ # The person's phone numbers.

10353

{ # A person's phone number.

10354

"canonicalForm": "A String", # Output only. The canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number.

10355

"formattedType": "A String", # Output only. The type of the phone number translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

10356

"metadata": { # Metadata about a field. # Metadata about the phone number.

10357

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

10358

"source": { # The source of a field. # The source of the field.

10359

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

10360

"id": "A String", # The unique identifier within the source type generated by the server.

10361

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

10362

"objectType": "A String", # Output only. The profile object type.

10363

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

10368

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

10369

},

10370

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

10371

},

10372

"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`

10373

"value": "A String", # The phone number.

10374

},

10375

],

10376

"photos": [ # Output only. The person's photos.

10377

{ # A person's photo. A picture shown next to the person's name to help others recognize the person.

10378

"default": True or False, # True if the photo is a default photo; false if the photo is a user-provided photo.

10379

"metadata": { # Metadata about a field. # Metadata about the photo.

10380

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

10381

"source": { # The source of a field. # The source of the field.

10382

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

10383

"id": "A String", # The unique identifier within the source type generated by the server.

10384

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

10385

"objectType": "A String", # Output only. The profile object type.

10386

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

10391

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

10392

},

10393

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

10394

},

10395

"url": "A String", # The URL of the photo. You can change the desired size by appending a query parameter `sz={size}` at the end of the url, where {size} is the size in pixels. Example: https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50

10396

},

10397

],

10398

"relations": [ # The person's relations.

10399

{ # A person's relation to another person.

10400

"formattedType": "A String", # Output only. The type of the relation translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.

10401

"metadata": { # Metadata about a field. # Metadata about the relation.

10402

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

10403

"source": { # The source of a field. # The source of the field.

10404

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

10405

"id": "A String", # The unique identifier within the source type generated by the server.

10406

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

10407

"objectType": "A String", # Output only. The profile object type.

10408

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

10413

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

10414

},

10415

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

10416

},

10417

"person": "A String", # The name of the other person this relation refers to.

10418

"type": "A String", # The person's relation to the other person. The type can be custom or one of these predefined values: * `spouse` * `child` * `mother` * `father` * `parent` * `brother` * `sister` * `friend` * `relative` * `domesticPartner` * `manager` * `assistant` * `referredBy` * `partner`

10419

},

10420

],

10421

"relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship interests.

10422

{ # **DEPRECATED**: No data will be returned A person's relationship interest .

10423

"formattedValue": "A String", # Output only. The value of the relationship interest translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.

10424

"metadata": { # Metadata about a field. # Metadata about the relationship interest.

10425

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

10426

"source": { # The source of a field. # The source of the field.

10427

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

10428

"id": "A String", # The unique identifier within the source type generated by the server.

10429

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

10430

"objectType": "A String", # Output only. The profile object type.

10431

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

10436

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

10437

},

10438

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

10439

},

10440

"value": "A String", # The kind of relationship the person is looking for. The value can be custom or one of these predefined values: * `friend` * `date` * `relationship` * `networking`

10441

},

10442

],

10443

"relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship statuses.

10444

{ # **DEPRECATED**: No data will be returned A person's relationship status.

10445

"formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

10446

"metadata": { # Metadata about a field. # Metadata about the relationship status.

10447

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

10448

"source": { # The source of a field. # The source of the field.

10449

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

10450

"id": "A String", # The unique identifier within the source type generated by the server.

10451

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

10452

"objectType": "A String", # Output only. The profile object type.

10453

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

10458

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

10459

},

10460

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

10461

},

10462

"value": "A String", # The relationship status. The value can be custom or one of these predefined values: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion`

10463

},

10464

],

10465

"residences": [ # **DEPRECATED**: (Please use `person.locations` instead) The person's residences.

10466

{ # **DEPRECATED**: Please use `person.locations` instead. A person's past or current residence.

10467

"current": True or False, # True if the residence is the person's current residence; false if the residence is a past residence.

10468

"metadata": { # Metadata about a field. # Metadata about the residence.

10469

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

10470

"source": { # The source of a field. # The source of the field.

10471

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

10472

"id": "A String", # The unique identifier within the source type generated by the server.

10473

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

10474

"objectType": "A String", # Output only. The profile object type.

10475

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

10480

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

10481

},

10482

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

10483

},

10484

"value": "A String", # The address of the residence.

10485

},

10486

],

10487

"resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters, in the form of `people/{person_id}`.

10488

"sipAddresses": [ # The person's SIP addresses.

10489

{ # A person's SIP address. Session Initial Protocol addresses are used for VoIP communications to make voice or video calls over the internet.

10490

"formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

10491

"metadata": { # Metadata about a field. # Metadata about the SIP address.

10492

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

10493

"source": { # The source of a field. # The source of the field.

10494

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

10495

"id": "A String", # The unique identifier within the source type generated by the server.

10496

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

10497

"objectType": "A String", # Output only. The profile object type.

10498

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

10503

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

10504

},

10505

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

10506

},

10507

"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`

10508

"value": "A String", # The SIP address in the [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI format.

10509

},

10510

],

10511

"skills": [ # The person's skills.

10512

{ # A skill that the person has.

10513

"metadata": { # Metadata about a field. # Metadata about the skill.

10514

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

10515

"source": { # The source of a field. # The source of the field.

10516

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

10517

"id": "A String", # The unique identifier within the source type generated by the server.

10518

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

10519

"objectType": "A String", # Output only. The profile object type.

10520

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

10525

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

10526

},

10527

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

10528

},

10529

"value": "A String", # The skill; for example, `underwater basket weaving`.

10530

},

10531

],

10532

"taglines": [ # Output only. **DEPRECATED**: No data will be returned The person's taglines.

10533

{ # **DEPRECATED**: No data will be returned A brief one-line description of the person.

10534

"metadata": { # Metadata about a field. # Metadata about the tagline.

10535

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

10536

"source": { # The source of a field. # The source of the field.

10537

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

10538

"id": "A String", # The unique identifier within the source type generated by the server.

10539

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

10540

"objectType": "A String", # Output only. The profile object type.

10541

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

10546

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

10547

},

10548

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

10549

},

10550

"value": "A String", # The tagline.

10551

},

10552

],

10553

"urls": [ # The person's associated URLs.

10554

{ # A person's associated URLs.

10555

"formattedType": "A String", # Output only. The type of the URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

10556

"metadata": { # Metadata about a field. # Metadata about the URL.

10557

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

10558

"source": { # The source of a field. # The source of the field.

10559

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

10560

"id": "A String", # The unique identifier within the source type generated by the server.

10561

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

10562

"objectType": "A String", # Output only. The profile object type.

10563

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

10568

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

10569

},

10570

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

10571

},

10572

"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 Currents application. * `other`

10573

"value": "A String", # The URL.

10574

},

10575

],

10576

"userDefined": [ # The person's user defined data.

10577

{ # Arbitrary user data that is populated by the end users.

10578

"key": "A String", # The end user specified key of the user defined data.

10579

"metadata": { # Metadata about a field. # Metadata about the user defined data.

10580

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

10581

"source": { # The source of a field. # The source of the field.

10582

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

10583

"id": "A String", # The unique identifier within the source type generated by the server.

10584

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

10585

"objectType": "A String", # Output only. The profile object type.

10586

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

10591

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

10592

},

10593

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

10594

},

10595

"value": "A String", # The end user specified value of the user defined data.

},

],

},

],

"totalSize": 42, # The total number of items in the list without pagination.

10601

}</pre>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

</div>

<code class="details" id="searchDirectoryPeople_next">searchDirectoryPeople_next(previous_request, previous_response)</code>

10606

<pre>Retrieves the next page of results.

10607

10608

Args:

10609

previous_request: The request for the previous page. (required)

10610

previous_response: The response from the request for the previous page. (required)

10611

10612

Returns:

10613

A request object that you can call 'execute()' on to request the next

10614

page. Returns None if there are no more items in the collection.

</pre>

</div>

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

10619

<code class="details" id="updateContact">updateContact(resourceName, body=None, personFields=None, sources=None, updatePersonFields=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

10620

<pre>Update contact data for an existing contact person. Any non-contact data will not be modified. Any non-contact data in the person to update will be ignored. All fields specified in the `update_mask` will be replaced. The server returns a 400 error if `person.metadata.sources` is not specified for the contact to be updated or if there is no contact source. The server returns a 400 error with reason `"failedPrecondition"` if `person.metadata.sources.etag` is different than the contact's etag, which indicates the contact has changed since its data was read. Clients should get the latest person and merge their updates into the latest person. The server returns a 400 error if `memberships` are being updated and there are no contact group memberships specified on the person. The server returns a 400 error if more than one field is specified on a field that is a singleton for contact sources: * biographies * birthdays * genders * names

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

10621

10622

Args:

10623

resourceName: string, The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters, in the form of `people/{person_id}`. (required)

10624

body: object, The request body.

10625

The object takes the form of:

10626

10627

{ # Information about a person merged from various data sources such as the authenticated user's contacts and profile data. Most fields can have multiple items. The items in a field have no guaranteed order, but each non-empty field is guaranteed to have exactly one field with `metadata.primary` set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

10628

"addresses": [ # The person's street addresses.

10629

{ # A person's physical address. May be a P.O. box or street address. All fields are optional.

10630

"city": "A String", # The city of the address.

10631

"country": "A String", # The country of the address.

10632

"countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address.

10633

"extendedAddress": "A String", # The extended address of the address; for example, the apartment number.

10634

"formattedType": "A String", # Output only. The type of the address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

10635

"formattedValue": "A String", # The unstructured value of the address. If this is not set by the user it will be automatically constructed from structured values.

10636

"metadata": { # Metadata about a field. # Metadata about the address.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

10637

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

10638

"source": { # The source of a field. # The source of the field.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

10639

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

10640

"id": "A String", # The unique identifier within the source type generated by the server.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

10641

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

10642

"objectType": "A String", # Output only. The profile object type.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

10643

"userTypes": [ # Output only. The user types.

10644

"A String",

10645

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

10646

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

10647

"type": "A String", # The source type.

10648

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

10649

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

10650

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

10651

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

10652

"poBox": "A String", # The P.O. box of the address.

10653

"postalCode": "A String", # The postal code of the address.

10654

"region": "A String", # The region of the address; for example, the state or province.

10655

"streetAddress": "A String", # The street address.

10656

"type": "A String", # The type of the address. The type can be custom or one of these predefined values: * `home` * `work` * `other`

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

10657

},

10658

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

10659

"ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead) The person's age range.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

10660

"ageRanges": [ # Output only. The person's age ranges.

10661

{ # A person's age range.

10662

"ageRange": "A String", # The age range.

10663

"metadata": { # Metadata about a field. # Metadata about the age range.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

10664

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

10665

"source": { # The source of a field. # The source of the field.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

10666

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

10667

"id": "A String", # The unique identifier within the source type generated by the server.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

10668

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

10669

"objectType": "A String", # Output only. The profile object type.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

10670

"userTypes": [ # Output only. The user types.

10671

"A String",

10672

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

10673

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

10674

"type": "A String", # The source type.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

10675

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

10676

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

10677

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

10678

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

10679

},

10680

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

10681

"biographies": [ # The person's biographies. This field is a singleton for contact sources.

10682

{ # A person's short biography.

10683

"contentType": "A String", # The content type of the biography.

10684

"metadata": { # Metadata about a field. # Metadata about the biography.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

10685

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

10686

"source": { # The source of a field. # The source of the field.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

10687

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

10688

"id": "A String", # The unique identifier within the source type generated by the server.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

10689

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

10690

"objectType": "A String", # Output only. The profile object type.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

10691

"userTypes": [ # Output only. The user types.

10692

"A String",

10693

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

10694

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

10695

"type": "A String", # The source type.

10696

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

10697

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

10698

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

10699

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

10700

"value": "A String", # The short biography.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

10701

},

10702

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

10703

"birthdays": [ # The person's birthdays. This field is a singleton for contact sources.

10704

{ # A person's birthday. At least one of the `date` and `text` fields are specified. The `date` and `text` fields typically represent the same date, but are not guaranteed to.

10705

"date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The date of the birthday.

10706

"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

10707

"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

10708

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

10709

},

10710

"metadata": { # Metadata about a field. # Metadata about the birthday.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

10711

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

10712

"source": { # The source of a field. # The source of the field.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

10713

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

10714

"id": "A String", # The unique identifier within the source type generated by the server.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

10715

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

10716

"objectType": "A String", # Output only. The profile object type.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

10717

"userTypes": [ # Output only. The user types.

10718

"A String",

10719

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

10720

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

10721

"type": "A String", # The source type.

10722

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

10723

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

10724

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

10725

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

10726

"text": "A String", # A free-form string representing the user's birthday.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

10727

},

10728

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

10729

"braggingRights": [ # **DEPRECATED**: No data will be returned The person's bragging rights.

10730

{ # **DEPRECATED**: No data will be returned A person's bragging rights.

10731

"metadata": { # Metadata about a field. # Metadata about the bragging rights.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

10732

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

10733

"source": { # The source of a field. # The source of the field.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

10734

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

10735

"id": "A String", # The unique identifier within the source type generated by the server.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

10736

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

10737

"objectType": "A String", # Output only. The profile object type.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

10738

"userTypes": [ # Output only. The user types.

10739

"A String",

10740

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

10741

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

10742

"type": "A String", # The source type.

10743

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

10744

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

10745

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

10746

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

10747

"value": "A String", # The bragging rights; for example, `climbed mount everest`.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

10748

},

10749

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

10750

"calendarUrls": [ # The person's calendar URLs.

10751

{ # A person's calendar URL.

10752

"formattedType": "A String", # Output only. The type of the calendar URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

10753

"metadata": { # Metadata about a field. # Metadata about the calendar URL.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

10754

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

10755

"source": { # The source of a field. # The source of the field.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

10756

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

10757

"id": "A String", # The unique identifier within the source type generated by the server.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

10758

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

10759

"objectType": "A String", # Output only. The profile object type.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

10760

"userTypes": [ # Output only. The user types.

10761

"A String",

10762

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

10763

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

10764

"type": "A String", # The source type.

10765

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

10766

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

10767

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

10768

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

10769

"type": "A String", # The type of the calendar URL. The type can be custom or one of these predefined values: * `home` * `freeBusy` * `work`

10770

"url": "A String", # The calendar URL.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

10771

},

10772

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

10773

"clientData": [ # The person's client data.

10774

{ # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.

10775

"key": "A String", # The client specified key of the client data.

10776

"metadata": { # Metadata about a field. # Metadata about the client data.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

10777

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

10778

"source": { # The source of a field. # The source of the field.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

10779

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

10780

"id": "A String", # The unique identifier within the source type generated by the server.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

10781

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

10782

"objectType": "A String", # Output only. The profile object type.

10783

"userTypes": [ # Output only. The user types.

10784

"A String",

10785

],

10786

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

10787

"type": "A String", # The source type.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

10788

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

10789

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

10790

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

10791

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

10792

"value": "A String", # The client specified value of the client data.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

10793

},

10794

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

10795

"coverPhotos": [ # Output only. The person's cover photos.

10796

{ # A person's cover photo. A large image shown on the person's profile page that represents who they are or what they care about.

10797

"default": True or False, # True if the cover photo is the default cover photo; false if the cover photo is a user-provided cover photo.

10798

"metadata": { # Metadata about a field. # Metadata about the cover photo.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

10799

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

10800

"source": { # The source of a field. # The source of the field.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

10801

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

10802

"id": "A String", # The unique identifier within the source type generated by the server.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

10803

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

10804

"objectType": "A String", # Output only. The profile object type.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

10805

"userTypes": [ # Output only. The user types.

10806

"A String",

10807

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

10808

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

10809

"type": "A String", # The source type.

10810

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

10811

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

10812

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

10813

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

10814

"url": "A String", # The URL of the cover photo.

10815

},

10816

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

10817

"emailAddresses": [ # The person's email addresses.

10818

{ # A person's email address.

10819

"displayName": "A String", # The display name of the email.

10820

"formattedType": "A String", # Output only. The type of the email address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

10821

"metadata": { # Metadata about a field. # Metadata about the email address.

10822

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

10823

"source": { # The source of a field. # The source of the field.

10824

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

10825

"id": "A String", # The unique identifier within the source type generated by the server.

10826

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

10827

"objectType": "A String", # Output only. The profile object type.

10828

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

10833

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

10834

},

10835

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

10836

},

10837

"type": "A String", # The type of the email address. The type can be custom or one of these predefined values: * `home` * `work` * `other`

10838

"value": "A String", # The email address.

10839

},

10840

],

10841

"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.

10842

"events": [ # The person's events.

10843

{ # An event related to the person.

10844

"date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The date of the event.

10845

"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

10846

"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

10847

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

10848

},

10849

"formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

10850

"metadata": { # Metadata about a field. # Metadata about the event.

10851

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

10852

"source": { # The source of a field. # The source of the field.

10853

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

10854

"id": "A String", # The unique identifier within the source type generated by the server.

10855

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

10856

"objectType": "A String", # Output only. The profile object type.

10857

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

10862

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

10863

},

10864

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

10865

},

10866

"type": "A String", # The type of the event. The type can be custom or one of these predefined values: * `anniversary` * `other`

10867

},

10868

],

10869

"externalIds": [ # The person's external IDs.

10870

{ # An identifier from an external entity related to the person.

10871

"formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

10872

"metadata": { # Metadata about a field. # Metadata about the external ID.

10873

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

10874

"source": { # The source of a field. # The source of the field.

10875

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

10876

"id": "A String", # The unique identifier within the source type generated by the server.

10877

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

10878

"objectType": "A String", # Output only. The profile object type.

10879

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

10884

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

10885

},

10886

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

10887

},

10888

"type": "A String", # The type of the external ID. The type can be custom or one of these predefined values: * `account` * `customer` * `loginId` * `network` * `organization`

10889

"value": "A String", # The value of the external ID.

10890

},

10891

],

10892

"fileAses": [ # The person's file-ases.

10893

{ # The name that should be used to sort the person in a list.

10894

"metadata": { # Metadata about a field. # Metadata about the file-as.

10895

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

10896

"source": { # The source of a field. # The source of the field.

10897

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

10898

"id": "A String", # The unique identifier within the source type generated by the server.

10899

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

10900

"objectType": "A String", # Output only. The profile object type.

10901

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

10906

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

10907

},

10908

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

10909

},

10910

"value": "A String", # The file-as value

10911

},

10912

],

10913

"genders": [ # The person's genders. This field is a singleton for contact sources.

10914

{ # A person's gender.

10915

"addressMeAs": "A String", # The type of pronouns that should be used to address the person. The value can be custom or one of these predefined values: * `male` * `female` * `other`

10916

"formattedValue": "A String", # Output only. The value of the gender translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. Unspecified or custom value are not localized.

10917

"metadata": { # Metadata about a field. # Metadata about the gender.

10918

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

10919

"source": { # The source of a field. # The source of the field.

10920

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

10921

"id": "A String", # The unique identifier within the source type generated by the server.

10922

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

10923

"objectType": "A String", # Output only. The profile object type.

10924

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

10929

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

10930

},

10931

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

10932

},

10933

"value": "A String", # The gender for the person. The gender can be custom or one of these predefined values: * `male` * `female` * `unspecified`

10934

},

10935

],

10936

"imClients": [ # The person's instant messaging clients.

10937

{ # A person's instant messaging client.

10938

"formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

10939

"formattedType": "A String", # Output only. The type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

10940

"metadata": { # Metadata about a field. # Metadata about the IM client.

10941

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

10942

"source": { # The source of a field. # The source of the field.

10943

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

10944

"id": "A String", # The unique identifier within the source type generated by the server.

10945

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

10946

"objectType": "A String", # Output only. The profile object type.

10947

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

10952

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

10953

},

10954

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

10955

},

10956

"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`

10957

"type": "A String", # The type of the IM client. The type can be custom or one of these predefined values: * `home` * `work` * `other`

10958

"username": "A String", # The user name used in the IM client.

10959

},

10960

],

10961

"interests": [ # The person's interests.

10962

{ # One of the person's interests.

10963

"metadata": { # Metadata about a field. # Metadata about the interest.

10964

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

10965

"source": { # The source of a field. # The source of the field.

10966

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

10967

"id": "A String", # The unique identifier within the source type generated by the server.

10968

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

10969

"objectType": "A String", # Output only. The profile object type.

10970

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

10975

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

10976

},

10977

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

10978

},

10979

"value": "A String", # The interest; for example, `stargazing`.

10980

},

10981

],

10982

"locales": [ # The person's locale preferences.

10983

{ # A person's locale preference.

10984

"metadata": { # Metadata about a field. # Metadata about the locale.

10985

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

10986

"source": { # The source of a field. # The source of the field.

10987

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

10988

"id": "A String", # The unique identifier within the source type generated by the server.

10989

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

10990

"objectType": "A String", # Output only. The profile object type.

10991

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

10996

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

10997

},

10998

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

10999

},

11000

"value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag representing the locale.

11001

},

11002

],

11003

"locations": [ # The person's locations.

11004

{ # A person's location.

11005

"buildingId": "A String", # The building identifier.

11006

"current": True or False, # Whether the location is the current location.

11007

"deskCode": "A String", # The individual desk location.

11008

"floor": "A String", # The floor name or number.

11009

"floorSection": "A String", # The floor section in `floor_name`.

11010

"metadata": { # Metadata about a field. # Metadata about the location.

11011

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

11012

"source": { # The source of a field. # The source of the field.

11013

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

11014

"id": "A String", # The unique identifier within the source type generated by the server.

11015

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

11016

"objectType": "A String", # Output only. The profile object type.

11017

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

11022

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

11023

},

11024

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

11025

},

11026

"type": "A String", # The type of the location. The type can be custom or one of these predefined values: * `desk` * `grewUp`

11027

"value": "A String", # The free-form value of the location.

11028

},

11029

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

11030

"memberships": [ # The person's group memberships.

11031

{ # A person's membership in a group. Only contact group memberships can be modified.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

11032

"contactGroupMembership": { # A Google contact group membership. # The contact group membership.

11033

"contactGroupId": "A String", # Output only. The contact group ID for the contact group membership.

11034

"contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`. Only contact_group_resource_name can be used for modifying memberships. Any contact group membership can be removed, but only user group or "myContacts" or "starred" system groups memberships can be added. A contact must always have at least one contact group membership.

11035

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

11036

"domainMembership": { # A G Suite Domain membership. # Output only. The domain membership.

11037

"inViewerDomain": True or False, # True if the person is in the viewer's G Suite domain.

11038

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

11039

"metadata": { # Metadata about a field. # Metadata about the membership.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11040

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

11041

"source": { # The source of a field. # The source of the field.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11042

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

11043

"id": "A String", # The unique identifier within the source type generated by the server.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

11044

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11045

"objectType": "A String", # Output only. The profile object type.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

11046

"userTypes": [ # Output only. The user types.

11047

"A String",

11048

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

11049

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

11050

"type": "A String", # The source type.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11051

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11052

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11053

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11054

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11055

},

11056

],

11057

"metadata": { # The metadata about a person. # Output only. Metadata about the person.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

11058

"deleted": True or False, # Output only. True if the person resource has been deleted. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token.

11059

"linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.

11060

"A String",

11061

],

11062

"objectType": "A String", # Output only. **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11063

"previousResourceNames": [ # Output only. Any former resource names this person has had. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token. The resource name may change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or profile URL.

11064

"A String",

11065

],

11066

"sources": [ # The sources of data for the person.

11067

{ # The source of a field.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11068

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

11069

"id": "A String", # The unique identifier within the source type generated by the server.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11070

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

11071

"objectType": "A String", # Output only. The profile object type.

11072

"userTypes": [ # Output only. The user types.

11073

"A String",

11074

],

11075

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

11076

"type": "A String", # The source type.

11077

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11078

},

11079

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11080

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

11081

"miscKeywords": [ # The person's miscellaneous keywords.

11082

{ # A person's miscellaneous keyword.

11083

"formattedType": "A String", # Output only. The type of the miscellaneous keyword translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

11084

"metadata": { # Metadata about a field. # Metadata about the miscellaneous keyword.

11085

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

11086

"source": { # The source of a field. # The source of the field.

11087

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

11088

"id": "A String", # The unique identifier within the source type generated by the server.

11089

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

11090

"objectType": "A String", # Output only. The profile object type.

11091

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

11096

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

11097

},

11098

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

11099

},

11100

"type": "A String", # The miscellaneous keyword type.

11101

"value": "A String", # The value of the miscellaneous keyword.

11102

},

11103

],

11104

"names": [ # The person's names. This field is a singleton for contact sources.

11105

{ # A person's name. If the name is a mononym, the family name is empty.

11106

"displayName": "A String", # Output only. The display name formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.

11107

"displayNameLastFirst": "A String", # Output only. The display name with the last name first formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.

11108

"familyName": "A String", # The family name.

11109

"givenName": "A String", # The given name.

11110

"honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`

11111

"honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`

11112

"metadata": { # Metadata about a field. # Metadata about the name.

11113

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

11114

"source": { # The source of a field. # The source of the field.

11115

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

11116

"id": "A String", # The unique identifier within the source type generated by the server.

11117

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

11118

"objectType": "A String", # Output only. The profile object type.

11119

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

11124

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

11125

},

11126

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

11127

},

11128

"middleName": "A String", # The middle name(s).

11129

"phoneticFamilyName": "A String", # The family name spelled as it sounds.

11130

"phoneticFullName": "A String", # The full name spelled as it sounds.

11131

"phoneticGivenName": "A String", # The given name spelled as it sounds.

11132

"phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.

11133

"phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.

11134

"phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.

11135

"unstructuredName": "A String", # The free form name value.

11136

},

11137

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11138

"nicknames": [ # The person's nicknames.

11139

{ # A person's nickname.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11140

"metadata": { # Metadata about a field. # Metadata about the nickname.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11141

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

11142

"source": { # The source of a field. # The source of the field.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11143

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

11144

"id": "A String", # The unique identifier within the source type generated by the server.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11145

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

11146

"objectType": "A String", # Output only. The profile object type.

11147

"userTypes": [ # Output only. The user types.

11148

"A String",

11149

],

11150

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

11151

"type": "A String", # The source type.

11152

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11153

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

11154

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11155

},

11156

"type": "A String", # The type of the nickname.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

11157

"value": "A String", # The nickname.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11158

},

11159

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

11160

"occupations": [ # The person's occupations.

11161

{ # A person's occupation.

11162

"metadata": { # Metadata about a field. # Metadata about the occupation.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11163

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

11164

"source": { # The source of a field. # The source of the field.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11165

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

11166

"id": "A String", # The unique identifier within the source type generated by the server.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11167

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

11168

"objectType": "A String", # Output only. The profile object type.

11169

"userTypes": [ # Output only. The user types.

11170

"A String",

11171

],

11172

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11173

"type": "A String", # The source type.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11174

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11175

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11176

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11177

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

11178

"value": "A String", # The occupation; for example, `carpenter`.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11179

},

11180

],

11181

"organizations": [ # The person's past or current organizations.

11182

{ # A person's past or current organization. Overlapping date ranges are permitted.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

11183

"current": True or False, # True if the organization is the person's current organization; false if the organization is a past organization.

11184

"department": "A String", # The person's department at the organization.

11185

"domain": "A String", # The domain name associated with the organization; for example, `google.com`.

11186

"endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The end date when the person left the organization.

11187

"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

11188

"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

11189

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

11190

},

11191

"formattedType": "A String", # Output only. The type of the organization translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

11192

"jobDescription": "A String", # The person's job description at the organization.

11193

"location": "A String", # The location of the organization office the person works at.

11194

"metadata": { # Metadata about a field. # Metadata about the organization.

11195

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

11196

"source": { # The source of a field. # The source of the field.

11197

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

11198

"id": "A String", # The unique identifier within the source type generated by the server.

11199

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

11200

"objectType": "A String", # Output only. The profile object type.

11201

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

11206

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

11207

},

11208

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

11209

},

11210

"name": "A String", # The name of the organization.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11211

"phoneticName": "A String", # The phonetic name of the organization.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

11212

"startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The start date when the person joined the organization.

11213

"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

11214

"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

11215

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

11216

},

11217

"symbol": "A String", # The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11218

"title": "A String", # The person's job title at the organization.

11219

"type": "A String", # The type of the organization. The type can be custom or one of these predefined values: * `work` * `school`

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11220

},

11221

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

11222

"phoneNumbers": [ # The person's phone numbers.

11223

{ # A person's phone number.

11224

"canonicalForm": "A String", # Output only. The canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number.

11225

"formattedType": "A String", # Output only. The type of the phone number translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

11226

"metadata": { # Metadata about a field. # Metadata about the phone number.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11227

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

11228

"source": { # The source of a field. # The source of the field.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11229

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

11230

"id": "A String", # The unique identifier within the source type generated by the server.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11231

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

11232

"objectType": "A String", # Output only. The profile object type.

11233

"userTypes": [ # Output only. The user types.

11234

"A String",

11235

],

11236

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

11237

"type": "A String", # The source type.

11238

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11239

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

11240

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11241

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

11242

"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`

11243

"value": "A String", # The phone number.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11244

},

11245

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

11246

"photos": [ # Output only. The person's photos.

11247

{ # A person's photo. A picture shown next to the person's name to help others recognize the person.

11248

"default": True or False, # True if the photo is a default photo; false if the photo is a user-provided photo.

11249

"metadata": { # Metadata about a field. # Metadata about the photo.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11250

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

11251

"source": { # The source of a field. # The source of the field.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11252

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

11253

"id": "A String", # The unique identifier within the source type generated by the server.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11254

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

11255

"objectType": "A String", # Output only. The profile object type.

11256

"userTypes": [ # Output only. The user types.

11257

"A String",

11258

],

11259

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

11260

"type": "A String", # The source type.

11261

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11262

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

11263

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11264

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

11265

"url": "A String", # The URL of the photo. You can change the desired size by appending a query parameter `sz={size}` at the end of the url, where {size} is the size in pixels. Example: https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50

11266

},

11267

],

11268

"relations": [ # The person's relations.

11269

{ # A person's relation to another person.

11270

"formattedType": "A String", # Output only. The type of the relation translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.

11271

"metadata": { # Metadata about a field. # Metadata about the relation.

11272

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

11273

"source": { # The source of a field. # The source of the field.

11274

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

11275

"id": "A String", # The unique identifier within the source type generated by the server.

11276

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

11277

"objectType": "A String", # Output only. The profile object type.

11278

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

11283

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

11284

},

11285

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

11286

},

11287

"person": "A String", # The name of the other person this relation refers to.

11288

"type": "A String", # The person's relation to the other person. The type can be custom or one of these predefined values: * `spouse` * `child` * `mother` * `father` * `parent` * `brother` * `sister` * `friend` * `relative` * `domesticPartner` * `manager` * `assistant` * `referredBy` * `partner`

11289

},

11290

],

11291

"relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship interests.

11292

{ # **DEPRECATED**: No data will be returned A person's relationship interest .

11293

"formattedValue": "A String", # Output only. The value of the relationship interest translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.

11294

"metadata": { # Metadata about a field. # Metadata about the relationship interest.

11295

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

11296

"source": { # The source of a field. # The source of the field.

11297

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

11298

"id": "A String", # The unique identifier within the source type generated by the server.

11299

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

11300

"objectType": "A String", # Output only. The profile object type.

11301

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

11306

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

11307

},

11308

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

11309

},

11310

"value": "A String", # The kind of relationship the person is looking for. The value can be custom or one of these predefined values: * `friend` * `date` * `relationship` * `networking`

11311

},

11312

],

11313

"relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship statuses.

11314

{ # **DEPRECATED**: No data will be returned A person's relationship status.

11315

"formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

11316

"metadata": { # Metadata about a field. # Metadata about the relationship status.

11317

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

11318

"source": { # The source of a field. # The source of the field.

11319

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

11320

"id": "A String", # The unique identifier within the source type generated by the server.

11321

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

11322

"objectType": "A String", # Output only. The profile object type.

11323

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

11328

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

11329

},

11330

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

11331

},

11332

"value": "A String", # The relationship status. The value can be custom or one of these predefined values: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion`

11333

},

11334

],

11335

"residences": [ # **DEPRECATED**: (Please use `person.locations` instead) The person's residences.

11336

{ # **DEPRECATED**: Please use `person.locations` instead. A person's past or current residence.

11337

"current": True or False, # True if the residence is the person's current residence; false if the residence is a past residence.

11338

"metadata": { # Metadata about a field. # Metadata about the residence.

11339

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

11340

"source": { # The source of a field. # The source of the field.

11341

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

11342

"id": "A String", # The unique identifier within the source type generated by the server.

11343

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

11344

"objectType": "A String", # Output only. The profile object type.

11345

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

11350

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

11351

},

11352

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

11353

},

11354

"value": "A String", # The address of the residence.

11355

},

11356

],

11357

"resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters, in the form of `people/{person_id}`.

11358

"sipAddresses": [ # The person's SIP addresses.

11359

{ # A person's SIP address. Session Initial Protocol addresses are used for VoIP communications to make voice or video calls over the internet.

11360

"formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

11361

"metadata": { # Metadata about a field. # Metadata about the SIP address.

11362

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

11363

"source": { # The source of a field. # The source of the field.

11364

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

11365

"id": "A String", # The unique identifier within the source type generated by the server.

11366

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

11367

"objectType": "A String", # Output only. The profile object type.

11368

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

11373

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

11374

},

11375

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

11376

},

11377

"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`

11378

"value": "A String", # The SIP address in the [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI format.

11379

},

11380

],

11381

"skills": [ # The person's skills.

11382

{ # A skill that the person has.

11383

"metadata": { # Metadata about a field. # Metadata about the skill.

11384

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

11385

"source": { # The source of a field. # The source of the field.

11386

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

11387

"id": "A String", # The unique identifier within the source type generated by the server.

11388

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

11389

"objectType": "A String", # Output only. The profile object type.

11390

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

11395

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

11396

},

11397

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

11398

},

11399

"value": "A String", # The skill; for example, `underwater basket weaving`.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11400

},

11401

],

11402

"taglines": [ # Output only. **DEPRECATED**: No data will be returned The person's taglines.

11403

{ # **DEPRECATED**: No data will be returned A brief one-line description of the person.

11404

"metadata": { # Metadata about a field. # Metadata about the tagline.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11405

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

11406

"source": { # The source of a field. # The source of the field.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11407

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

11408

"id": "A String", # The unique identifier within the source type generated by the server.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11409

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

11410

"objectType": "A String", # Output only. The profile object type.

11411

"userTypes": [ # Output only. The user types.

11412

"A String",

11413

],

11414

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

11415

"type": "A String", # The source type.

11416

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11417

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

11418

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11419

},

11420

"value": "A String", # The tagline.

11421

},

11422

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

11423

"urls": [ # The person's associated URLs.

11424

{ # A person's associated URLs.

11425

"formattedType": "A String", # Output only. The type of the URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

11426

"metadata": { # Metadata about a field. # Metadata about the URL.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11427

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

11428

"source": { # The source of a field. # The source of the field.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11429

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

11430

"id": "A String", # The unique identifier within the source type generated by the server.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11431

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

11432

"objectType": "A String", # Output only. The profile object type.

11433

"userTypes": [ # Output only. The user types.

11434

"A String",

11435

],

11436

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

11437

"type": "A String", # The source type.

11438

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11439

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

11440

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11441

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

11442

"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 Currents application. * `other`

11443

"value": "A String", # The URL.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11444

},

11445

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

11446

"userDefined": [ # The person's user defined data.

11447

{ # Arbitrary user data that is populated by the end users.

11448

"key": "A String", # The end user specified key of the user defined data.

11449

"metadata": { # Metadata about a field. # Metadata about the user defined data.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11450

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

11451

"source": { # The source of a field. # The source of the field.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11452

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

11453

"id": "A String", # The unique identifier within the source type generated by the server.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11454

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

11455

"objectType": "A String", # Output only. The profile object type.

11456

"userTypes": [ # Output only. The user types.

11457

"A String",

11458

],

11459

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11460

"type": "A String", # The source type.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

11461

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11462

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

11463

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11464

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

11465

"value": "A String", # The end user specified value of the user defined data.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

11466

},

11467

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

11468

}

11469

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11470

personFields: string, Optional. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Defaults to all fields if not set. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

11471

sources: string, Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set. (repeated)

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

11472

Allowed values

11473

READ_SOURCE_TYPE_UNSPECIFIED - Unspecified.

11474

READ_SOURCE_TYPE_PROFILE - Returns SourceType.ACCOUNT, SourceType.DOMAIN_PROFILE, and SourceType.PROFILE.

11475

READ_SOURCE_TYPE_CONTACT - Returns SourceType.CONTACT.

11476

READ_SOURCE_TYPE_DOMAIN_CONTACT - Returns SourceType.DOMAIN_CONTACT.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

11477

updatePersonFields: string, Required. A field mask to restrict which fields on the person are updated. Multiple fields can be specified by separating them with commas. All updated fields will be replaced. Valid values are: * addresses * biographies * birthdays * calendarUrls * clientData * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * relations * sipAddresses * urls * userDefined

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

11478

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

11485

11486

{ # Information about a person merged from various data sources such as the authenticated user's contacts and profile data. Most fields can have multiple items. The items in a field have no guaranteed order, but each non-empty field is guaranteed to have exactly one field with `metadata.primary` set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

11487

"addresses": [ # The person's street addresses.

11488

{ # A person's physical address. May be a P.O. box or street address. All fields are optional.

11489

"city": "A String", # The city of the address.

11490

"country": "A String", # The country of the address.

11491

"countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address.

11492

"extendedAddress": "A String", # The extended address of the address; for example, the apartment number.

11493

"formattedType": "A String", # Output only. The type of the address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

11494

"formattedValue": "A String", # The unstructured value of the address. If this is not set by the user it will be automatically constructed from structured values.

11495

"metadata": { # Metadata about a field. # Metadata about the address.

11496

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

11497

"source": { # The source of a field. # The source of the field.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11498

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

11499

"id": "A String", # The unique identifier within the source type generated by the server.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11500

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

11501

"objectType": "A String", # Output only. The profile object type.

11502

"userTypes": [ # Output only. The user types.

11503

"A String",

11504

],

11505

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

11506

"type": "A String", # The source type.

11507

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11508

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

11509

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

11510

},

11511

"poBox": "A String", # The P.O. box of the address.

11512

"postalCode": "A String", # The postal code of the address.

11513

"region": "A String", # The region of the address; for example, the state or province.

11514

"streetAddress": "A String", # The street address.

11515

"type": "A String", # The type of the address. The type can be custom or one of these predefined values: * `home` * `work` * `other`

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11516

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

11517

],

11518

"ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead) The person's age range.

11519

"ageRanges": [ # Output only. The person's age ranges.

11520

{ # A person's age range.

11521

"ageRange": "A String", # The age range.

11522

"metadata": { # Metadata about a field. # Metadata about the age range.

11523

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

11524

"source": { # The source of a field. # The source of the field.

11525

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

11526

"id": "A String", # The unique identifier within the source type generated by the server.

11527

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

11528

"objectType": "A String", # Output only. The profile object type.

11529

"userTypes": [ # Output only. The user types.

11530

"A String",

11531

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11532

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

11533

"type": "A String", # The source type.

11534

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11535

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

11536

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

},

},

],

"biographies": [ # The person's biographies. This field is a singleton for contact sources.

11541

{ # A person's short biography.

11542

"contentType": "A String", # The content type of the biography.

11543

"metadata": { # Metadata about a field. # Metadata about the biography.

11544

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

11545

"source": { # The source of a field. # The source of the field.

11546

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

11547

"id": "A String", # The unique identifier within the source type generated by the server.

11548

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

11549

"objectType": "A String", # Output only. The profile object type.

11550

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

11555

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

11556

},

11557

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

11558

},

11559

"value": "A String", # The short biography.

11560

},

11561

],

11562

"birthdays": [ # The person's birthdays. This field is a singleton for contact sources.

11563

{ # A person's birthday. At least one of the `date` and `text` fields are specified. The `date` and `text` fields typically represent the same date, but are not guaranteed to.

11564

"date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The date of the birthday.

11565

"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

11566

"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

11567

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

11568

},

11569

"metadata": { # Metadata about a field. # Metadata about the birthday.

11570

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

11571

"source": { # The source of a field. # The source of the field.

11572

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

11573

"id": "A String", # The unique identifier within the source type generated by the server.

11574

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

11575

"objectType": "A String", # Output only. The profile object type.

11576

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

11581

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

11582

},

11583

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

11584

},

11585

"text": "A String", # A free-form string representing the user's birthday.

11586

},

11587

],

11588

"braggingRights": [ # **DEPRECATED**: No data will be returned The person's bragging rights.

11589

{ # **DEPRECATED**: No data will be returned A person's bragging rights.

11590

"metadata": { # Metadata about a field. # Metadata about the bragging rights.

11591

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

11592

"source": { # The source of a field. # The source of the field.

11593

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

11594

"id": "A String", # The unique identifier within the source type generated by the server.

11595

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

11596

"objectType": "A String", # Output only. The profile object type.

11597

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

11602

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

11603

},

11604

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

11605

},

11606

"value": "A String", # The bragging rights; for example, `climbed mount everest`.

11607

},

11608

],

11609

"calendarUrls": [ # The person's calendar URLs.

11610

{ # A person's calendar URL.

11611

"formattedType": "A String", # Output only. The type of the calendar URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

11612

"metadata": { # Metadata about a field. # Metadata about the calendar URL.

11613

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

11614

"source": { # The source of a field. # The source of the field.

11615

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

11616

"id": "A String", # The unique identifier within the source type generated by the server.

11617

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

11618

"objectType": "A String", # Output only. The profile object type.

11619

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

11624

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

11625

},

11626

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

11627

},

11628

"type": "A String", # The type of the calendar URL. The type can be custom or one of these predefined values: * `home` * `freeBusy` * `work`

11629

"url": "A String", # The calendar URL.

11630

},

11631

],

11632

"clientData": [ # The person's client data.

11633

{ # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.

11634

"key": "A String", # The client specified key of the client data.

11635

"metadata": { # Metadata about a field. # Metadata about the client data.

11636

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

11637

"source": { # The source of a field. # The source of the field.

11638

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

11639

"id": "A String", # The unique identifier within the source type generated by the server.

11640

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

11641

"objectType": "A String", # Output only. The profile object type.

11642

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

11647

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

11648

},

11649

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

11650

},

11651

"value": "A String", # The client specified value of the client data.

11652

},

11653

],

11654

"coverPhotos": [ # Output only. The person's cover photos.

11655

{ # A person's cover photo. A large image shown on the person's profile page that represents who they are or what they care about.

11656

"default": True or False, # True if the cover photo is the default cover photo; false if the cover photo is a user-provided cover photo.

11657

"metadata": { # Metadata about a field. # Metadata about the cover photo.

11658

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

11659

"source": { # The source of a field. # The source of the field.

11660

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

11661

"id": "A String", # The unique identifier within the source type generated by the server.

11662

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

11663

"objectType": "A String", # Output only. The profile object type.

11664

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

11669

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

11670

},

11671

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

11672

},

11673

"url": "A String", # The URL of the cover photo.

11674

},

11675

],

11676

"emailAddresses": [ # The person's email addresses.

11677

{ # A person's email address.

11678

"displayName": "A String", # The display name of the email.

11679

"formattedType": "A String", # Output only. The type of the email address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

11680

"metadata": { # Metadata about a field. # Metadata about the email address.

11681

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

11682

"source": { # The source of a field. # The source of the field.

11683

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

11684

"id": "A String", # The unique identifier within the source type generated by the server.

11685

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

11686

"objectType": "A String", # Output only. The profile object type.

11687

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

11692

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

11693

},

11694

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

11695

},

11696

"type": "A String", # The type of the email address. The type can be custom or one of these predefined values: * `home` * `work` * `other`

11697

"value": "A String", # The email address.

11698

},

11699

],

11700

"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.

11701

"events": [ # The person's events.

11702

{ # An event related to the person.

11703

"date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The date of the event.

11704

"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

11705

"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

11706

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

11707

},

11708

"formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

11709

"metadata": { # Metadata about a field. # Metadata about the event.

11710

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

11711

"source": { # The source of a field. # The source of the field.

11712

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

11713

"id": "A String", # The unique identifier within the source type generated by the server.

11714

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

11715

"objectType": "A String", # Output only. The profile object type.

11716

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

11721

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

11722

},

11723

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

11724

},

11725

"type": "A String", # The type of the event. The type can be custom or one of these predefined values: * `anniversary` * `other`

11726

},

11727

],

11728

"externalIds": [ # The person's external IDs.

11729

{ # An identifier from an external entity related to the person.

11730

"formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

11731

"metadata": { # Metadata about a field. # Metadata about the external ID.

11732

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

11733

"source": { # The source of a field. # The source of the field.

11734

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

11735

"id": "A String", # The unique identifier within the source type generated by the server.

11736

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

11737

"objectType": "A String", # Output only. The profile object type.

11738

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

11743

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

11744

},

11745

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

11746

},

11747

"type": "A String", # The type of the external ID. The type can be custom or one of these predefined values: * `account` * `customer` * `loginId` * `network` * `organization`

11748

"value": "A String", # The value of the external ID.

11749

},

11750

],

11751

"fileAses": [ # The person's file-ases.

11752

{ # The name that should be used to sort the person in a list.

11753

"metadata": { # Metadata about a field. # Metadata about the file-as.

11754

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

11755

"source": { # The source of a field. # The source of the field.

11756

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

11757

"id": "A String", # The unique identifier within the source type generated by the server.

11758

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

11759

"objectType": "A String", # Output only. The profile object type.

11760

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

11765

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

11766

},

11767

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

11768

},

11769

"value": "A String", # The file-as value

11770

},

11771

],

11772

"genders": [ # The person's genders. This field is a singleton for contact sources.

11773

{ # A person's gender.

11774

"addressMeAs": "A String", # The type of pronouns that should be used to address the person. The value can be custom or one of these predefined values: * `male` * `female` * `other`

11775

"formattedValue": "A String", # Output only. The value of the gender translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. Unspecified or custom value are not localized.

11776

"metadata": { # Metadata about a field. # Metadata about the gender.

11777

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

11778

"source": { # The source of a field. # The source of the field.

11779

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

11780

"id": "A String", # The unique identifier within the source type generated by the server.

11781

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

11782

"objectType": "A String", # Output only. The profile object type.

11783

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

11788

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

11789

},

11790

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

11791

},

11792

"value": "A String", # The gender for the person. The gender can be custom or one of these predefined values: * `male` * `female` * `unspecified`

11793

},

11794

],

11795

"imClients": [ # The person's instant messaging clients.

11796

{ # A person's instant messaging client.

11797

"formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

11798

"formattedType": "A String", # Output only. The type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

11799

"metadata": { # Metadata about a field. # Metadata about the IM client.

11800

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

11801

"source": { # The source of a field. # The source of the field.

11802

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

11803

"id": "A String", # The unique identifier within the source type generated by the server.

11804

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

11805

"objectType": "A String", # Output only. The profile object type.

11806

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

11811

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

11812

},

11813

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

11814

},

11815

"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`

11816

"type": "A String", # The type of the IM client. The type can be custom or one of these predefined values: * `home` * `work` * `other`

11817

"username": "A String", # The user name used in the IM client.

11818

},

11819

],

11820

"interests": [ # The person's interests.

11821

{ # One of the person's interests.

11822

"metadata": { # Metadata about a field. # Metadata about the interest.

11823

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

11824

"source": { # The source of a field. # The source of the field.

11825

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

11826

"id": "A String", # The unique identifier within the source type generated by the server.

11827

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

11828

"objectType": "A String", # Output only. The profile object type.

11829

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

11834

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

11835

},

11836

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

11837

},

11838

"value": "A String", # The interest; for example, `stargazing`.

11839

},

11840

],

11841

"locales": [ # The person's locale preferences.

11842

{ # A person's locale preference.

11843

"metadata": { # Metadata about a field. # Metadata about the locale.

11844

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

11845

"source": { # The source of a field. # The source of the field.

11846

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

11847

"id": "A String", # The unique identifier within the source type generated by the server.

11848

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

11849

"objectType": "A String", # Output only. The profile object type.

11850

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

11855

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

11856

},

11857

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

11858

},

11859

"value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag representing the locale.

11860

},

11861

],

11862

"locations": [ # The person's locations.

11863

{ # A person's location.

11864

"buildingId": "A String", # The building identifier.

11865

"current": True or False, # Whether the location is the current location.

11866

"deskCode": "A String", # The individual desk location.

11867

"floor": "A String", # The floor name or number.

11868

"floorSection": "A String", # The floor section in `floor_name`.

11869

"metadata": { # Metadata about a field. # Metadata about the location.

11870

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

11871

"source": { # The source of a field. # The source of the field.

11872

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

11873

"id": "A String", # The unique identifier within the source type generated by the server.

11874

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

11875

"objectType": "A String", # Output only. The profile object type.

11876

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

11881

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

11882

},

11883

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

11884

},

11885

"type": "A String", # The type of the location. The type can be custom or one of these predefined values: * `desk` * `grewUp`

11886

"value": "A String", # The free-form value of the location.

11887

},

11888

],

11889

"memberships": [ # The person's group memberships.

11890

{ # A person's membership in a group. Only contact group memberships can be modified.

11891

"contactGroupMembership": { # A Google contact group membership. # The contact group membership.

11892

"contactGroupId": "A String", # Output only. The contact group ID for the contact group membership.

11893

"contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`. Only contact_group_resource_name can be used for modifying memberships. Any contact group membership can be removed, but only user group or "myContacts" or "starred" system groups memberships can be added. A contact must always have at least one contact group membership.

11894

},

11895

"domainMembership": { # A G Suite Domain membership. # Output only. The domain membership.

11896

"inViewerDomain": True or False, # True if the person is in the viewer's G Suite domain.

11897

},

11898

"metadata": { # Metadata about a field. # Metadata about the membership.

11899

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

11900

"source": { # The source of a field. # The source of the field.

11901

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

11902

"id": "A String", # The unique identifier within the source type generated by the server.

11903

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

11904

"objectType": "A String", # Output only. The profile object type.

11905

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

11910

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

11911

},

11912

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

},

},

],

"metadata": { # The metadata about a person. # Output only. Metadata about the person.

11917

"deleted": True or False, # Output only. True if the person resource has been deleted. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token.

11918

"linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.

11919

"A String",

11920

],

11921

"objectType": "A String", # Output only. **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object.

11922

"previousResourceNames": [ # Output only. Any former resource names this person has had. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token. The resource name may change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or profile URL.

11923

"A String",

11924

],

11925

"sources": [ # The sources of data for the person.

11926

{ # The source of a field.

11927

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

11928

"id": "A String", # The unique identifier within the source type generated by the server.

11929

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

11930

"objectType": "A String", # Output only. The profile object type.

11931

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

11936

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11937

},

11938

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

11939

},

11940

"miscKeywords": [ # The person's miscellaneous keywords.

11941

{ # A person's miscellaneous keyword.

11942

"formattedType": "A String", # Output only. The type of the miscellaneous keyword translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

11943

"metadata": { # Metadata about a field. # Metadata about the miscellaneous keyword.

11944

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

11945

"source": { # The source of a field. # The source of the field.

11946

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

11947

"id": "A String", # The unique identifier within the source type generated by the server.

11948

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

11949

"objectType": "A String", # Output only. The profile object type.

11950

"userTypes": [ # Output only. The user types.

11951

"A String",

11952

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11953

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

11954

"type": "A String", # The source type.

11955

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11956

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

11957

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11958

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

11959

"type": "A String", # The miscellaneous keyword type.

11960

"value": "A String", # The value of the miscellaneous keyword.

11961

},

11962

],

11963

"names": [ # The person's names. This field is a singleton for contact sources.

11964

{ # A person's name. If the name is a mononym, the family name is empty.

11965

"displayName": "A String", # Output only. The display name formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.

11966

"displayNameLastFirst": "A String", # Output only. The display name with the last name first formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.

11967

"familyName": "A String", # The family name.

11968

"givenName": "A String", # The given name.

11969

"honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`

11970

"honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`

11971

"metadata": { # Metadata about a field. # Metadata about the name.

11972

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

11973

"source": { # The source of a field. # The source of the field.

11974

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

11975

"id": "A String", # The unique identifier within the source type generated by the server.

11976

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

11977

"objectType": "A String", # Output only. The profile object type.

11978

"userTypes": [ # Output only. The user types.

11979

"A String",

11980

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11981

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

11982

"type": "A String", # The source type.

11983

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11984

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

11985

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

11986

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

11987

"middleName": "A String", # The middle name(s).

11988

"phoneticFamilyName": "A String", # The family name spelled as it sounds.

11989

"phoneticFullName": "A String", # The full name spelled as it sounds.

11990

"phoneticGivenName": "A String", # The given name spelled as it sounds.

11991

"phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.

11992

"phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.

11993

"phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.

11994

"unstructuredName": "A String", # The free form name value.

11995

},

11996

],

11997

"nicknames": [ # The person's nicknames.

11998

{ # A person's nickname.

11999

"metadata": { # Metadata about a field. # Metadata about the nickname.

12000

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

12001

"source": { # The source of a field. # The source of the field.

12002

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

12003

"id": "A String", # The unique identifier within the source type generated by the server.

12004

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

12005

"objectType": "A String", # Output only. The profile object type.

12006

"userTypes": [ # Output only. The user types.

12007

"A String",

12008

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12009

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12010

"type": "A String", # The source type.

12011

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12012

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12013

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12014

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12015

"type": "A String", # The type of the nickname.

12016

"value": "A String", # The nickname.

12017

},

12018

],

12019

"occupations": [ # The person's occupations.

12020

{ # A person's occupation.

12021

"metadata": { # Metadata about a field. # Metadata about the occupation.

12022

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

12023

"source": { # The source of a field. # The source of the field.

12024

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

12025

"id": "A String", # The unique identifier within the source type generated by the server.

12026

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

12027

"objectType": "A String", # Output only. The profile object type.

12028

"userTypes": [ # Output only. The user types.

12029

"A String",

12030

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12031

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12032

"type": "A String", # The source type.

12033

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12034

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12035

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12036

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12037

"value": "A String", # The occupation; for example, `carpenter`.

12038

},

12039

],

12040

"organizations": [ # The person's past or current organizations.

12041

{ # A person's past or current organization. Overlapping date ranges are permitted.

12042

"current": True or False, # True if the organization is the person's current organization; false if the organization is a past organization.

12043

"department": "A String", # The person's department at the organization.

12044

"domain": "A String", # The domain name associated with the organization; for example, `google.com`.

12045

"endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The end date when the person left the organization.

12046

"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

12047

"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

12048

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

12049

},

12050

"formattedType": "A String", # Output only. The type of the organization translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

12051

"jobDescription": "A String", # The person's job description at the organization.

12052

"location": "A String", # The location of the organization office the person works at.

12053

"metadata": { # Metadata about a field. # Metadata about the organization.

12054

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

12055

"source": { # The source of a field. # The source of the field.

12056

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

12057

"id": "A String", # The unique identifier within the source type generated by the server.

12058

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

12059

"objectType": "A String", # Output only. The profile object type.

12060

"userTypes": [ # Output only. The user types.

12061

"A String",

12062

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12063

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12064

"type": "A String", # The source type.

12065

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12066

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12067

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12068

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12069

"name": "A String", # The name of the organization.

12070

"phoneticName": "A String", # The phonetic name of the organization.

12071

"startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The start date when the person joined the organization.

12072

"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

12073

"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

12074

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

12075

},

12076

"symbol": "A String", # The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym.

12077

"title": "A String", # The person's job title at the organization.

12078

"type": "A String", # The type of the organization. The type can be custom or one of these predefined values: * `work` * `school`

12079

},

12080

],

12081

"phoneNumbers": [ # The person's phone numbers.

12082

{ # A person's phone number.

12083

"canonicalForm": "A String", # Output only. The canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number.

12084

"formattedType": "A String", # Output only. The type of the phone number translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

12085

"metadata": { # Metadata about a field. # Metadata about the phone number.

12086

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

12087

"source": { # The source of a field. # The source of the field.

12088

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

12089

"id": "A String", # The unique identifier within the source type generated by the server.

12090

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

12091

"objectType": "A String", # Output only. The profile object type.

12092

"userTypes": [ # Output only. The user types.

12093

"A String",

12094

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12095

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12096

"type": "A String", # The source type.

12097

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12098

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12099

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12100

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12101

"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`

12102

"value": "A String", # The phone number.

12103

},

12104

],

12105

"photos": [ # Output only. The person's photos.

12106

{ # A person's photo. A picture shown next to the person's name to help others recognize the person.

12107

"default": True or False, # True if the photo is a default photo; false if the photo is a user-provided photo.

12108

"metadata": { # Metadata about a field. # Metadata about the photo.

12109

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

12110

"source": { # The source of a field. # The source of the field.

12111

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

12112

"id": "A String", # The unique identifier within the source type generated by the server.

12113

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

12114

"objectType": "A String", # Output only. The profile object type.

12115

"userTypes": [ # Output only. The user types.

12116

"A String",

12117

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12118

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12119

"type": "A String", # The source type.

12120

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12121

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12122

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12123

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12124

"url": "A String", # The URL of the photo. You can change the desired size by appending a query parameter `sz={size}` at the end of the url, where {size} is the size in pixels. Example: https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50

12125

},

12126

],

12127

"relations": [ # The person's relations.

12128

{ # A person's relation to another person.

12129

"formattedType": "A String", # Output only. The type of the relation translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.

12130

"metadata": { # Metadata about a field. # Metadata about the relation.

12131

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

12132

"source": { # The source of a field. # The source of the field.

12133

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

12134

"id": "A String", # The unique identifier within the source type generated by the server.

12135

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

12136

"objectType": "A String", # Output only. The profile object type.

12137

"userTypes": [ # Output only. The user types.

12138

"A String",

12139

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12140

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12141

"type": "A String", # The source type.

12142

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12143

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12144

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12145

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12146

"person": "A String", # The name of the other person this relation refers to.

12147

"type": "A String", # The person's relation to the other person. The type can be custom or one of these predefined values: * `spouse` * `child` * `mother` * `father` * `parent` * `brother` * `sister` * `friend` * `relative` * `domesticPartner` * `manager` * `assistant` * `referredBy` * `partner`

12148

},

12149

],

12150

"relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship interests.

12151

{ # **DEPRECATED**: No data will be returned A person's relationship interest .

12152

"formattedValue": "A String", # Output only. The value of the relationship interest translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.

12153

"metadata": { # Metadata about a field. # Metadata about the relationship interest.

12154

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

12155

"source": { # The source of a field. # The source of the field.

12156

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

12157

"id": "A String", # The unique identifier within the source type generated by the server.

12158

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

12159

"objectType": "A String", # Output only. The profile object type.

12160

"userTypes": [ # Output only. The user types.

12161

"A String",

12162

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12163

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12164

"type": "A String", # The source type.

12165

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12166

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12167

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12168

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12169

"value": "A String", # The kind of relationship the person is looking for. The value can be custom or one of these predefined values: * `friend` * `date` * `relationship` * `networking`

12170

},

12171

],

12172

"relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship statuses.

12173

{ # **DEPRECATED**: No data will be returned A person's relationship status.

12174

"formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

12175

"metadata": { # Metadata about a field. # Metadata about the relationship status.

12176

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

12177

"source": { # The source of a field. # The source of the field.

12178

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

12179

"id": "A String", # The unique identifier within the source type generated by the server.

12180

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

12181

"objectType": "A String", # Output only. The profile object type.

12182

"userTypes": [ # Output only. The user types.

12183

"A String",

12184

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12185

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12186

"type": "A String", # The source type.

12187

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12188

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12189

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12190

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12191

"value": "A String", # The relationship status. The value can be custom or one of these predefined values: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion`

12192

},

12193

],

12194

"residences": [ # **DEPRECATED**: (Please use `person.locations` instead) The person's residences.

12195

{ # **DEPRECATED**: Please use `person.locations` instead. A person's past or current residence.

12196

"current": True or False, # True if the residence is the person's current residence; false if the residence is a past residence.

12197

"metadata": { # Metadata about a field. # Metadata about the residence.

12198

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

12199

"source": { # The source of a field. # The source of the field.

12200

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

12201

"id": "A String", # The unique identifier within the source type generated by the server.

12202

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

12203

"objectType": "A String", # Output only. The profile object type.

12204

"userTypes": [ # Output only. The user types.

12205

"A String",

12206

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12207

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12208

"type": "A String", # The source type.

12209

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12210

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12211

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12212

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12213

"value": "A String", # The address of the residence.

12214

},

12215

],

12216

"resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters, in the form of `people/{person_id}`.

12217

"sipAddresses": [ # The person's SIP addresses.

12218

{ # A person's SIP address. Session Initial Protocol addresses are used for VoIP communications to make voice or video calls over the internet.

12219

"formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

12220

"metadata": { # Metadata about a field. # Metadata about the SIP address.

12221

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

12222

"source": { # The source of a field. # The source of the field.

12223

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

12224

"id": "A String", # The unique identifier within the source type generated by the server.

12225

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

12226

"objectType": "A String", # Output only. The profile object type.

12227

"userTypes": [ # Output only. The user types.

12228

"A String",

12229

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12230

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12231

"type": "A String", # The source type.

12232

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12233

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12234

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12235

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12236

"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`

12237

"value": "A String", # The SIP address in the [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI format.

12238

},

12239

],

12240

"skills": [ # The person's skills.

12241

{ # A skill that the person has.

12242

"metadata": { # Metadata about a field. # Metadata about the skill.

12243

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

12244

"source": { # The source of a field. # The source of the field.

12245

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

12246

"id": "A String", # The unique identifier within the source type generated by the server.

12247

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

12248

"objectType": "A String", # Output only. The profile object type.

12249

"userTypes": [ # Output only. The user types.

12250

"A String",

12251

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12252

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12253

"type": "A String", # The source type.

12254

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12255

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12256

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12257

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12258

"value": "A String", # The skill; for example, `underwater basket weaving`.

12259

},

12260

],

12261

"taglines": [ # Output only. **DEPRECATED**: No data will be returned The person's taglines.

12262

{ # **DEPRECATED**: No data will be returned A brief one-line description of the person.

12263

"metadata": { # Metadata about a field. # Metadata about the tagline.

12264

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

12265

"source": { # The source of a field. # The source of the field.

12266

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

12267

"id": "A String", # The unique identifier within the source type generated by the server.

12268

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

12269

"objectType": "A String", # Output only. The profile object type.

12270

"userTypes": [ # Output only. The user types.

12271

"A String",

12272

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12273

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12274

"type": "A String", # The source type.

12275

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12276

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12277

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

12278

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12279

"value": "A String", # The tagline.

12280

},

12281

],

12282

"urls": [ # The person's associated URLs.

12283

{ # A person's associated URLs.

12284

"formattedType": "A String", # Output only. The type of the URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

12285

"metadata": { # Metadata about a field. # Metadata about the URL.

12286

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

12287

"source": { # The source of a field. # The source of the field.

12288

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

12289

"id": "A String", # The unique identifier within the source type generated by the server.

12290

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

12291

"objectType": "A String", # Output only. The profile object type.

12292

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

12297

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

12298

},

12299

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

12300

},

12301

"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 Currents application. * `other`

12302

"value": "A String", # The URL.

12303

},

12304

],

12305

"userDefined": [ # The person's user defined data.

12306

{ # Arbitrary user data that is populated by the end users.

12307

"key": "A String", # The end user specified key of the user defined data.

12308

"metadata": { # Metadata about a field. # Metadata about the user defined data.

12309

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

12310

"source": { # The source of a field. # The source of the field.

12311

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

12312

"id": "A String", # The unique identifier within the source type generated by the server.

12313

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

12314

"objectType": "A String", # Output only. The profile object type.

12315

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

12320

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

12321

},

12322

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

12323

},

12324

"value": "A String", # The end user specified value of the user defined data.

12325

},

12326

],

12327

}</pre>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

</div>

<code class="details" id="updateContactPhoto">updateContactPhoto(resourceName, body=None, x__xgafv=None)</code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

12332

<pre>Update a contact's photo.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

12333

12334

Args:

12335

resourceName: string, Required. Person resource name (required)

12336

body: object, The request body.

12337

The object takes the form of:

12338

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

12339

{ # A request to update an existing contact's photo. All requests must have a valid photo format: JPEG or PNG.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12340

"personFields": "A String", # Optional. A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Defaults to empty if not set, which will skip the post mutate get. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined

12341

"photoBytes": "A String", # Required. Raw photo bytes

12342

"sources": [ # Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.

12343

"A String",

12344

],

12345

}

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

12346

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

12347

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

12354

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

12355

{ # The response for updating a contact's photo.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12356

"person": { # Information about a person merged from various data sources such as the authenticated user's contacts and profile data. Most fields can have multiple items. The items in a field have no guaranteed order, but each non-empty field is guaranteed to have exactly one field with `metadata.primary` set to true. # The updated person, if person_fields is set in the UpdateContactPhotoRequest; otherwise this will be unset.

12357

"addresses": [ # The person's street addresses.

12358

{ # A person's physical address. May be a P.O. box or street address. All fields are optional.

12359

"city": "A String", # The city of the address.

12360

"country": "A String", # The country of the address.

12361

"countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address.

12362

"extendedAddress": "A String", # The extended address of the address; for example, the apartment number.

12363

"formattedType": "A String", # Output only. The type of the address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

12364

"formattedValue": "A String", # The unstructured value of the address. If this is not set by the user it will be automatically constructed from structured values.

12365

"metadata": { # Metadata about a field. # Metadata about the address.

12366

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

12367

"source": { # The source of a field. # The source of the field.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12368

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

12369

"id": "A String", # The unique identifier within the source type generated by the server.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12370

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

12371

"objectType": "A String", # Output only. The profile object type.

12372

"userTypes": [ # Output only. The user types.

12373

"A String",

12374

],

12375

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12376

"type": "A String", # The source type.

12377

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12378

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12379

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

12380

},

12381

"poBox": "A String", # The P.O. box of the address.

12382

"postalCode": "A String", # The postal code of the address.

12383

"region": "A String", # The region of the address; for example, the state or province.

12384

"streetAddress": "A String", # The street address.

12385

"type": "A String", # The type of the address. The type can be custom or one of these predefined values: * `home` * `work` * `other`

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12386

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12387

],

12388

"ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead) The person's age range.

12389

"ageRanges": [ # Output only. The person's age ranges.

12390

{ # A person's age range.

12391

"ageRange": "A String", # The age range.

12392

"metadata": { # Metadata about a field. # Metadata about the age range.

12393

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

12394

"source": { # The source of a field. # The source of the field.

12395

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

12396

"id": "A String", # The unique identifier within the source type generated by the server.

12397

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

12398

"objectType": "A String", # Output only. The profile object type.

12399

"userTypes": [ # Output only. The user types.

12400

"A String",

12401

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12402

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12403

"type": "A String", # The source type.

12404

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12405

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12406

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12407

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12408

},

12409

],

12410

"biographies": [ # The person's biographies. This field is a singleton for contact sources.

12411

{ # A person's short biography.

12412

"contentType": "A String", # The content type of the biography.

12413

"metadata": { # Metadata about a field. # Metadata about the biography.

12414

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

12415

"source": { # The source of a field. # The source of the field.

12416

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

12417

"id": "A String", # The unique identifier within the source type generated by the server.

12418

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

12419

"objectType": "A String", # Output only. The profile object type.

12420

"userTypes": [ # Output only. The user types.

12421

"A String",

12422

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12423

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12424

"type": "A String", # The source type.

12425

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12426

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12427

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12428

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12429

"value": "A String", # The short biography.

12430

},

12431

],

12432

"birthdays": [ # The person's birthdays. This field is a singleton for contact sources.

12433

{ # A person's birthday. At least one of the `date` and `text` fields are specified. The `date` and `text` fields typically represent the same date, but are not guaranteed to.

12434

"date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The date of the birthday.

12435

"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

12436

"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

12437

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12438

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12439

"metadata": { # Metadata about a field. # Metadata about the birthday.

12440

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

12441

"source": { # The source of a field. # The source of the field.

12442

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

12443

"id": "A String", # The unique identifier within the source type generated by the server.

12444

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

12445

"objectType": "A String", # Output only. The profile object type.

12446

"userTypes": [ # Output only. The user types.

12447

"A String",

12448

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12449

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12450

"type": "A String", # The source type.

12451

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12452

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12453

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12454

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12455

"text": "A String", # A free-form string representing the user's birthday.

12456

},

12457

],

12458

"braggingRights": [ # **DEPRECATED**: No data will be returned The person's bragging rights.

12459

{ # **DEPRECATED**: No data will be returned A person's bragging rights.

12460

"metadata": { # Metadata about a field. # Metadata about the bragging rights.

12461

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

12462

"source": { # The source of a field. # The source of the field.

12463

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

12464

"id": "A String", # The unique identifier within the source type generated by the server.

12465

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

12466

"objectType": "A String", # Output only. The profile object type.

12467

"userTypes": [ # Output only. The user types.

12468

"A String",

12469

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12470

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12471

"type": "A String", # The source type.

12472

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12473

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12474

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12475

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12476

"value": "A String", # The bragging rights; for example, `climbed mount everest`.

12477

},

12478

],

12479

"calendarUrls": [ # The person's calendar URLs.

12480

{ # A person's calendar URL.

12481

"formattedType": "A String", # Output only. The type of the calendar URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

12482

"metadata": { # Metadata about a field. # Metadata about the calendar URL.

12483

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

12484

"source": { # The source of a field. # The source of the field.

12485

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

12486

"id": "A String", # The unique identifier within the source type generated by the server.

12487

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

12488

"objectType": "A String", # Output only. The profile object type.

12489

"userTypes": [ # Output only. The user types.

12490

"A String",

12491

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12492

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12493

"type": "A String", # The source type.

12494

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12495

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12496

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12497

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12498

"type": "A String", # The type of the calendar URL. The type can be custom or one of these predefined values: * `home` * `freeBusy` * `work`

12499

"url": "A String", # The calendar URL.

12500

},

12501

],

12502

"clientData": [ # The person's client data.

12503

{ # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.

12504

"key": "A String", # The client specified key of the client data.

12505

"metadata": { # Metadata about a field. # Metadata about the client data.

12506

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

12507

"source": { # The source of a field. # The source of the field.

12508

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

12509

"id": "A String", # The unique identifier within the source type generated by the server.

12510

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

12511

"objectType": "A String", # Output only. The profile object type.

12512

"userTypes": [ # Output only. The user types.

12513

"A String",

12514

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12515

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12516

"type": "A String", # The source type.

12517

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12518

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12519

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12520

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12521

"value": "A String", # The client specified value of the client data.

12522

},

12523

],

12524

"coverPhotos": [ # Output only. The person's cover photos.

12525

{ # A person's cover photo. A large image shown on the person's profile page that represents who they are or what they care about.

12526

"default": True or False, # True if the cover photo is the default cover photo; false if the cover photo is a user-provided cover photo.

12527

"metadata": { # Metadata about a field. # Metadata about the cover photo.

12528

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

12529

"source": { # The source of a field. # The source of the field.

12530

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

12531

"id": "A String", # The unique identifier within the source type generated by the server.

12532

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

12533

"objectType": "A String", # Output only. The profile object type.

12534

"userTypes": [ # Output only. The user types.

12535

"A String",

12536

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12537

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12538

"type": "A String", # The source type.

12539

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12540

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12541

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12542

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12543

"url": "A String", # The URL of the cover photo.

12544

},

12545

],

12546

"emailAddresses": [ # The person's email addresses.

12547

{ # A person's email address.

12548

"displayName": "A String", # The display name of the email.

12549

"formattedType": "A String", # Output only. The type of the email address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

12550

"metadata": { # Metadata about a field. # Metadata about the email address.

12551

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

12552

"source": { # The source of a field. # The source of the field.

12553

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

12554

"id": "A String", # The unique identifier within the source type generated by the server.

12555

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

12556

"objectType": "A String", # Output only. The profile object type.

12557

"userTypes": [ # Output only. The user types.

12558

"A String",

12559

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12560

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12561

"type": "A String", # The source type.

12562

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12563

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12564

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12565

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12566

"type": "A String", # The type of the email address. The type can be custom or one of these predefined values: * `home` * `work` * `other`

12567

"value": "A String", # The email address.

12568

},

12569

],

12570

"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.

12571

"events": [ # The person's events.

12572

{ # An event related to the person.

12573

"date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The date of the event.

12574

"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

12575

"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

12576

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12577

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12578

"formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

12579

"metadata": { # Metadata about a field. # Metadata about the event.

12580

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

12581

"source": { # The source of a field. # The source of the field.

12582

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

12583

"id": "A String", # The unique identifier within the source type generated by the server.

12584

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

12585

"objectType": "A String", # Output only. The profile object type.

12586

"userTypes": [ # Output only. The user types.

12587

"A String",

12588

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12589

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12590

"type": "A String", # The source type.

12591

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12592

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12593

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12594

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12595

"type": "A String", # The type of the event. The type can be custom or one of these predefined values: * `anniversary` * `other`

12596

},

12597

],

12598

"externalIds": [ # The person's external IDs.

12599

{ # An identifier from an external entity related to the person.

12600

"formattedType": "A String", # Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

12601

"metadata": { # Metadata about a field. # Metadata about the external ID.

12602

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

12603

"source": { # The source of a field. # The source of the field.

12604

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

12605

"id": "A String", # The unique identifier within the source type generated by the server.

12606

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

12607

"objectType": "A String", # Output only. The profile object type.

12608

"userTypes": [ # Output only. The user types.

12609

"A String",

12610

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12611

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12612

"type": "A String", # The source type.

12613

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12614

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12615

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12616

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12617

"type": "A String", # The type of the external ID. The type can be custom or one of these predefined values: * `account` * `customer` * `loginId` * `network` * `organization`

12618

"value": "A String", # The value of the external ID.

12619

},

12620

],

12621

"fileAses": [ # The person's file-ases.

12622

{ # The name that should be used to sort the person in a list.

12623

"metadata": { # Metadata about a field. # Metadata about the file-as.

12624

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

12625

"source": { # The source of a field. # The source of the field.

12626

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

12627

"id": "A String", # The unique identifier within the source type generated by the server.

12628

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

12629

"objectType": "A String", # Output only. The profile object type.

12630

"userTypes": [ # Output only. The user types.

12631

"A String",

12632

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12633

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12634

"type": "A String", # The source type.

12635

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12636

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12637

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12638

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12639

"value": "A String", # The file-as value

12640

},

12641

],

12642

"genders": [ # The person's genders. This field is a singleton for contact sources.

12643

{ # A person's gender.

12644

"addressMeAs": "A String", # The type of pronouns that should be used to address the person. The value can be custom or one of these predefined values: * `male` * `female` * `other`

12645

"formattedValue": "A String", # Output only. The value of the gender translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. Unspecified or custom value are not localized.

12646

"metadata": { # Metadata about a field. # Metadata about the gender.

12647

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

12648

"source": { # The source of a field. # The source of the field.

12649

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

12650

"id": "A String", # The unique identifier within the source type generated by the server.

12651

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

12652

"objectType": "A String", # Output only. The profile object type.

12653

"userTypes": [ # Output only. The user types.

12654

"A String",

12655

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12656

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12657

"type": "A String", # The source type.

12658

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12659

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12660

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12661

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12662

"value": "A String", # The gender for the person. The gender can be custom or one of these predefined values: * `male` * `female` * `unspecified`

12663

},

12664

],

12665

"imClients": [ # The person's instant messaging clients.

12666

{ # A person's instant messaging client.

12667

"formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

12668

"formattedType": "A String", # Output only. The type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

12669

"metadata": { # Metadata about a field. # Metadata about the IM client.

12670

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

12671

"source": { # The source of a field. # The source of the field.

12672

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

12673

"id": "A String", # The unique identifier within the source type generated by the server.

12674

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

12675

"objectType": "A String", # Output only. The profile object type.

12676

"userTypes": [ # Output only. The user types.

12677

"A String",

12678

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12679

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12680

"type": "A String", # The source type.

12681

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

12682

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

12683

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

12684

},

12685

"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`

12686

"type": "A String", # The type of the IM client. The type can be custom or one of these predefined values: * `home` * `work` * `other`

12687

"username": "A String", # The user name used in the IM client.

12688

},

12689

],

12690

"interests": [ # The person's interests.

12691

{ # One of the person's interests.

12692

"metadata": { # Metadata about a field. # Metadata about the interest.

12693

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

12694

"source": { # The source of a field. # The source of the field.

12695

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

12696

"id": "A String", # The unique identifier within the source type generated by the server.

12697

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

12698

"objectType": "A String", # Output only. The profile object type.

12699

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

12704

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

12705

},

12706

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

12707

},

12708

"value": "A String", # The interest; for example, `stargazing`.

12709

},

12710

],

12711

"locales": [ # The person's locale preferences.

12712

{ # A person's locale preference.

12713

"metadata": { # Metadata about a field. # Metadata about the locale.

12714

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

12715

"source": { # The source of a field. # The source of the field.

12716

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

12717

"id": "A String", # The unique identifier within the source type generated by the server.

12718

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

12719

"objectType": "A String", # Output only. The profile object type.

12720

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

12725

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

12726

},

12727

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

12728

},

12729

"value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag representing the locale.

12730

},

12731

],

12732

"locations": [ # The person's locations.

12733

{ # A person's location.

12734

"buildingId": "A String", # The building identifier.

12735

"current": True or False, # Whether the location is the current location.

12736

"deskCode": "A String", # The individual desk location.

12737

"floor": "A String", # The floor name or number.

12738

"floorSection": "A String", # The floor section in `floor_name`.

12739

"metadata": { # Metadata about a field. # Metadata about the location.

12740

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

12741

"source": { # The source of a field. # The source of the field.

12742

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

12743

"id": "A String", # The unique identifier within the source type generated by the server.

12744

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

12745

"objectType": "A String", # Output only. The profile object type.

12746

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

12751

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

12752

},

12753

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

12754

},

12755

"type": "A String", # The type of the location. The type can be custom or one of these predefined values: * `desk` * `grewUp`

12756

"value": "A String", # The free-form value of the location.

12757

},

12758

],

12759

"memberships": [ # The person's group memberships.

12760

{ # A person's membership in a group. Only contact group memberships can be modified.

12761

"contactGroupMembership": { # A Google contact group membership. # The contact group membership.

12762

"contactGroupId": "A String", # Output only. The contact group ID for the contact group membership.

12763

"contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`. Only contact_group_resource_name can be used for modifying memberships. Any contact group membership can be removed, but only user group or "myContacts" or "starred" system groups memberships can be added. A contact must always have at least one contact group membership.

12764

},

12765

"domainMembership": { # A G Suite Domain membership. # Output only. The domain membership.

12766

"inViewerDomain": True or False, # True if the person is in the viewer's G Suite domain.

12767

},

12768

"metadata": { # Metadata about a field. # Metadata about the membership.

12769

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

12770

"source": { # The source of a field. # The source of the field.

12771

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

12772

"id": "A String", # The unique identifier within the source type generated by the server.

12773

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

12774

"objectType": "A String", # Output only. The profile object type.

12775

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

12780

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

12781

},

12782

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

},

},

],

"metadata": { # The metadata about a person. # Output only. Metadata about the person.

12787

"deleted": True or False, # Output only. True if the person resource has been deleted. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token.

12788

"linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.

12789

"A String",

12790

],

12791

"objectType": "A String", # Output only. **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object.

12792

"previousResourceNames": [ # Output only. Any former resource names this person has had. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token. The resource name may change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or profile URL.

12793

"A String",

12794

],

12795

"sources": [ # The sources of data for the person.

12796

{ # The source of a field.

12797

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

12798

"id": "A String", # The unique identifier within the source type generated by the server.

12799

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

12800

"objectType": "A String", # Output only. The profile object type.

12801

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

12806

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

12807

},

12808

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

12809

},

Yoshi Automation Bot