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

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

[diff] [blame]

91

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

92

<pre>Close httplib2 connections.</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

96

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

97

<pre>Copies an "Other contact" to a new contact in the user's "myContacts" group

98

99

Args:

100

resourceName: string, Required. The resource name of the "Other contact" to copy. (required)

101

body: object, The request body.

102

The object takes the form of:

103

104

{ # A request to copy an "Other contact" to my contacts group.

Bu Sun Kim

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

[diff] [blame]

105

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

Bu Sun Kim

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

[diff] [blame]

106

"A String",

107

],

Bu Sun Kim

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

[diff] [blame]

108

"copyMask": "A String", # Required. A field mask to restrict which fields are copied into the new contact. Valid values are: * emailAddresses * names * phoneNumbers

Dmitry Frenkel

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

[diff] [blame]

109

"readMask": "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 the copy mask with metadata and membership 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-07-22 17:02:09 -0700

[diff] [blame]

110

}

111

112

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

119

120

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

Dmitry Frenkel

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

[diff] [blame]

121

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

122

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

Bu Sun Kim

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

[diff] [blame]

123

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

124

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

125

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

126

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

127

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

128

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

129

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

130

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

"A String",

],

},

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

135

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

136

},

137

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

138

},

Dmitry Frenkel

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

[diff] [blame]

139

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

140

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

Dmitry Frenkel

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

[diff] [blame]

141

},

142

],

Bu Sun Kim

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

[diff] [blame]

143

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

Dmitry Frenkel

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

[diff] [blame]

144

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

145

{ # A person's age range.

Dmitry Frenkel

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

[diff] [blame]

146

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

Bu Sun Kim

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

[diff] [blame]

147

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

148

"verified": True or False, # Output only. True if the field is verified; false if the field is 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]

149

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

Dmitry Frenkel

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

[diff] [blame]

150

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

151

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

Dmitry Frenkel

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

[diff] [blame]

152

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

153

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

Dmitry Frenkel

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

[diff] [blame]

154

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

155

"A String",

156

],

Dmitry Frenkel

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

[diff] [blame]

157

},

Dmitry Frenkel

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

[diff] [blame]

158

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

159

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

Bu Sun Kim

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

[diff] [blame]

160

},

Dmitry Frenkel

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

[diff] [blame]

161

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

},

},

],

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

166

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

Dmitry Frenkel

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

[diff] [blame]

167

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

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.

Dmitry Frenkel

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

[diff] [blame]

169

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

Dmitry Frenkel

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

[diff] [blame]

170

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

171

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

Dmitry Frenkel

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

[diff] [blame]

172

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

173

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

Dmitry Frenkel

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

[diff] [blame]

174

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

175

"A String",

176

],

Dmitry Frenkel

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

[diff] [blame]

177

},

Bu Sun Kim

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

[diff] [blame]

178

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

179

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

180

},

Dmitry Frenkel

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

[diff] [blame]

181

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

182

},

Bu Sun Kim

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

[diff] [blame]

183

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

Bu Sun Kim

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

[diff] [blame]

184

},

185

],

Bu Sun Kim

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

[diff] [blame]

186

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

187

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

188

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

189

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

190

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

191

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

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.

Bu Sun Kim

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

[diff] [blame]

193

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

Bu Sun Kim

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

[diff] [blame]

194

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

195

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

Bu Sun Kim

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

[diff] [blame]

196

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

197

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

Bu Sun Kim

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

[diff] [blame]

198

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

199

"A String",

200

],

Bu Sun Kim

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

[diff] [blame]

201

},

Bu Sun Kim

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

[diff] [blame]

202

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

203

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

Bu Sun Kim

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

[diff] [blame]

204

},

Dmitry Frenkel

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

[diff] [blame]

205

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

206

},

207

},

208

],

Dmitry Frenkel

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

[diff] [blame]

209

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

210

{ # A person's associated URLs.

211

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

Bu Sun Kim

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

[diff] [blame]

212

"verified": True or False, # Output only. True if the field is verified; false if the field is 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-07-22 17:02:09 -0700

[diff] [blame]

213

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

Bu Sun Kim

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

[diff] [blame]

214

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

215

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

Bu Sun Kim

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

[diff] [blame]

216

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

217

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

Bu Sun Kim

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

[diff] [blame]

218

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

219

"A String",

220

],

Bu Sun Kim

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

[diff] [blame]

221

},

Bu Sun Kim

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

[diff] [blame]

222

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

223

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

Bu Sun Kim

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

[diff] [blame]

224

},

Bu Sun Kim

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

[diff] [blame]

225

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

226

},

Dmitry Frenkel

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

[diff] [blame]

227

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

Bu Sun Kim

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

[diff] [blame]

228

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

Dmitry Frenkel

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

[diff] [blame]

229

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

Bu Sun Kim

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

[diff] [blame]

230

},

231

],

Bu Sun Kim

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

[diff] [blame]

232

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

233

{ # A person's instant messaging client.

234

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

235

"verified": True or False, # Output only. True if the field is verified; false if the field is 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-07-22 17:02:09 -0700

[diff] [blame]

236

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

Bu Sun Kim

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

[diff] [blame]

237

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

238

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

Bu Sun Kim

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

[diff] [blame]

239

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

240

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

Bu Sun Kim

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

[diff] [blame]

241

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

242

"A String",

243

],

