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

3e17f89

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-12-09 08:56:03 -0800

[diff] [blame^]

81

<code><a href="#list">list(resourceName, pageSize=None, requestSyncToken=None, requestMask_includeField=None, sources=None, syncToken=None, personFields=None, pageToken=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

3e17f89

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-12-09 08:56:03 -0800

[diff] [blame^]

93

<code class="details" id="list">list(resourceName, pageSize=None, requestSyncToken=None, requestMask_includeField=None, sources=None, syncToken=None, personFields=None, pageToken=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-12-09 08:56:03 -0800

[diff] [blame^]

98

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

Yoshi Automation Bot

c2228be

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

[diff] [blame]

99

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-12-09 08:56:03 -0800

[diff] [blame^]

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

Yoshi Automation Bot

c2228be

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

[diff] [blame]

101

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)

102

Allowed values

103

READ_SOURCE_TYPE_UNSPECIFIED - Unspecified.

104

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

105

READ_SOURCE_TYPE_CONTACT - Returns SourceType.CONTACT.

106

READ_SOURCE_TYPE_DOMAIN_CONTACT - Returns SourceType.DOMAIN_CONTACT.

Yoshi Automation Bot

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

[diff] [blame^]

107

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.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

108

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

Yoshi Automation Bot

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

[diff] [blame^]

109

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.

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.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

125

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

Bu Sun Kim

6502091

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

[diff] [blame]

126

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

Bu Sun Kim

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

[diff] [blame]

127

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

Yoshi Automation Bot

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

[diff] [blame^]

128

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

129

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

130

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

131

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

132

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

133

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

Bu Sun Kim

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

[diff] [blame]

134

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

Yoshi Automation Bot

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

[diff] [blame^]

135

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

136

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

137

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

138

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

Bu Sun Kim

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

[diff] [blame]

139

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

Yoshi Automation Bot

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

[diff] [blame^]

140

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

Bu Sun Kim

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

[diff] [blame]

141

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

142

"A String",

143

],

Dmitry Frenkel

3e17f89

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

[diff] [blame]

144

},

Bu Sun Kim

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

[diff] [blame]

145

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

146

},

Yoshi Automation Bot

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

[diff] [blame^]

147

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

148

},

149

],

Yoshi Automation Bot

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

[diff] [blame^]

150

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

151

{ # A person's age range.

152

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

153

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

154

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

155

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

156

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

Yoshi Automation Bot

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

[diff] [blame^]

157

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

158

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

159

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

160

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

161

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

Yoshi Automation Bot

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

[diff] [blame^]

162

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

163

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

164

"A String",

165

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

166

},

167

},

Bu Sun Kim

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

[diff] [blame]

168

},

Bu Sun Kim

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

[diff] [blame]

169

},

170

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

171

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

172

{ # A person's associated URLs.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

173

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

174

"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-12-09 08:56:03 -0800

[diff] [blame^]

175

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

176

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

Yoshi Automation Bot

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

[diff] [blame^]

177

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

178

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

179

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

Yoshi Automation Bot

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

[diff] [blame^]

180

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

181

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

182

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

183

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

184

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

Yoshi Automation Bot

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

[diff] [blame^]

185

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

186

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

187

"A String",

188

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

189

},

190

},

Yoshi Automation Bot

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

[diff] [blame]

191

},

192

},

193

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

194

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

195

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

196

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

Yoshi Automation Bot

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

[diff] [blame^]

197

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

198

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

199

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

Yoshi Automation Bot

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

[diff] [blame^]

200

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

201

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

202

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

203

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

Yoshi Automation Bot

2020-11-25 07:50:41 -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.

Yoshi Automation Bot

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

[diff] [blame^]

205

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

Yoshi Automation Bot

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

[diff] [blame]

206

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

207

"A String",

208

],

Yoshi Automation Bot

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

[diff] [blame]

209

},

Yoshi Automation Bot

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

[diff] [blame]

210

},

