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

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

[diff] [blame]

76

<h2>Instance Methods</h2>

77

Dmitry Frenkel

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

[diff] [blame]

78

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

79

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

80

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

81

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

Bu Sun Kim

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

[diff] [blame]

82

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

Jon Wayne Parrott

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

[diff] [blame]

83

84

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

85

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

86

<h3>Method Details</h3>

87

Dmitry Frenkel

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

[diff] [blame]

88

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

89

<pre>Close httplib2 connections.</pre>

</div>

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

93

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

Bu Sun Kim

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

[diff] [blame]

94

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

Jon Wayne Parrott

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

[diff] [blame]

95

96

Args:

Dan O'Meara

dd49464

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

[diff] [blame]

97

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

Yoshi Automation Bot

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

[diff] [blame]

98

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

99

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.

100

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

Yoshi Automation Bot

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

[diff] [blame]

101

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

102

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.

103

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

Yoshi Automation Bot

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

[diff] [blame]

104

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

105

Allowed values

106

READ_SOURCE_TYPE_UNSPECIFIED - Unspecified.

107

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

108

READ_SOURCE_TYPE_CONTACT - Returns SourceType.CONTACT.

109

READ_SOURCE_TYPE_DOMAIN_CONTACT - Returns SourceType.DOMAIN_CONTACT.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

110

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

111

Allowed values

112

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

113

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

114

FIRST_NAME_ASCENDING - Sort people by first name.

115

LAST_NAME_ASCENDING - Sort people by last name.

Bu Sun Kim

6502091

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

[diff] [blame]

116

x__xgafv: string, V1 error format.

117

Allowed values

118

1 - v1 error format

119

2 - v2 error format

Jon Wayne Parrott

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

[diff] [blame]

120

121

Returns:

122

An object of the form:

123

Bu Sun Kim

6502091

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

[diff] [blame]

124

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

Bu Sun Kim

6502091

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

[diff] [blame]

125

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

Bu Sun Kim

d059ad8

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

[diff] [blame]

126

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

Dmitry Frenkel

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

[diff] [blame]

127

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

128

{ # A person's associated URLs.

Bu Sun Kim

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

[diff] [blame]

129

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

Yoshi Automation Bot

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

[diff] [blame]

130

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

Dmitry Frenkel

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

[diff] [blame]

131

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

Yoshi Automation Bot

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

[diff] [blame]

132

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

133

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

Bu Sun Kim

d059ad8

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

[diff] [blame]

134

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

Bu Sun Kim

d059ad8

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

[diff] [blame]

135

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

136

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

137

"A String",

138

],

Bu Sun Kim

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

[diff] [blame]

139

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

Dmitry Frenkel

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

[diff] [blame]

140

},

Bu Sun Kim

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

[diff] [blame]

141

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

Bu Sun Kim

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

[diff] [blame]

142

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

Yoshi Automation Bot

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

[diff] [blame]

143

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

144

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

Bu Sun Kim

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

[diff] [blame]

145

},

Yoshi Automation Bot

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

[diff] [blame]

146

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

Bu Sun Kim

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

[diff] [blame]

147

},

Bu Sun Kim

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

[diff] [blame]

148

},

149

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

150

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

151

{ # An event related to the person.

152

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

153

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

154

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

155

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

Bu Sun Kim

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

[diff] [blame]

156

},

Bu Sun Kim

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

[diff] [blame]

157

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

158

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

159

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

160

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

Yoshi Automation Bot

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

[diff] [blame]

161

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

Yoshi Automation Bot

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

[diff] [blame]

162

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

163

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

164

"A String",

165

],

166

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

167

},

Yoshi Automation Bot

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

[diff] [blame]

168

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

Yoshi Automation Bot

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

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

Yoshi Automation Bot

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

[diff] [blame]

170

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

171

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

Yoshi Automation Bot

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

[diff] [blame]

172

},

173

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

Yoshi Automation Bot

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

[diff] [blame]

174

},

Yoshi Automation Bot

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

[diff] [blame]

175

},

176

],

177

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

178

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

179

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

180

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

181

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

Yoshi Automation Bot

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

[diff] [blame]

182

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

Yoshi Automation Bot

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

[diff] [blame]

183

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

184

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

185

"A String",

186

],

187

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

188

},

Yoshi Automation Bot

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

[diff] [blame]

189

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

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

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

Yoshi Automation Bot

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

[diff] [blame]

193

},

194

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

Yoshi Automation Bot

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