Bu Sun Kim

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

[diff] [blame]

244

},

Bu Sun Kim

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

[diff] [blame]

245

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

246

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

Bu Sun Kim

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

[diff] [blame]

247

},

Dmitry Frenkel

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

[diff] [blame]

248

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

249

},

Bu Sun Kim

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

[diff] [blame]

250

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

251

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

252

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

253

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

254

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

Bu Sun Kim

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

[diff] [blame]

255

},

256

],

Dmitry Frenkel

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

[diff] [blame]

257

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

Dmitry Frenkel

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

[diff] [blame]

258

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

259

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

260

{ # The source of a field.

Dmitry Frenkel

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

[diff] [blame]

261

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

262

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

Dmitry Frenkel

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

[diff] [blame]

263

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

264

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

Dmitry Frenkel

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

[diff] [blame]

265

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

266

"A String",

267

],

Dmitry Frenkel

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

[diff] [blame]

268

},

Bu Sun Kim

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

[diff] [blame]

269

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

270

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

271

},

272

],

Bu Sun Kim

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

[diff] [blame]

273

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

274

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

275

"A String",

276

],

Dmitry Frenkel

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

[diff] [blame]

277

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

278

"A String",

279

],

280

},

Bu Sun Kim

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

[diff] [blame]

281

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

282

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

283

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

284

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

285

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

286

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

287

},

288

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

289

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

290

"verified": True or False, # Output only. True if the field is verified; false if the field is 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]

291

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

Dmitry Frenkel

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

[diff] [blame]

292

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

293

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

Dmitry Frenkel

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

[diff] [blame]

294

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

295

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

Dmitry Frenkel

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

[diff] [blame]

296

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

297

"A String",

298

],

Dmitry Frenkel

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

[diff] [blame]

299

},

Bu Sun Kim

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

[diff] [blame]

300

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

301

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

302

},

Dmitry Frenkel

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

[diff] [blame]

303

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

304

},

305

},

306

],

Bu Sun Kim

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

[diff] [blame]

307

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

308

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

309

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

310

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

311

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

312

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

313

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

314

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

315

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

316

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

"A String",

],

},

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

321

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

322

},

323

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

324

},

325

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

326

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

327

},

328

],

329

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

330

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

331

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

332

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

333

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

334

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

335

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

336

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

337

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

338

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

339

},

340

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

341

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

342

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

343

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

344

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

345

},

346

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

347

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

348

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

349

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

350

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

351

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

352

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

353

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

354

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

355

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

"A String",

],

},

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

360

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

361

},

362

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

363

},

364

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

365

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

366

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

367

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

368

},

369

],

Dmitry Frenkel

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

[diff] [blame]

370

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

371

{ # A person's nickname.

Dmitry Frenkel

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

[diff] [blame]

372

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

Bu Sun Kim

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

[diff] [blame]

373

"verified": True or False, # Output only. True if the field is verified; false if the field is 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]

374

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

Dmitry Frenkel

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

[diff] [blame]

375

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

376

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

Dmitry Frenkel

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

[diff] [blame]

377

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

378

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

Dmitry Frenkel

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

[diff] [blame]

379

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

380

"A String",

381

],

Dmitry Frenkel

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

[diff] [blame]

382

},

Bu Sun Kim

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

[diff] [blame]

383

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

384

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

385

},

Dmitry Frenkel

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

[diff] [blame]

386

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

387

},

Bu Sun Kim

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

[diff] [blame]

388

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

Dmitry Frenkel

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

[diff] [blame]

389

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

390

},

391

],

Bu Sun Kim

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

[diff] [blame]

392

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

393

{ # A person's occupation.

394

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

395

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

396

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

397

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

398

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

399

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

400

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

401

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

"A String",

],

},

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

406

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

407

},

408

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

409

},

410

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

411

},

412

],

413

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

414

{ # A person's phone number.

415

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

416

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

417

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

418

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

419

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

420

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

421

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

422

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

423

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

424

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

"A String",

],

},

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

429

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

430

},

431

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

432

},

433

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

434

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

435

},

436

],

437

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

438

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

439

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

440

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

441

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

442

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

443

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

444

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

445

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

446

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

447

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

"A String",

],

},

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

452

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

453

},

454

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

455

},

456

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

457

},

458

],

Dmitry Frenkel

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

[diff] [blame]

459

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

460

{ # A person's email address.

Bu Sun Kim

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

[diff] [blame]

461

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

462

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

463

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

Dmitry Frenkel

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

[diff] [blame]

464

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

465

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

Bu Sun Kim

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

[diff] [blame]

466

"verified": True or False, # Output only. True if the field is verified; false if the field is 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]

467

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

Dmitry Frenkel

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

[diff] [blame]

468

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

469

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

Dmitry Frenkel

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

[diff] [blame]

470

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

471

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

Dmitry Frenkel

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

[diff] [blame]

472

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

473

"A String",

474

],

Dmitry Frenkel

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

[diff] [blame]

475

},

Bu Sun Kim

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

[diff] [blame]

476

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

477

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

478

},

Dmitry Frenkel

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

[diff] [blame]

479

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

480

},

Dmitry Frenkel

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

[diff] [blame]

481

},

482

],