Yoshi Automation Bot

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

[diff] [blame]

211

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

212

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

Yoshi Automation Bot

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

[diff] [blame]

213

},

214

],

Yoshi Automation Bot

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

[diff] [blame^]

215

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

216

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

217

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

218

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

219

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

220

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

Yoshi Automation Bot

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

[diff] [blame^]

221

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

222

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

223

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

224

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

Yoshi Automation Bot

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

[diff] [blame]

225

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

Yoshi Automation Bot

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

[diff] [blame^]

226

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

Yoshi Automation Bot

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

[diff] [blame]

227

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

228

"A String",

229

],

Yoshi Automation Bot

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

[diff] [blame]

230

},

Yoshi Automation Bot

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

[diff] [blame]

231

},

Yoshi Automation Bot

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

[diff] [blame]

232

},

Yoshi Automation Bot

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

[diff] [blame^]

233

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

234

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

235

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

236

},

237

],

238

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

239

{ # A person's relation to another person.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

240

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

Yoshi Automation Bot

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

[diff] [blame^]

241

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

242

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

243

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

Yoshi Automation Bot

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

[diff] [blame^]

244

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

245

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

246

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

247

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

248

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

Yoshi Automation Bot

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

[diff] [blame^]

249

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

250

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

251

"A String",

252

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

253

},

254

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

255

},

Yoshi Automation Bot

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

[diff] [blame^]

256

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

257

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

258

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

259

},

260

],

261

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

262

{ # A person's miscellaneous keyword.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

263

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

Yoshi Automation Bot

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

[diff] [blame^]

264

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

265

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

266

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

Yoshi Automation Bot

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

[diff] [blame^]

267

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

268

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

269

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

270

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

271

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

Yoshi Automation Bot

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

[diff] [blame^]

272

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

273

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

274

"A String",

275

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

276

},

277

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

278

},

Yoshi Automation Bot

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

[diff] [blame^]

279

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

280

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

281

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

282

},

283

],

Yoshi Automation Bot

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

[diff] [blame^]

284

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

285

{ # A person's short biography.

286

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

287

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

288

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

289

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

290

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

Yoshi Automation Bot

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

[diff] [blame^]

291

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

292

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

293

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

294

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

295

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

Yoshi Automation Bot

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

[diff] [blame^]

296

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

297

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

298

"A String",

299

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

300

},

301

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

302

},

Yoshi Automation Bot

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

[diff] [blame^]

303

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

304

},

305

],

Yoshi Automation Bot

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

[diff] [blame^]

306

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

307

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

308

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

309

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

310

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

311

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

Yoshi Automation Bot

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

[diff] [blame^]

312

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

313

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

314

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

315

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

316

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

Yoshi Automation Bot

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

[diff] [blame^]

317

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

318

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

319

"A String",

320

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

321

},

322

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

323

},

Yoshi Automation Bot

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

[diff] [blame^]

324

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

325

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

326

},

327

],

Yoshi Automation Bot

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

[diff] [blame^]

328

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

329

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

330

{ # A skill that the person has.

Yoshi Automation Bot

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

[diff] [blame^]

331

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

332

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

Yoshi Automation Bot

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

[diff] [blame^]

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

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

335

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

Yoshi Automation Bot

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

[diff] [blame^]

336

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

337

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

338

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

339

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

340

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

Yoshi Automation Bot

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

[diff] [blame^]

341

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

342

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

343

"A String",

344

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

345

},

346

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

347

},

Yoshi Automation Bot

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

[diff] [blame]

348

},

349

],

Yoshi Automation Bot

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

[diff] [blame^]

350

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

351

{ # A person's location.

352

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

353

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

354

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

355

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

356

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

357

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

358

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

359

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

360

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

Yoshi Automation Bot

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

[diff] [blame^]

361

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

362

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

363

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

364

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

Yoshi Automation Bot

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

[diff] [blame]

365

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

Yoshi Automation Bot

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

[diff] [blame^]

366

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

Yoshi Automation Bot

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

[diff] [blame]

367

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

368

"A String",

369

],

