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

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

[diff] [blame]

76

<h2>Instance Methods</h2>

77

Bu Sun Kim

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

[diff] [blame^]

78

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

79

<p class="firstline">Provides a list of the authenticated user's contacts. The request throws a 400 error if 'personFields' is not specified.</p>

Jon Wayne Parrott

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

[diff] [blame]

80

81

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

82

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

83

<h3>Method Details</h3>

84

Bu Sun Kim

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

[diff] [blame^]

85

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

86

<pre>Provides a list of the authenticated user's contacts. The request throws a 400 error if 'personFields' is not specified.

Jon Wayne Parrott

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

[diff] [blame]

87

88

Args:

Dan O'Meara

dd49464

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

[diff] [blame]

89

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

Bu Sun Kim

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

[diff] [blame^]

90

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

91

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

92

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.

93

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

94

sources: string, Optional. A mask of what source types to return. Defaults to ReadSourceType.CONTACT and ReadSourceType.PROFILE if not set. (repeated)

95

Allowed values

96

READ_SOURCE_TYPE_UNSPECIFIED - Unspecified.

97

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

98

READ_SOURCE_TYPE_CONTACT - Returns SourceType.CONTACT.

99

READ_SOURCE_TYPE_DOMAIN_CONTACT - Returns SourceType.DOMAIN_CONTACT.

100

requestMask_includeField: string, Required. Comma-separated list of person fields to be included in the response. Each path should start with `person.`: for example, `person.names` or `person.photos`.

101

personFields: string, Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * coverPhotos * emailAddresses * events * genders * imClients * interests * locales * memberships * metadata * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined

102

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

103

Allowed values

104

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

105

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

106

FIRST_NAME_ASCENDING - Sort people by first name.

107

LAST_NAME_ASCENDING - Sort people by last name.

Bu Sun Kim

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

[diff] [blame]

108

x__xgafv: string, V1 error format.

109

Allowed values

110

1 - v1 error format

111

2 - v2 error format

Jon Wayne Parrott

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

[diff] [blame]

112

113

Returns:

114

An object of the form:

115

Bu Sun Kim

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

[diff] [blame]

116

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

Bu Sun Kim

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

[diff] [blame^]

117

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

118

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

119

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

Bu Sun Kim

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

[diff] [blame]

120

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

Bu Sun Kim

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

[diff] [blame^]

121

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

122

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

123

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

Bu Sun Kim

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

[diff] [blame]

124

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

Bu Sun Kim

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

[diff] [blame]

125

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

Bu Sun Kim

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

[diff] [blame^]

126

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

127

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

128

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

[diff] [blame]

129

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

130

"A String",

131

],

132

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

133

},

Bu Sun Kim

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

[diff] [blame^]

134

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

Bu Sun Kim

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

[diff] [blame]

135

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

Bu Sun Kim

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

[diff] [blame]

136

},

Bu Sun Kim

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

[diff] [blame^]

137

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

138

"verified": True or False, # Output only. True if the field is verified; false if the field is 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-05-27 12:20:54 -0700

[diff] [blame]

139

},

140

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

141

},

142

],

Bu Sun Kim

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

[diff] [blame^]

143

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

144

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

145

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

Bu Sun Kim

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

[diff] [blame]

146

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

Bu Sun Kim

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

[diff] [blame^]

147

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

148

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

149

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

[diff] [blame]

150

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

151

"A String",

152

],

153

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

154

},

Bu Sun Kim

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

[diff] [blame^]

155

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

Bu Sun Kim

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

[diff] [blame]

156

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

Bu Sun Kim

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

[diff] [blame]

157

},

Bu Sun Kim

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

[diff] [blame^]

158

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

159

"verified": True or False, # Output only. True if the field is verified; false if the field is 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-05-27 12:20:54 -0700

[diff] [blame]

160

},

Bu Sun Kim

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

[diff] [blame^]

161

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

162

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

Bu Sun Kim

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

[diff] [blame]

163

},

164

],

165

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

166

{ # A person's locale preference.

Bu Sun Kim

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

[diff] [blame]

167

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

Bu Sun Kim

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

[diff] [blame]

168

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

Bu Sun Kim

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

[diff] [blame^]

169

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

170

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

171

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

[diff] [blame]

172

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

173

"A String",

174

],

175

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

176

},

Bu Sun Kim

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

[diff] [blame^]

177

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

Bu Sun Kim

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

[diff] [blame]

178

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

Bu Sun Kim

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

[diff] [blame]

179

},

Bu Sun Kim

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

[diff] [blame^]

180

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

181

"verified": True or False, # Output only. True if the field is verified; false if the field is 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-05-27 12:20:54 -0700

[diff] [blame]

182

},

Bu Sun Kim

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

[diff] [blame^]

183

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

Bu Sun Kim

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

[diff] [blame]

184

},

185

],

186

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

187