Bu Sun Kim

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

[diff] [blame]

483

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

484

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

485

{ # A person's relation to another person.

486

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

487

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

488

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

489

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

490

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

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

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

493

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

494

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

"A String",

],

},

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

499

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

500

},

501

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

502

},

503

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

504

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

505

},

506

],

507

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

508

{ # A person's miscellaneous keyword.

509

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

510

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

511

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

512

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

513

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

514

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

515

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

516

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

517

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

"A String",

],

},

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

522

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

523

},

524

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

525

},

526

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

527

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

528

},

529

],

530

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

531

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

532

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

533

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

534

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

535

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

536

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

537

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

538

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

539

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

"A String",

],

},

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

544

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

545

},

546

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

547

},

548

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

549

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

550

},

551

],

552

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

553

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

554

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

555

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

556

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

557

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

558

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

559

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

560

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

561

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

562

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

563

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

564

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

565

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

566

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

567

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

568

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

569

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

570

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

"A String",

],

},

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

575

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

576

},

577

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

578

},

579

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

580

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

581

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

582

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

583

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

584

},

585

],

586

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

587

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

588

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

589

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

590

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

591

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

592

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

593

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

594

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

595

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

596

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

597

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

598

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

599

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

600

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

601

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

602

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

603

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

"A String",

],

},

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

608

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

609

},

610

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

611

},

612

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

613

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

614

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

615

},

616

],

617

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

618

{ # A person's gender.

619

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

620

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

621

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

622

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

623

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

624

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

625

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

626

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

627

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

628

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

"A String",

],

},

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

633

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

634

},

635

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

636

},

637

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

638

},

639

],

640

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

641

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

642

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

643

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

644

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

645

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

646

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

647

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

648

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

649

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

"A String",

],

},

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

654

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

655

},

656

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

657

},

658

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

659

},

660

],

661

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

662

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

663

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

664

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

665

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

666

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

667

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

668

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

669

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

670

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

671

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

672

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

"A String",

],

},

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

677

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

678

},

679

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

680

},

681

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

682

},

683

],

684

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

685

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

686

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

687

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

688

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

689

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

690

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

691

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

692

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

693

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

"A String",

],

},

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

698

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

699

},

700

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

701

},

702

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

703

"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

704

},

705

],

706

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

707

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

708

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

709

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

710

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

711

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

712

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

713

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

714

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

715

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

716

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

717

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

"A String",

],

},

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

722

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

723

},

724

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

},

},

],

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

729

{ # One of the person's interests.

730

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

731

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

732

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

733

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

734

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

735

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

736

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

737

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

738

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

"A String",

],

},

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

743

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

744

},

745

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

},

},

],

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

750

{ # A person's locale preference.

751

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

752

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

753

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

754

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

755

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

756

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

757

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

758

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

"A String",

],

},

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

763

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

764

},

765

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

766

},

767

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

768

},

769

],

770

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

771

{ # An event related to the person.

772

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

773

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

774

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

775

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

776

},

777

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

778

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

779

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

780

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

781

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

782

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

783

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

784

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

785

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

"A String",

],

},

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

790

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

791

},

792

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

793

},

794

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

795

},

796

],

797

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

798

{ # A person's calendar URL.

799

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

800

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

801

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

802

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

803

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

804

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

805

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

806

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

807

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

808

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

"A String",

],

},

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

813

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

814

},

815

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

816

},

817

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

818

},

819

],

820

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

821

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

822

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

823

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

824

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

825

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

826

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

827

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

828

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

829

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

830

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

"A String",

],

},

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

835

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

836

},

837

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

842

{ # A skill that the person has.

843

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

844

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

845

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

846

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

847

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

848

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

849

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

850

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

"A String",

],

},

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

855

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

856

},

857

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

858

},

859

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

860

},

861

],

862

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

863

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

864

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

865

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

866

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

867

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

868

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

869

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

870

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

871

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

"A String",

],

},

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

876

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

877

},

878

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

879

},

880

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

881

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

882

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

883

},

884

],

885

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

886

{ # A person's short biography.

887

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

888

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

889

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

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

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

892

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

893

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

894

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

895

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

896

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

"A String",

],

},

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

901

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

902

},

903

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

},

},

],

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

908

{ # A person's location.

909

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

910

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

911

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

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

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

914

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

915

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

916

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

917

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

918

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

"A String",

],

},

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

923

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

924

},

925

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

926

},

927

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

928

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

929

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

930

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

931

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

932

},

933

],

Dmitry Frenkel

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

[diff] [blame]

934

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

935

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

Bu Sun Kim

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

[diff] [blame]

936

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

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

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

939

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

940

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

941

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

942

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

943

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

"A String",

],

},

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

948

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

949

},

950

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

951

},

Dmitry Frenkel

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

[diff] [blame]

952

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

953

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

954

},

955

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

956

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

957

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

958

},

Dmitry Frenkel

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

[diff] [blame]

959

},

960

],

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

965

<code class="details" id="list">list(readMask=None, pageToken=None, pageSize=None, requestSyncToken=None, syncToken=None, x__xgafv=None)</code>

Bu Sun Kim

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

[diff] [blame]

966

<pre>List all "Other contacts", that is contacts that are not in a contact group. "Other contacts" are typically auto created contacts from interactions.

967

968