Yoshi Automation Bot

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

[diff] [blame]

370

},

Yoshi Automation Bot

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

[diff] [blame]

371

},

Yoshi Automation Bot

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

[diff] [blame^]

372

},

373

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

374

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

375

},

376

],

377

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

378

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

379

{ # A person's occupation.

380

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

381

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

Yoshi Automation Bot

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

[diff] [blame]

382

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

383

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

Yoshi Automation Bot

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

[diff] [blame^]

384

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

385

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

386

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

387

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

388

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

389

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

390

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

391

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

"A String",

],

},

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

396

},

Yoshi Automation Bot

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

[diff] [blame^]

397

},

398

],

399

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

400

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

401

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

402

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

403

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

404

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

405

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

406

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

407

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

408

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

409

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

410

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

411

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

"A String",

],

},

},

Yoshi Automation Bot

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

[diff] [blame]

416

},

Yoshi Automation Bot

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

[diff] [blame^]

417

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

418

},

419

],

420

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

421

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

422

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

423

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

424

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

425

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

426

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

427

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

428

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

429

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

430

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

431

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

432

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

433

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

"A String",

],

},

},

},

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

Yoshi Automation Bot

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

[diff] [blame]

440

},

441

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

442

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

443

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

444

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

445

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

Yoshi Automation Bot

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

[diff] [blame^]

446

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

447

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

448

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

Yoshi Automation Bot

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

[diff] [blame^]

449

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

450

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

451

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

452

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

Yoshi Automation Bot

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

[diff] [blame]

453

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

Yoshi Automation Bot

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

[diff] [blame^]

454

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

Yoshi Automation Bot

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

[diff] [blame]

455

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

456

"A String",

457

],

Yoshi Automation Bot

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

[diff] [blame]

458

},

Yoshi Automation Bot

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

[diff] [blame]

459

},

Yoshi Automation Bot

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

[diff] [blame]

460

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

461

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

462

},

463

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

464

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

465

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

466

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

467

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

468

},

469

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

470

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

Yoshi Automation Bot

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

[diff] [blame^]

471

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

472

},

473

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

Yoshi Automation Bot

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

[diff] [blame^]

474

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

475

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

476

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

Yoshi Automation Bot

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

[diff] [blame^]

477

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

478

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

479

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

480

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

481

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

Yoshi Automation Bot

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

[diff] [blame^]

482

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

483

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

484

"A String",

485

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

486

},

487

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

488

},

489

},

490

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

491

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

492

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

493

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

Yoshi Automation Bot

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

[diff] [blame^]

494

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

495

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

496

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

Yoshi Automation Bot

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

[diff] [blame^]

497

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

498

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

499

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

500

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

501

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

Yoshi Automation Bot

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

[diff] [blame^]

502

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

503

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

504

"A String",

505

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

506

},

507

},

Yoshi Automation Bot

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

[diff] [blame^]

508

},

509

"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

510

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

511

},

512

],

513

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

514

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

515

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

516

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

517

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

518

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

519

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

Yoshi Automation Bot

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

[diff] [blame^]

520

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

521

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

522

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

523

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

524

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

525

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

526

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

527

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

"A String",

],

},

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

532

},

Yoshi Automation Bot

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

[diff] [blame^]

533

},

534

],

535

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

536

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

537

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

538

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

539

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

540

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

541

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

542

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

543

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

544

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

545

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

546

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

547

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

548

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

549

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

550

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

551

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

552

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

553

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

554

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

555

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

556

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

557

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

558

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

559

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

"A String",

],

},

},

},

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

566

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

567

},

568

],

569

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

570

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

571

"A String",

572

],

573

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

574

{ # The source of a field.

575

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

576

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

577

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

578

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

579

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

580

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

581

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

"A String",

],

},

},

],

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

588

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