{ # One of the person's interests.

188

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

Bu Sun Kim

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

[diff] [blame]

189

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

Bu Sun Kim

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

[diff] [blame^]

190

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

191

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

192

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

[diff] [blame]

193

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

194

"A String",

195

],

196

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

197

},

Bu Sun Kim

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

[diff] [blame^]

198

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

Bu Sun Kim

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

[diff] [blame]

199

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

Bu Sun Kim

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

[diff] [blame]

200

},

Bu Sun Kim

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

[diff] [blame^]

201

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

202

"verified": True or False, # Output only. True if the field is verified; false if the field is 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-05-27 12:20:54 -0700

[diff] [blame]

203

},

204

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

205

},

206

],

Bu Sun Kim

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

[diff] [blame]

207

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

208

{ # A person's nickname.

Bu Sun Kim

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

[diff] [blame^]

209

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

Bu Sun Kim

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

[diff] [blame]

210

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

211

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

Bu Sun Kim

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

[diff] [blame]

212

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

Bu Sun Kim

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

[diff] [blame^]

213

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

214

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

215

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

[diff] [blame]

216

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

217

"A String",

218

],

219

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

220

},

Bu Sun Kim

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

[diff] [blame^]

221

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

Bu Sun Kim

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

[diff] [blame]

222

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

Bu Sun Kim

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

[diff] [blame]

223

},

Bu Sun Kim

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

[diff] [blame^]

224

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

225

"verified": True or False, # Output only. True if the field is verified; false if the field is 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-05-27 12:20:54 -0700

[diff] [blame]

226

},

Bu Sun Kim

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

[diff] [blame]

227

},

228

],

Bu Sun Kim

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

[diff] [blame^]

229

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

230

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

231

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

Bu Sun Kim

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

[diff] [blame]

232

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

Bu Sun Kim

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

[diff] [blame^]

233

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

234

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

235

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

[diff] [blame]

236

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

237

"A String",

238

],

239

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

240

},

Bu Sun Kim

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

[diff] [blame^]

241

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

Bu Sun Kim

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

[diff] [blame]

242

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

Bu Sun Kim

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

[diff] [blame]

243

},

Bu Sun Kim

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

[diff] [blame^]

244

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

245

"verified": True or False, # Output only. True if the field is verified; false if the field is 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-05-27 12:20:54 -0700

[diff] [blame]

246

},

Bu Sun Kim

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

[diff] [blame^]

247

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

248

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

249

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

250

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

251

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

252

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant.

253

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

254

},

255

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

256

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

257

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

258

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

259

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

260

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

261

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

262

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant.

263

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

264

},

265

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

266

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

267

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

268

},

269

],

270

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

271

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

272

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

273

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

274

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

275

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

276

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

277

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

278

"A String",

279

],

280

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

281

},

282

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

283

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

284

},

285

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

286

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

287

},

288

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

289

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

290

},

291

],

292

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

293

{ # A person's short biography.

294

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

295

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

296

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

297

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

298

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

299

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

300

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

301

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

302

"A String",

303

],

304

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

305

},

306

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

307

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

308

},

309

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

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.

},

},

],

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

315

{ # A person's phone number.

316

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

317

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

318

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

319

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

320

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

321

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

322

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

323

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

324

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

325

"A String",

326

],

327

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

328

},

329

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

330

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

331

},

332

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

333

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

334

},

335

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

336

},

337

],

338

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

339

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

340

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

341

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

342

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

343

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

344

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

345

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

346

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

347

"A String",

348

],

349

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

350

},

351

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

352

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

353

},

354

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

355

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

356

},

357

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

358

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

359

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

360

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

361

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

362

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

363

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

364

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

365

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

366

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

367

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

368

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

369

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

370

},

371

],

372

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

373

{ # A person's instant messaging client.

374

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

375

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

376

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

377

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

378

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

379

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

380

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

381

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

382

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

383

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

384

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

385

"A String",

386

],

387

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

388

},

389

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

390

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

391

},

392

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

393

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

},

},

],

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

398

{ # A person's associated URLs.

399

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

400

"type": "A String", # The type of the URL. The type can be custom or one of these predefined values: * `home` * `work` * `blog` * `profile` * `homePage` * `ftp` * `reservations` * `appInstallPage`: website for a Google+ application. * `other`

401

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

402

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

403

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

404

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

405

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

406

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

407

"A String",

408

],

409

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

410

},

411

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

412

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

413

},

414

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

415

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

416

},

417

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

418

},

419

],

420

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

421

{ # A person's age range.

422

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

423

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

424

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

425

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

426

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

427

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

428

"A String",

429

],

430

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

431

},

432

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

433

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

434

},

435

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

436

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

437

},

438

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

439

},

440

],

441

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

442

{ # A person's occupation.

443

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

444

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

445

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

446

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

447

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

448

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

449

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

450

"A String",

451

],

452

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

453

},

454

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

455

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

456

},

457

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

458

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

},

},

],

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