Args:

Dmitry Frenkel

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

[diff] [blame]

969

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: * emailAddresses * names * phoneNumbers

Bu Sun Kim

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

[diff] [blame]

970

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

Dmitry Frenkel

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

[diff] [blame]

971

pageSize: integer, Optional. The number of "Other contacts" to include in the response. Valid values are between 1 and 1000, inclusive. Defaults to 100 if not set or set to 0.

972

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. Initial sync requests that specify `request_sync_token` have an additional rate limit.

Bu Sun Kim

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

[diff] [blame]

973

syncToken: string, Optional. A sync token, received from a previous `ListOtherContacts` 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 `ListOtherContacts` must match the call that provided the sync token.

Bu Sun Kim

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

[diff] [blame]

974

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

981

982

{ # The response to a request for the authenticated user's "Other contacts".

Bu Sun Kim

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

[diff] [blame]

983

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

984

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

Bu Sun Kim

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

[diff] [blame]

985

"otherContacts": [ # The list of "Other contacts" returned as Person resources. "Other contacts" support a limited subset of fields. See ListOtherContactsRequest.request_mask for more detailed information.

986

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

Dmitry Frenkel

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

[diff] [blame]

987

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

988

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

Bu Sun Kim

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

[diff] [blame]

989

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

990

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

991

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

992

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

993

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

994

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

995

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

996

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

"A String",

],

},

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

1001

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

1002

},

1003

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

1004

},

Dmitry Frenkel

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

[diff] [blame]

1005

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

1006

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

Dmitry Frenkel

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

[diff] [blame]

1007

},

1008

],

Bu Sun Kim

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

[diff] [blame]

1009

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

Dmitry Frenkel

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

[diff] [blame]

1010

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

1011

{ # A person's age range.

Dmitry Frenkel

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

[diff] [blame]

1012

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

Bu Sun Kim

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

[diff] [blame]

1013

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

1014

"verified": True or False, # Output only. True if the field is verified; false if the field is 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]

1015

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

Dmitry Frenkel

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

[diff] [blame]

1016

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

1017

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

Dmitry Frenkel

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

[diff] [blame]

1018

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

1019

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

Dmitry Frenkel

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

[diff] [blame]

1020

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

1021

"A String",

1022

],

Dmitry Frenkel

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

[diff] [blame]

1023

},

Dmitry Frenkel

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

[diff] [blame]

1024

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

1025

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

Bu Sun Kim

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

[diff] [blame]

1026

},

Dmitry Frenkel

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

[diff] [blame]

1027

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

},

},

],

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

1032

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

Dmitry Frenkel

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

[diff] [blame]

1033

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

Bu Sun Kim

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

[diff] [blame]

1034

"verified": True or False, # Output only. True if the field is verified; false if the field is 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]

1035

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

Dmitry Frenkel

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

[diff] [blame]

1036

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

1037

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

Dmitry Frenkel

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

[diff] [blame]

1038

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

1039

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

Dmitry Frenkel

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

[diff] [blame]

1040

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

1041

"A String",

1042

],

Dmitry Frenkel

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

[diff] [blame]

1043

},

Bu Sun Kim

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

[diff] [blame]

1044

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

1045

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

1046

},

Dmitry Frenkel

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

[diff] [blame]

1047

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

1048

},

Bu Sun Kim

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

[diff] [blame]

1049

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

Bu Sun Kim

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

[diff] [blame]

1050

},

1051

],

Bu Sun Kim

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

[diff] [blame]

1052

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

1053

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

1054

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

1055

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

1056

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

1057

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

1058

"verified": True or False, # Output only. True if the field is verified; false if the field is 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-07-22 17:02:09 -0700

[diff] [blame]

1059

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

Bu Sun Kim

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

[diff] [blame]

1060

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

1061

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

Bu Sun Kim

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

[diff] [blame]

1062

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

1063

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

Bu Sun Kim

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

[diff] [blame]

1064

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

1065

"A String",

1066

],

Bu Sun Kim

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

[diff] [blame]

1067

},

Bu Sun Kim

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

[diff] [blame]

1068

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

1069

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

Bu Sun Kim

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

[diff] [blame]

1070

},

Dmitry Frenkel

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

[diff] [blame]

1071

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

1072

},

1073

},

1074

],

Dmitry Frenkel

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

[diff] [blame]

1075

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

1076

{ # A person's associated URLs.

1077

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

Bu Sun Kim

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

[diff] [blame]

1078

"verified": True or False, # Output only. True if the field is verified; false if the field is 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-07-22 17:02:09 -0700

[diff] [blame]

1079

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

Bu Sun Kim

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

[diff] [blame]

1080

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

1081

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

Bu Sun Kim

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

[diff] [blame]

1082

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

1083

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

Bu Sun Kim

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

[diff] [blame]

1084

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

1085

"A String",

1086

],

Bu Sun Kim

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

[diff] [blame]

1087

},

Bu Sun Kim

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

[diff] [blame]

1088

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

1089

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

Bu Sun Kim

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

[diff] [blame]

1090

},

Bu Sun Kim

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

[diff] [blame]

1091

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

1092

},

Dmitry Frenkel

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

[diff] [blame]

1093

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

Bu Sun Kim

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

[diff] [blame]

1094

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

Dmitry Frenkel

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