589

"A String",

590

],

591

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

592

},

593

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

594

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

595

{ # A person's nickname.

596

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

597

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

598

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

599

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

600

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

601

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

602

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

603

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

604

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

605

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

606

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

607

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

"A String",

],

},

},

},

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

614

},

615

],

616

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

617

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

618

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

619

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

620

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

621

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

622

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

623

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

624

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

625

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

626

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

627

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

628

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

"A String",

],

},

},

},

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

635

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

636

},

637

],

638

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

639

{ # A person's email address.

640

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

641

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

642

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

643

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

644

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

645

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

646

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

647

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

648

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

649

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

650

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

"A String",

],

},

},

},

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

657

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

658

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

659

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

660

},

661

],

662

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

663

{ # A person's locale preference.

664

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

665

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

666

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

667

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

668

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

669

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

670

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

671

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

672

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

673

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

674

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

"A String",

],

},

},

},

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

681

},

682

],

683

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

684

{ # A person's phone number.

685

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

686

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

687

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

688

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

689

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

690

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

691

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

692

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

693

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

694

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

695

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

"A String",

],

},

},

},

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

702

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

703

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

704

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

705

},

706

],

707

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

708

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

709

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

710

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

711

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

712

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

713

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

714

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

715

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

716

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

717

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

718

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

719

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

"A String",

],

},

},

},

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

726

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

727

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

728

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

729

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

},

},

],

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

734

{ # An event related to the person.

735

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

736

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

737

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

738

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

739

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

740

},

741

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

742

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

743

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

744

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

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

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

750

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

751

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

"A String",

],

},

},

},

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

758

},

759

],

760

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

761

{ # A person's instant messaging client.

762

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

763

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

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

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

766

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

767

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

768

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

769

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

770

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

771

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

772

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

773

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

"A String",

],

},

},

},

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

780

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

781

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

782

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

783

},

784

],

785

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

786

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

787

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

788

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

789

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

790

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

791

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

792

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

793

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

794

},

795

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

796

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

797

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

798

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

799

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

800

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

801

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

802

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

803

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

804

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

805

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

806

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

807

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

"A String",

],

},

},

},

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

814

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

815

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

816

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

817

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

818

},

819

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

820

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

821

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

822

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

823

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

824

},

825

],

826

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

827

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

828

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

829

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

830

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

831

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

832

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

833

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

834

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

835

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

836

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

837

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

838

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

839

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

840

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

841

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

"A String",

],

},

},

},

},

],

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

850

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

851

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

852

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

853

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

854

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

855

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

856

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

857

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

858

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

859

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

860

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

861

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

862

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

863

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

864

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

865

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

866

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

"A String",

],

},

},

},

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

873

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

874

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

875

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

876

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

877

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

878

},

879

],

880

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

881

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

882

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

883

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

884

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

885

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

886

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

887

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

888

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

889

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

890

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

891

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

892

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

"A String",

],

},

},

},

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

899

},

900

],

901

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

902

{ # A person's gender.

903

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

904

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

905

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

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

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

909

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

910

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

911

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

912

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

913

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

914

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

"A String",

],

},

},

},

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

921

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

922

},

923

],

924

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

925

{ # A person's calendar URL.

926

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

927

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

928

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

929

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

930

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

931

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

932

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

933

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

934

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

935

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

936

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

937

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

"A String",

],

},

},

},

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

944

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

945

},

946

],

947

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

948

{ # One of the person's interests.

949

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

950

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

951

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

952

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

953

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

954

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

955

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

956

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

957

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

958

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

959

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

960

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

"A String",

],

},

},

},

Yoshi Automation Bot

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

[diff] [blame]

966

},

967

],

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

968

},

Jon Wayne Parrott

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

[diff] [blame]

969

],

Yoshi Automation Bot

2020-11-26 17:16: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-12-09 08:56:03 -0800

[diff] [blame^]

971

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

972

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

Jon Wayne Parrott