[diff] [blame]

195

},

196

},

197

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

198

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

199

{ # A person's locale preference.

200

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

201

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

202

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

Yoshi Automation Bot

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

[diff] [blame]

203

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

Yoshi Automation Bot

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

[diff] [blame]

204

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

205

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

206

"A String",

207

],

208

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

209

},

Yoshi Automation Bot

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

[diff] [blame]

210

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

Yoshi Automation Bot

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

[diff] [blame]

211

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

Yoshi Automation Bot

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

[diff] [blame]

212

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

213

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

Yoshi Automation Bot

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

[diff] [blame]

214

},

215

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

Yoshi Automation Bot

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

[diff] [blame]

216

},

217

},

218

],

Yoshi Automation Bot

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

[diff] [blame]

219

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

220

{ # A person's location.

Yoshi Automation Bot

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

[diff] [blame]

221

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

222

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

Yoshi Automation Bot

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

[diff] [blame]

223

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

224

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

Yoshi Automation Bot

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

[diff] [blame]

225

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

Yoshi Automation Bot

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

[diff] [blame]

226

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

227

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

228

"A String",

229

],

230

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

231

},

Yoshi Automation Bot

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

[diff] [blame]

232

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

Yoshi Automation Bot

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

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

Yoshi Automation Bot

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

[diff] [blame]

234

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

235

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

Yoshi Automation Bot

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

[diff] [blame]

236

},

237

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

Yoshi Automation Bot

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

[diff] [blame]

238

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

239

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

240

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

241

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

242

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

243

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

Yoshi Automation Bot

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

[diff] [blame]

244

},

245

],

246

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

247

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

248

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

249

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

250

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

Yoshi Automation Bot

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

[diff] [blame]

251

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

Yoshi Automation Bot

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

[diff] [blame]

252

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

253

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

254

"A String",

255

],

256

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

257

},

Yoshi Automation Bot

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

[diff] [blame]

258

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

259

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

260

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

261

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

Yoshi Automation Bot

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

[diff] [blame]

262

},

263

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

},

},

],

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

268

{ # A person's gender.

269

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

Yoshi Automation Bot

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

[diff] [blame]

270

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

271

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

272

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

273

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

274

"A String",

275

],

276

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

277

},

278

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

279

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

280

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

281

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

282

},

283

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

284

},

285

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

286

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

287

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

288

},

289

],

290

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

291

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

292

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

293

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

294

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

295

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

296

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

297

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

298

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

299

"A String",

300

],

301

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

302

},

303

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

304

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

305

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

306

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

307

},

308

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

},

},

],

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

313

{ # A person's relation to another person.

314

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

315

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

316

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

317

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

318

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

319

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

320

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

321

"A String",

322

],

323

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

324

},

325

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

326

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

327

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

328

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

329

},

330

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

331

},

332

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

333

},

334

],

335

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

336

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

337

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

338

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

339

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

340

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

341

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

342

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

343

"A String",

344

],

345

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

346

},

347

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

348

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

349

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

350

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

351

},

352

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

},

},

],

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

357

{ # A skill that the person has.

358

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

359

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

360

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

361

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

362

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

363

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

364

"A String",

365

],

366

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

367

},

368

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

369

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

370

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

371

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

372

},

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.

Yoshi Automation Bot

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

[diff] [blame]

374

},

Bu Sun Kim

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

[diff] [blame]

375

},

376

],

377

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

378

{ # A person's short biography.

379

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

380

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

381

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

382

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

Bu Sun Kim

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

[diff] [blame]

383

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

Bu Sun Kim

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

[diff] [blame]

384

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

385

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

386

"A String",

387

],

Yoshi Automation Bot

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

[diff] [blame]

388

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

Bu Sun Kim

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

[diff] [blame]

389

},

Bu Sun Kim

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

[diff] [blame]

390

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

391

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

392

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

393

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

Bu Sun Kim

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

[diff] [blame]

394

},

Yoshi Automation Bot

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

[diff] [blame]

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.

Bu Sun Kim

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

[diff] [blame]

396

},

397

},

398

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

399

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

400

{ # A person's email address.

401

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

402

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

403

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

404

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

405

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

406

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

Bu Sun Kim

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

[diff] [blame]

407

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

Bu Sun Kim

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

[diff] [blame]

408

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

409

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

410

"A String",

411

],

Yoshi Automation Bot

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

[diff] [blame]

412

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

Bu Sun Kim

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

[diff] [blame]

