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

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

[diff] [blame]

76

<h2>Instance Methods</h2>

77

Dmitry Frenkel

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

[diff] [blame]

78

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

79

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

80

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

81

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

Bu Sun Kim

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

[diff] [blame]

82

<p class="firstline">Provides a list of the authenticated user's contacts. The request returns a 400 error if `personFields` is not specified. The request returns a 410 error if `sync_token` is specified and is expired. Sync tokens expire after 7 days. A request without `sync_token` should be made and all contacts should be synced.</p>

Jon Wayne Parrott

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

[diff] [blame]

83

84

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

85

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

86

<h3>Method Details</h3>

87

Dmitry Frenkel

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

[diff] [blame]

88

<code class="details" id="close">close()</code>

89

<pre>Close httplib2 connections.</pre>

</div>

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

93

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

Bu Sun Kim

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

[diff] [blame]

94

<pre>Provides a list of the authenticated user's contacts. The request returns a 400 error if `personFields` is not specified. The request returns a 410 error if `sync_token` is specified and is expired. Sync tokens expire after 7 days. A request without `sync_token` should be made and all contacts should be synced.

Jon Wayne Parrott

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

[diff] [blame]

95

96

Args:

Dan O'Meara

dd49464

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

[diff] [blame]

97

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

Dmitry Frenkel

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

[diff] [blame]

98

pageSize: integer, Optional. The number of connections 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

2020-11-24 15:48:03 -0800

[diff] [blame^]

99

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

100

syncToken: string, Optional. A sync token, received from a previous `ListConnections` call. Provide this to retrieve only the resources changed since the last request. Sync requests that specify `sync_token` have an additional rate limit. When syncing, all other parameters provided to `ListConnections` must match the call that provided the sync token.

Bu Sun Kim

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

[diff] [blame]

101

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

102

Allowed values

103

LAST_MODIFIED_ASCENDING - Sort people by when they were changed; older entries first.

104

LAST_MODIFIED_DESCENDING - Sort people by when they were changed; newer entries first.

105

FIRST_NAME_ASCENDING - Sort people by first name.

106

LAST_NAME_ASCENDING - Sort people by last name.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

107

requestSyncToken: boolean, Optional. Whether the response should include `next_sync_token` on the last page, which can be used to get all changes since the last request. For subsequent sync requests use the `sync_token` param instead. Initial sync requests that specify `request_sync_token` have an additional rate limit.

108

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

109

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)

110

Allowed values

111

READ_SOURCE_TYPE_UNSPECIFIED - Unspecified.

112

READ_SOURCE_TYPE_PROFILE - Returns SourceType.ACCOUNT, SourceType.DOMAIN_PROFILE, and SourceType.PROFILE.

113

READ_SOURCE_TYPE_CONTACT - Returns SourceType.CONTACT.

114

READ_SOURCE_TYPE_DOMAIN_CONTACT - Returns SourceType.DOMAIN_CONTACT.

115

