OLD | NEW |
1 { | 1 { |
2 "auth": { | 2 "auth": { |
3 "oauth2": { | 3 "oauth2": { |
4 "scopes": { | 4 "scopes": { |
| 5 "https://www.googleapis.com/auth/plus.login": { |
| 6 "description": "Know the list of people in your circles, you
r age range, and language" |
| 7 }, |
| 8 "https://www.googleapis.com/auth/userinfo.profile": { |
| 9 "description": "View your basic profile info" |
| 10 }, |
| 11 "https://www.googleapis.com/auth/user.emails.read": { |
| 12 "description": "View your email addresses" |
| 13 }, |
5 "https://www.googleapis.com/auth/contacts": { | 14 "https://www.googleapis.com/auth/contacts": { |
6 "description": "Manage your contacts" | 15 "description": "Manage your contacts" |
7 }, | 16 }, |
8 "https://www.googleapis.com/auth/contacts.readonly": { | |
9 "description": "View your contacts" | |
10 }, | |
11 "https://www.googleapis.com/auth/plus.login": { | |
12 "description": "Know your basic profile info and list of peo
ple in your circles." | |
13 }, | |
14 "https://www.googleapis.com/auth/user.addresses.read": { | 17 "https://www.googleapis.com/auth/user.addresses.read": { |
15 "description": "View your street addresses" | 18 "description": "View your street addresses" |
16 }, | 19 }, |
17 "https://www.googleapis.com/auth/user.birthday.read": { | |
18 "description": "View your complete date of birth" | |
19 }, | |
20 "https://www.googleapis.com/auth/user.emails.read": { | |
21 "description": "View your email addresses" | |
22 }, | |
23 "https://www.googleapis.com/auth/user.phonenumbers.read": { | 20 "https://www.googleapis.com/auth/user.phonenumbers.read": { |
24 "description": "View your phone numbers" | 21 "description": "View your phone numbers" |
25 }, | 22 }, |
26 "https://www.googleapis.com/auth/userinfo.email": { | 23 "https://www.googleapis.com/auth/userinfo.email": { |
27 "description": "View your email address" | 24 "description": "View your email address" |
28 }, | 25 }, |
29 "https://www.googleapis.com/auth/userinfo.profile": { | 26 "https://www.googleapis.com/auth/user.birthday.read": { |
30 "description": "View your basic profile info" | 27 "description": "View your complete date of birth" |
| 28 }, |
| 29 "https://www.googleapis.com/auth/contacts.readonly": { |
| 30 "description": "View your contacts" |
31 } | 31 } |
32 } | 32 } |
33 } | 33 } |
34 }, | 34 }, |
35 "basePath": "", | 35 "basePath": "", |
36 "baseUrl": "https://people.googleapis.com/", | 36 "baseUrl": "https://people.googleapis.com/", |
37 "batchPath": "batch", | 37 "batchPath": "batch", |
38 "description": "The Google People API service gives access to information ab
out profiles and contacts.", | 38 "description": "Provides access to information about profiles and contacts."
, |
39 "discoveryVersion": "v1", | 39 "discoveryVersion": "v1", |
40 "documentationLink": "https://developers.google.com/people/", | 40 "documentationLink": "https://developers.google.com/people/", |
41 "etag": "\"tbys6C40o18GZwyMen5GMkdK-3s/tzwJjoO4XDFgwNQjmiM8lPsFMzA\"", | |
42 "icons": { | 41 "icons": { |
43 "x16": "http://www.google.com/images/icons/product/search-16.gif", | 42 "x16": "http://www.google.com/images/icons/product/search-16.gif", |
44 "x32": "http://www.google.com/images/icons/product/search-32.gif" | 43 "x32": "http://www.google.com/images/icons/product/search-32.gif" |
45 }, | 44 }, |
46 "id": "people:v1", | 45 "id": "people:v1", |
47 "kind": "discovery#restDescription", | 46 "kind": "discovery#restDescription", |
48 "name": "people", | 47 "name": "people", |
49 "ownerDomain": "google.com", | 48 "ownerDomain": "google.com", |
50 "ownerName": "Google", | 49 "ownerName": "Google", |
51 "parameters": { | 50 "parameters": { |
52 "access_token": { | 51 "upload_protocol": { |
53 "description": "OAuth access token.", | 52 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
54 "location": "query", | 53 "location": "query", |
55 "type": "string" | 54 "type": "string" |
56 }, | 55 }, |
57 "alt": { | |
58 "default": "json", | |
59 "description": "Data format for response.", | |
60 "enumDescriptions": [ | |
61 "Responses with Content-Type of application/json", | |
62 "Media download with context-dependent Content-Type", | |
63 "Responses with Content-Type of application/x-protobuf" | |
64 ], | |
65 "location": "query", | |
66 "type": "string" | |
67 }, | |
68 "bearer_token": { | |
69 "description": "OAuth bearer token.", | |
70 "location": "query", | |
71 "type": "string" | |
72 }, | |
73 "callback": { | |
74 "description": "JSONP", | |
75 "location": "query", | |
76 "type": "string" | |
77 }, | |
78 "fields": { | |
79 "description": "Selector specifying which fields to include in a par
tial response.", | |
80 "location": "query", | |
81 "type": "string" | |
82 }, | |
83 "key": { | |
84 "description": "API key. Your API key identifies your project and pr
ovides you with API access, quota, and reports. Required unless you provide an O
Auth 2.0 token.", | |
85 "location": "query", | |
86 "type": "string" | |
87 }, | |
88 "oauth_token": { | |
89 "description": "OAuth 2.0 token for the current user.", | |
90 "location": "query", | |
91 "type": "string" | |
92 }, | |
93 "pp": { | |
94 "default": "true", | |
95 "description": "Pretty-print response.", | |
96 "location": "query", | |
97 "type": "boolean" | |
98 }, | |
99 "prettyPrint": { | 56 "prettyPrint": { |
100 "default": "true", | 57 "default": "true", |
101 "description": "Returns response with indentations and line breaks."
, | 58 "description": "Returns response with indentations and line breaks."
, |
102 "location": "query", | 59 "location": "query", |
103 "type": "boolean" | 60 "type": "boolean" |
104 }, | 61 }, |
105 "quotaUser": { | 62 "fields": { |
106 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters.", | 63 "description": "Selector specifying which fields to include in a par
tial response.", |
107 "location": "query", | |
108 "type": "string" | |
109 }, | |
110 "upload_protocol": { | |
111 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", | |
112 "location": "query", | 64 "location": "query", |
113 "type": "string" | 65 "type": "string" |
114 }, | 66 }, |
115 "uploadType": { | 67 "uploadType": { |
116 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", | 68 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", |
117 "location": "query", | 69 "location": "query", |
118 "type": "string" | 70 "type": "string" |
119 }, | 71 }, |
120 "$.xgafv": { | 72 "$.xgafv": { |
121 "description": "V1 error format.", | 73 "description": "V1 error format.", |
| 74 "enum": [ |
| 75 "1", |
| 76 "2" |
| 77 ], |
122 "enumDescriptions": [ | 78 "enumDescriptions": [ |
123 "v1 error format", | 79 "v1 error format", |
124 "v2 error format" | 80 "v2 error format" |
125 ], | 81 ], |
126 "location": "query", | 82 "location": "query", |
127 "type": "string" | 83 "type": "string" |
| 84 }, |
| 85 "callback": { |
| 86 "description": "JSONP", |
| 87 "location": "query", |
| 88 "type": "string" |
| 89 }, |
| 90 "alt": { |
| 91 "default": "json", |
| 92 "description": "Data format for response.", |
| 93 "enum": [ |
| 94 "json", |
| 95 "media", |
| 96 "proto" |
| 97 ], |
| 98 "enumDescriptions": [ |
| 99 "Responses with Content-Type of application/json", |
| 100 "Media download with context-dependent Content-Type", |
| 101 "Responses with Content-Type of application/x-protobuf" |
| 102 ], |
| 103 "location": "query", |
| 104 "type": "string" |
| 105 }, |
| 106 "access_token": { |
| 107 "description": "OAuth access token.", |
| 108 "location": "query", |
| 109 "type": "string" |
| 110 }, |
| 111 "key": { |
| 112 "description": "API key. Your API key identifies your project and pr
ovides you with API access, quota, and reports. Required unless you provide an O
Auth 2.0 token.", |
| 113 "location": "query", |
| 114 "type": "string" |
| 115 }, |
| 116 "quotaUser": { |
| 117 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters.", |
| 118 "location": "query", |
| 119 "type": "string" |
| 120 }, |
| 121 "pp": { |
| 122 "default": "true", |
| 123 "description": "Pretty-print response.", |
| 124 "location": "query", |
| 125 "type": "boolean" |
| 126 }, |
| 127 "oauth_token": { |
| 128 "description": "OAuth 2.0 token for the current user.", |
| 129 "location": "query", |
| 130 "type": "string" |
| 131 }, |
| 132 "bearer_token": { |
| 133 "description": "OAuth bearer token.", |
| 134 "location": "query", |
| 135 "type": "string" |
128 } | 136 } |
129 }, | 137 }, |
130 "protocol": "rest", | 138 "protocol": "rest", |
131 "resources": { | 139 "resources": { |
132 "people": { | 140 "people": { |
133 "methods": { | 141 "methods": { |
134 "get": { | 142 "getBatchGet": { |
135 "description": "Provides information about a person resource
for a resource name. Use `people/me` to indicate the authenticated user.", | 143 "description": "Provides information about a list of specifi
c people by specifying a list\nof requested resource names. Use `people/me` to i
ndicate the authenticated\nuser.", |
136 "httpMethod": "GET", | 144 "httpMethod": "GET", |
137 "id": "people.people.get", | 145 "id": "people.people.getBatchGet", |
138 "parameterOrder": [ | 146 "parameterOrder": [], |
139 "resourceName" | |
140 ], | |
141 "parameters": { | 147 "parameters": { |
142 "resourceName": { | 148 "requestMask.includeField": { |
143 "description": "The resource name of the person to p
rovide information about. - To get information about the authenticated user, spe
cify `people/me`. - To get information about any user, specify the resource name
that identifies the user, such as the resource names returned by [`people.conne
ctions.list`](/people/api/rest/v1/people.connections/list).", | 149 "description": "Comma-separated list of fields to be
included in the response. Omitting\nthis field will include all fields except f
or connections.list requests,\nwhich have a default mask that includes common fi
elds like metadata, name,\nphoto, and profile url.\nEach path should start with
`person.`: for example, `person.names` or\n`person.photos`.", |
144 "location": "path", | 150 "format": "google-fieldmask", |
145 "pattern": "^people/[^/]*$", | 151 "location": "query", |
146 "required": true, | |
147 "type": "string" | 152 "type": "string" |
148 }, | 153 }, |
149 "requestMask.includeField": { | 154 "resourceNames": { |
150 "description": "Comma-separated list of fields to be
included in the response. Omitting this field will include all fields. Each pat
h should start with `person.`: for example, `person.names` or `person.photos`.", | 155 "description": "The resource name, such as one retur
ned by\n[`people.connections.list`](/people/api/rest/v1/people.connections/list)
,\nof one of the people to provide information about. You can include this\npara
meter up to 50 times in one request.", |
151 "location": "query", | 156 "location": "query", |
| 157 "repeated": true, |
152 "type": "string" | 158 "type": "string" |
153 } | 159 } |
154 }, | 160 }, |
155 "path": "v1/{+resourceName}", | 161 "path": "v1/people:batchGet", |
156 "response": { | 162 "response": { |
157 "$ref": "Person" | 163 "$ref": "GetPeopleResponse" |
158 }, | 164 }, |
159 "scopes": [ | 165 "scopes": [ |
160 "https://www.googleapis.com/auth/contacts", | 166 "https://www.googleapis.com/auth/contacts", |
161 "https://www.googleapis.com/auth/contacts.readonly", | 167 "https://www.googleapis.com/auth/contacts.readonly", |
162 "https://www.googleapis.com/auth/plus.login", | 168 "https://www.googleapis.com/auth/plus.login", |
163 "https://www.googleapis.com/auth/user.addresses.read", | 169 "https://www.googleapis.com/auth/user.addresses.read", |
164 "https://www.googleapis.com/auth/user.birthday.read", | 170 "https://www.googleapis.com/auth/user.birthday.read", |
165 "https://www.googleapis.com/auth/user.emails.read", | 171 "https://www.googleapis.com/auth/user.emails.read", |
166 "https://www.googleapis.com/auth/user.phonenumbers.read"
, | 172 "https://www.googleapis.com/auth/user.phonenumbers.read"
, |
167 "https://www.googleapis.com/auth/userinfo.email", | 173 "https://www.googleapis.com/auth/userinfo.email", |
168 "https://www.googleapis.com/auth/userinfo.profile" | 174 "https://www.googleapis.com/auth/userinfo.profile" |
169 ] | 175 ] |
170 }, | 176 }, |
171 "getBatchGet": { | 177 "get": { |
172 "description": "Provides information about a list of specifi
c people by specifying a list of requested resource names. Use `people/me` to in
dicate the authenticated user.", | 178 "description": "Provides information about a person resource
for a resource name. Use\n`people/me` to indicate the authenticated user.", |
173 "httpMethod": "GET", | 179 "httpMethod": "GET", |
174 "id": "people.people.getBatchGet", | 180 "id": "people.people.get", |
| 181 "parameterOrder": [ |
| 182 "resourceName" |
| 183 ], |
175 "parameters": { | 184 "parameters": { |
176 "resourceNames": { | 185 "resourceName": { |
177 "description": "The resource name, such as one retur
ned by [`people.connections.list`](/people/api/rest/v1/people.connections/list),
of one of the people to provide information about. You can include this paramet
er up to 50 times in one request.", | 186 "description": "The resource name of the person to p
rovide information about.\n\n- To get information about the authenticated user,
specify `people/me`.\n- To get information about any user, specify the resource
name that\n identifies the user, such as the resource names returned by\n [`pe
ople.connections.list`](/people/api/rest/v1/people.connections/list).", |
178 "location": "query", | 187 "location": "path", |
179 "repeated": true, | 188 "pattern": "^people/[^/]+$", |
| 189 "required": true, |
180 "type": "string" | 190 "type": "string" |
181 }, | 191 }, |
182 "requestMask.includeField": { | 192 "requestMask.includeField": { |
183 "description": "Comma-separated list of fields to be
included in the response. Omitting this field will include all fields. Each pat
h should start with `person.`: for example, `person.names` or `person.photos`.", | 193 "description": "Comma-separated list of fields to be
included in the response. Omitting\nthis field will include all fields except f
or connections.list requests,\nwhich have a default mask that includes common fi
elds like metadata, name,\nphoto, and profile url.\nEach path should start with
`person.`: for example, `person.names` or\n`person.photos`.", |
| 194 "format": "google-fieldmask", |
184 "location": "query", | 195 "location": "query", |
185 "type": "string" | 196 "type": "string" |
186 } | 197 } |
187 }, | 198 }, |
188 "path": "v1/people:batchGet", | 199 "path": "v1/{+resourceName}", |
189 "response": { | 200 "response": { |
190 "$ref": "GetPeopleResponse" | 201 "$ref": "Person" |
191 }, | 202 }, |
192 "scopes": [ | 203 "scopes": [ |
193 "https://www.googleapis.com/auth/contacts", | 204 "https://www.googleapis.com/auth/contacts", |
194 "https://www.googleapis.com/auth/contacts.readonly", | 205 "https://www.googleapis.com/auth/contacts.readonly", |
195 "https://www.googleapis.com/auth/plus.login", | 206 "https://www.googleapis.com/auth/plus.login", |
196 "https://www.googleapis.com/auth/user.addresses.read", | 207 "https://www.googleapis.com/auth/user.addresses.read", |
197 "https://www.googleapis.com/auth/user.birthday.read", | 208 "https://www.googleapis.com/auth/user.birthday.read", |
198 "https://www.googleapis.com/auth/user.emails.read", | 209 "https://www.googleapis.com/auth/user.emails.read", |
199 "https://www.googleapis.com/auth/user.phonenumbers.read"
, | 210 "https://www.googleapis.com/auth/user.phonenumbers.read"
, |
200 "https://www.googleapis.com/auth/userinfo.email", | 211 "https://www.googleapis.com/auth/userinfo.email", |
201 "https://www.googleapis.com/auth/userinfo.profile" | 212 "https://www.googleapis.com/auth/userinfo.profile" |
202 ] | 213 ] |
203 } | 214 } |
204 }, | 215 }, |
205 "resources": { | 216 "resources": { |
206 "connections": { | 217 "me": { |
207 "methods": { | 218 "resources": { |
208 "list": { | 219 "connections": { |
209 "description": "Provides a list of the authenticated
user's contacts merged with any linked profiles.", | 220 "methods": { |
210 "httpMethod": "GET", | 221 "list": { |
211 "id": "people.people.connections.list", | 222 "description": "Provides a list of the authe
nticated user's contacts merged with any\nlinked profiles.", |
212 "parameterOrder": [ | 223 "httpMethod": "GET", |
213 "resourceName" | 224 "id": "people.people.me.connections.list", |
214 ], | 225 "parameterOrder": [], |
215 "parameters": { | 226 "parameters": { |
216 "resourceName": { | 227 "sortOrder": { |
217 "description": "The resource name to return
connections for. Only `people/me` is valid.", | 228 "description": "The order in which t
he connections should be sorted. Defaults to\n`LAST_MODIFIED_ASCENDING`.", |
218 "location": "path", | 229 "enum": [ |
219 "pattern": "^people/[^/]*$", | 230 "LAST_MODIFIED_ASCENDING", |
220 "required": true, | 231 "FIRST_NAME_ASCENDING", |
221 "type": "string" | 232 "LAST_NAME_ASCENDING" |
222 }, | 233 ], |
223 "pageToken": { | 234 "location": "query", |
224 "description": "The token of the page to be
returned.", | 235 "type": "string" |
225 "location": "query", | 236 }, |
226 "type": "string" | 237 "syncToken": { |
227 }, | 238 "description": "A sync token, return
ed by a previous call to `people.connections.list`.\nOnly resources changed sinc
e the sync token was created will be returned.", |
228 "pageSize": { | 239 "location": "query", |
229 "description": "The number of connections to
include in the response. Valid values are between 1 and 500, inclusive. Default
s to 100.", | 240 "type": "string" |
230 "format": "int32", | 241 }, |
231 "location": "query", | 242 "pageToken": { |
232 "type": "integer" | 243 "description": "The token of the pag
e to be returned.", |
233 }, | 244 "location": "query", |
234 "sortOrder": { | 245 "type": "string" |
235 "description": "The order in which the conne
ctions should be sorted. Defaults to `LAST_MODIFIED_ASCENDING`.", | 246 }, |
236 "enum": [ | 247 "pageSize": { |
237 "LAST_MODIFIED_ASCENDING", | 248 "description": "The number of connec
tions to include in the response. Valid values are\nbetween 1 and 500, inclusive
. Defaults to 100.", |
238 "FIRST_NAME_ASCENDING", | 249 "format": "int32", |
239 "LAST_NAME_ASCENDING" | 250 "location": "query", |
240 ], | 251 "type": "integer" |
241 "location": "query", | 252 }, |
242 "type": "string" | 253 "requestMask.includeField": { |
243 }, | 254 "description": "Comma-separated list
of fields to be included in the response. Omitting\nthis field will include all
fields except for connections.list requests,\nwhich have a default mask that in
cludes common fields like metadata, name,\nphoto, and profile url.\nEach path sh
ould start with `person.`: for example, `person.names` or\n`person.photos`.", |
244 "syncToken": { | 255 "format": "google-fieldmask", |
245 "description": "A sync token, returned by a
previous call to `people.connections.list`. Only resources changed since the syn
c token was created are returned.", | 256 "location": "query", |
246 "location": "query", | 257 "type": "string" |
247 "type": "string" | 258 } |
248 }, | 259 }, |
249 "requestMask.includeField": { | 260 "path": "v1/people/me/connections", |
250 "description": "Comma-separated list of fiel
ds to be included in the response. Omitting this field will include all fields.
Each path should start with `person.`: for example, `person.names` or `person.ph
otos`.", | 261 "response": { |
251 "location": "query", | 262 "$ref": "ListConnectionsResponse" |
252 "type": "string" | 263 }, |
| 264 "scopes": [ |
| 265 "https://www.googleapis.com/auth/contact
s", |
| 266 "https://www.googleapis.com/auth/contact
s.readonly" |
| 267 ] |
253 } | 268 } |
254 }, | 269 } |
255 "path": "v1/{+resourceName}/connections", | |
256 "response": { | |
257 "$ref": "ListConnectionsResponse" | |
258 }, | |
259 "scopes": [ | |
260 "https://www.googleapis.com/auth/contacts", | |
261 "https://www.googleapis.com/auth/contacts.readon
ly" | |
262 ] | |
263 } | 270 } |
264 } | 271 } |
265 } | 272 } |
266 } | 273 } |
267 } | 274 } |
268 }, | 275 }, |
269 "revision": "20160210", | 276 "revision": "20170209", |
270 "rootUrl": "https://people.googleapis.com/", | 277 "rootUrl": "https://people.googleapis.com/", |
271 "schemas": { | 278 "schemas": { |
272 "Person": { | 279 "PhoneNumber": { |
273 "description": "Information about a person merged from various data
sources such as the authenticated user's contacts and profile data. Fields other
than IDs, metadata, and group memberships are user-edited. Most fields can have
multiple items. The items in a field have no guaranteed order, but each non-emp
ty field is guaranteed to have exactly one field with `metadata.primary` set to
true.", | 280 "description": "A person's phone number.", |
274 "id": "Person", | 281 "id": "PhoneNumber", |
275 "properties": { | 282 "properties": { |
276 "resourceName": { | 283 "value": { |
277 "description": "The resource name for the person, assigned b
y the server. An ASCII string with a max length of 27 characters. Always starts
with `people/`.", | 284 "description": "The phone number.", |
278 "type": "string" | 285 "type": "string" |
279 }, | 286 }, |
280 "etag": { | 287 "formattedType": { |
281 "description": "The [HTTP entity tag](https://en.wikipedia.o
rg/wiki/HTTP_ETag) of the resource. Used for web cache validation.", | 288 "description": "The read-only type of the phone number trans
lated and formatted in the\nviewer's account locale or the the `Accept-Language`
HTTP header locale.", |
282 "type": "string" | 289 "type": "string" |
283 }, | 290 }, |
284 "metadata": { | 291 "canonicalForm": { |
285 "$ref": "PersonMetadata", | 292 "description": "The read-only canonicalized [ITU-T E.164](ht
tps://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf)\nform of the p
hone number.", |
286 "description": "Metadata about the person." | 293 "type": "string" |
287 }, | 294 }, |
288 "locales": { | 295 "metadata": { |
289 "description": "The person's locale preferences.", | 296 "$ref": "FieldMetadata", |
| 297 "description": "Metadata about the phone number." |
| 298 }, |
| 299 "type": { |
| 300 "description": "The type of the phone number. The type can b
e custom or predefined.\nPossible values include, but are not limited to, the fo
llowing:\n\n* `home`\n* `work`\n* `mobile`\n* `homeFax`\n* `workFax`\n* `otherFa
x`\n* `pager`\n* `workMobile`\n* `workPager`\n* `main`\n* `googleVoice`\n* `othe
r`", |
| 301 "type": "string" |
| 302 } |
| 303 }, |
| 304 "type": "object" |
| 305 }, |
| 306 "Photo": { |
| 307 "description": "A person's read-only photo. A picture shown next to
the person's name to\nhelp others recognize the person.", |
| 308 "id": "Photo", |
| 309 "properties": { |
| 310 "metadata": { |
| 311 "$ref": "FieldMetadata", |
| 312 "description": "Metadata about the photo." |
| 313 }, |
| 314 "url": { |
| 315 "description": "The URL of the photo.", |
| 316 "type": "string" |
| 317 } |
| 318 }, |
| 319 "type": "object" |
| 320 }, |
| 321 "ListConnectionsResponse": { |
| 322 "id": "ListConnectionsResponse", |
| 323 "properties": { |
| 324 "nextPageToken": { |
| 325 "description": "The token that can be used to retrieve the n
ext page of results.", |
| 326 "type": "string" |
| 327 }, |
| 328 "connections": { |
| 329 "description": "The list of people that the requestor is con
nected to.", |
290 "items": { | 330 "items": { |
291 "$ref": "Locale" | 331 "$ref": "Person" |
292 }, | 332 }, |
293 "type": "array" | 333 "type": "array" |
294 }, | 334 }, |
295 "names": { | 335 "nextSyncToken": { |
296 "description": "The person's names.", | 336 "description": "The token that can be used to retrieve chang
es since the last request.", |
| 337 "type": "string" |
| 338 } |
| 339 }, |
| 340 "type": "object" |
| 341 }, |
| 342 "Birthday": { |
| 343 "description": "A person's birthday. At least one of the `date` and
`text` fields are\nspecified. The `date` and `text` fields typically represent t
he same\ndate, but are not guaranteed to.", |
| 344 "id": "Birthday", |
| 345 "properties": { |
| 346 "metadata": { |
| 347 "$ref": "FieldMetadata", |
| 348 "description": "Metadata about the birthday." |
| 349 }, |
| 350 "text": { |
| 351 "description": "A free-form string representing the user's b
irthday.", |
| 352 "type": "string" |
| 353 }, |
| 354 "date": { |
| 355 "$ref": "Date", |
| 356 "description": "The date of the birthday." |
| 357 } |
| 358 }, |
| 359 "type": "object" |
| 360 }, |
| 361 "Residence": { |
| 362 "description": "A person's past or current residence.", |
| 363 "id": "Residence", |
| 364 "properties": { |
| 365 "value": { |
| 366 "description": "The address of the residence.", |
| 367 "type": "string" |
| 368 }, |
| 369 "metadata": { |
| 370 "$ref": "FieldMetadata", |
| 371 "description": "Metadata about the residence." |
| 372 }, |
| 373 "current": { |
| 374 "description": "True if the residence is the person's curren
t residence;\nfalse if the residence is a past residence.", |
| 375 "type": "boolean" |
| 376 } |
| 377 }, |
| 378 "type": "object" |
| 379 }, |
| 380 "Address": { |
| 381 "description": "A person's physical address. May be a P.O. box or st
reet address. All fields\nare optional.", |
| 382 "id": "Address", |
| 383 "properties": { |
| 384 "extendedAddress": { |
| 385 "description": "The extended address of the address; for exa
mple, the apartment number.", |
| 386 "type": "string" |
| 387 }, |
| 388 "poBox": { |
| 389 "description": "The P.O. box of the address.", |
| 390 "type": "string" |
| 391 }, |
| 392 "postalCode": { |
| 393 "description": "The postal code of the address.", |
| 394 "type": "string" |
| 395 }, |
| 396 "region": { |
| 397 "description": "The region of the address; for example, the
state or province.", |
| 398 "type": "string" |
| 399 }, |
| 400 "streetAddress": { |
| 401 "description": "The street address.", |
| 402 "type": "string" |
| 403 }, |
| 404 "metadata": { |
| 405 "$ref": "FieldMetadata", |
| 406 "description": "Metadata about the address." |
| 407 }, |
| 408 "countryCode": { |
| 409 "description": "The [ISO 3166-1 alpha-2](http://www.iso.org/
iso/country_codes.htm) country\ncode of the address.", |
| 410 "type": "string" |
| 411 }, |
| 412 "formattedType": { |
| 413 "description": "The read-only type of the address translated
and formatted in the viewer's\naccount locale or the `Accept-Language` HTTP hea
der locale.", |
| 414 "type": "string" |
| 415 }, |
| 416 "city": { |
| 417 "description": "The city of the address.", |
| 418 "type": "string" |
| 419 }, |
| 420 "formattedValue": { |
| 421 "description": "The unstructured value of the address. If th
is is not set by the user it\nwill be automatically constructed from structured
values.", |
| 422 "type": "string" |
| 423 }, |
| 424 "country": { |
| 425 "description": "The country of the address.", |
| 426 "type": "string" |
| 427 }, |
| 428 "type": { |
| 429 "description": "The type of the address. The type can be cus
tom or predefined.\nPossible values include, but are not limited to, the followi
ng:\n\n* `home`\n* `work`\n* `other`", |
| 430 "type": "string" |
| 431 } |
| 432 }, |
| 433 "type": "object" |
| 434 }, |
| 435 "ContactGroupMembership": { |
| 436 "description": "A Google contact group membership.", |
| 437 "id": "ContactGroupMembership", |
| 438 "properties": { |
| 439 "contactGroupId": { |
| 440 "description": "The contact group ID for the contact group m
embership. The contact group\nID can be custom or predefined. Possible values in
clude, but are not\nlimited to, the following:\n\n* `myContacts`\n* `starred`\
n* A numerical ID for user-created groups.", |
| 441 "type": "string" |
| 442 } |
| 443 }, |
| 444 "type": "object" |
| 445 }, |
| 446 "PersonMetadata": { |
| 447 "description": "The read-only metadata about a person.", |
| 448 "id": "PersonMetadata", |
| 449 "properties": { |
| 450 "objectType": { |
| 451 "description": "The type of the person object.", |
| 452 "enum": [ |
| 453 "OBJECT_TYPE_UNSPECIFIED", |
| 454 "PERSON", |
| 455 "PAGE" |
| 456 ], |
| 457 "enumDescriptions": [ |
| 458 "Unspecified.", |
| 459 "Person.", |
| 460 "[Google+ Page.](http://www.google.com/+/brands/)" |
| 461 ], |
| 462 "type": "string" |
| 463 }, |
| 464 "linkedPeopleResourceNames": { |
| 465 "description": "Resource names of people linked to this reso
urce.", |
297 "items": { | 466 "items": { |
298 "$ref": "Name" | 467 "type": "string" |
299 }, | 468 }, |
300 "type": "array" | 469 "type": "array" |
301 }, | 470 }, |
302 "nicknames": { | |
303 "description": "The person's nicknames.", | |
304 "items": { | |
305 "$ref": "Nickname" | |
306 }, | |
307 "type": "array" | |
308 }, | |
309 "coverPhotos": { | |
310 "description": "The person's cover photos.", | |
311 "items": { | |
312 "$ref": "CoverPhoto" | |
313 }, | |
314 "type": "array" | |
315 }, | |
316 "photos": { | |
317 "description": "The person's photos.", | |
318 "items": { | |
319 "$ref": "Photo" | |
320 }, | |
321 "type": "array" | |
322 }, | |
323 "genders": { | |
324 "description": "The person's genders.", | |
325 "items": { | |
326 "$ref": "Gender" | |
327 }, | |
328 "type": "array" | |
329 }, | |
330 "ageRange": { | |
331 "description": "The person's age range.", | |
332 "enum": [ | |
333 "AGE_RANGE_UNSPECIFIED", | |
334 "LESS_THAN_EIGHTEEN", | |
335 "EIGHTEEN_TO_TWENTY", | |
336 "TWENTY_ONE_OR_OLDER" | |
337 ], | |
338 "type": "string" | |
339 }, | |
340 "birthdays": { | |
341 "description": "The person's birthdays.", | |
342 "items": { | |
343 "$ref": "Birthday" | |
344 }, | |
345 "type": "array" | |
346 }, | |
347 "events": { | |
348 "description": "The person's events.", | |
349 "items": { | |
350 "$ref": "Event" | |
351 }, | |
352 "type": "array" | |
353 }, | |
354 "addresses": { | |
355 "description": "The person's street addresses.", | |
356 "items": { | |
357 "$ref": "Address" | |
358 }, | |
359 "type": "array" | |
360 }, | |
361 "residences": { | |
362 "description": "The person's residences.", | |
363 "items": { | |
364 "$ref": "Residence" | |
365 }, | |
366 "type": "array" | |
367 }, | |
368 "emailAddresses": { | |
369 "description": "The person's email addresses.", | |
370 "items": { | |
371 "$ref": "EmailAddress" | |
372 }, | |
373 "type": "array" | |
374 }, | |
375 "phoneNumbers": { | |
376 "description": "The person's phone numbers.", | |
377 "items": { | |
378 "$ref": "PhoneNumber" | |
379 }, | |
380 "type": "array" | |
381 }, | |
382 "imClients": { | |
383 "description": "The person's instant messaging clients.", | |
384 "items": { | |
385 "$ref": "ImClient" | |
386 }, | |
387 "type": "array" | |
388 }, | |
389 "taglines": { | |
390 "description": "The person's taglines.", | |
391 "items": { | |
392 "$ref": "Tagline" | |
393 }, | |
394 "type": "array" | |
395 }, | |
396 "biographies": { | |
397 "description": "The person's biographies.", | |
398 "items": { | |
399 "$ref": "Biography" | |
400 }, | |
401 "type": "array" | |
402 }, | |
403 "urls": { | |
404 "description": "The person's associated URLs.", | |
405 "items": { | |
406 "$ref": "Url" | |
407 }, | |
408 "type": "array" | |
409 }, | |
410 "organizations": { | |
411 "description": "The person's past or current organizations."
, | |
412 "items": { | |
413 "$ref": "Organization" | |
414 }, | |
415 "type": "array" | |
416 }, | |
417 "occupations": { | |
418 "description": "The person's occupations.", | |
419 "items": { | |
420 "$ref": "Occupation" | |
421 }, | |
422 "type": "array" | |
423 }, | |
424 "interests": { | |
425 "description": "The person's interests.", | |
426 "items": { | |
427 "$ref": "Interest" | |
428 }, | |
429 "type": "array" | |
430 }, | |
431 "skills": { | |
432 "description": "The person's skills.", | |
433 "items": { | |
434 "$ref": "Skill" | |
435 }, | |
436 "type": "array" | |
437 }, | |
438 "braggingRights": { | |
439 "description": "The person's bragging rights.", | |
440 "items": { | |
441 "$ref": "BraggingRights" | |
442 }, | |
443 "type": "array" | |
444 }, | |
445 "relations": { | |
446 "description": "The person's relations.", | |
447 "items": { | |
448 "$ref": "Relation" | |
449 }, | |
450 "type": "array" | |
451 }, | |
452 "relationshipInterests": { | |
453 "description": "The kind of relationship the person is looki
ng for.", | |
454 "items": { | |
455 "$ref": "RelationshipInterest" | |
456 }, | |
457 "type": "array" | |
458 }, | |
459 "relationshipStatuses": { | |
460 "description": "The person's relationship statuses.", | |
461 "items": { | |
462 "$ref": "RelationshipStatus" | |
463 }, | |
464 "type": "array" | |
465 }, | |
466 "memberships": { | |
467 "description": "The person's group memberships.", | |
468 "items": { | |
469 "$ref": "Membership" | |
470 }, | |
471 "type": "array" | |
472 } | |
473 }, | |
474 "type": "object" | |
475 }, | |
476 "PersonMetadata": { | |
477 "description": "Metadata about a person.", | |
478 "id": "PersonMetadata", | |
479 "properties": { | |
480 "sources": { | 471 "sources": { |
481 "description": "The sources of data for the person.", | 472 "description": "The sources of data for the person.", |
482 "items": { | 473 "items": { |
483 "$ref": "Source" | 474 "$ref": "Source" |
484 }, | 475 }, |
485 "type": "array" | 476 "type": "array" |
486 }, | 477 }, |
487 "previousResourceNames": { | 478 "previousResourceNames": { |
488 "description": "Any former resource names this person has ha
d. Populated only for [`connections.list`](/people/api/rest/v1/people.connection
s/list) requests that include a sync token. The resource name may change when ad
ding or removing fields that link a contact and profile such as a verified email
, verified phone number, or profile URL.", | 479 "description": "Any former resource names this person has ha
d. Populated only for\n[`connections.list`](/people/api/rest/v1/people.connectio
ns/list) requests\nthat include a sync token.\n\nThe resource name may change wh
en adding or removing fields that link a\ncontact and profile such as a verified
email, verified phone number, or\nprofile URL.", |
489 "items": { | 480 "items": { |
490 "type": "string" | 481 "type": "string" |
491 }, | 482 }, |
492 "type": "array" | 483 "type": "array" |
493 }, | 484 }, |
494 "deleted": { | 485 "deleted": { |
495 "description": "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.", | 486 "description": "True if the person resource has been deleted
. Populated only for\n[`connections.list`](/people/api/rest/v1/people.connection
s/list) requests\nthat include a sync token.", |
496 "type": "boolean" | 487 "type": "boolean" |
| 488 } |
| 489 }, |
| 490 "type": "object" |
| 491 }, |
| 492 "Event": { |
| 493 "description": "An event related to the person.", |
| 494 "id": "Event", |
| 495 "properties": { |
| 496 "date": { |
| 497 "$ref": "Date", |
| 498 "description": "The date of the event." |
497 }, | 499 }, |
498 "objectType": { | 500 "formattedType": { |
499 "description": "The type of the person object.", | 501 "description": "The read-only type of the event translated a
nd formatted in the\nviewer's account locale or the `Accept-Language` HTTP heade
r locale.", |
500 "enum": [ | 502 "type": "string" |
501 "OBJECT_TYPE_UNSPECIFIED", | 503 }, |
502 "PERSON", | 504 "metadata": { |
503 "PAGE" | 505 "$ref": "FieldMetadata", |
504 ], | 506 "description": "Metadata about the event." |
| 507 }, |
| 508 "type": { |
| 509 "description": "The type of the event. The type can be custo
m or predefined.\nPossible values include, but are not limited to, the following
:\n\n* `anniversary`\n* `other`", |
505 "type": "string" | 510 "type": "string" |
506 } | 511 } |
507 }, | 512 }, |
508 "type": "object" | 513 "type": "object" |
509 }, | 514 }, |
510 "Source": { | 515 "Url": { |
511 "description": "The source of a field.", | 516 "description": "A person's associated URLs.", |
512 "id": "Source", | 517 "id": "Url", |
513 "properties": { | 518 "properties": { |
514 "type": { | 519 "value": { |
515 "description": "The source type.", | 520 "description": "The URL.", |
516 "enum": [ | |
517 "OTHER", | |
518 "ACCOUNT", | |
519 "PROFILE", | |
520 "DOMAIN_PROFILE", | |
521 "CONTACT" | |
522 ], | |
523 "type": "string" | 521 "type": "string" |
524 }, | 522 }, |
525 "id": { | 523 "formattedType": { |
526 "description": "A unique identifier within the source type g
enerated by the server.", | 524 "description": "The read-only type of the URL translated and
formatted in the viewer's\naccount locale or the `Accept-Language` HTTP header
locale.", |
| 525 "type": "string" |
| 526 }, |
| 527 "metadata": { |
| 528 "$ref": "FieldMetadata", |
| 529 "description": "Metadata about the URL." |
| 530 }, |
| 531 "type": { |
| 532 "description": "The type of the URL. The type can be custom
or predefined.\nPossible values include, but are not limited to, the following:\
n\n* `home`\n* `work`\n* `blog`\n* `profile`\n* `homePage`\n* `ftp`\n* `reservat
ions`\n* `appInstallPage`: website for a Google+ application.\n* `other`", |
527 "type": "string" | 533 "type": "string" |
528 } | 534 } |
529 }, | 535 }, |
530 "type": "object" | 536 "type": "object" |
531 }, | 537 }, |
532 "Locale": { | 538 "Gender": { |
533 "description": "A person's locale preference.", | 539 "description": "A person's gender.", |
534 "id": "Locale", | 540 "id": "Gender", |
535 "properties": { | 541 "properties": { |
| 542 "value": { |
| 543 "description": "The gender for the person. The gender can be
custom or predefined.\nPossible values include, but are not limited to, the\nfo
llowing:\n\n* `male`\n* `female`\n* `other`\n* `unknown`", |
| 544 "type": "string" |
| 545 }, |
| 546 "formattedValue": { |
| 547 "description": "The read-only value of the gender translated
and formatted in the viewer's\naccount locale or the `Accept-Language` HTTP hea
der locale.", |
| 548 "type": "string" |
| 549 }, |
536 "metadata": { | 550 "metadata": { |
537 "$ref": "FieldMetadata", | 551 "$ref": "FieldMetadata", |
538 "description": "Metadata about the locale." | 552 "description": "Metadata about the gender." |
| 553 } |
| 554 }, |
| 555 "type": "object" |
| 556 }, |
| 557 "CoverPhoto": { |
| 558 "description": "A person's read-only cover photo. A large image show
n on the person's\nprofile page that represents who they are or what they care a
bout.", |
| 559 "id": "CoverPhoto", |
| 560 "properties": { |
| 561 "url": { |
| 562 "description": "The URL of the cover photo.", |
| 563 "type": "string" |
539 }, | 564 }, |
540 "value": { | 565 "metadata": { |
541 "description": "The well-formed [IETF BCP 47](https://tools.
ietf.org/html/bcp47) language tag representing the locale.", | 566 "$ref": "FieldMetadata", |
| 567 "description": "Metadata about the cover photo." |
| 568 }, |
| 569 "default": { |
| 570 "description": "True if the cover photo is the default cover
photo;\nfalse if the cover photo is a user-provided cover photo.", |
| 571 "type": "boolean" |
| 572 } |
| 573 }, |
| 574 "type": "object" |
| 575 }, |
| 576 "ImClient": { |
| 577 "description": "A person's instant messaging client.", |
| 578 "id": "ImClient", |
| 579 "properties": { |
| 580 "username": { |
| 581 "description": "The user name used in the IM client.", |
| 582 "type": "string" |
| 583 }, |
| 584 "formattedProtocol": { |
| 585 "description": "The read-only protocol of the IM client form
atted in the viewer's account\nlocale or the `Accept-Language` HTTP header local
e.", |
| 586 "type": "string" |
| 587 }, |
| 588 "formattedType": { |
| 589 "description": "The read-only type of the IM client translat
ed and formatted in the\nviewer's account locale or the `Accept-Language` HTTP h
eader locale.", |
| 590 "type": "string" |
| 591 }, |
| 592 "metadata": { |
| 593 "$ref": "FieldMetadata", |
| 594 "description": "Metadata about the IM client." |
| 595 }, |
| 596 "type": { |
| 597 "description": "The type of the IM client. The type can be c
ustom or predefined.\nPossible values include, but are not limited to, the follo
wing:\n\n* `home`\n* `work`\n* `other`", |
| 598 "type": "string" |
| 599 }, |
| 600 "protocol": { |
| 601 "description": "The protocol of the IM client. The protocol
can be custom or predefined.\nPossible values include, but are not limited to, t
he following:\n\n* `aim`\n* `msn`\n* `yahoo`\n* `skype`\n* `qq`\n* `googleTalk`\
n* `icq`\n* `jabber`\n* `netMeeting`", |
542 "type": "string" | 602 "type": "string" |
543 } | 603 } |
544 }, | 604 }, |
545 "type": "object" | 605 "type": "object" |
546 }, | 606 }, |
547 "FieldMetadata": { | 607 "Interest": { |
548 "description": "Metadata about a field.", | 608 "description": "One of the person's interests.", |
549 "id": "FieldMetadata", | 609 "id": "Interest", |
550 "properties": { | 610 "properties": { |
551 "primary": { | 611 "metadata": { |
552 "description": "True if the field is the primary field; fals
e if the field is a secondary field.", | 612 "$ref": "FieldMetadata", |
553 "type": "boolean" | 613 "description": "Metadata about the interest." |
554 }, | 614 }, |
555 "verified": { | 615 "value": { |
556 "description": "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.", | 616 "description": "The interest; for example, `stargazing`.", |
557 "type": "boolean" | 617 "type": "string" |
558 }, | |
559 "source": { | |
560 "$ref": "Source", | |
561 "description": "The source of the field." | |
562 } | 618 } |
563 }, | 619 }, |
564 "type": "object" | 620 "type": "object" |
565 }, | 621 }, |
566 "Name": { | 622 "EmailAddress": { |
567 "description": "A person's name. If the name is a mononym, the famil
y name is empty.", | 623 "description": "A person's email address.", |
568 "id": "Name", | 624 "id": "EmailAddress", |
569 "properties": { | 625 "properties": { |
| 626 "displayName": { |
| 627 "description": "The display name of the email.", |
| 628 "type": "string" |
| 629 }, |
570 "metadata": { | 630 "metadata": { |
571 "$ref": "FieldMetadata", | 631 "$ref": "FieldMetadata", |
572 "description": "Metadata about the name." | 632 "description": "Metadata about the email address." |
573 }, | 633 }, |
574 "displayName": { | 634 "type": { |
575 "description": "The display name formatted according to the
locale specified by the viewer's account or the Accept-Language HTTP header.", | 635 "description": "The type of the email address. The type can
be custom or predefined.\nPossible values include, but are not limited to, the f
ollowing:\n\n* `home`\n* `work`\n* `other`", |
576 "type": "string" | 636 "type": "string" |
577 }, | 637 }, |
578 "familyName": { | 638 "value": { |
579 "description": "The family name.", | 639 "description": "The email address.", |
580 "type": "string" | 640 "type": "string" |
581 }, | 641 }, |
582 "givenName": { | 642 "formattedType": { |
583 "description": "The given name.", | 643 "description": "The read-only type of the email address tran
slated and formatted in the\nviewer's account locale or the `Accept-Language` HT
TP header locale.", |
584 "type": "string" | |
585 }, | |
586 "middleName": { | |
587 "description": "The middle name(s).", | |
588 "type": "string" | |
589 }, | |
590 "honorificPrefix": { | |
591 "description": "The honorific prefixes, such as `Mrs.` or `D
r.`", | |
592 "type": "string" | |
593 }, | |
594 "honorificSuffix": { | |
595 "description": "The honorific suffixes, such as `Jr.`", | |
596 "type": "string" | |
597 }, | |
598 "phoneticFamilyName": { | |
599 "description": "The family name spelled as it sounds.", | |
600 "type": "string" | |
601 }, | |
602 "phoneticGivenName": { | |
603 "description": "The given name spelled as it sounds.", | |
604 "type": "string" | |
605 }, | |
606 "phoneticMiddleName": { | |
607 "description": "The middle name(s) spelled as they sound.", | |
608 "type": "string" | |
609 }, | |
610 "phoneticHonorificPrefix": { | |
611 "description": "The honorific prefixes spelled as they sound
.", | |
612 "type": "string" | |
613 }, | |
614 "phoneticHonorificSuffix": { | |
615 "description": "The honorific suffixes spelled as they sound
.", | |
616 "type": "string" | 644 "type": "string" |
617 } | 645 } |
618 }, | 646 }, |
619 "type": "object" | 647 "type": "object" |
620 }, | 648 }, |
621 "Nickname": { | 649 "Nickname": { |
622 "description": "A person's nickname.", | 650 "description": "A person's nickname.", |
623 "id": "Nickname", | 651 "id": "Nickname", |
624 "properties": { | 652 "properties": { |
625 "metadata": { | 653 "metadata": { |
626 "$ref": "FieldMetadata", | 654 "$ref": "FieldMetadata", |
627 "description": "Metadata about the nickname." | 655 "description": "Metadata about the nickname." |
628 }, | 656 }, |
629 "value": { | |
630 "description": "The nickname.", | |
631 "type": "string" | |
632 }, | |
633 "type": { | 657 "type": { |
634 "description": "The type of the nickname.", | 658 "description": "The type of the nickname.", |
635 "enum": [ | 659 "enum": [ |
636 "DEFAULT", | 660 "DEFAULT", |
637 "MAIDEN_NAME", | 661 "MAIDEN_NAME", |
638 "INITIALS", | 662 "INITIALS", |
639 "GPLUS", | 663 "GPLUS", |
640 "OTHER_NAME" | 664 "OTHER_NAME" |
641 ], | 665 ], |
642 "type": "string" | 666 "enumDescriptions": [ |
643 } | 667 "Generic nickname.", |
644 }, | 668 "Maiden name or birth family name. Used when the person'
s family name has\nchanged as a result of marriage.", |
645 "type": "object" | 669 "Initials.", |
646 }, | 670 "Google+ profile nickname.", |
647 "CoverPhoto": { | 671 "A professional affiliation or other name; for example,
`Dr. Smith.`" |
648 "description": "A person's cover photo. A large image shown on the p
erson's profile page that represents who they are or what they care about.", | 672 ], |
649 "id": "CoverPhoto", | 673 "type": "string" |
650 "properties": { | 674 }, |
651 "metadata": { | 675 "value": { |
652 "$ref": "FieldMetadata", | 676 "description": "The nickname.", |
653 "description": "Metadata about the cover photo." | 677 "type": "string" |
654 }, | 678 } |
655 "url": { | 679 }, |
656 "description": "The URL of the cover photo.", | 680 "type": "object" |
657 "type": "string" | 681 }, |
658 }, | 682 "Skill": { |
659 "default": { | 683 "description": "A skill that the person has.", |
660 "description": "True if the cover photo is the default cover
photo; false if the cover photo is a user-provided cover photo.", | 684 "id": "Skill", |
| 685 "properties": { |
| 686 "value": { |
| 687 "description": "The skill; for example, `underwater basket w
eaving`.", |
| 688 "type": "string" |
| 689 }, |
| 690 "metadata": { |
| 691 "$ref": "FieldMetadata", |
| 692 "description": "Metadata about the skill." |
| 693 } |
| 694 }, |
| 695 "type": "object" |
| 696 }, |
| 697 "DomainMembership": { |
| 698 "description": "A Google Apps Domain membership.", |
| 699 "id": "DomainMembership", |
| 700 "properties": { |
| 701 "inViewerDomain": { |
| 702 "description": "True if the person is in the viewer's Google
Apps domain.", |
661 "type": "boolean" | 703 "type": "boolean" |
662 } | 704 } |
663 }, | 705 }, |
664 "type": "object" | 706 "type": "object" |
665 }, | 707 }, |
666 "Photo": { | 708 "Membership": { |
667 "description": "A person's photo. A picture shown next to the person
's name to help others recognize the person.", | 709 "description": "A person's read-only membership in a group.", |
668 "id": "Photo", | 710 "id": "Membership", |
669 "properties": { | 711 "properties": { |
670 "metadata": { | 712 "metadata": { |
671 "$ref": "FieldMetadata", | 713 "$ref": "FieldMetadata", |
672 "description": "Metadata about the photo." | 714 "description": "Metadata about the membership." |
673 }, | 715 }, |
674 "url": { | 716 "contactGroupMembership": { |
675 "description": "The URL of the photo.", | 717 "$ref": "ContactGroupMembership", |
676 "type": "string" | 718 "description": "The contact group membership." |
677 } | 719 }, |
678 }, | 720 "domainMembership": { |
679 "type": "object" | 721 "$ref": "DomainMembership", |
680 }, | 722 "description": "The domain membership." |
681 "Gender": { | 723 } |
682 "description": "A person's gender.", | 724 }, |
683 "id": "Gender", | 725 "type": "object" |
684 "properties": { | 726 }, |
685 "metadata": { | 727 "RelationshipStatus": { |
686 "$ref": "FieldMetadata", | 728 "description": "A person's read-only relationship status.", |
687 "description": "Metadata about the gender." | 729 "id": "RelationshipStatus", |
688 }, | 730 "properties": { |
689 "value": { | |
690 "description": "The gender for the person. The gender can be
custom or predefined. Possible values include, but are not limited to, the foll
owing: * `male` * `female` * `other` * `unknown`", | |
691 "type": "string" | |
692 }, | |
693 "formattedValue": { | 731 "formattedValue": { |
694 "description": "The read-only value of the gender translated
and formatted in the viewer's account locale or the `Accept-Language` HTTP head
er locale.", | 732 "description": "The read-only value of the relationship stat
us translated and formatted in\nthe viewer's account locale or the `Accept-Langu
age` HTTP header locale.", |
695 "type": "string" | 733 "type": "string" |
696 } | 734 }, |
697 }, | 735 "metadata": { |
698 "type": "object" | 736 "$ref": "FieldMetadata", |
699 }, | 737 "description": "Metadata about the relationship status." |
700 "Birthday": { | 738 }, |
701 "description": "A person's birthday. At least one of the `date` and
`text` fields are specified. The `date` and `text` fields typically represent th
e same date, but are not guaranteed to.", | 739 "value": { |
702 "id": "Birthday", | 740 "description": "The relationship status. The value can be cu
stom or predefined.\nPossible values include, but are not limited to, the follow
ing:\n\n* `single`\n* `inARelationship`\n* `engaged`\n* `married`\n* `itsComplic
ated`\n* `openRelationship`\n* `widowed`\n* `inDomesticPartnership`\n* `inCivilU
nion`", |
703 "properties": { | 741 "type": "string" |
704 "metadata": { | 742 } |
705 "$ref": "FieldMetadata", | 743 }, |
706 "description": "Metadata about the birthday." | 744 "type": "object" |
707 }, | 745 }, |
708 "date": { | 746 "Tagline": { |
709 "$ref": "Date", | 747 "description": "A read-only brief one-line description of the person
.", |
710 "description": "The date of the birthday." | 748 "id": "Tagline", |
711 }, | 749 "properties": { |
712 "text": { | 750 "metadata": { |
713 "description": "A free-form string representing the user's b
irthday.", | 751 "$ref": "FieldMetadata", |
| 752 "description": "Metadata about the tagline." |
| 753 }, |
| 754 "value": { |
| 755 "description": "The tagline.", |
714 "type": "string" | 756 "type": "string" |
715 } | 757 } |
716 }, | 758 }, |
717 "type": "object" | 759 "type": "object" |
718 }, | 760 }, |
719 "Date": { | 761 "Date": { |
720 "description": "Represents a whole calendar date, for example a date
of birth. The time of day and time zone are either specified elsewhere or are n
ot significant. The date is relative to the [Proleptic Gregorian Calendar](https
://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The day may be 0 to repr
esent a year and month where the day is not significant. The year may be 0 to re
present a month and day independent of year; for example, anniversary date.", | 762 "description": "Represents a whole calendar date, for example a date
of birth. The time\nof day and time zone are either specified elsewhere or are
not\nsignificant. The date is relative to the\n[Proleptic Gregorian Calendar](ht
tps://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).\nThe day may be 0 to
represent a year and month where the day is not\nsignificant. The year may be 0
to represent a month and day independent\nof year; for example, anniversary date
.", |
721 "id": "Date", | 763 "id": "Date", |
722 "properties": { | 764 "properties": { |
723 "year": { | |
724 "description": "Year of date. Must be from 1 to 9999, or 0 i
f specifying a date without a year.", | |
725 "format": "int32", | |
726 "type": "integer" | |
727 }, | |
728 "month": { | 765 "month": { |
729 "description": "Month of year. Must be from 1 to 12.", | 766 "description": "Month of year. Must be from 1 to 12.", |
730 "format": "int32", | 767 "format": "int32", |
731 "type": "integer" | 768 "type": "integer" |
732 }, | 769 }, |
733 "day": { | 770 "year": { |
734 "description": "Day of month. Must be from 1 to 31 and valid
for the year and month, or 0 if specifying a year/month where the day is not si
gnificant.", | 771 "description": "Year of date. Must be from 1 to 9999, or 0 i
f specifying a date without\na year.", |
735 "format": "int32", | 772 "format": "int32", |
736 "type": "integer" | 773 "type": "integer" |
737 } | 774 }, |
738 }, | 775 "day": { |
739 "type": "object" | 776 "description": "Day of month. Must be from 1 to 31 and valid
for the year and month, or 0\nif specifying a year/month where the day is not s
ignificant.", |
740 }, | 777 "format": "int32", |
741 "Event": { | 778 "type": "integer" |
742 "description": "An event related to the person.", | 779 } |
743 "id": "Event", | 780 }, |
744 "properties": { | 781 "type": "object" |
745 "metadata": { | 782 }, |
746 "$ref": "FieldMetadata", | 783 "Name": { |
747 "description": "Metadata about the event." | 784 "description": "A person's name. If the name is a mononym, the famil
y name is empty.", |
748 }, | 785 "id": "Name", |
749 "date": { | 786 "properties": { |
| 787 "phoneticHonorificPrefix": { |
| 788 "description": "The honorific prefixes spelled as they sound
.", |
| 789 "type": "string" |
| 790 }, |
| 791 "phoneticGivenName": { |
| 792 "description": "The given name spelled as it sounds.", |
| 793 "type": "string" |
| 794 }, |
| 795 "phoneticFamilyName": { |
| 796 "description": "The family name spelled as it sounds.", |
| 797 "type": "string" |
| 798 }, |
| 799 "familyName": { |
| 800 "description": "The family name.", |
| 801 "type": "string" |
| 802 }, |
| 803 "metadata": { |
| 804 "$ref": "FieldMetadata", |
| 805 "description": "Metadata about the name." |
| 806 }, |
| 807 "phoneticMiddleName": { |
| 808 "description": "The middle name(s) spelled as they sound.", |
| 809 "type": "string" |
| 810 }, |
| 811 "phoneticFullName": { |
| 812 "description": "The full name spelled as it sounds.", |
| 813 "type": "string" |
| 814 }, |
| 815 "displayNameLastFirst": { |
| 816 "description": "The read-only display name with the last nam
e first formatted according to\nthe locale specified by the viewer's account or
the\n<code>Accept-Language</code> HTTP header.", |
| 817 "type": "string" |
| 818 }, |
| 819 "displayName": { |
| 820 "description": "The read-only display name formatted accordi
ng to the locale specified by\nthe viewer's account or the <code>Accept-Language
</code> HTTP header.", |
| 821 "type": "string" |
| 822 }, |
| 823 "honorificSuffix": { |
| 824 "description": "The honorific suffixes, such as `Jr.`", |
| 825 "type": "string" |
| 826 }, |
| 827 "honorificPrefix": { |
| 828 "description": "The honorific prefixes, such as `Mrs.` or `D
r.`", |
| 829 "type": "string" |
| 830 }, |
| 831 "phoneticHonorificSuffix": { |
| 832 "description": "The honorific suffixes spelled as they sound
.", |
| 833 "type": "string" |
| 834 }, |
| 835 "givenName": { |
| 836 "description": "The given name.", |
| 837 "type": "string" |
| 838 }, |
| 839 "middleName": { |
| 840 "description": "The middle name(s).", |
| 841 "type": "string" |
| 842 } |
| 843 }, |
| 844 "type": "object" |
| 845 }, |
| 846 "BraggingRights": { |
| 847 "description": "A person's bragging rights.", |
| 848 "id": "BraggingRights", |
| 849 "properties": { |
| 850 "metadata": { |
| 851 "$ref": "FieldMetadata", |
| 852 "description": "Metadata about the bragging rights." |
| 853 }, |
| 854 "value": { |
| 855 "description": "The bragging rights; for example, `climbed m
ount everest`.", |
| 856 "type": "string" |
| 857 } |
| 858 }, |
| 859 "type": "object" |
| 860 }, |
| 861 "Locale": { |
| 862 "description": "A person's locale preference.", |
| 863 "id": "Locale", |
| 864 "properties": { |
| 865 "value": { |
| 866 "description": "The well-formed [IETF BCP 47](https://tools.
ietf.org/html/bcp47)\nlanguage tag representing the locale.", |
| 867 "type": "string" |
| 868 }, |
| 869 "metadata": { |
| 870 "$ref": "FieldMetadata", |
| 871 "description": "Metadata about the locale." |
| 872 } |
| 873 }, |
| 874 "type": "object" |
| 875 }, |
| 876 "Organization": { |
| 877 "description": "A person's past or current organization. Overlapping
date ranges are\npermitted.", |
| 878 "id": "Organization", |
| 879 "properties": { |
| 880 "current": { |
| 881 "description": "True if the organization is the person's cur
rent organization;\nfalse if the organization is a past organization.", |
| 882 "type": "boolean" |
| 883 }, |
| 884 "formattedType": { |
| 885 "description": "The read-only type of the organization trans
lated and formatted in the\nviewer's account locale or the `Accept-Language` HTT
P header locale.", |
| 886 "type": "string" |
| 887 }, |
| 888 "startDate": { |
750 "$ref": "Date", | 889 "$ref": "Date", |
751 "description": "The date of the event." | 890 "description": "The start date when the person joined the or
ganization." |
| 891 }, |
| 892 "domain": { |
| 893 "description": "The domain name associated with the organiza
tion; for example, `google.com`.", |
| 894 "type": "string" |
| 895 }, |
| 896 "department": { |
| 897 "description": "The person's department at the organization.
", |
| 898 "type": "string" |
| 899 }, |
| 900 "phoneticName": { |
| 901 "description": "The phonetic name of the organization.", |
| 902 "type": "string" |
752 }, | 903 }, |
753 "type": { | 904 "type": { |
754 "description": "The type of the event. The type can be custo
m or predefined. Possible values include, but are not limited to, the following:
* `anniversary` * `other`", | 905 "description": "The type of the organization. The type can b
e custom or predefined.\nPossible values include, but are not limited to, the fo
llowing:\n\n* `work`\n* `school`", |
755 "type": "string" | 906 "type": "string" |
756 }, | 907 }, |
757 "formattedType": { | 908 "jobDescription": { |
758 "description": "The read-only type of the event translated a
nd formatted in the viewer's account locale or the `Accept-Language` HTTP header
locale.", | 909 "description": "The person's job description at the organiza
tion.", |
759 "type": "string" | 910 "type": "string" |
760 } | 911 }, |
761 }, | 912 "endDate": { |
762 "type": "object" | 913 "$ref": "Date", |
763 }, | 914 "description": "The end date when the person left the organi
zation." |
764 "Address": { | 915 }, |
765 "description": "A person's physical address. May be a P.O. box or st
reet address. All fields are optional.", | 916 "symbol": { |
766 "id": "Address", | 917 "description": "The symbol associated with the organization;
for example, a stock ticker\nsymbol, abbreviation, or acronym.", |
767 "properties": { | 918 "type": "string" |
768 "metadata": { | 919 }, |
769 "$ref": "FieldMetadata", | 920 "name": { |
770 "description": "Metadata about the address." | 921 "description": "The name of the organization.", |
771 }, | 922 "type": "string" |
772 "formattedValue": { | 923 }, |
773 "description": "The read-only value of the address formatted
in the viewer's account locale or the `Accept-Language` HTTP header locale.", | 924 "metadata": { |
774 "type": "string" | 925 "$ref": "FieldMetadata", |
775 }, | 926 "description": "Metadata about the organization." |
776 "type": { | 927 }, |
777 "description": "The type of the address. The type can be cus
tom or predefined. Possible values include, but are not limited to, the followin
g: * `home` * `work` * `other`", | 928 "location": { |
778 "type": "string" | 929 "description": "The location of the organization office the
person works at.", |
779 }, | 930 "type": "string" |
780 "formattedType": { | 931 }, |
781 "description": "The read-only type of the address translated
and formatted in the viewer's account locale or the `Accept-Language` HTTP head
er locale.", | 932 "title": { |
782 "type": "string" | 933 "description": "The person's job title at the organization."
, |
783 }, | 934 "type": "string" |
784 "poBox": { | 935 } |
785 "description": "The P.O. box of the address.", | 936 }, |
786 "type": "string" | |
787 }, | |
788 "streetAddress": { | |
789 "description": "The street address.", | |
790 "type": "string" | |
791 }, | |
792 "extendedAddress": { | |
793 "description": "The extended address of the address; for exa
mple, the apartment number.", | |
794 "type": "string" | |
795 }, | |
796 "city": { | |
797 "description": "The city of the address.", | |
798 "type": "string" | |
799 }, | |
800 "region": { | |
801 "description": "The region of the address; for example, the
state or province.", | |
802 "type": "string" | |
803 }, | |
804 "postalCode": { | |
805 "description": "The postal code of the address.", | |
806 "type": "string" | |
807 }, | |
808 "country": { | |
809 "description": "The country of the address.", | |
810 "type": "string" | |
811 }, | |
812 "countryCode": { | |
813 "description": "The [ISO 3166-1 alpha-2](http://www.iso.org/
iso/country_codes.htm) country code of the address.", | |
814 "type": "string" | |
815 } | |
816 }, | |
817 "type": "object" | |
818 }, | |
819 "Residence": { | |
820 "description": "A person's past or current residence.", | |
821 "id": "Residence", | |
822 "properties": { | |
823 "metadata": { | |
824 "$ref": "FieldMetadata", | |
825 "description": "Metadata about the residence." | |
826 }, | |
827 "value": { | |
828 "description": "The address of the residence.", | |
829 "type": "string" | |
830 }, | |
831 "current": { | |
832 "description": "True if the residence is the person's curren
t residence; false if the residence is a past residence.", | |
833 "type": "boolean" | |
834 } | |
835 }, | |
836 "type": "object" | |
837 }, | |
838 "EmailAddress": { | |
839 "description": "A person's email address.", | |
840 "id": "EmailAddress", | |
841 "properties": { | |
842 "metadata": { | |
843 "$ref": "FieldMetadata", | |
844 "description": "Metadata about the email address." | |
845 }, | |
846 "value": { | |
847 "description": "The email address.", | |
848 "type": "string" | |
849 }, | |
850 "type": { | |
851 "description": "The type of the email address. The type can
be custom or predefined. Possible values include, but are not limited to, the fo
llowing: * `home` * `work` * `other`", | |
852 "type": "string" | |
853 }, | |
854 "formattedType": { | |
855 "description": "The read-only type of the email address tran
slated and formatted in the viewer's account locale or the `Accept-Language` HTT
P header locale.", | |
856 "type": "string" | |
857 } | |
858 }, | |
859 "type": "object" | |
860 }, | |
861 "PhoneNumber": { | |
862 "description": "A person's phone number.", | |
863 "id": "PhoneNumber", | |
864 "properties": { | |
865 "metadata": { | |
866 "$ref": "FieldMetadata", | |
867 "description": "Metadata about the phone number." | |
868 }, | |
869 "value": { | |
870 "description": "The phone number.", | |
871 "type": "string" | |
872 }, | |
873 "canonicalForm": { | |
874 "description": "The read-only canonicalized [ITU-T E.164](ht
tps://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the ph
one number.", | |
875 "type": "string" | |
876 }, | |
877 "type": { | |
878 "description": "The type of the phone number. The type can b
e custom or predefined. Possible values include, but are not limited to, the fol
lowing: * `home` * `work` * `mobile` * `homeFax` * `workFax` * `otherFax` * `pag
er` * `workMobile` * `workPager` * `main` * `googleVoice` * `other`", | |
879 "type": "string" | |
880 }, | |
881 "formattedType": { | |
882 "description": "The read-only type of the phone number trans
lated and formatted in the viewer's account locale or the the `Accept-Language`
HTTP header locale.", | |
883 "type": "string" | |
884 } | |
885 }, | |
886 "type": "object" | |
887 }, | |
888 "ImClient": { | |
889 "description": "A person's instant messaging client.", | |
890 "id": "ImClient", | |
891 "properties": { | |
892 "metadata": { | |
893 "$ref": "FieldMetadata", | |
894 "description": "Metadata about the IM client." | |
895 }, | |
896 "username": { | |
897 "description": "The user name used in the IM client.", | |
898 "type": "string" | |
899 }, | |
900 "type": { | |
901 "description": "The type of the IM client. The type can be c
ustom or predefined. Possible values include, but are not limited to, the follow
ing: * `home` * `work` * `other`", | |
902 "type": "string" | |
903 }, | |
904 "formattedType": { | |
905 "description": "The read-only type of the IM client translat
ed and formatted in the viewer's account locale or the `Accept-Language` HTTP he
ader locale.", | |
906 "type": "string" | |
907 }, | |
908 "protocol": { | |
909 "description": "The protocol of the IM client. The protocol
can be custom or predefined. Possible values include, but are not limited to, th
e following: * `aim` * `msn` * `yahoo` * `skype` * `qq` * `googleTalk` * `icq` *
`jabber` * `netMeeting`", | |
910 "type": "string" | |
911 }, | |
912 "formattedProtocol": { | |
913 "description": "The read-only protocol of the IM client form
atted in the viewer's account locale or the `Accept-Language` HTTP header locale
.", | |
914 "type": "string" | |
915 } | |
916 }, | |
917 "type": "object" | |
918 }, | |
919 "Tagline": { | |
920 "description": "A brief one-line description of the person.", | |
921 "id": "Tagline", | |
922 "properties": { | |
923 "metadata": { | |
924 "$ref": "FieldMetadata", | |
925 "description": "Metadata about the tagline." | |
926 }, | |
927 "value": { | |
928 "description": "The tagline.", | |
929 "type": "string" | |
930 } | |
931 }, | |
932 "type": "object" | 937 "type": "object" |
933 }, | 938 }, |
934 "Biography": { | 939 "Biography": { |
935 "description": "A person's short biography.", | 940 "description": "A person's short biography.", |
936 "id": "Biography", | 941 "id": "Biography", |
937 "properties": { | 942 "properties": { |
| 943 "contentType": { |
| 944 "description": "The content type of the biography.", |
| 945 "enum": [ |
| 946 "CONTENT_TYPE_UNSPECIFIED", |
| 947 "TEXT_PLAIN", |
| 948 "TEXT_HTML" |
| 949 ], |
| 950 "enumDescriptions": [ |
| 951 "Unspecified.", |
| 952 "Plain text.", |
| 953 "HTML text." |
| 954 ], |
| 955 "type": "string" |
| 956 }, |
938 "metadata": { | 957 "metadata": { |
939 "$ref": "FieldMetadata", | 958 "$ref": "FieldMetadata", |
940 "description": "Metadata about the biography." | 959 "description": "Metadata about the biography." |
941 }, | 960 }, |
942 "value": { | 961 "value": { |
943 "description": "The short biography.", | 962 "description": "The short biography.", |
944 "type": "string" | 963 "type": "string" |
945 } | 964 } |
946 }, | 965 }, |
947 "type": "object" | 966 "type": "object" |
948 }, | 967 }, |
949 "Url": { | 968 "FieldMetadata": { |
950 "description": "A person's associated URLs.", | 969 "description": "Metadata about a field.", |
951 "id": "Url", | 970 "id": "FieldMetadata", |
952 "properties": { | 971 "properties": { |
953 "metadata": { | 972 "verified": { |
954 "$ref": "FieldMetadata", | 973 "description": "True if the field is verified; false if the
field is unverified. A\nverified field is typically a name, email address, phone
number, or\nwebsite that has been confirmed to be owned by the person.", |
955 "description": "Metadata about the URL." | 974 "type": "boolean" |
956 }, | 975 }, |
957 "value": { | 976 "primary": { |
958 "description": "The URL.", | 977 "description": "True if the field is the primary field; fals
e if the field is a secondary\nfield.", |
| 978 "type": "boolean" |
| 979 }, |
| 980 "source": { |
| 981 "$ref": "Source", |
| 982 "description": "The source of the field." |
| 983 } |
| 984 }, |
| 985 "type": "object" |
| 986 }, |
| 987 "Source": { |
| 988 "description": "The source of a field.", |
| 989 "id": "Source", |
| 990 "properties": { |
| 991 "resourceName": { |
| 992 "description": "The resource name of the source. Only set if
there is a separate\nresource endpoint.", |
959 "type": "string" | 993 "type": "string" |
960 }, | 994 }, |
961 "type": { | 995 "type": { |
962 "description": "The type of the URL. The type can be custom
or predefined. Possible values include, but are not limited to, the following: *
`home` * `work` * `blog` * `profile` * `homePage` * `ftp` * `reservations` * `a
ppInstallPage`: website for a Google+ application. * `other`", | 996 "description": "The source type.", |
| 997 "enum": [ |
| 998 "SOURCE_TYPE_UNSPECIFIED", |
| 999 "ACCOUNT", |
| 1000 "PROFILE", |
| 1001 "DOMAIN_PROFILE", |
| 1002 "CONTACT" |
| 1003 ], |
| 1004 "enumDescriptions": [ |
| 1005 "Unspecified.", |
| 1006 "[Google Account](https://accounts.google.com).", |
| 1007 "[Google profile](https://profiles.google.com). You can
view the\nprofile at https://profiles.google.com/<id> where <id> is the source\n
id.", |
| 1008 "[Google Apps domain profile](https://admin.google.com).
", |
| 1009 "[Google contact](https://contacts.google.com). You can
view the\ncontact at https://contact.google.com/<id> where <id> is the source\ni
d." |
| 1010 ], |
963 "type": "string" | 1011 "type": "string" |
964 }, | 1012 }, |
965 "formattedType": { | 1013 "etag": { |
966 "description": "The read-only type of the URL translated and
formatted in the viewer's account locale or the `Accept-Language` HTTP header l
ocale.", | 1014 "description": "The [HTTP entity tag](https://en.wikipedia.o
rg/wiki/HTTP_ETag) of the\nsource. Used for web cache validation. Only populated
in\nperson.metadata.sources.", |
| 1015 "type": "string" |
| 1016 }, |
| 1017 "id": { |
| 1018 "description": "The unique identifier within the source type
generated by the server.", |
967 "type": "string" | 1019 "type": "string" |
968 } | 1020 } |
969 }, | 1021 }, |
970 "type": "object" | 1022 "type": "object" |
971 }, | 1023 }, |
972 "Organization": { | 1024 "RelationshipInterest": { |
973 "description": "A person's past or current organization. Overlapping
date ranges are permitted.", | 1025 "description": "A person's read-only relationship interest .", |
974 "id": "Organization", | 1026 "id": "RelationshipInterest", |
975 "properties": { | 1027 "properties": { |
| 1028 "value": { |
| 1029 "description": "The kind of relationship the person is looki
ng for. The value can be custom\nor predefined. Possible values include, but are
not limited to, the\nfollowing values:\n\n* `friend`\n* `date`\n* `relationship
`\n* `networking`", |
| 1030 "type": "string" |
| 1031 }, |
| 1032 "formattedValue": { |
| 1033 "description": "The value of the relationship interest trans
lated and formatted in the\nviewer's account locale or the locale specified in t
he Accept-Language\nHTTP header.", |
| 1034 "type": "string" |
| 1035 }, |
976 "metadata": { | 1036 "metadata": { |
977 "$ref": "FieldMetadata", | 1037 "$ref": "FieldMetadata", |
978 "description": "Metadata about the organization." | 1038 "description": "Metadata about the relationship interest." |
979 }, | |
980 "type": { | |
981 "description": "The type of the organization. The type can b
e custom or predefined. Possible values include, but are not limited to, the fol
lowing: * `work` * `school`", | |
982 "type": "string" | |
983 }, | |
984 "formattedType": { | |
985 "description": "The read-only type of the organization trans
lated and formatted in the viewer's account locale or the `Accept-Language` HTTP
header locale.", | |
986 "type": "string" | |
987 }, | |
988 "startDate": { | |
989 "$ref": "Date", | |
990 "description": "The start date when the person joined the or
ganization." | |
991 }, | |
992 "endDate": { | |
993 "$ref": "Date", | |
994 "description": "The end date when the person left the organi
zation." | |
995 }, | |
996 "current": { | |
997 "description": "True if the organization is the person's cur
rent organization; false if the organization is a past organization.", | |
998 "type": "boolean" | |
999 }, | |
1000 "name": { | |
1001 "description": "The name of the organization.", | |
1002 "type": "string" | |
1003 }, | |
1004 "phoneticName": { | |
1005 "description": "The phonetic name of the organization.", | |
1006 "type": "string" | |
1007 }, | |
1008 "department": { | |
1009 "description": "The person's department at the organization.
", | |
1010 "type": "string" | |
1011 }, | |
1012 "title": { | |
1013 "description": "The person's job title at the organization."
, | |
1014 "type": "string" | |
1015 }, | |
1016 "jobDescription": { | |
1017 "description": "The person's job description at the organiza
tion.", | |
1018 "type": "string" | |
1019 }, | |
1020 "symbol": { | |
1021 "description": "The symbol associated with the organization;
for example, a stock ticker symbol, abbreviation, or acronym.", | |
1022 "type": "string" | |
1023 }, | |
1024 "domain": { | |
1025 "description": "The domain name associated with the organiza
tion; for example, `google.com`.", | |
1026 "type": "string" | |
1027 }, | |
1028 "location": { | |
1029 "description": "The location of the organization office the
person works at.", | |
1030 "type": "string" | |
1031 } | 1039 } |
1032 }, | 1040 }, |
1033 "type": "object" | 1041 "type": "object" |
1034 }, | 1042 }, |
1035 "Occupation": { | 1043 "PersonResponse": { |
1036 "description": "A person's occupation.", | 1044 "description": "The response for a single person", |
1037 "id": "Occupation", | 1045 "id": "PersonResponse", |
1038 "properties": { | 1046 "properties": { |
1039 "metadata": { | 1047 "person": { |
1040 "$ref": "FieldMetadata", | 1048 "$ref": "Person", |
1041 "description": "Metadata about the occupation." | 1049 "description": "The person." |
1042 }, | 1050 }, |
1043 "value": { | 1051 "httpStatusCode": { |
1044 "description": "The occupation; for example, `carpenter`.", | 1052 "description": "[HTTP 1.1 status code](http://www.w3.org/Pro
tocols/rfc2616/rfc2616-sec10.html).", |
| 1053 "format": "int32", |
| 1054 "type": "integer" |
| 1055 }, |
| 1056 "requestedResourceName": { |
| 1057 "description": "The original requested resource name. May be
different than the resource\nname on the returned person.\n\nThe resource name
can change when adding or removing fields that link a\ncontact and profile such
as a verified email, verified phone number, or a\nprofile URL.", |
1045 "type": "string" | 1058 "type": "string" |
1046 } | 1059 } |
1047 }, | 1060 }, |
1048 "type": "object" | |
1049 }, | |
1050 "Interest": { | |
1051 "description": "One of the person's interests.", | |
1052 "id": "Interest", | |
1053 "properties": { | |
1054 "metadata": { | |
1055 "$ref": "FieldMetadata", | |
1056 "description": "Metadata about the interest." | |
1057 }, | |
1058 "value": { | |
1059 "description": "The interest; for example, `stargazing`.", | |
1060 "type": "string" | |
1061 } | |
1062 }, | |
1063 "type": "object" | |
1064 }, | |
1065 "Skill": { | |
1066 "description": "A skill that the person has.", | |
1067 "id": "Skill", | |
1068 "properties": { | |
1069 "metadata": { | |
1070 "$ref": "FieldMetadata", | |
1071 "description": "Metadata about the skill." | |
1072 }, | |
1073 "value": { | |
1074 "description": "The skill; for example, `underwater basket w
eaving`.", | |
1075 "type": "string" | |
1076 } | |
1077 }, | |
1078 "type": "object" | |
1079 }, | |
1080 "BraggingRights": { | |
1081 "description": "A person's bragging rights.", | |
1082 "id": "BraggingRights", | |
1083 "properties": { | |
1084 "metadata": { | |
1085 "$ref": "FieldMetadata", | |
1086 "description": "Metadata about the bragging rights." | |
1087 }, | |
1088 "value": { | |
1089 "description": "The bragging rights; for example, `climbed m
ount everest`.", | |
1090 "type": "string" | |
1091 } | |
1092 }, | |
1093 "type": "object" | 1061 "type": "object" |
1094 }, | 1062 }, |
1095 "Relation": { | 1063 "Relation": { |
1096 "description": "A person's relation to another person.", | 1064 "description": "A person's relation to another person.", |
1097 "id": "Relation", | 1065 "id": "Relation", |
1098 "properties": { | 1066 "properties": { |
1099 "metadata": { | 1067 "metadata": { |
1100 "$ref": "FieldMetadata", | 1068 "$ref": "FieldMetadata", |
1101 "description": "Metadata about the relation." | 1069 "description": "Metadata about the relation." |
1102 }, | 1070 }, |
| 1071 "type": { |
| 1072 "description": "The person's relation to the other person. T
he type can be custom or predefined.\nPossible values include, but are not limit
ed to, the following values:\n\n* `spouse`\n* `child`\n* `mother`\n* `father`\n*
`parent`\n* `brother`\n* `sister`\n* `friend`\n* `relative`\n* `domesticPartner
`\n* `manager`\n* `assistant`\n* `referredBy`\n* `partner`", |
| 1073 "type": "string" |
| 1074 }, |
1103 "person": { | 1075 "person": { |
1104 "description": "The name of the other person this relation r
efers to.", | 1076 "description": "The name of the other person this relation r
efers to.", |
1105 "type": "string" | 1077 "type": "string" |
1106 }, | 1078 }, |
1107 "type": { | |
1108 "description": "The person's relation to the other person. T
he type can be custom or predefined. Possible values include, but are not limite
d to, the following values: * `spouse` * `child` * `mother` * `father` * `parent
` * `brother` * `sister` * `friend` * `relative` * `domesticPartner` * `manager`
* `assistant` * `referredBy` * `partner`", | |
1109 "type": "string" | |
1110 }, | |
1111 "formattedType": { | 1079 "formattedType": { |
1112 "description": "The type of the relation translated and form
atted in the viewer's account locale or the locale specified in the Accept-Langu
age HTTP header.", | 1080 "description": "The type of the relation translated and form
atted in the viewer's account\nlocale or the locale specified in the Accept-Lang
uage HTTP header.", |
1113 "type": "string" | 1081 "type": "string" |
1114 } | 1082 } |
1115 }, | 1083 }, |
1116 "type": "object" | 1084 "type": "object" |
1117 }, | 1085 }, |
1118 "RelationshipInterest": { | 1086 "Occupation": { |
1119 "description": "The kind of relationship the person is looking for."
, | 1087 "description": "A person's occupation.", |
1120 "id": "RelationshipInterest", | 1088 "id": "Occupation", |
1121 "properties": { | 1089 "properties": { |
1122 "metadata": { | 1090 "metadata": { |
1123 "$ref": "FieldMetadata", | 1091 "$ref": "FieldMetadata", |
1124 "description": "Metadata about the relationship interest." | 1092 "description": "Metadata about the occupation." |
1125 }, | 1093 }, |
1126 "value": { | 1094 "value": { |
1127 "description": "The kind of relationship the person is looki
ng for. The value can be custom or predefined. Possible values include, but are
not limited to, the following values: * `friend` * `date` * `relationship` * `ne
tworking`", | 1095 "description": "The occupation; for example, `carpenter`.", |
1128 "type": "string" | |
1129 }, | |
1130 "formattedValue": { | |
1131 "description": "The value of the relationship interest trans
lated and formatted in the viewer's account locale or the locale specified in th
e Accept-Language HTTP header.", | |
1132 "type": "string" | 1096 "type": "string" |
1133 } | 1097 } |
1134 }, | 1098 }, |
1135 "type": "object" | 1099 "type": "object" |
1136 }, | 1100 }, |
1137 "RelationshipStatus": { | 1101 "Person": { |
1138 "description": "A person's relationship status.", | 1102 "description": "Information about a person merged from various data
sources such as the\nauthenticated user's contacts and profile data. Fields othe
r than IDs,\nmetadata, and group memberships are user-edited.\n\nMost fields can
have multiple items. The items in a field have no guaranteed\norder, but each n
on-empty field is guaranteed to have exactly one field with\n`metadata.primary`
set to true.", |
1139 "id": "RelationshipStatus", | 1103 "id": "Person", |
1140 "properties": { | 1104 "properties": { |
| 1105 "birthdays": { |
| 1106 "description": "The person's birthdays.", |
| 1107 "items": { |
| 1108 "$ref": "Birthday" |
| 1109 }, |
| 1110 "type": "array" |
| 1111 }, |
| 1112 "locales": { |
| 1113 "description": "The person's locale preferences.", |
| 1114 "items": { |
| 1115 "$ref": "Locale" |
| 1116 }, |
| 1117 "type": "array" |
| 1118 }, |
| 1119 "relationshipInterests": { |
| 1120 "description": "The kind of relationship the person is looki
ng for.", |
| 1121 "items": { |
| 1122 "$ref": "RelationshipInterest" |
| 1123 }, |
| 1124 "type": "array" |
| 1125 }, |
| 1126 "urls": { |
| 1127 "description": "The person's associated URLs.", |
| 1128 "items": { |
| 1129 "$ref": "Url" |
| 1130 }, |
| 1131 "type": "array" |
| 1132 }, |
| 1133 "nicknames": { |
| 1134 "description": "The person's nicknames.", |
| 1135 "items": { |
| 1136 "$ref": "Nickname" |
| 1137 }, |
| 1138 "type": "array" |
| 1139 }, |
| 1140 "names": { |
| 1141 "description": "The person's names.", |
| 1142 "items": { |
| 1143 "$ref": "Name" |
| 1144 }, |
| 1145 "type": "array" |
| 1146 }, |
| 1147 "relations": { |
| 1148 "description": "The person's relations.", |
| 1149 "items": { |
| 1150 "$ref": "Relation" |
| 1151 }, |
| 1152 "type": "array" |
| 1153 }, |
| 1154 "occupations": { |
| 1155 "description": "The person's occupations.", |
| 1156 "items": { |
| 1157 "$ref": "Occupation" |
| 1158 }, |
| 1159 "type": "array" |
| 1160 }, |
| 1161 "emailAddresses": { |
| 1162 "description": "The person's email addresses.", |
| 1163 "items": { |
| 1164 "$ref": "EmailAddress" |
| 1165 }, |
| 1166 "type": "array" |
| 1167 }, |
| 1168 "organizations": { |
| 1169 "description": "The person's past or current organizations."
, |
| 1170 "items": { |
| 1171 "$ref": "Organization" |
| 1172 }, |
| 1173 "type": "array" |
| 1174 }, |
| 1175 "etag": { |
| 1176 "description": "The [HTTP entity tag](https://en.wikipedia.o
rg/wiki/HTTP_ETag) of the\nresource. Used for web cache validation.", |
| 1177 "type": "string" |
| 1178 }, |
| 1179 "braggingRights": { |
| 1180 "description": "The person's bragging rights.", |
| 1181 "items": { |
| 1182 "$ref": "BraggingRights" |
| 1183 }, |
| 1184 "type": "array" |
| 1185 }, |
1141 "metadata": { | 1186 "metadata": { |
1142 "$ref": "FieldMetadata", | 1187 "$ref": "PersonMetadata", |
1143 "description": "Metadata about the relationship status." | 1188 "description": "Metadata about the person." |
1144 }, | 1189 }, |
1145 "value": { | 1190 "residences": { |
1146 "description": "The relationship status. The value can be cu
stom or predefined. Possible values include, but are not limited to, the followi
ng: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` *
`openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion`", | 1191 "description": "The person's residences.", |
1147 "type": "string" | 1192 "items": { |
1148 }, | 1193 "$ref": "Residence" |
1149 "formattedValue": { | 1194 }, |
1150 "description": "The read-only value of the relationship stat
us translated and formatted in the viewer's account locale or the `Accept-Langua
ge` HTTP header locale.", | 1195 "type": "array" |
1151 "type": "string" | 1196 }, |
1152 } | 1197 "genders": { |
1153 }, | 1198 "description": "The person's genders.", |
1154 "type": "object" | 1199 "items": { |
1155 }, | 1200 "$ref": "Gender" |
1156 "Membership": { | 1201 }, |
1157 "description": "A person's membership in a group.", | 1202 "type": "array" |
1158 "id": "Membership", | 1203 }, |
1159 "properties": { | 1204 "interests": { |
1160 "metadata": { | 1205 "description": "The person's interests.", |
1161 "$ref": "FieldMetadata", | 1206 "items": { |
1162 "description": "Metadata about the membership." | 1207 "$ref": "Interest" |
1163 }, | 1208 }, |
1164 "contactGroupMembership": { | 1209 "type": "array" |
1165 "$ref": "ContactGroupMembership", | 1210 }, |
1166 "description": "The contact group membership." | 1211 "resourceName": { |
1167 }, | 1212 "description": "The resource name for the person, assigned b
y the server. An ASCII string\nwith a max length of 27 characters. Always starts
with `people/`.", |
1168 "domainMembership": { | 1213 "type": "string" |
1169 "$ref": "DomainMembership", | 1214 }, |
1170 "description": "The domain membership." | 1215 "biographies": { |
1171 } | 1216 "description": "The person's biographies.", |
1172 }, | 1217 "items": { |
1173 "type": "object" | 1218 "$ref": "Biography" |
1174 }, | 1219 }, |
1175 "ContactGroupMembership": { | 1220 "type": "array" |
1176 "description": "A Google contact group membership.", | 1221 }, |
1177 "id": "ContactGroupMembership", | 1222 "skills": { |
1178 "properties": { | 1223 "description": "The person's skills.", |
1179 "contactGroupId": { | 1224 "items": { |
1180 "description": "The contact group ID for the contact group m
embership. The contact group ID can be custom or predefined. Possible values inc
lude, but are not limited to, the following: * `myContacts` * `starred` * A nume
rical ID for user-created groups.", | 1225 "$ref": "Skill" |
1181 "type": "string" | 1226 }, |
1182 } | 1227 "type": "array" |
1183 }, | 1228 }, |
1184 "type": "object" | 1229 "relationshipStatuses": { |
1185 }, | 1230 "description": "The person's relationship statuses.", |
1186 "DomainMembership": { | 1231 "items": { |
1187 "description": "A Google Apps Domain membership.", | 1232 "$ref": "RelationshipStatus" |
1188 "id": "DomainMembership", | 1233 }, |
1189 "properties": { | 1234 "type": "array" |
1190 "inViewerDomain": { | 1235 }, |
1191 "description": "True if the person is in the viewer's Google
Apps domain.", | 1236 "photos": { |
1192 "type": "boolean" | 1237 "description": "The person's photos.", |
| 1238 "items": { |
| 1239 "$ref": "Photo" |
| 1240 }, |
| 1241 "type": "array" |
| 1242 }, |
| 1243 "ageRange": { |
| 1244 "description": "The person's age range.", |
| 1245 "enum": [ |
| 1246 "AGE_RANGE_UNSPECIFIED", |
| 1247 "LESS_THAN_EIGHTEEN", |
| 1248 "EIGHTEEN_TO_TWENTY", |
| 1249 "TWENTY_ONE_OR_OLDER" |
| 1250 ], |
| 1251 "enumDescriptions": [ |
| 1252 "Unspecified.", |
| 1253 "Younger than eighteen.", |
| 1254 "Between eighteen and twenty.", |
| 1255 "Twenty-one and older." |
| 1256 ], |
| 1257 "type": "string" |
| 1258 }, |
| 1259 "taglines": { |
| 1260 "description": "The person's taglines.", |
| 1261 "items": { |
| 1262 "$ref": "Tagline" |
| 1263 }, |
| 1264 "type": "array" |
| 1265 }, |
| 1266 "addresses": { |
| 1267 "description": "The person's street addresses.", |
| 1268 "items": { |
| 1269 "$ref": "Address" |
| 1270 }, |
| 1271 "type": "array" |
| 1272 }, |
| 1273 "events": { |
| 1274 "description": "The person's events.", |
| 1275 "items": { |
| 1276 "$ref": "Event" |
| 1277 }, |
| 1278 "type": "array" |
| 1279 }, |
| 1280 "memberships": { |
| 1281 "description": "The person's group memberships.", |
| 1282 "items": { |
| 1283 "$ref": "Membership" |
| 1284 }, |
| 1285 "type": "array" |
| 1286 }, |
| 1287 "phoneNumbers": { |
| 1288 "description": "The person's phone numbers.", |
| 1289 "items": { |
| 1290 "$ref": "PhoneNumber" |
| 1291 }, |
| 1292 "type": "array" |
| 1293 }, |
| 1294 "coverPhotos": { |
| 1295 "description": "The person's cover photos.", |
| 1296 "items": { |
| 1297 "$ref": "CoverPhoto" |
| 1298 }, |
| 1299 "type": "array" |
| 1300 }, |
| 1301 "imClients": { |
| 1302 "description": "The person's instant messaging clients.", |
| 1303 "items": { |
| 1304 "$ref": "ImClient" |
| 1305 }, |
| 1306 "type": "array" |
1193 } | 1307 } |
1194 }, | 1308 }, |
1195 "type": "object" | 1309 "type": "object" |
1196 }, | 1310 }, |
1197 "GetPeopleResponse": { | 1311 "GetPeopleResponse": { |
1198 "id": "GetPeopleResponse", | 1312 "id": "GetPeopleResponse", |
1199 "properties": { | 1313 "properties": { |
1200 "responses": { | 1314 "responses": { |
1201 "description": "The response for each requested resource nam
e.", | 1315 "description": "The response for each requested resource nam
e.", |
1202 "items": { | 1316 "items": { |
1203 "$ref": "PersonResponse" | 1317 "$ref": "PersonResponse" |
1204 }, | 1318 }, |
1205 "type": "array" | 1319 "type": "array" |
1206 } | 1320 } |
1207 }, | 1321 }, |
1208 "type": "object" | 1322 "type": "object" |
1209 }, | |
1210 "PersonResponse": { | |
1211 "description": "The response for a single person", | |
1212 "id": "PersonResponse", | |
1213 "properties": { | |
1214 "httpStatusCode": { | |
1215 "description": "[HTTP 1.1 status code](http://www.w3.org/Pro
tocols/rfc2616/rfc2616-sec10.html).", | |
1216 "format": "int32", | |
1217 "type": "integer" | |
1218 }, | |
1219 "person": { | |
1220 "$ref": "Person", | |
1221 "description": "The person." | |
1222 }, | |
1223 "requestedResourceName": { | |
1224 "description": "The original requested resource name. May be
different than the resource name on the returned person. The resource name can
change when adding or removing fields that link a contact and profile such as a
verified email, verified phone number, or a profile URL.", | |
1225 "type": "string" | |
1226 } | |
1227 }, | |
1228 "type": "object" | |
1229 }, | |
1230 "ListConnectionsResponse": { | |
1231 "id": "ListConnectionsResponse", | |
1232 "properties": { | |
1233 "connections": { | |
1234 "description": "The list of people that the requestor is con
nected to.", | |
1235 "items": { | |
1236 "$ref": "Person" | |
1237 }, | |
1238 "type": "array" | |
1239 }, | |
1240 "nextPageToken": { | |
1241 "description": "The token that can be used to retrieve the n
ext page of results.", | |
1242 "type": "string" | |
1243 }, | |
1244 "nextSyncToken": { | |
1245 "description": "The token that can be used to retrieve chang
es since the last request.", | |
1246 "type": "string" | |
1247 } | |
1248 }, | |
1249 "type": "object" | |
1250 } | 1323 } |
1251 }, | 1324 }, |
1252 "servicePath": "", | 1325 "servicePath": "", |
1253 "title": "Google People API", | 1326 "title": "Google People API", |
1254 "version": "v1" | 1327 "version": "v1" |
1255 } | 1328 } |
OLD | NEW |