463

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

464

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

465

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

466

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

467

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

468

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

469

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

470

"A String",

471

],

472

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

473

},

474

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

475

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

476

},

477

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

478

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

479

},

480

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

481

"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

482

},

483

],

484

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

485

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

486

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

487

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

488

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

489

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

490

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

491

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

492

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

493

"A String",

494

],

495

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

496

},

497

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

498

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

499

},

500

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

501

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

502

},

503

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

504

},

505

],

506

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

507

{ # A person's relation to another person.

508

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

509

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

510

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

511

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

512

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

513

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

514

"A String",

515

],

516

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

517

},

518

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

519

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

520

},

521

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

522

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

523

},

524

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

525

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

526

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

527

},

528

],

529

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

530

{ # An event related to the person.

531

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

532

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

533

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

534

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

535

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant.

536

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

537

},

538

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

539

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

540

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

541

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

542

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

543

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

544

"A String",

545

],

546

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

547

},

548

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

549

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

550

},

551

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

552

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

},

},

],

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

557

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

558

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

559

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

560

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

561

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

562

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

563

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

564

"A String",

565

],

566

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

567

},

568

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

569

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

570

},

571

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

572

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

573

},

574

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

575

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

576

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant.

577

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

578

},

579

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

Bu Sun Kim

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

[diff] [blame]

580

},

581

],

582

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

Bu Sun Kim

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

[diff] [blame^]

583

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

584

"A String",

585

],

586

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

Bu Sun Kim

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

[diff] [blame]

587

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

588

"A String",

Bu Sun Kim

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

[diff] [blame]

589

],

Bu Sun Kim

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

[diff] [blame^]

590

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

Bu Sun Kim

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

[diff] [blame]

591

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

592

{ # The source of a field.

Bu Sun Kim

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

[diff] [blame^]

593

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

594

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

595

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

[diff] [blame]

596

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

597

"A String",

598

],

599

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

600

},

Bu Sun Kim

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

[diff] [blame^]

601

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

Bu Sun Kim

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

[diff] [blame]

602

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

Bu Sun Kim

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

[diff] [blame]

603

},

604

],

605

},

Bu Sun Kim

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

[diff] [blame^]

606

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

607

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

608

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

609

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

610

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

611

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

612

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

613

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

614

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

615

"A String",

616

],

617

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

618

},

619

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

620

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

621

},

622

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

623

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

624

},

625

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

626

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

627

},

628

],

629

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

630

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

631

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

632

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

633

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

634

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

635

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

636

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

637

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

638

"A String",

639

],

640

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

641

},

642

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

643

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

644

},

645

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

646

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

},

},

],

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

651

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

652

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

653

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

654

},

655

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

656

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

657

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

658

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

659

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

660

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

661

"A String",

662

],

663

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

664

},

665

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

666

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

667

},

668

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

669

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

670

},

671

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

672

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

673

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

},

},

],

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

678

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

679

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

680

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

681

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

682

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

683

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

684

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

685

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

686

"A String",

687

],

688

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

689

},

690

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

691

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

692

},

693

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

694

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

695

},

696

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

697

},

698

],

699

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

700

{ # A person's gender.

701

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

702

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

703

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

704

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

705

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

706

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

707

"A String",

708

],

709

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

710

},

711

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

712

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

713

},

714

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

715

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

716

},

717

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

718

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

719

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

720

},

721

],

722

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

723

{ # A person's email address.

724

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

725

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

726

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

727

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

728

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

729

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

730

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

731

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

732

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

733

"A String",

734

],

735

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

736

},

737

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

738

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

739

},

740

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

741

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

742

},

743

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

744

},

745

],

746

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

747

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

748

{ # A person's past or current residence.

749

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

750

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

751

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

752

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

753

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

754

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

755

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

756

"A String",

757

],

758

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

759

},

760

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

761

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

762

},

763

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

764

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

765

},

766

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

767

},

768

],

769

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

770

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

771

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

772

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

773

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

774

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

775

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

776

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

777

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

778

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

779

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

780

"A String",

781

],

782

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

783

},

784

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

785

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

786

},

787

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

788

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

},

},

],

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

793

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

794

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

795

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

796

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

797

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

798

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

799

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

800

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

801

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

802

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

803

"A String",

804

],

805

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

806

},

807

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

808

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

809

},

810

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

811

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

812

},

813

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

814

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

815

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

816

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

817

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

818

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

819

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

820

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

821

},

822

],

823

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

824

{ # A skill that the person has.

825

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

826

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

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

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

829

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

830

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

831

"A String",

832

],

833

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

834

},

835

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

836

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

837

},

838

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

839

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

840

},

841

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

842

},

843

],

Bu Sun Kim

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

[diff] [blame]

844

},

Jon Wayne Parrott

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

[diff] [blame]

845

],

Bu Sun Kim

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

[diff] [blame^]

846

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

Jon Wayne Parrott