413

},

Bu Sun Kim

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

[diff] [blame]

414

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

Yoshi Automation Bot

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

[diff] [blame]

415

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

Yoshi Automation Bot

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

[diff] [blame]

416

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

417

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

Yoshi Automation Bot

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

[diff] [blame]

418

},

419

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

Yoshi Automation Bot

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

[diff] [blame]

420

},

Yoshi Automation Bot

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

[diff] [blame]

421

},

422

],

423

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

424

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

Yoshi Automation Bot

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

[diff] [blame]

425

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

426

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

Yoshi Automation Bot

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

[diff] [blame]

427

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

Yoshi Automation Bot

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

[diff] [blame]

428

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

429

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

430

"A String",

431

],

432

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

433

},

Yoshi Automation Bot

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

[diff] [blame]

434

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

435

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

436

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

437

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

Yoshi Automation Bot

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

[diff] [blame]

438

},

439

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

440

},

441

"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

442

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

443

},

444

],

445

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

446

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

447

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

448

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

449

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

450

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

Yoshi Automation Bot

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

[diff] [blame]

451

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

452

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

453

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

454

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

455

"A String",

456

],

457

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

458

},

459

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

460

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

461

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

462

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

463

},

464

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

Yoshi Automation Bot

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

[diff] [blame]

},

},

],

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

469

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

470

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

471

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

Yoshi Automation Bot

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

[diff] [blame]

472

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

Yoshi Automation Bot

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

[diff] [blame]

473

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

474

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

475

"A String",

476

],

477

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

478

},

Yoshi Automation Bot

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

[diff] [blame]

479

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

480

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

481

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

482

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

Yoshi Automation Bot

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

[diff] [blame]

483

},

484

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

Yoshi Automation Bot

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

[diff] [blame]

485

},

486

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

487

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

488

},

489

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

490

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

491

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

492

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

493

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

Yoshi Automation Bot

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

[diff] [blame]

494

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

Yoshi Automation Bot

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

[diff] [blame]

495

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

496

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

497

"A String",

498

],

499

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

500

},

Yoshi Automation Bot

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

[diff] [blame]

501

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

502

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

503

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

504

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

Yoshi Automation Bot

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

[diff] [blame]

505

},

506

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

Yoshi Automation Bot

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

[diff] [blame]

507

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

508

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

509

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

Yoshi Automation Bot

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

[diff] [blame]

510

},

511

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

512

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

513

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

514

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

515

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

516

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

517

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

518

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

519

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

520

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

521

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

522

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

Yoshi Automation Bot

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

[diff] [blame]

523

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

Yoshi Automation Bot

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

[diff] [blame]

524

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

525

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

526

"A String",

527

],

528

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

529

},

Yoshi Automation Bot

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

[diff] [blame]

530

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

531

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

532

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

533

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

Yoshi Automation Bot

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

[diff] [blame]

534

},

535

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

Yoshi Automation Bot

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

[diff] [blame]

536

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

537

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

538

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

539

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

540

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

541

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

542

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

543

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

544

},

545

],

546

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

547

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

548

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

549

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

550

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

551

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

552

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

553

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

554

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

555

"A String",

556

],

557

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

558

},

559

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

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

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

563

},

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

},

Yoshi Automation Bot

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

[diff] [blame]

566

},

567

],

568

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

569

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

570

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

Yoshi Automation Bot

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

[diff] [blame]

571

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

572

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

573

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

Yoshi Automation Bot

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

[diff] [blame]

574

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

Yoshi Automation Bot

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

[diff] [blame]

575

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

576

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

577

"A String",

578

],

579

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

580

},

Yoshi Automation Bot

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

[diff] [blame]

581

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

582

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

583

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

584

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

Yoshi Automation Bot

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

[diff] [blame]

585

},

586

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

Yoshi Automation Bot

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

[diff] [blame]

587

},

Yoshi Automation Bot

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

[diff] [blame]

588

},

589

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

590

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

591

{ # A person's instant messaging client.

592

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

593

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

594

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

595

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

596

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

597

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

598

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

599

"A String",

600

],

601

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

602

},

603

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

604

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

605

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

606

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

607

},

608

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

609

},

610

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

611

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

612

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

613

},

614

],

615

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

616

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

617

{ # A person's phone number.

618

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

619

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

620

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

621

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

622

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

623

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

624

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

625

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

626

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

627

"A String",

628

],

629

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

630

},

631

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

632

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

633

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

634

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