pageToken: string, Optional. A page token, received from a previous `ListConnections` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListConnections` must match the call that provided the page token.

Bu Sun Kim

6502091

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

[diff] [blame]

116

x__xgafv: string, V1 error format.

117

Allowed values

118

1 - v1 error format

119

2 - v2 error format

Jon Wayne Parrott

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

[diff] [blame]

120

121

Returns:

122

An object of the form:

123

Bu Sun Kim

6502091

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

[diff] [blame]

124

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

Bu Sun Kim

6502091

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

[diff] [blame]

125

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

Bu Sun Kim

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

[diff] [blame]

126

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

2020-11-24 15:48:03 -0800

[diff] [blame^]

127

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

128

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

129

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

130

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

Bu Sun Kim

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

[diff] [blame]

131

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

Bu Sun Kim

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

[diff] [blame]

132

"etag": "A String", # **Only 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-24 15:48:03 -0800

[diff] [blame^]

133

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

Bu Sun Kim

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

[diff] [blame]

134

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

Bu Sun Kim

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

[diff] [blame]

135

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

136

"A String",

137

],

Bu Sun Kim

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

[diff] [blame]

138

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

Dmitry Frenkel

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

[diff] [blame]

139

},

Dmitry Frenkel

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

[diff] [blame]

140

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

Bu Sun Kim

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

[diff] [blame]

141

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

Dmitry Frenkel

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

[diff] [blame]

142

},

Bu Sun Kim

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

[diff] [blame]

143

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

Dmitry Frenkel

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

[diff] [blame]

144

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

145

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

146

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

147

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

Bu Sun Kim

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

[diff] [blame]

148

},

149

],

Dmitry Frenkel

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

[diff] [blame]

150

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

151

{ # A person's associated URLs.

Bu Sun Kim

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

[diff] [blame]

152

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

153

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

Dmitry Frenkel

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

[diff] [blame]

154

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

155

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

Bu Sun Kim

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

[diff] [blame]

156

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

Bu Sun Kim

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

[diff] [blame]

157

"etag": "A String", # **Only 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-24 15:48:03 -0800

[diff] [blame^]

158

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

Bu Sun Kim

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

[diff] [blame]

159

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

160

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

161

"A String",

162

],

Bu Sun Kim

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

[diff] [blame]

163

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

Dmitry Frenkel

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

[diff] [blame]

164

},

Bu Sun Kim

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

[diff] [blame]

165

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

Bu Sun Kim

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

[diff] [blame]

166

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

167

},

Bu Sun Kim

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

[diff] [blame]

168

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

Bu Sun Kim

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

[diff] [blame]

169

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

},

},

],

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

174

{ # A skill that the person has.

175

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

Bu Sun Kim

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

[diff] [blame]

176

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

Bu Sun Kim

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

[diff] [blame]

177

"etag": "A String", # **Only 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-24 15:48:03 -0800

[diff] [blame^]

178

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

Bu Sun Kim

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

[diff] [blame]

179

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

Bu Sun Kim

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

[diff] [blame]

180

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

181

"A String",

182

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

183

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

Bu Sun Kim

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

[diff] [blame]

184

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

185

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

Bu Sun Kim

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

[diff] [blame]

186

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

187

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

188

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

Bu Sun Kim

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

[diff] [blame]

189

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

190

},

191

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

192

},

193

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

194

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

195

{ # A person's gender.

196

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

197

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

Bu Sun Kim

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

[diff] [blame]

198

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

Bu Sun Kim

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

[diff] [blame]

199

"etag": "A String", # **Only 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-24 15:48:03 -0800

[diff] [blame^]

200

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

Bu Sun Kim

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

[diff] [blame]

201

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

Bu Sun Kim

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

[diff] [blame]

202

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

203

"A String",

204

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

205

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

Bu Sun Kim

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

[diff] [blame]

206

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

207

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

Bu Sun Kim

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

[diff] [blame]

208

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

209

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

210

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

Bu Sun Kim

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

[diff] [blame]

211

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

212

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

213

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

214

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

215

},

216

],

217

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

218

{ # A person's nickname.

219

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

220

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

221

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

222

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

223

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

224

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

225

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

226

"A String",

227

],

228

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

229

},

230

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

231

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

232

},

233

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

234

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

235

},

236

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

237

},

238

],

239

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

240

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

Bu Sun Kim

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

[diff] [blame]

241

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

242

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

243

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

244

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

245

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

246

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

247

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

248

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

249

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

250

"A String",

251

],

252

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

253

},

254

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

255

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

256

},

257

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

258

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

},

},

],

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

263

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

264

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

265

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

266

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

267

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

268

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

269

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

270

"A String",

271

],

272

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

273

},

274

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

275

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

276

},

277

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

278

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

279

},

280

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

281

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

282

},

283

],

284

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

285

{ # A person's phone number.

286

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

287

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

288

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

289

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

290

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

291

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

292

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

293

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

294

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

295

"A String",

296

],

297

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

298

},

299

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

300

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

301

},

302

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

303

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

304

},

305

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

306

},

307

],

308

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

309

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

310

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

311

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

312

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

313

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

314

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

315

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

316

"A String",

317

],

318

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

319

},

320

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

321

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

322

},

323

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

324

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

325

},

326

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

327

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

328

},

329

],

330

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

331

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

332

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

333

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

334

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

335

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

336

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

337

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

338

"A String",

339

],

340

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

341

},

342

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

343

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

344

},

345

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

346

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

347

},

348

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

349

},

350

],

351

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

352

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

353

{ # A person's instant messaging client.

354

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

355

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

356

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

357

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

358

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

359

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

360

"A String",

361

],

362

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

363

},

364

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

365

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

366

},

367

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

368

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

369

},

370

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

371

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

372

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

373

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

374

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

375

},

376

],

377

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

378

{ # A person's locale preference.

379

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

380

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

381

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

382

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

383

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

384

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

385

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

386

"A String",

387

],

388

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

389

},

390

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

391

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

392

},

393

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

394

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

},

},

],

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

399

{ # A person's relation to another person.

400

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

401

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

402

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

403

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

404

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

405

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

406

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

407

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

408

"A String",

409

],

410

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

411

},

412

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

413

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

414

},

415

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

416

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

417

},

418

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

419

},

420

],

421

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

422

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

423

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

424

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

425

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

426

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

427

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

428

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

429

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

430

"A String",

431

],

432

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

433

},

434

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

435

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

436

},

437

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

438

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

439

},

440

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

441

},

442

],

443

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

444

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

445

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

446

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

447

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

448

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

449

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

450

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

451

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

452

"A String",

453

],

454

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

455

},

456

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

457

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

458

},

459

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

460

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

},

},

],

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

465

{ # A person's age range.

466

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

467

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

468

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

469

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

470

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

471

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

472

"A String",

473

],

474

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

475

},

476

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

477

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

478

},

479

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

480

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

481

},

482

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

483

},

484

],

485

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

486

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

487

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

488

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

489

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

490

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

491

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

492

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

493

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

494

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

495

"A String",

496

],

497

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

498

},

499

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

500

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

501

},

502

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

503

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

},

},

],

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

508

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

509

{ # A person's location.

510

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

511

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

512

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

513

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

514

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

515

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

516

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

517

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

518

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

519

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

520

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

521

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

522

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

523

"A String",

524

],

525

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

526

},

527

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

528

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

529

},

530

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

531

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

},

},

],

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

536

{ # A person's occupation.

537

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

538

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

539

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

540

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

541

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

542

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

543

"A String",

544

],

545

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

546

},

547

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

548

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

549

},

550

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

551

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

552

},

553

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

554

},

555

],

556

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

557

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

558

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

559

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

560

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

561

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

562

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

563

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

564

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

565

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

566

"A String",

567

],

568

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

569

},

570

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

571

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

572

},

573

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

574

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

575

},

576

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

577

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

578

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

579

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

580

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

581

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

582

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

583

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

584

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

585

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

586

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

587

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

588

},

589

],

590

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

591

{ # A person's email address.

592

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

593

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

594

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

595

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

596

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

597

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

598

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

599

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

600

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

601

"A String",

602

],

603

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

604

},

605

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

606

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

607

},

608

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

609

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

610

},

611

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

612

},

613

],

614

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

615

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

616

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

617

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

618

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

619

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

620

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

621

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

622

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

623

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

624

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

625

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

626

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

627

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

628

"A String",

629

],

630

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

631

},

632

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

633

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

634

},

635

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

636

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

637

},

638

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

639

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

640

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

641

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

642

},

643

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

644

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

645

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

646

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

647

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

648

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

649

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

650

},

651

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

652

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

653

},

654

],

655

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

656

{ # A person's calendar URL.

657

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

658

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

659

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

660

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

661

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

662

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

663

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

664

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

665

"A String",

666

],

667

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

668

},

669

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

670

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

671

},

672

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

673

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

674

},

675

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

676

},

677

],

678

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

679

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

680

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

681

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

682

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

683

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

684

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

685

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

686

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

687

"A String",

688

],

689

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

690

},

691

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

692

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

693

},

694

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

695

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

696

},

Bu Sun Kim

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

[diff] [blame]

697

},

698

],

699

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

700

{ # A person's short biography.

701

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

702

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

703

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

Bu Sun Kim

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

[diff] [blame]

704

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

Bu Sun Kim

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

[diff] [blame]

705

"etag": "A String", # **Only 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-24 15:48:03 -0800

[diff] [blame^]

706

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

Bu Sun Kim

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

[diff] [blame]

707

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

Bu Sun Kim

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

[diff] [blame]

708

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

709

"A String",

710

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

711

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

Bu Sun Kim

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

[diff] [blame]

712

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

713

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

Bu Sun Kim

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

[diff] [blame]

714

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

715

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

716

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

Bu Sun Kim

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

[diff] [blame]

717

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

718

},

719

},

720

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

721

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

722

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

723

{ # A person's miscellaneous keyword.

724

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

725

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

726

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

Bu Sun Kim

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

[diff] [blame]

727

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

Bu Sun Kim

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

[diff] [blame]

728

"etag": "A String", # **Only 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-24 15:48:03 -0800

[diff] [blame^]

729

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

Bu Sun Kim

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

[diff] [blame]

730

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

Bu Sun Kim

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

[diff] [blame]

731

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

732

"A String",

733

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

734

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

Bu Sun Kim

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

[diff] [blame]

735

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

736

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

Bu Sun Kim

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

[diff] [blame]

737

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

738

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

739

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

Bu Sun Kim

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

[diff] [blame]

740

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

741

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

742

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

743

},

744

],

745

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

746

{ # An event related to the person.

747

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

748

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

749

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

750

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

751

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

752

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

753

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

754

"A String",

755

],

756

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

757

},

758

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

759

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

760

},

761

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

762

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

763

},

764

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

765

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

766

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

767

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

768

},

769

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

Bu Sun Kim

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

[diff] [blame]

770

},

771

],

Dmitry Frenkel

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

[diff] [blame]

772

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

773

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

774

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

775

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

776

},

Bu Sun Kim

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

[diff] [blame]

777

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

Bu Sun Kim

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

[diff] [blame]

778

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

Bu Sun Kim

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

[diff] [blame]

779

"etag": "A String", # **Only 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-24 15:48:03 -0800

[diff] [blame^]

780

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

Bu Sun Kim

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

[diff] [blame]

781

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

Bu Sun Kim

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

[diff] [blame]

782

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

783

"A String",

784

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

785

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

Bu Sun Kim

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

[diff] [blame]

786

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

787

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

Bu Sun Kim

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

[diff] [blame]

788

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

789

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

790

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

Bu Sun Kim

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

[diff] [blame]

791

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

792

},

Dmitry Frenkel

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

[diff] [blame]

793

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

794

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

795

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

796

},

Dmitry Frenkel

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

[diff] [blame]

797

},

798

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

799

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

800

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

801

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

802

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

803

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

804

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

805

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

806

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

807

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

808

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

809

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

810

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

811

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

812

"A String",

813

],

814

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

815

},

816

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

817

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

818

},

819

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

820

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

821

},

822

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

823

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

824

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

825

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

826

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

827

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

828

},

829

],

830

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

831

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

832

"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

833

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

834

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

835

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

836

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

837

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

838

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

839

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

840

"A String",

841

],

842

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

843

},

844

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

845

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

846

},

847

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

848

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

},

},

],

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

853

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

854

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

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

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

858

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

859

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

860

"A String",

861

],

862

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

863

},

864

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

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

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

869

},

870

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

871

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

872

},

873

],

874

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

875

{ # One of the person's interests.

876

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

877

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

878

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

879

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

880

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

881

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

882

"A String",

883

],

884

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

885

},

886

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

887

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

888

},

889

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

890

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

891

},

892

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

893

},

894

],

895

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

896

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

897

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

898

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

899

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

900

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

901

},

902

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

903

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

904

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

905

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

906

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

907

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

908

"A String",

909

],

910

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

911

},

912

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

913

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

914

},

915

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

916

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

917

},

918

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

919

},

920

],

921

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

922

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

923

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

924

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

925

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

926

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

927

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

928

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

929

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

930

"A String",

931

],

932

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

933

},

934

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

935

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

936

},

937

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

938

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

939

},

940

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

941

},

942

],

943

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

944

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

945

"A String",

946

],

947

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

948

"A String",

949

],

950

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

951

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

952

{ # The source of a field.

953

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

954

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

955

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

956

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

957

"A String",

958

],

959

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

960

},

961

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

962

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

963

},

964

],

965

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

966

},

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

967

},

Jon Wayne Parrott

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

[diff] [blame]

968

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

969

"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. When the response is paginated, only the last page will contain `nextSyncToken`.

970

"totalPeople": 42, # **DEPRECATED** (Please use totalItems) The total number of people in the list without pagination.

971

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

972

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

Jon Wayne Parrott