[diff] [blame]

1095

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

Bu Sun Kim

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

[diff] [blame]

1096

},

1097

],

Bu Sun Kim

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

[diff] [blame]

1098

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

1099

{ # A person's instant messaging client.

1100

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

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.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1102

"source": { # The source of a field. # The source of the field.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1103

"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]

1104

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1105

"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]

1106

"objectType": "A String", # Output only. The profile object type.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1107

"userTypes": [ # Output only. The user types.

1108

"A String",

1109

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1110

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1111

"type": "A String", # The source type.

1112

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1113

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1114

"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]

1115

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1116

"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`

1117

"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.

1118

"type": "A String", # The type of the IM client. The type can be custom or one of these predefined values: * `home` * `work` * `other`

1119

"username": "A String", # The user name used in the IM client.

1120

"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.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1121

},

1122

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1123

"metadata": { # The metadata about a person. # Output only. Metadata about the person.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1124

"objectType": "A String", # Output only. **DEPRECATED** (Please use `person.metadata.sources.profileMetadata.objectType` instead) The type of the person object.

1125

"sources": [ # The sources of data for the person.

1126

{ # The source of a field.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1127

"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]

1128

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1129

"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]

1130

"objectType": "A String", # Output only. The profile object type.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1131

"userTypes": [ # Output only. The user types.

1132

"A String",

1133

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1134

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1135

"type": "A String", # The source type.

1136

"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]

1137

},

1138

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1139

"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.

1140

"linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.

1141

"A String",

1142

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1143

"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.

1144

"A String",

1145

],

1146

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1147

"birthdays": [ # The person's birthdays. This field is a singleton for contact sources.

1148

{ # 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.

1149

"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.

1150

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

1151

"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

1152

"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.

1153

},

1154

"text": "A String", # A free-form string representing the user's birthday.

1155

"metadata": { # Metadata about a field. # Metadata about the birthday.

1156

"verified": True or False, # Output only. True if the field is verified; false if the field is 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]

1157

"source": { # The source of a field. # The source of the field.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1158

"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]

1159

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1160

"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]

1161

"objectType": "A String", # Output only. The profile object type.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1162

"userTypes": [ # Output only. The user types.

1163

"A String",

1164

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1165

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1166

"type": "A String", # The source type.

1167

"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]

1168

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1169

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

1170

},

1171

},

1172

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1173

"clientData": [ # The person's client data.

1174

{ # Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.

1175

"metadata": { # Metadata about a field. # Metadata about the client data.

1176

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

1177

"source": { # The source of a field. # The source of the field.

1178

"id": "A String", # The unique identifier within the source type generated by the server.

1179

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

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

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

1190

},

1191

"value": "A String", # The client specified value of the client data.

1192

"key": "A String", # The client specified key of the client data.

1193

},

1194

],

1195

"organizations": [ # The person's past or current organizations.

1196

{ # A person's past or current organization. Overlapping date ranges are permitted.

1197

"type": "A String", # The type of the organization. The type can be custom or one of these predefined values: * `work` * `school`

1198

"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.

1199

"title": "A String", # The person's job title at the organization.

1200

"location": "A String", # The location of the organization office the person works at.

1201

"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.

1202

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

1203

"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

1204

"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.

1205

},

1206

"domain": "A String", # The domain name associated with the organization; for example, `google.com`.

1207

"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.

1208

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

1209

"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

1210

"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.

1211

},

1212

"name": "A String", # The name of the organization.

1213

"symbol": "A String", # The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym.

1214

"metadata": { # Metadata about a field. # Metadata about the organization.

1215

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

1216

"source": { # The source of a field. # The source of the field.

1217

"id": "A String", # The unique identifier within the source type generated by the server.

1218

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

1219

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

1220

"objectType": "A String", # Output only. The profile object type.

1221

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

1226

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

1227

},

1228

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

1229

},

1230

"phoneticName": "A String", # The phonetic name of the organization.

1231

"current": True or False, # True if the organization is the person's current organization; false if the organization is a past organization.

1232

"department": "A String", # The person's department at the organization.

1233

"jobDescription": "A String", # The person's job description at the organization.

1234

},

1235

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1236

"nicknames": [ # The person's nicknames.

1237

{ # A person's nickname.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1238

"metadata": { # Metadata about a field. # Metadata about the nickname.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1239

"verified": True or False, # Output only. True if the field is verified; false if the field is 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]

1240

"source": { # The source of a field. # The source of the field.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1241

"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]

1242

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1243

"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]

1244

"objectType": "A String", # Output only. The profile object type.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1245

"userTypes": [ # Output only. The user types.

1246

"A String",

1247

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1248

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1249

"type": "A String", # The source type.

1250

"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]

1251

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1252

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

1253

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1254

"value": "A String", # The nickname.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1255

"type": "A String", # The type of the nickname.

1256

},

1257

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1258

"occupations": [ # The person's occupations.

1259

{ # A person's occupation.

1260

"metadata": { # Metadata about a field. # Metadata about the occupation.

1261

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

1262

"source": { # The source of a field. # The source of the field.

1263

"id": "A String", # The unique identifier within the source type generated by the server.

1264

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

1265

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

1266

"objectType": "A String", # Output only. The profile object type.

1267

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

1272

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

1273

},

1274

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

1275

},

1276

"value": "A String", # The occupation; for example, `carpenter`.

1277

},

1278

],

1279

"phoneNumbers": [ # The person's phone numbers.

1280

{ # A person's phone number.

1281

"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.

1282

"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.

1283

"metadata": { # Metadata about a field. # Metadata about the phone number.

1284

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

1285

"source": { # The source of a field. # The source of the field.

1286

"id": "A String", # The unique identifier within the source type generated by the server.

1287

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

1288

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

1289

"objectType": "A String", # Output only. The profile object type.

1290

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

1295

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

1296

},

1297

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

1298

},

1299

"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`

1300

"value": "A String", # The phone number.

1301

},

1302

],

1303

"coverPhotos": [ # Output only. The person's cover photos.

1304

{ # 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.

1305

"url": "A String", # The URL of the cover photo.

1306

"metadata": { # Metadata about a field. # Metadata about the cover photo.

1307

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

1308

"source": { # The source of a field. # The source of the field.

1309

"id": "A String", # The unique identifier within the source type generated by the server.

1310

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

1311

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

1312

"objectType": "A String", # Output only. The profile object type.

1313

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

1318

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

1319

},

1320

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

1321

},

1322

"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.

1323

},

1324

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1325

"emailAddresses": [ # The person's email addresses.

1326

{ # A person's email address.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1327

"displayName": "A String", # The display name of the email.

1328

"value": "A String", # The email address.

1329

"type": "A String", # The type of the email address. The type can be custom or one of these predefined values: * `home` * `work` * `other`

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1330

"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.

1331

"metadata": { # Metadata about a field. # Metadata about the email address.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1332

"verified": True or False, # Output only. True if the field is verified; false if the field is 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]

1333

"source": { # The source of a field. # The source of the field.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1334

"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]

1335

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1336

"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]

1337

"objectType": "A String", # Output only. The profile object type.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1338

"userTypes": [ # Output only. The user types.

1339

"A String",

1340

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1341

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1342

"type": "A String", # The source type.

1343

"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]

1344

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1345

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

1346

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1347

},

1348

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1349

"ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead) The person's age range.

1350

"relations": [ # The person's relations.

1351

{ # A person's relation to another person.

1352

"person": "A String", # The name of the other person this relation refers to.

1353

"metadata": { # Metadata about a field. # Metadata about the relation.

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

"source": { # The source of a field. # The source of the field.

1356

"id": "A String", # The unique identifier within the source type generated by the server.

1357

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

1358

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

1359

"objectType": "A String", # Output only. The profile object type.

1360

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

1365

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

1366

},

1367

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

1368

},

1369

"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.

1370

"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`

1371

},

1372

],

1373

"miscKeywords": [ # The person's miscellaneous keywords.

1374

{ # A person's miscellaneous keyword.

1375

"value": "A String", # The value of the miscellaneous keyword.

1376

"metadata": { # Metadata about a field. # Metadata about the miscellaneous keyword.

1377

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

1378

"source": { # The source of a field. # The source of the field.

1379

"id": "A String", # The unique identifier within the source type generated by the server.

1380

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

1381

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

1382

"objectType": "A String", # Output only. The profile object type.

1383

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

1388

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

1389

},

1390

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

1391

},

1392

"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.

1393

"type": "A String", # The miscellaneous keyword type.

1394

},

1395

],

1396

"relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship statuses.

1397

{ # **DEPRECATED**: No data will be returned A person's relationship status.

1398

"metadata": { # Metadata about a field. # Metadata about the relationship status.

1399

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

1400

"source": { # The source of a field. # The source of the field.

1401

"id": "A String", # The unique identifier within the source type generated by the server.

1402

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

1403

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

1404

"objectType": "A String", # Output only. The profile object type.

1405

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

1410

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

1411

},

1412

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

1413

},

1414

"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`

1415

"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.

1416

},

1417

],

1418

"names": [ # The person's names. This field is a singleton for contact sources.

1419

{ # A person's name. If the name is a mononym, the family name is empty.

1420

"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.

1421

"honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`

1422

"familyName": "A String", # The family name.

1423

"givenName": "A String", # The given name.

1424

"honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`

1425

"middleName": "A String", # The middle name(s).

1426

"phoneticFullName": "A String", # The full name spelled as it sounds.

1427

"phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.

1428

"phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.

1429

"metadata": { # Metadata about a field. # Metadata about the name.

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.

1431

"source": { # The source of a field. # The source of the field.

1432

"id": "A String", # The unique identifier within the source type generated by the server.

1433

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

1434

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

1435

"objectType": "A String", # Output only. The profile object type.

1436

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

1441

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

1442

},

1443

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

1444

},

1445

"phoneticFamilyName": "A String", # The family name spelled as it sounds.

1446

"phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.

1447

"phoneticGivenName": "A String", # The given name spelled as it sounds.

1448

"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.

1449

"unstructuredName": "A String", # The free form name value.

1450

},

1451

],

1452

"addresses": [ # The person's street addresses.

1453

{ # A person's physical address. May be a P.O. box or street address. All fields are optional.

1454

"countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address.

1455

"extendedAddress": "A String", # The extended address of the address; for example, the apartment number.

1456

"city": "A String", # The city of the address.

1457

"country": "A String", # The country of the address.

1458

"streetAddress": "A String", # The street address.

1459

"region": "A String", # The region of the address; for example, the state or province.

1460

"type": "A String", # The type of the address. The type can be custom or one of these predefined values: * `home` * `work` * `other`

1461

"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.

1462

"metadata": { # Metadata about a field. # Metadata about the address.

1463

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

1464

"source": { # The source of a field. # The source of the field.

1465

"id": "A String", # The unique identifier within the source type generated by the server.

1466

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

1467

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

1468

"objectType": "A String", # Output only. The profile object type.

1469

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

1474

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

1475

},

1476

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

1477

},

1478

"poBox": "A String", # The P.O. box of the address.

1479

"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.

1480

"postalCode": "A String", # The postal code of the address.

1481

},

1482

],

1483

"genders": [ # The person's genders. This field is a singleton for contact sources.

1484

{ # A person's gender.

1485

"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.

1486

"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`

1487

"metadata": { # Metadata about a field. # Metadata about the gender.

1488

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

1489

"source": { # The source of a field. # The source of the field.

1490

"id": "A String", # The unique identifier within the source type generated by the server.

1491

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

1492

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

1493

"objectType": "A String", # Output only. The profile object type.

1494

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

1499

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

1500

},

1501

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

1502

},

1503

"value": "A String", # The gender for the person. The gender can be custom or one of these predefined values: * `male` * `female` * `unspecified`

1504

},

1505

],

1506

"taglines": [ # Output only. **DEPRECATED**: No data will be returned The person's taglines.

1507

{ # **DEPRECATED**: No data will be returned A brief one-line description of the person.

1508

"metadata": { # Metadata about a field. # Metadata about the tagline.

1509

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

1510

"source": { # The source of a field. # The source of the field.

1511

"id": "A String", # The unique identifier within the source type generated by the server.

1512

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

1513

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

1514

"objectType": "A String", # Output only. The profile object type.

1515

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

1520

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

1521

},

1522

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

1523

},

1524

"value": "A String", # The tagline.

1525

},

1526

],

1527

"sipAddresses": [ # The person's SIP addresses.

1528

{ # A person's SIP address. Session Initial Protocol addresses are used for VoIP communications to make voice or video calls over the internet.

1529

"value": "A String", # The SIP address in the [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI format.

1530

"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`

1531

"metadata": { # Metadata about a field. # Metadata about the SIP address.

1532

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

1533

"source": { # The source of a field. # The source of the field.

1534

"id": "A String", # The unique identifier within the source type generated by the server.

1535

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

1536

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

1537

"objectType": "A String", # Output only. The profile object type.

1538

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

1543

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

1544

},

1545

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

1546

},

1547

"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.

1548

},

1549

],

1550

"photos": [ # Output only. The person's photos.

1551

{ # A person's photo. A picture shown next to the person's name to help others recognize the person.

1552

"metadata": { # Metadata about a field. # Metadata about the photo.

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

"source": { # The source of a field. # The source of the field.

1555

"id": "A String", # The unique identifier within the source type generated by the server.

1556

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

1557

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

1558

"objectType": "A String", # Output only. The profile object type.

1559

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

1564

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

1565

},

1566

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

1567

},

1568

"default": True or False, # True if the photo is a default photo; false if the photo is a user-provided photo.

1569

"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

1570

},

1571

],

1572

"relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned The person's relationship interests.

1573

{ # **DEPRECATED**: No data will be returned A person's relationship interest .

1574

"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.

1575

"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`

1576

"metadata": { # Metadata about a field. # Metadata about the relationship interest.

1577

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

1578

"source": { # The source of a field. # The source of the field.

1579

"id": "A String", # The unique identifier within the source type generated by the server.

1580

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

1581

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

1582

"objectType": "A String", # Output only. The profile object type.

1583

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

1588

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

1589

},

1590

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

},

},

],

"interests": [ # The person's interests.

1595

{ # One of the person's interests.

1596

"value": "A String", # The interest; for example, `stargazing`.

1597

"metadata": { # Metadata about a field. # Metadata about the interest.

1598

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

1599

"source": { # The source of a field. # The source of the field.

1600

"id": "A String", # The unique identifier within the source type generated by the server.

1601

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

1602

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

1603

"objectType": "A String", # Output only. The profile object type.

1604

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

1609

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

1610

},

1611

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

},

},

],

"locales": [ # The person's locale preferences.

1616

{ # A person's locale preference.

1617

"metadata": { # Metadata about a field. # Metadata about the locale.

1618

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

1619

"source": { # The source of a field. # The source of the field.

1620

"id": "A String", # The unique identifier within the source type generated by the server.

1621

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

1622

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

1623

"objectType": "A String", # Output only. The profile object type.

1624

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

1629

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

1630

},

1631

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

1632

},

1633

"value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag representing the locale.

1634

},

1635

],

1636

"events": [ # The person's events.

1637

{ # An event related to the person.

1638

"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.

1639

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

1640

"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

1641

"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.

1642

},

1643

"type": "A String", # The type of the event. The type can be custom or one of these predefined values: * `anniversary` * `other`

1644

"metadata": { # Metadata about a field. # Metadata about the event.

1645

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

1646

"source": { # The source of a field. # The source of the field.

1647

"id": "A String", # The unique identifier within the source type generated by the server.

1648

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

1649

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

1650

"objectType": "A String", # Output only. The profile object type.

1651

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

1656

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

1657

},

1658

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

1659

},

1660

"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.

1661

},

1662

],

1663

"calendarUrls": [ # The person's calendar URLs.

1664

{ # A person's calendar URL.

1665

"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.

1666

"type": "A String", # The type of the calendar URL. The type can be custom or one of these predefined values: * `home` * `freeBusy` * `work`

1667

"metadata": { # Metadata about a field. # Metadata about the calendar URL.

1668

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

1669

"source": { # The source of a field. # The source of the field.

1670

"id": "A String", # The unique identifier within the source type generated by the server.

1671

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

1672

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

1673

"objectType": "A String", # Output only. The profile object type.

1674

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

1679

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

1680

},

1681

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

1682

},

1683

"url": "A String", # The calendar URL.

1684

},

1685

],

1686

"braggingRights": [ # **DEPRECATED**: No data will be returned The person's bragging rights.

1687

{ # **DEPRECATED**: No data will be returned A person's bragging rights.

1688

"value": "A String", # The bragging rights; for example, `climbed mount everest`.

1689

"metadata": { # Metadata about a field. # Metadata about the bragging rights.

1690

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

1691

"source": { # The source of a field. # The source of the field.

1692

"id": "A String", # The unique identifier within the source type generated by the server.

1693

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

1694

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

1695

"objectType": "A String", # Output only. The profile object type.

1696

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

1701

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

1702

},

1703

"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.

1708

{ # A skill that the person has.

1709

"metadata": { # Metadata about a field. # Metadata about the skill.

1710

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

1711

"source": { # The source of a field. # The source of the field.

1712

"id": "A String", # The unique identifier within the source type generated by the server.

1713

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

1714

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

1715

"objectType": "A String", # Output only. The profile object type.

1716

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

1721

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

1722

},

1723

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

1724

},

1725

"value": "A String", # The skill; for example, `underwater basket weaving`.

1726

},

1727

],

1728

"externalIds": [ # The person's external IDs.

1729

{ # An identifier from an external entity related to the person.

1730

"metadata": { # Metadata about a field. # Metadata about the external ID.

1731

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

1732

"source": { # The source of a field. # The source of the field.

1733

"id": "A String", # The unique identifier within the source type generated by the server.

1734

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

1735

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

1736

"objectType": "A String", # Output only. The profile object type.

1737

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

1742

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

1743

},

1744

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

1745

},

1746

"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`

1747

"value": "A String", # The value of the external ID.

1748

"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.

1749

},

1750

],

1751

"biographies": [ # The person's biographies. This field is a singleton for contact sources.

1752

{ # A person's short biography.

1753

"contentType": "A String", # The content type of the biography.

1754

"value": "A String", # The short biography.

1755

"metadata": { # Metadata about a field. # Metadata about the biography.

1756

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

1757

"source": { # The source of a field. # The source of the field.

1758

"id": "A String", # The unique identifier within the source type generated by the server.

1759

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

1760

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

1761

"objectType": "A String", # Output only. The profile object type.

1762

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

1767

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

1768

},

1769

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

},

},

],

"locations": [ # The person's locations.

1774

{ # A person's location.

1775

"deskCode": "A String", # The individual desk location.

1776

"floor": "A String", # The floor name or number.

1777

"metadata": { # Metadata about a field. # Metadata about the location.

1778

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

1779

"source": { # The source of a field. # The source of the field.

1780

"id": "A String", # The unique identifier within the source type generated by the server.

1781

"etag": "A String", # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation.

1782

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

1783

"objectType": "A String", # Output only. The profile object type.

1784

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

1789

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

1790

},

1791

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

1792

},

1793

"floorSection": "A String", # The floor section in `floor_name`.

1794

"buildingId": "A String", # The building identifier.

1795

"type": "A String", # The type of the location. The type can be custom or one of these predefined values: * `desk` * `grewUp`

1796

"current": True or False, # Whether the location is the current location.

1797

"value": "A String", # The free-form value of the location.

1798

},

1799

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1800

"memberships": [ # The person's group memberships.

1801

{ # A person's membership in a group. Only contact group memberships can be modified.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1802

"metadata": { # Metadata about a field. # Metadata about the membership.

1803

"verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.

1804

"source": { # The source of a field. # The source of the field.

1805

"id": "A String", # The unique identifier within the source type generated by the server.

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

"profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.** Metadata about a source of type PROFILE.

1808

"objectType": "A String", # Output only. The profile object type.

1809

"userTypes": [ # Output only. The user types.

"A String",

],

},

"type": "A String", # The source type.

1814

"updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.** Last update timestamp of this source.

1815

},

1816

"primary": True or False, # True if the field is the primary field; false if the field is a secondary field.

1817

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1818

"domainMembership": { # A G Suite Domain membership. # Output only. The domain membership.

1819

"inViewerDomain": True or False, # True if the person is in the viewer's G Suite domain.

1820

},

1821

"contactGroupMembership": { # A Google contact group membership. # The contact group membership.

1822

"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.

1823

"contactGroupId": "A String", # Output only. The contact group ID for the contact group membership.

1824

},

Dmitry Frenkel