635

},

636

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

},

},

],

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

641

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

642

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

643

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

644

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

645

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

646

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

647

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

648

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

649

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

650

"A String",

651

],

652

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

653

},

654

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

655

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

656

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

657

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

658

},

659

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

},

},

],

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

664

{ # A person's calendar URL.

665

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

666

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

667

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

668

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

669

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

670

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

671

"A String",

672

],

673

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

674

},

675

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

676

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

677

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

678

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

679

},

680

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

681

},

682

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

683

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

684

},

685

],

686

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

687

{ # A person's miscellaneous keyword.

688

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

689

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

690

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

691

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

692

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

693

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

694

"A String",

695

],

696

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

697

},

698

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

699

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

700

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

701

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

702

},

703

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

704

},

705

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

706

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

707

},

708

],

709

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

710

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

711

{ # One of the person's interests.

712

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

713

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

714

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

715

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

716

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

717

"A String",

718

],

719

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

720

},

721

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

722

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

723

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

724

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

725

},

726

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

727

},

728

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

729

},

730

],

731

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

732

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

733

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

734

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

735

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

736

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

737

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

738

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

739

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

740

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

741

"A String",

742

],

743

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

744

},

745

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

746

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

747

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

748

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

749

},

750

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

751

},

752

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

753

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

754

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

755

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

756

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

757

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

758

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

759

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

760

},

761

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

762

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

763

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

764

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

765

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

766

},

767

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

768

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

769

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

770

},

771

],

772

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

773

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

774

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

775

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

776

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

777

},

778

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

779

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

780

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

781

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

782

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

783

"A String",

784

],

785

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

786

},

787

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

788

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

789

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

790

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

791

},

792

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

793

},

794

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

795

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

},

},

],

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

800

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

801

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

802

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

803

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

804

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

805

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

806

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

807

"A String",

808

],

809

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

810

},

811

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

812

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

813

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

814

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

815

},

816

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

817

},

818

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

819

},

820

],

821

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

Yoshi Automation Bot

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

[diff] [blame]

822

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

Yoshi Automation Bot

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

[diff] [blame]

823

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

824

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

Yoshi Automation Bot

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

[diff] [blame]

825

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

826

{ # The source of a field.

Yoshi Automation Bot

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

[diff] [blame]

827

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

828

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

829

"A String",

830

],

831

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

832

},

Yoshi Automation Bot

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

[diff] [blame]

833

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

834

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

835

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

836

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

Yoshi Automation Bot

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

[diff] [blame]

837

},

838

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

839

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

840

"A String",

841

],

842

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

843

"A String",

844

],

Yoshi Automation Bot

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

[diff] [blame]

845

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

846

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

847

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

848

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

849

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

850

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

851

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

852

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

853

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

854

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

855

"A String",

856

],

857

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

858

},

859

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

860

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

861

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

862

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

863

},

864

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

865

},

866

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

867

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

868

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

869

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

870

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

871

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

872

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

873

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

874

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

875

},

876

],

877

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

878

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

879

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

880

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

881

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

882

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

883

},

884

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

885

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

886

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

887

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

888

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

889

"A String",

890

],

891

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

892

},

893

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

894

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

895

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

896

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

897

},

898

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

899

},

900

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

901

},

902

],

903

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

904

{ # A person's age range.

905

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

906

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

907

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

908

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

909

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

910

"A String",

911

],

912

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

913

},

914

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

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

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

917

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

918

},

919

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

920

},

921

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

922

},

923

],

924

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

925

{ # A person's occupation.

926

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

927

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

928

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

929

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

930

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

931

"A String",

932

],

933

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

934

},

935

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

936

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

937

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

938

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

939

},

940

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

941

},

942

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

943

},

944

],

945

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

946

{ # A person's nickname.

947

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

948

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

949

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

950

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

951

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

952

"A String",

953

],

954

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

955

},

956

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

957

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

958

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

959

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

960

},

961

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

962

},

963

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

964

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

965

},

966

],

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

967

},

Jon Wayne Parrott

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

[diff] [blame]

968

],

Yoshi Automation Bot

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

[diff] [blame]

969

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

Yoshi Automation Bot

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

[diff] [blame]

970

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

971

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

972

"nextSyncToken": "A String", # A token, which can be sent as `sync_token` to retrieve changes since the last request. Request must set `request_sync_token` to return the sync token. When the response is paginated, only the last page will contain `nextSyncToken`.

Jon Wayne Parrott