OLD | NEW |
1 { | 1 { |
2 "auth": { | 2 "auth": { |
3 "oauth2": { | 3 "oauth2": { |
4 "scopes": { | 4 "scopes": { |
5 "https://www.googleapis.com/auth/plus.login": { | 5 "https://www.googleapis.com/auth/plus.login": { |
6 "description": "Know the list of people in your circles, you
r age range, and language" | 6 "description": "Know the list of people in your circles, you
r age range, and language" |
7 }, | 7 }, |
8 "https://www.googleapis.com/auth/userinfo.profile": { | 8 "https://www.googleapis.com/auth/userinfo.profile": { |
9 "description": "View your basic profile info" | 9 "description": "View your basic profile info" |
10 }, | 10 }, |
| 11 "https://www.googleapis.com/auth/user.addresses.read": { |
| 12 "description": "View your street addresses" |
| 13 }, |
| 14 "https://www.googleapis.com/auth/contacts": { |
| 15 "description": "Manage your contacts" |
| 16 }, |
11 "https://www.googleapis.com/auth/user.emails.read": { | 17 "https://www.googleapis.com/auth/user.emails.read": { |
12 "description": "View your email addresses" | 18 "description": "View your email addresses" |
13 }, | 19 }, |
14 "https://www.googleapis.com/auth/contacts": { | |
15 "description": "Manage your contacts" | |
16 }, | |
17 "https://www.googleapis.com/auth/user.addresses.read": { | |
18 "description": "View your street addresses" | |
19 }, | |
20 "https://www.googleapis.com/auth/userinfo.email": { | 20 "https://www.googleapis.com/auth/userinfo.email": { |
21 "description": "View your email address" | 21 "description": "View your email address" |
22 }, | 22 }, |
23 "https://www.googleapis.com/auth/user.phonenumbers.read": { | 23 "https://www.googleapis.com/auth/user.phonenumbers.read": { |
24 "description": "View your phone numbers" | 24 "description": "View your phone numbers" |
25 }, | 25 }, |
| 26 "https://www.googleapis.com/auth/contacts.readonly": { |
| 27 "description": "View your contacts" |
| 28 }, |
26 "https://www.googleapis.com/auth/user.birthday.read": { | 29 "https://www.googleapis.com/auth/user.birthday.read": { |
27 "description": "View your complete date of birth" | 30 "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": "Provides access to information about 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 "icons": { | 41 "icons": { |
42 "x16": "http://www.google.com/images/icons/product/search-16.gif", | 42 "x16": "http://www.google.com/images/icons/product/search-16.gif", |
43 "x32": "http://www.google.com/images/icons/product/search-32.gif" | 43 "x32": "http://www.google.com/images/icons/product/search-32.gif" |
44 }, | 44 }, |
45 "id": "people:v1", | 45 "id": "people:v1", |
46 "kind": "discovery#restDescription", | 46 "kind": "discovery#restDescription", |
47 "name": "people", | 47 "name": "people", |
48 "ownerDomain": "google.com", | 48 "ownerDomain": "google.com", |
49 "ownerName": "Google", | 49 "ownerName": "Google", |
50 "parameters": { | 50 "parameters": { |
| 51 "quotaUser": { |
| 52 "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.", |
| 53 "location": "query", |
| 54 "type": "string" |
| 55 }, |
| 56 "pp": { |
| 57 "default": "true", |
| 58 "description": "Pretty-print response.", |
| 59 "location": "query", |
| 60 "type": "boolean" |
| 61 }, |
| 62 "oauth_token": { |
| 63 "description": "OAuth 2.0 token for the current user.", |
| 64 "location": "query", |
| 65 "type": "string" |
| 66 }, |
| 67 "bearer_token": { |
| 68 "description": "OAuth bearer token.", |
| 69 "location": "query", |
| 70 "type": "string" |
| 71 }, |
51 "upload_protocol": { | 72 "upload_protocol": { |
52 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", | 73 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
53 "location": "query", | 74 "location": "query", |
54 "type": "string" | 75 "type": "string" |
55 }, | 76 }, |
56 "prettyPrint": { | 77 "prettyPrint": { |
57 "default": "true", | 78 "default": "true", |
58 "description": "Returns response with indentations and line breaks."
, | 79 "description": "Returns response with indentations and line breaks."
, |
59 "location": "query", | 80 "location": "query", |
60 "type": "boolean" | 81 "type": "boolean" |
61 }, | 82 }, |
62 "fields": { | 83 "fields": { |
63 "description": "Selector specifying which fields to include in a par
tial response.", | 84 "description": "Selector specifying which fields to include in a par
tial response.", |
64 "location": "query", | 85 "location": "query", |
65 "type": "string" | 86 "type": "string" |
66 }, | 87 }, |
67 "uploadType": { | 88 "uploadType": { |
68 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", | 89 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", |
69 "location": "query", | 90 "location": "query", |
70 "type": "string" | 91 "type": "string" |
71 }, | 92 }, |
72 "callback": { | |
73 "description": "JSONP", | |
74 "location": "query", | |
75 "type": "string" | |
76 }, | |
77 "$.xgafv": { | 93 "$.xgafv": { |
78 "description": "V1 error format.", | 94 "description": "V1 error format.", |
79 "enum": [ | 95 "enum": [ |
80 "1", | 96 "1", |
81 "2" | 97 "2" |
82 ], | 98 ], |
83 "enumDescriptions": [ | 99 "enumDescriptions": [ |
84 "v1 error format", | 100 "v1 error format", |
85 "v2 error format" | 101 "v2 error format" |
86 ], | 102 ], |
87 "location": "query", | 103 "location": "query", |
88 "type": "string" | 104 "type": "string" |
89 }, | 105 }, |
| 106 "callback": { |
| 107 "description": "JSONP", |
| 108 "location": "query", |
| 109 "type": "string" |
| 110 }, |
90 "alt": { | 111 "alt": { |
91 "default": "json", | 112 "default": "json", |
92 "description": "Data format for response.", | 113 "description": "Data format for response.", |
93 "enum": [ | 114 "enum": [ |
94 "json", | 115 "json", |
95 "media", | 116 "media", |
96 "proto" | 117 "proto" |
97 ], | 118 ], |
98 "enumDescriptions": [ | 119 "enumDescriptions": [ |
99 "Responses with Content-Type of application/json", | 120 "Responses with Content-Type of application/json", |
100 "Media download with context-dependent Content-Type", | 121 "Media download with context-dependent Content-Type", |
101 "Responses with Content-Type of application/x-protobuf" | 122 "Responses with Content-Type of application/x-protobuf" |
102 ], | 123 ], |
103 "location": "query", | 124 "location": "query", |
104 "type": "string" | 125 "type": "string" |
105 }, | 126 }, |
106 "access_token": { | 127 "access_token": { |
107 "description": "OAuth access token.", | 128 "description": "OAuth access token.", |
108 "location": "query", | 129 "location": "query", |
109 "type": "string" | 130 "type": "string" |
110 }, | 131 }, |
111 "key": { | 132 "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.", | 133 "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", | 134 "location": "query", |
114 "type": "string" | 135 "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 "bearer_token": { | |
128 "description": "OAuth bearer token.", | |
129 "location": "query", | |
130 "type": "string" | |
131 }, | |
132 "oauth_token": { | |
133 "description": "OAuth 2.0 token for the current user.", | |
134 "location": "query", | |
135 "type": "string" | |
136 } | 136 } |
137 }, | 137 }, |
138 "protocol": "rest", | 138 "protocol": "rest", |
139 "resources": { | 139 "resources": { |
140 "people": { | 140 "people": { |
141 "methods": { | 141 "methods": { |
142 "getBatchGet": { | 142 "get": { |
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.", | 143 "description": "Provides information about a person resource
for a resource name. Use\n`people/me` to indicate the authenticated user.", |
144 "httpMethod": "GET", | 144 "httpMethod": "GET", |
145 "id": "people.people.getBatchGet", | 145 "id": "people.people.get", |
146 "parameterOrder": [], | 146 "parameterOrder": [ |
| 147 "resourceName" |
| 148 ], |
147 "parameters": { | 149 "parameters": { |
| 150 "resourceName": { |
| 151 "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).", |
| 152 "location": "path", |
| 153 "pattern": "^people/[^/]+$", |
| 154 "required": true, |
| 155 "type": "string" |
| 156 }, |
148 "requestMask.includeField": { | 157 "requestMask.includeField": { |
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`.", | 158 "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`.", |
150 "format": "google-fieldmask", | 159 "format": "google-fieldmask", |
151 "location": "query", | 160 "location": "query", |
152 "type": "string" | 161 "type": "string" |
153 }, | |
154 "resourceNames": { | |
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.", | |
156 "location": "query", | |
157 "repeated": true, | |
158 "type": "string" | |
159 } | 162 } |
160 }, | 163 }, |
161 "path": "v1/people:batchGet", | 164 "path": "v1/{+resourceName}", |
162 "response": { | 165 "response": { |
163 "$ref": "GetPeopleResponse" | 166 "$ref": "Person" |
164 }, | 167 }, |
165 "scopes": [ | 168 "scopes": [ |
166 "https://www.googleapis.com/auth/contacts", | 169 "https://www.googleapis.com/auth/contacts", |
167 "https://www.googleapis.com/auth/contacts.readonly", | 170 "https://www.googleapis.com/auth/contacts.readonly", |
168 "https://www.googleapis.com/auth/plus.login", | 171 "https://www.googleapis.com/auth/plus.login", |
169 "https://www.googleapis.com/auth/user.addresses.read", | 172 "https://www.googleapis.com/auth/user.addresses.read", |
170 "https://www.googleapis.com/auth/user.birthday.read", | 173 "https://www.googleapis.com/auth/user.birthday.read", |
171 "https://www.googleapis.com/auth/user.emails.read", | 174 "https://www.googleapis.com/auth/user.emails.read", |
172 "https://www.googleapis.com/auth/user.phonenumbers.read"
, | 175 "https://www.googleapis.com/auth/user.phonenumbers.read"
, |
173 "https://www.googleapis.com/auth/userinfo.email", | 176 "https://www.googleapis.com/auth/userinfo.email", |
174 "https://www.googleapis.com/auth/userinfo.profile" | 177 "https://www.googleapis.com/auth/userinfo.profile" |
175 ] | 178 ] |
176 }, | 179 }, |
177 "get": { | 180 "getBatchGet": { |
178 "description": "Provides information about a person resource
for a resource name. Use\n`people/me` to indicate the authenticated user.", | 181 "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.", |
179 "httpMethod": "GET", | 182 "httpMethod": "GET", |
180 "id": "people.people.get", | 183 "id": "people.people.getBatchGet", |
181 "parameterOrder": [ | 184 "parameterOrder": [], |
182 "resourceName" | |
183 ], | |
184 "parameters": { | 185 "parameters": { |
185 "resourceName": { | |
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).", | |
187 "location": "path", | |
188 "pattern": "^people/[^/]+$", | |
189 "required": true, | |
190 "type": "string" | |
191 }, | |
192 "requestMask.includeField": { | 186 "requestMask.includeField": { |
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`.", | 187 "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", | 188 "format": "google-fieldmask", |
195 "location": "query", | 189 "location": "query", |
196 "type": "string" | 190 "type": "string" |
| 191 }, |
| 192 "resourceNames": { |
| 193 "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.", |
| 194 "location": "query", |
| 195 "repeated": true, |
| 196 "type": "string" |
197 } | 197 } |
198 }, | 198 }, |
199 "path": "v1/{+resourceName}", | 199 "path": "v1/people:batchGet", |
200 "response": { | 200 "response": { |
201 "$ref": "Person" | 201 "$ref": "GetPeopleResponse" |
202 }, | 202 }, |
203 "scopes": [ | 203 "scopes": [ |
204 "https://www.googleapis.com/auth/contacts", | 204 "https://www.googleapis.com/auth/contacts", |
205 "https://www.googleapis.com/auth/contacts.readonly", | 205 "https://www.googleapis.com/auth/contacts.readonly", |
206 "https://www.googleapis.com/auth/plus.login", | 206 "https://www.googleapis.com/auth/plus.login", |
207 "https://www.googleapis.com/auth/user.addresses.read", | 207 "https://www.googleapis.com/auth/user.addresses.read", |
208 "https://www.googleapis.com/auth/user.birthday.read", | 208 "https://www.googleapis.com/auth/user.birthday.read", |
209 "https://www.googleapis.com/auth/user.emails.read", | 209 "https://www.googleapis.com/auth/user.emails.read", |
210 "https://www.googleapis.com/auth/user.phonenumbers.read"
, | 210 "https://www.googleapis.com/auth/user.phonenumbers.read"
, |
211 "https://www.googleapis.com/auth/userinfo.email", | 211 "https://www.googleapis.com/auth/userinfo.email", |
212 "https://www.googleapis.com/auth/userinfo.profile" | 212 "https://www.googleapis.com/auth/userinfo.profile" |
213 ] | 213 ] |
214 } | 214 } |
215 }, | 215 }, |
216 "resources": { | 216 "resources": { |
217 "connections": { | 217 "connections": { |
218 "methods": { | 218 "methods": { |
219 "list": { | 219 "list": { |
220 "description": "Provides a list of the authenticated
user's contacts merged with any\nlinked profiles.", | 220 "description": "Provides a list of the authenticated
user's contacts merged with any\nlinked profiles.", |
221 "httpMethod": "GET", | 221 "httpMethod": "GET", |
222 "id": "people.people.connections.list", | 222 "id": "people.people.connections.list", |
223 "parameterOrder": [ | 223 "parameterOrder": [ |
224 "resourceName" | 224 "resourceName" |
225 ], | 225 ], |
226 "parameters": { | 226 "parameters": { |
227 "requestSyncToken": { | |
228 "description": "Whether the response should
include a sync token, which can be used to get\nall changes since the last reque
st.", | |
229 "location": "query", | |
230 "type": "boolean" | |
231 }, | |
232 "resourceName": { | 227 "resourceName": { |
233 "description": "The resource name to return
connections for. Only `people/me` is valid.", | 228 "description": "The resource name to return
connections for. Only `people/me` is valid.", |
234 "location": "path", | 229 "location": "path", |
235 "pattern": "^people/[^/]+$", | 230 "pattern": "^people/[^/]+$", |
236 "required": true, | 231 "required": true, |
237 "type": "string" | 232 "type": "string" |
238 }, | 233 }, |
239 "pageToken": { | 234 "pageToken": { |
240 "description": "The token of the page to be
returned.", | 235 "description": "The token of the page to be
returned.", |
241 "location": "query", | 236 "location": "query", |
(...skipping 18 matching lines...) Expand all Loading... |
260 }, | 255 }, |
261 "sortOrder": { | 256 "sortOrder": { |
262 "description": "The order in which the conne
ctions should be sorted. Defaults to\n`LAST_MODIFIED_ASCENDING`.", | 257 "description": "The order in which the conne
ctions should be sorted. Defaults to\n`LAST_MODIFIED_ASCENDING`.", |
263 "enum": [ | 258 "enum": [ |
264 "LAST_MODIFIED_ASCENDING", | 259 "LAST_MODIFIED_ASCENDING", |
265 "FIRST_NAME_ASCENDING", | 260 "FIRST_NAME_ASCENDING", |
266 "LAST_NAME_ASCENDING" | 261 "LAST_NAME_ASCENDING" |
267 ], | 262 ], |
268 "location": "query", | 263 "location": "query", |
269 "type": "string" | 264 "type": "string" |
| 265 }, |
| 266 "requestSyncToken": { |
| 267 "description": "Whether the response should
include a sync token, which can be used to get\nall changes since the last reque
st.", |
| 268 "location": "query", |
| 269 "type": "boolean" |
270 } | 270 } |
271 }, | 271 }, |
272 "path": "v1/{+resourceName}/connections", | 272 "path": "v1/{+resourceName}/connections", |
273 "response": { | 273 "response": { |
274 "$ref": "ListConnectionsResponse" | 274 "$ref": "ListConnectionsResponse" |
275 }, | 275 }, |
276 "scopes": [ | 276 "scopes": [ |
277 "https://www.googleapis.com/auth/contacts", | 277 "https://www.googleapis.com/auth/contacts", |
278 "https://www.googleapis.com/auth/contacts.readon
ly" | 278 "https://www.googleapis.com/auth/contacts.readon
ly" |
279 ] | 279 ] |
280 } | 280 } |
281 } | 281 } |
282 } | 282 } |
283 } | 283 } |
284 } | 284 } |
285 }, | 285 }, |
286 "revision": "20170302", | 286 "revision": "20170323", |
287 "rootUrl": "https://people.googleapis.com/", | 287 "rootUrl": "https://people.googleapis.com/", |
288 "schemas": { | 288 "schemas": { |
| 289 "Membership": { |
| 290 "description": "A person's read-only membership in a group.", |
| 291 "id": "Membership", |
| 292 "properties": { |
| 293 "contactGroupMembership": { |
| 294 "$ref": "ContactGroupMembership", |
| 295 "description": "The contact group membership." |
| 296 }, |
| 297 "domainMembership": { |
| 298 "$ref": "DomainMembership", |
| 299 "description": "The domain membership." |
| 300 }, |
| 301 "metadata": { |
| 302 "$ref": "FieldMetadata", |
| 303 "description": "Metadata about the membership." |
| 304 } |
| 305 }, |
| 306 "type": "object" |
| 307 }, |
| 308 "RelationshipStatus": { |
| 309 "description": "A person's read-only relationship status.", |
| 310 "id": "RelationshipStatus", |
| 311 "properties": { |
| 312 "formattedValue": { |
| 313 "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.", |
| 314 "type": "string" |
| 315 }, |
| 316 "metadata": { |
| 317 "$ref": "FieldMetadata", |
| 318 "description": "Metadata about the relationship status." |
| 319 }, |
| 320 "value": { |
| 321 "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`", |
| 322 "type": "string" |
| 323 } |
| 324 }, |
| 325 "type": "object" |
| 326 }, |
| 327 "Date": { |
| 328 "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
.", |
| 329 "id": "Date", |
| 330 "properties": { |
| 331 "year": { |
| 332 "description": "Year of date. Must be from 1 to 9999, or 0 i
f specifying a date without\na year.", |
| 333 "format": "int32", |
| 334 "type": "integer" |
| 335 }, |
| 336 "day": { |
| 337 "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.", |
| 338 "format": "int32", |
| 339 "type": "integer" |
| 340 }, |
| 341 "month": { |
| 342 "description": "Month of year. Must be from 1 to 12.", |
| 343 "format": "int32", |
| 344 "type": "integer" |
| 345 } |
| 346 }, |
| 347 "type": "object" |
| 348 }, |
| 349 "Tagline": { |
| 350 "description": "A read-only brief one-line description of the person
.", |
| 351 "id": "Tagline", |
| 352 "properties": { |
| 353 "value": { |
| 354 "description": "The tagline.", |
| 355 "type": "string" |
| 356 }, |
| 357 "metadata": { |
| 358 "$ref": "FieldMetadata", |
| 359 "description": "Metadata about the tagline." |
| 360 } |
| 361 }, |
| 362 "type": "object" |
| 363 }, |
| 364 "Name": { |
| 365 "description": "A person's name. If the name is a mononym, the famil
y name is empty.", |
| 366 "id": "Name", |
| 367 "properties": { |
| 368 "honorificPrefix": { |
| 369 "description": "The honorific prefixes, such as `Mrs.` or `D
r.`", |
| 370 "type": "string" |
| 371 }, |
| 372 "phoneticHonorificSuffix": { |
| 373 "description": "The honorific suffixes spelled as they sound
.", |
| 374 "type": "string" |
| 375 }, |
| 376 "givenName": { |
| 377 "description": "The given name.", |
| 378 "type": "string" |
| 379 }, |
| 380 "middleName": { |
| 381 "description": "The middle name(s).", |
| 382 "type": "string" |
| 383 }, |
| 384 "phoneticHonorificPrefix": { |
| 385 "description": "The honorific prefixes spelled as they sound
.", |
| 386 "type": "string" |
| 387 }, |
| 388 "phoneticGivenName": { |
| 389 "description": "The given name spelled as it sounds.", |
| 390 "type": "string" |
| 391 }, |
| 392 "phoneticFamilyName": { |
| 393 "description": "The family name spelled as it sounds.", |
| 394 "type": "string" |
| 395 }, |
| 396 "familyName": { |
| 397 "description": "The family name.", |
| 398 "type": "string" |
| 399 }, |
| 400 "phoneticMiddleName": { |
| 401 "description": "The middle name(s) spelled as they sound.", |
| 402 "type": "string" |
| 403 }, |
| 404 "metadata": { |
| 405 "$ref": "FieldMetadata", |
| 406 "description": "Metadata about the name." |
| 407 }, |
| 408 "phoneticFullName": { |
| 409 "description": "The full name spelled as it sounds.", |
| 410 "type": "string" |
| 411 }, |
| 412 "displayNameLastFirst": { |
| 413 "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.", |
| 414 "type": "string" |
| 415 }, |
| 416 "displayName": { |
| 417 "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.", |
| 418 "type": "string" |
| 419 }, |
| 420 "honorificSuffix": { |
| 421 "description": "The honorific suffixes, such as `Jr.`", |
| 422 "type": "string" |
| 423 } |
| 424 }, |
| 425 "type": "object" |
| 426 }, |
| 427 "BraggingRights": { |
| 428 "description": "A person's bragging rights.", |
| 429 "id": "BraggingRights", |
| 430 "properties": { |
| 431 "metadata": { |
| 432 "$ref": "FieldMetadata", |
| 433 "description": "Metadata about the bragging rights." |
| 434 }, |
| 435 "value": { |
| 436 "description": "The bragging rights; for example, `climbed m
ount everest`.", |
| 437 "type": "string" |
| 438 } |
| 439 }, |
| 440 "type": "object" |
| 441 }, |
| 442 "Locale": { |
| 443 "description": "A person's locale preference.", |
| 444 "id": "Locale", |
| 445 "properties": { |
| 446 "metadata": { |
| 447 "$ref": "FieldMetadata", |
| 448 "description": "Metadata about the locale." |
| 449 }, |
| 450 "value": { |
| 451 "description": "The well-formed [IETF BCP 47](https://tools.
ietf.org/html/bcp47)\nlanguage tag representing the locale.", |
| 452 "type": "string" |
| 453 } |
| 454 }, |
| 455 "type": "object" |
| 456 }, |
| 457 "Organization": { |
| 458 "description": "A person's past or current organization. Overlapping
date ranges are\npermitted.", |
| 459 "id": "Organization", |
| 460 "properties": { |
| 461 "type": { |
| 462 "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`", |
| 463 "type": "string" |
| 464 }, |
| 465 "phoneticName": { |
| 466 "description": "The phonetic name of the organization.", |
| 467 "type": "string" |
| 468 }, |
| 469 "jobDescription": { |
| 470 "description": "The person's job description at the organiza
tion.", |
| 471 "type": "string" |
| 472 }, |
| 473 "endDate": { |
| 474 "$ref": "Date", |
| 475 "description": "The end date when the person left the organi
zation." |
| 476 }, |
| 477 "symbol": { |
| 478 "description": "The symbol associated with the organization;
for example, a stock ticker\nsymbol, abbreviation, or acronym.", |
| 479 "type": "string" |
| 480 }, |
| 481 "name": { |
| 482 "description": "The name of the organization.", |
| 483 "type": "string" |
| 484 }, |
| 485 "metadata": { |
| 486 "$ref": "FieldMetadata", |
| 487 "description": "Metadata about the organization." |
| 488 }, |
| 489 "location": { |
| 490 "description": "The location of the organization office the
person works at.", |
| 491 "type": "string" |
| 492 }, |
| 493 "title": { |
| 494 "description": "The person's job title at the organization."
, |
| 495 "type": "string" |
| 496 }, |
| 497 "current": { |
| 498 "description": "True if the organization is the person's cur
rent organization;\nfalse if the organization is a past organization.", |
| 499 "type": "boolean" |
| 500 }, |
| 501 "formattedType": { |
| 502 "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.", |
| 503 "type": "string" |
| 504 }, |
| 505 "startDate": { |
| 506 "$ref": "Date", |
| 507 "description": "The start date when the person joined the or
ganization." |
| 508 }, |
| 509 "domain": { |
| 510 "description": "The domain name associated with the organiza
tion; for example, `google.com`.", |
| 511 "type": "string" |
| 512 }, |
| 513 "department": { |
| 514 "description": "The person's department at the organization.
", |
| 515 "type": "string" |
| 516 } |
| 517 }, |
| 518 "type": "object" |
| 519 }, |
| 520 "Biography": { |
| 521 "description": "A person's short biography.", |
| 522 "id": "Biography", |
| 523 "properties": { |
| 524 "contentType": { |
| 525 "description": "The content type of the biography.", |
| 526 "enum": [ |
| 527 "CONTENT_TYPE_UNSPECIFIED", |
| 528 "TEXT_PLAIN", |
| 529 "TEXT_HTML" |
| 530 ], |
| 531 "enumDescriptions": [ |
| 532 "Unspecified.", |
| 533 "Plain text.", |
| 534 "HTML text." |
| 535 ], |
| 536 "type": "string" |
| 537 }, |
| 538 "metadata": { |
| 539 "$ref": "FieldMetadata", |
| 540 "description": "Metadata about the biography." |
| 541 }, |
| 542 "value": { |
| 543 "description": "The short biography.", |
| 544 "type": "string" |
| 545 } |
| 546 }, |
| 547 "type": "object" |
| 548 }, |
| 549 "AgeRangeType": { |
| 550 "description": "A person's age range.", |
| 551 "id": "AgeRangeType", |
| 552 "properties": { |
| 553 "ageRange": { |
| 554 "description": "The age range.", |
| 555 "enum": [ |
| 556 "AGE_RANGE_UNSPECIFIED", |
| 557 "LESS_THAN_EIGHTEEN", |
| 558 "EIGHTEEN_TO_TWENTY", |
| 559 "TWENTY_ONE_OR_OLDER" |
| 560 ], |
| 561 "enumDescriptions": [ |
| 562 "Unspecified.", |
| 563 "Younger than eighteen.", |
| 564 "Between eighteen and twenty.", |
| 565 "Twenty-one and older." |
| 566 ], |
| 567 "type": "string" |
| 568 }, |
| 569 "metadata": { |
| 570 "$ref": "FieldMetadata", |
| 571 "description": "Metadata about the age range." |
| 572 } |
| 573 }, |
| 574 "type": "object" |
| 575 }, |
| 576 "FieldMetadata": { |
| 577 "description": "Metadata about a field.", |
| 578 "id": "FieldMetadata", |
| 579 "properties": { |
| 580 "verified": { |
| 581 "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.", |
| 582 "type": "boolean" |
| 583 }, |
| 584 "primary": { |
| 585 "description": "True if the field is the primary field; fals
e if the field is a secondary\nfield.", |
| 586 "type": "boolean" |
| 587 }, |
| 588 "source": { |
| 589 "$ref": "Source", |
| 590 "description": "The source of the field." |
| 591 } |
| 592 }, |
| 593 "type": "object" |
| 594 }, |
| 595 "PersonResponse": { |
| 596 "description": "The response for a single person", |
| 597 "id": "PersonResponse", |
| 598 "properties": { |
| 599 "person": { |
| 600 "$ref": "Person", |
| 601 "description": "The person." |
| 602 }, |
| 603 "httpStatusCode": { |
| 604 "description": "[HTTP 1.1 status code](http://www.w3.org/Pro
tocols/rfc2616/rfc2616-sec10.html).", |
| 605 "format": "int32", |
| 606 "type": "integer" |
| 607 }, |
| 608 "requestedResourceName": { |
| 609 "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.", |
| 610 "type": "string" |
| 611 } |
| 612 }, |
| 613 "type": "object" |
| 614 }, |
| 615 "RelationshipInterest": { |
| 616 "description": "A person's read-only relationship interest .", |
| 617 "id": "RelationshipInterest", |
| 618 "properties": { |
| 619 "value": { |
| 620 "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`", |
| 621 "type": "string" |
| 622 }, |
| 623 "formattedValue": { |
| 624 "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.", |
| 625 "type": "string" |
| 626 }, |
| 627 "metadata": { |
| 628 "$ref": "FieldMetadata", |
| 629 "description": "Metadata about the relationship interest." |
| 630 } |
| 631 }, |
| 632 "type": "object" |
| 633 }, |
| 634 "Source": { |
| 635 "description": "The source of a field.", |
| 636 "id": "Source", |
| 637 "properties": { |
| 638 "profileMetadata": { |
| 639 "$ref": "ProfileMetadata", |
| 640 "description": "Metadata about a source of type PROFILE." |
| 641 }, |
| 642 "type": { |
| 643 "description": "The source type.", |
| 644 "enum": [ |
| 645 "SOURCE_TYPE_UNSPECIFIED", |
| 646 "ACCOUNT", |
| 647 "PROFILE", |
| 648 "DOMAIN_PROFILE", |
| 649 "CONTACT" |
| 650 ], |
| 651 "enumDescriptions": [ |
| 652 "Unspecified.", |
| 653 "[Google Account](https://accounts.google.com).", |
| 654 "[Google profile](https://profiles.google.com). You can
view the\nprofile at https://profiles.google.com/<id> where <id> is the source\n
id.", |
| 655 "[Google Apps domain profile](https://admin.google.com).
", |
| 656 "[Google contact](https://contacts.google.com). You can
view the\ncontact at https://contact.google.com/<id> where <id> is the source\ni
d." |
| 657 ], |
| 658 "type": "string" |
| 659 }, |
| 660 "etag": { |
| 661 "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.", |
| 662 "type": "string" |
| 663 }, |
| 664 "id": { |
| 665 "description": "The unique identifier within the source type
generated by the server.", |
| 666 "type": "string" |
| 667 } |
| 668 }, |
| 669 "type": "object" |
| 670 }, |
289 "Relation": { | 671 "Relation": { |
290 "description": "A person's relation to another person.", | 672 "description": "A person's relation to another person.", |
291 "id": "Relation", | 673 "id": "Relation", |
292 "properties": { | 674 "properties": { |
293 "metadata": { | 675 "metadata": { |
294 "$ref": "FieldMetadata", | 676 "$ref": "FieldMetadata", |
295 "description": "Metadata about the relation." | 677 "description": "Metadata about the relation." |
296 }, | 678 }, |
297 "type": { | 679 "type": { |
298 "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`", | 680 "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`", |
299 "type": "string" | 681 "type": "string" |
300 }, | 682 }, |
301 "person": { | 683 "person": { |
302 "description": "The name of the other person this relation r
efers to.", | 684 "description": "The name of the other person this relation r
efers to.", |
303 "type": "string" | 685 "type": "string" |
304 }, | 686 }, |
305 "formattedType": { | 687 "formattedType": { |
306 "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.", | 688 "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.", |
307 "type": "string" | 689 "type": "string" |
308 } | 690 } |
309 }, | 691 }, |
310 "type": "object" | 692 "type": "object" |
311 }, | 693 }, |
312 "Occupation": { | 694 "Occupation": { |
313 "description": "A person's occupation.", | 695 "description": "A person's occupation.", |
314 "id": "Occupation", | 696 "id": "Occupation", |
315 "properties": { | 697 "properties": { |
| 698 "metadata": { |
| 699 "$ref": "FieldMetadata", |
| 700 "description": "Metadata about the occupation." |
| 701 }, |
316 "value": { | 702 "value": { |
317 "description": "The occupation; for example, `carpenter`.", | 703 "description": "The occupation; for example, `carpenter`.", |
318 "type": "string" | 704 "type": "string" |
319 }, | |
320 "metadata": { | |
321 "$ref": "FieldMetadata", | |
322 "description": "Metadata about the occupation." | |
323 } | 705 } |
324 }, | 706 }, |
325 "type": "object" | 707 "type": "object" |
326 }, | 708 }, |
327 "Person": { | 709 "Person": { |
328 "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.\nNEXT_ID: 31", | 710 "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.\nNEXT_ID: 31", |
329 "id": "Person", | 711 "id": "Person", |
330 "properties": { | 712 "properties": { |
331 "nicknames": { | |
332 "description": "The person's nicknames.", | |
333 "items": { | |
334 "$ref": "Nickname" | |
335 }, | |
336 "type": "array" | |
337 }, | |
338 "names": { | |
339 "description": "The person's names.", | |
340 "items": { | |
341 "$ref": "Name" | |
342 }, | |
343 "type": "array" | |
344 }, | |
345 "relations": { | |
346 "description": "The person's relations.", | |
347 "items": { | |
348 "$ref": "Relation" | |
349 }, | |
350 "type": "array" | |
351 }, | |
352 "occupations": { | |
353 "description": "The person's occupations.", | |
354 "items": { | |
355 "$ref": "Occupation" | |
356 }, | |
357 "type": "array" | |
358 }, | |
359 "emailAddresses": { | |
360 "description": "The person's email addresses.", | |
361 "items": { | |
362 "$ref": "EmailAddress" | |
363 }, | |
364 "type": "array" | |
365 }, | |
366 "organizations": { | |
367 "description": "The person's past or current organizations."
, | |
368 "items": { | |
369 "$ref": "Organization" | |
370 }, | |
371 "type": "array" | |
372 }, | |
373 "etag": { | |
374 "description": "The [HTTP entity tag](https://en.wikipedia.o
rg/wiki/HTTP_ETag) of the\nresource. Used for web cache validation.", | |
375 "type": "string" | |
376 }, | |
377 "braggingRights": { | |
378 "description": "The person's bragging rights.", | |
379 "items": { | |
380 "$ref": "BraggingRights" | |
381 }, | |
382 "type": "array" | |
383 }, | |
384 "metadata": { | 713 "metadata": { |
385 "$ref": "PersonMetadata", | 714 "$ref": "PersonMetadata", |
386 "description": "Metadata about the person." | 715 "description": "Metadata about the person." |
387 }, | 716 }, |
388 "residences": { | 717 "residences": { |
389 "description": "The person's residences.", | 718 "description": "The person's residences.", |
390 "items": { | 719 "items": { |
391 "$ref": "Residence" | 720 "$ref": "Residence" |
392 }, | 721 }, |
393 "type": "array" | 722 "type": "array" |
394 }, | 723 }, |
395 "genders": { | 724 "genders": { |
396 "description": "The person's genders.", | 725 "description": "The person's genders.", |
397 "items": { | 726 "items": { |
398 "$ref": "Gender" | 727 "$ref": "Gender" |
399 }, | 728 }, |
400 "type": "array" | 729 "type": "array" |
401 }, | 730 }, |
| 731 "resourceName": { |
| 732 "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/`.", |
| 733 "type": "string" |
| 734 }, |
402 "interests": { | 735 "interests": { |
403 "description": "The person's interests.", | 736 "description": "The person's interests.", |
404 "items": { | 737 "items": { |
405 "$ref": "Interest" | 738 "$ref": "Interest" |
406 }, | 739 }, |
407 "type": "array" | 740 "type": "array" |
408 }, | 741 }, |
409 "resourceName": { | |
410 "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/`.", | |
411 "type": "string" | |
412 }, | |
413 "biographies": { | 742 "biographies": { |
414 "description": "The person's biographies.", | 743 "description": "The person's biographies.", |
415 "items": { | 744 "items": { |
416 "$ref": "Biography" | 745 "$ref": "Biography" |
417 }, | 746 }, |
418 "type": "array" | 747 "type": "array" |
419 }, | 748 }, |
420 "skills": { | 749 "skills": { |
421 "description": "The person's skills.", | 750 "description": "The person's skills.", |
422 "items": { | 751 "items": { |
(...skipping 107 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
530 "$ref": "RelationshipInterest" | 859 "$ref": "RelationshipInterest" |
531 }, | 860 }, |
532 "type": "array" | 861 "type": "array" |
533 }, | 862 }, |
534 "urls": { | 863 "urls": { |
535 "description": "The person's associated URLs.", | 864 "description": "The person's associated URLs.", |
536 "items": { | 865 "items": { |
537 "$ref": "Url" | 866 "$ref": "Url" |
538 }, | 867 }, |
539 "type": "array" | 868 "type": "array" |
| 869 }, |
| 870 "nicknames": { |
| 871 "description": "The person's nicknames.", |
| 872 "items": { |
| 873 "$ref": "Nickname" |
| 874 }, |
| 875 "type": "array" |
| 876 }, |
| 877 "relations": { |
| 878 "description": "The person's relations.", |
| 879 "items": { |
| 880 "$ref": "Relation" |
| 881 }, |
| 882 "type": "array" |
| 883 }, |
| 884 "names": { |
| 885 "description": "The person's names.", |
| 886 "items": { |
| 887 "$ref": "Name" |
| 888 }, |
| 889 "type": "array" |
| 890 }, |
| 891 "occupations": { |
| 892 "description": "The person's occupations.", |
| 893 "items": { |
| 894 "$ref": "Occupation" |
| 895 }, |
| 896 "type": "array" |
| 897 }, |
| 898 "emailAddresses": { |
| 899 "description": "The person's email addresses.", |
| 900 "items": { |
| 901 "$ref": "EmailAddress" |
| 902 }, |
| 903 "type": "array" |
| 904 }, |
| 905 "organizations": { |
| 906 "description": "The person's past or current organizations."
, |
| 907 "items": { |
| 908 "$ref": "Organization" |
| 909 }, |
| 910 "type": "array" |
| 911 }, |
| 912 "etag": { |
| 913 "description": "The [HTTP entity tag](https://en.wikipedia.o
rg/wiki/HTTP_ETag) of the\nresource. Used for web cache validation.", |
| 914 "type": "string" |
| 915 }, |
| 916 "braggingRights": { |
| 917 "description": "The person's bragging rights.", |
| 918 "items": { |
| 919 "$ref": "BraggingRights" |
| 920 }, |
| 921 "type": "array" |
540 } | 922 } |
541 }, | 923 }, |
542 "type": "object" | 924 "type": "object" |
543 }, | 925 }, |
544 "GetPeopleResponse": { | 926 "GetPeopleResponse": { |
545 "id": "GetPeopleResponse", | 927 "id": "GetPeopleResponse", |
546 "properties": { | 928 "properties": { |
547 "responses": { | 929 "responses": { |
548 "description": "The response for each requested resource nam
e.", | 930 "description": "The response for each requested resource nam
e.", |
549 "items": { | 931 "items": { |
550 "$ref": "PersonResponse" | 932 "$ref": "PersonResponse" |
551 }, | 933 }, |
552 "type": "array" | 934 "type": "array" |
553 } | 935 } |
554 }, | 936 }, |
555 "type": "object" | 937 "type": "object" |
556 }, | 938 }, |
| 939 "Photo": { |
| 940 "description": "A person's read-only photo. A picture shown next to
the person's name to\nhelp others recognize the person.", |
| 941 "id": "Photo", |
| 942 "properties": { |
| 943 "metadata": { |
| 944 "$ref": "FieldMetadata", |
| 945 "description": "Metadata about the photo." |
| 946 }, |
| 947 "url": { |
| 948 "description": "The URL of the photo.", |
| 949 "type": "string" |
| 950 } |
| 951 }, |
| 952 "type": "object" |
| 953 }, |
557 "PhoneNumber": { | 954 "PhoneNumber": { |
558 "description": "A person's phone number.", | 955 "description": "A person's phone number.", |
559 "id": "PhoneNumber", | 956 "id": "PhoneNumber", |
560 "properties": { | 957 "properties": { |
561 "metadata": { | |
562 "$ref": "FieldMetadata", | |
563 "description": "Metadata about the phone number." | |
564 }, | |
565 "type": { | |
566 "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`", | |
567 "type": "string" | |
568 }, | |
569 "value": { | |
570 "description": "The phone number.", | |
571 "type": "string" | |
572 }, | |
573 "formattedType": { | 958 "formattedType": { |
574 "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.", | 959 "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.", |
575 "type": "string" | 960 "type": "string" |
576 }, | 961 }, |
577 "canonicalForm": { | 962 "canonicalForm": { |
578 "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.", | 963 "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.", |
579 "type": "string" | 964 "type": "string" |
580 } | 965 }, |
581 }, | 966 "metadata": { |
582 "type": "object" | 967 "$ref": "FieldMetadata", |
583 }, | 968 "description": "Metadata about the phone number." |
584 "Photo": { | 969 }, |
585 "description": "A person's read-only photo. A picture shown next to
the person's name to\nhelp others recognize the person.", | 970 "type": { |
586 "id": "Photo", | 971 "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`", |
587 "properties": { | 972 "type": "string" |
588 "metadata": { | 973 }, |
589 "$ref": "FieldMetadata", | 974 "value": { |
590 "description": "Metadata about the photo." | 975 "description": "The phone number.", |
591 }, | |
592 "url": { | |
593 "description": "The URL of the photo.", | |
594 "type": "string" | 976 "type": "string" |
595 } | 977 } |
596 }, | 978 }, |
597 "type": "object" | 979 "type": "object" |
598 }, | 980 }, |
599 "ListConnectionsResponse": { | 981 "ListConnectionsResponse": { |
600 "id": "ListConnectionsResponse", | 982 "id": "ListConnectionsResponse", |
601 "properties": { | 983 "properties": { |
602 "nextPageToken": { | 984 "nextPageToken": { |
603 "description": "The token that can be used to retrieve the n
ext page of results.", | 985 "description": "The token that can be used to retrieve the n
ext page of results.", |
604 "type": "string" | 986 "type": "string" |
605 }, | 987 }, |
606 "connections": { | 988 "connections": { |
607 "description": "The list of people that the requestor is con
nected to.", | 989 "description": "The list of people that the requestor is con
nected to.", |
608 "items": { | 990 "items": { |
609 "$ref": "Person" | 991 "$ref": "Person" |
610 }, | 992 }, |
611 "type": "array" | 993 "type": "array" |
612 }, | 994 }, |
613 "nextSyncToken": { | 995 "nextSyncToken": { |
614 "description": "The token that can be used to retrieve chang
es since the last request.", | 996 "description": "The token that can be used to retrieve chang
es since the last request.", |
615 "type": "string" | 997 "type": "string" |
| 998 }, |
| 999 "totalPeople": { |
| 1000 "description": "The total number of people in the list witho
ut pagination.", |
| 1001 "format": "int32", |
| 1002 "type": "integer" |
616 } | 1003 } |
617 }, | 1004 }, |
618 "type": "object" | 1005 "type": "object" |
619 }, | 1006 }, |
620 "Birthday": { | 1007 "Birthday": { |
621 "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.", | 1008 "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.", |
622 "id": "Birthday", | 1009 "id": "Birthday", |
623 "properties": { | 1010 "properties": { |
624 "metadata": { | 1011 "metadata": { |
625 "$ref": "FieldMetadata", | 1012 "$ref": "FieldMetadata", |
626 "description": "Metadata about the birthday." | 1013 "description": "Metadata about the birthday." |
627 }, | 1014 }, |
628 "text": { | 1015 "text": { |
629 "description": "A free-form string representing the user's b
irthday.", | 1016 "description": "A free-form string representing the user's b
irthday.", |
630 "type": "string" | 1017 "type": "string" |
631 }, | 1018 }, |
632 "date": { | 1019 "date": { |
633 "$ref": "Date", | 1020 "$ref": "Date", |
634 "description": "The date of the birthday." | 1021 "description": "The date of the birthday." |
635 } | 1022 } |
636 }, | 1023 }, |
637 "type": "object" | 1024 "type": "object" |
638 }, | 1025 }, |
| 1026 "Address": { |
| 1027 "description": "A person's physical address. May be a P.O. box or st
reet address. All fields\nare optional.", |
| 1028 "id": "Address", |
| 1029 "properties": { |
| 1030 "extendedAddress": { |
| 1031 "description": "The extended address of the address; for exa
mple, the apartment number.", |
| 1032 "type": "string" |
| 1033 }, |
| 1034 "poBox": { |
| 1035 "description": "The P.O. box of the address.", |
| 1036 "type": "string" |
| 1037 }, |
| 1038 "postalCode": { |
| 1039 "description": "The postal code of the address.", |
| 1040 "type": "string" |
| 1041 }, |
| 1042 "region": { |
| 1043 "description": "The region of the address; for example, the
state or province.", |
| 1044 "type": "string" |
| 1045 }, |
| 1046 "streetAddress": { |
| 1047 "description": "The street address.", |
| 1048 "type": "string" |
| 1049 }, |
| 1050 "metadata": { |
| 1051 "$ref": "FieldMetadata", |
| 1052 "description": "Metadata about the address." |
| 1053 }, |
| 1054 "countryCode": { |
| 1055 "description": "The [ISO 3166-1 alpha-2](http://www.iso.org/
iso/country_codes.htm) country\ncode of the address.", |
| 1056 "type": "string" |
| 1057 }, |
| 1058 "formattedType": { |
| 1059 "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.", |
| 1060 "type": "string" |
| 1061 }, |
| 1062 "city": { |
| 1063 "description": "The city of the address.", |
| 1064 "type": "string" |
| 1065 }, |
| 1066 "formattedValue": { |
| 1067 "description": "The unstructured value of the address. If th
is is not set by the user it\nwill be automatically constructed from structured
values.", |
| 1068 "type": "string" |
| 1069 }, |
| 1070 "country": { |
| 1071 "description": "The country of the address.", |
| 1072 "type": "string" |
| 1073 }, |
| 1074 "type": { |
| 1075 "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`", |
| 1076 "type": "string" |
| 1077 } |
| 1078 }, |
| 1079 "type": "object" |
| 1080 }, |
639 "Residence": { | 1081 "Residence": { |
640 "description": "A person's past or current residence.", | 1082 "description": "A person's past or current residence.", |
641 "id": "Residence", | 1083 "id": "Residence", |
642 "properties": { | 1084 "properties": { |
643 "metadata": { | 1085 "metadata": { |
644 "$ref": "FieldMetadata", | 1086 "$ref": "FieldMetadata", |
645 "description": "Metadata about the residence." | 1087 "description": "Metadata about the residence." |
646 }, | 1088 }, |
647 "current": { | 1089 "current": { |
648 "description": "True if the residence is the person's curren
t residence;\nfalse if the residence is a past residence.", | 1090 "description": "True if the residence is the person's curren
t residence;\nfalse if the residence is a past residence.", |
649 "type": "boolean" | 1091 "type": "boolean" |
650 }, | 1092 }, |
651 "value": { | 1093 "value": { |
652 "description": "The address of the residence.", | 1094 "description": "The address of the residence.", |
653 "type": "string" | 1095 "type": "string" |
654 } | 1096 } |
655 }, | 1097 }, |
656 "type": "object" | 1098 "type": "object" |
657 }, | 1099 }, |
658 "Address": { | |
659 "description": "A person's physical address. May be a P.O. box or st
reet address. All fields\nare optional.", | |
660 "id": "Address", | |
661 "properties": { | |
662 "region": { | |
663 "description": "The region of the address; for example, the
state or province.", | |
664 "type": "string" | |
665 }, | |
666 "streetAddress": { | |
667 "description": "The street address.", | |
668 "type": "string" | |
669 }, | |
670 "metadata": { | |
671 "$ref": "FieldMetadata", | |
672 "description": "Metadata about the address." | |
673 }, | |
674 "countryCode": { | |
675 "description": "The [ISO 3166-1 alpha-2](http://www.iso.org/
iso/country_codes.htm) country\ncode of the address.", | |
676 "type": "string" | |
677 }, | |
678 "formattedType": { | |
679 "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.", | |
680 "type": "string" | |
681 }, | |
682 "city": { | |
683 "description": "The city of the address.", | |
684 "type": "string" | |
685 }, | |
686 "formattedValue": { | |
687 "description": "The unstructured value of the address. If th
is is not set by the user it\nwill be automatically constructed from structured
values.", | |
688 "type": "string" | |
689 }, | |
690 "country": { | |
691 "description": "The country of the address.", | |
692 "type": "string" | |
693 }, | |
694 "type": { | |
695 "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`", | |
696 "type": "string" | |
697 }, | |
698 "extendedAddress": { | |
699 "description": "The extended address of the address; for exa
mple, the apartment number.", | |
700 "type": "string" | |
701 }, | |
702 "poBox": { | |
703 "description": "The P.O. box of the address.", | |
704 "type": "string" | |
705 }, | |
706 "postalCode": { | |
707 "description": "The postal code of the address.", | |
708 "type": "string" | |
709 } | |
710 }, | |
711 "type": "object" | |
712 }, | |
713 "ContactGroupMembership": { | 1100 "ContactGroupMembership": { |
714 "description": "A Google contact group membership.", | 1101 "description": "A Google contact group membership.", |
715 "id": "ContactGroupMembership", | 1102 "id": "ContactGroupMembership", |
716 "properties": { | 1103 "properties": { |
717 "contactGroupId": { | 1104 "contactGroupId": { |
718 "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.", | 1105 "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.", |
719 "type": "string" | 1106 "type": "string" |
720 } | 1107 } |
721 }, | 1108 }, |
722 "type": "object" | 1109 "type": "object" |
723 }, | 1110 }, |
724 "Event": { | |
725 "description": "An event related to the person.", | |
726 "id": "Event", | |
727 "properties": { | |
728 "formattedType": { | |
729 "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.", | |
730 "type": "string" | |
731 }, | |
732 "metadata": { | |
733 "$ref": "FieldMetadata", | |
734 "description": "Metadata about the event." | |
735 }, | |
736 "type": { | |
737 "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`", | |
738 "type": "string" | |
739 }, | |
740 "date": { | |
741 "$ref": "Date", | |
742 "description": "The date of the event." | |
743 } | |
744 }, | |
745 "type": "object" | |
746 }, | |
747 "PersonMetadata": { | 1111 "PersonMetadata": { |
748 "description": "The read-only metadata about a person.", | 1112 "description": "The read-only metadata about a person.", |
749 "id": "PersonMetadata", | 1113 "id": "PersonMetadata", |
750 "properties": { | 1114 "properties": { |
| 1115 "sources": { |
| 1116 "description": "The sources of data for the person.", |
| 1117 "items": { |
| 1118 "$ref": "Source" |
| 1119 }, |
| 1120 "type": "array" |
| 1121 }, |
| 1122 "previousResourceNames": { |
| 1123 "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.", |
| 1124 "items": { |
| 1125 "type": "string" |
| 1126 }, |
| 1127 "type": "array" |
| 1128 }, |
751 "deleted": { | 1129 "deleted": { |
752 "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.", | 1130 "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.", |
753 "type": "boolean" | 1131 "type": "boolean" |
754 }, | 1132 }, |
755 "objectType": { | 1133 "objectType": { |
756 "description": "DEPRECATED(Please read person.metadata.sourc
es.profile_metadata instead).\nThe type of the person object.", | 1134 "description": "DEPRECATED(Please read person.metadata.sourc
es.profile_metadata instead).\nThe type of the person object.", |
757 "enum": [ | 1135 "enum": [ |
758 "OBJECT_TYPE_UNSPECIFIED", | 1136 "OBJECT_TYPE_UNSPECIFIED", |
759 "PERSON", | 1137 "PERSON", |
760 "PAGE" | 1138 "PAGE" |
761 ], | 1139 ], |
762 "enumDescriptions": [ | 1140 "enumDescriptions": [ |
763 "Unspecified.", | 1141 "Unspecified.", |
764 "Person.", | 1142 "Person.", |
765 "[Google+ Page.](http://www.google.com/+/brands/)" | 1143 "[Google+ Page.](http://www.google.com/+/brands/)" |
766 ], | 1144 ], |
767 "type": "string" | 1145 "type": "string" |
768 }, | 1146 }, |
769 "linkedPeopleResourceNames": { | 1147 "linkedPeopleResourceNames": { |
770 "description": "Resource names of people linked to this reso
urce.", | 1148 "description": "Resource names of people linked to this reso
urce.", |
771 "items": { | 1149 "items": { |
772 "type": "string" | 1150 "type": "string" |
773 }, | 1151 }, |
774 "type": "array" | 1152 "type": "array" |
775 }, | 1153 } |
776 "sources": { | 1154 }, |
777 "description": "The sources of data for the person.", | 1155 "type": "object" |
778 "items": { | 1156 }, |
779 "$ref": "Source" | 1157 "Event": { |
780 }, | 1158 "description": "An event related to the person.", |
781 "type": "array" | 1159 "id": "Event", |
782 }, | 1160 "properties": { |
783 "previousResourceNames": { | 1161 "metadata": { |
784 "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.", | 1162 "$ref": "FieldMetadata", |
785 "items": { | 1163 "description": "Metadata about the event." |
786 "type": "string" | 1164 }, |
787 }, | 1165 "type": { |
788 "type": "array" | 1166 "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`", |
| 1167 "type": "string" |
| 1168 }, |
| 1169 "date": { |
| 1170 "$ref": "Date", |
| 1171 "description": "The date of the event." |
| 1172 }, |
| 1173 "formattedType": { |
| 1174 "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.", |
| 1175 "type": "string" |
789 } | 1176 } |
790 }, | 1177 }, |
791 "type": "object" | 1178 "type": "object" |
792 }, | 1179 }, |
793 "ProfileMetadata": { | 1180 "ProfileMetadata": { |
794 "description": "The read-only metadata about a profile.", | 1181 "description": "The read-only metadata about a profile.", |
795 "id": "ProfileMetadata", | 1182 "id": "ProfileMetadata", |
796 "properties": { | 1183 "properties": { |
797 "objectType": { | 1184 "objectType": { |
798 "description": "The profile object type.", | 1185 "description": "The profile object type.", |
799 "enum": [ | 1186 "enum": [ |
800 "OBJECT_TYPE_UNSPECIFIED", | 1187 "OBJECT_TYPE_UNSPECIFIED", |
801 "PERSON", | 1188 "PERSON", |
802 "PAGE" | 1189 "PAGE" |
803 ], | 1190 ], |
804 "enumDescriptions": [ | 1191 "enumDescriptions": [ |
805 "Unspecified.", | 1192 "Unspecified.", |
806 "Person.", | 1193 "Person.", |
807 "[Google+ Page.](http://www.google.com/+/brands/)" | 1194 "[Google+ Page.](http://www.google.com/+/brands/)" |
808 ], | 1195 ], |
809 "type": "string" | 1196 "type": "string" |
810 } | 1197 } |
811 }, | 1198 }, |
812 "type": "object" | 1199 "type": "object" |
813 }, | 1200 }, |
| 1201 "Gender": { |
| 1202 "description": "A person's gender.", |
| 1203 "id": "Gender", |
| 1204 "properties": { |
| 1205 "formattedValue": { |
| 1206 "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.", |
| 1207 "type": "string" |
| 1208 }, |
| 1209 "metadata": { |
| 1210 "$ref": "FieldMetadata", |
| 1211 "description": "Metadata about the gender." |
| 1212 }, |
| 1213 "value": { |
| 1214 "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`", |
| 1215 "type": "string" |
| 1216 } |
| 1217 }, |
| 1218 "type": "object" |
| 1219 }, |
814 "Url": { | 1220 "Url": { |
815 "description": "A person's associated URLs.", | 1221 "description": "A person's associated URLs.", |
816 "id": "Url", | 1222 "id": "Url", |
817 "properties": { | 1223 "properties": { |
818 "metadata": { | |
819 "$ref": "FieldMetadata", | |
820 "description": "Metadata about the URL." | |
821 }, | |
822 "type": { | |
823 "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`", | |
824 "type": "string" | |
825 }, | |
826 "value": { | 1224 "value": { |
827 "description": "The URL.", | 1225 "description": "The URL.", |
828 "type": "string" | 1226 "type": "string" |
829 }, | 1227 }, |
830 "formattedType": { | 1228 "formattedType": { |
831 "description": "The read-only type of the URL translated and
formatted in the viewer's\naccount locale or the `Accept-Language` HTTP header
locale.", | 1229 "description": "The read-only type of the URL translated and
formatted in the viewer's\naccount locale or the `Accept-Language` HTTP header
locale.", |
832 "type": "string" | 1230 "type": "string" |
833 } | 1231 }, |
834 }, | 1232 "metadata": { |
835 "type": "object" | 1233 "$ref": "FieldMetadata", |
836 }, | 1234 "description": "Metadata about the URL." |
837 "Gender": { | 1235 }, |
838 "description": "A person's gender.", | 1236 "type": { |
839 "id": "Gender", | 1237 "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`", |
840 "properties": { | |
841 "formattedValue": { | |
842 "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.", | |
843 "type": "string" | |
844 }, | |
845 "metadata": { | |
846 "$ref": "FieldMetadata", | |
847 "description": "Metadata about the gender." | |
848 }, | |
849 "value": { | |
850 "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`", | |
851 "type": "string" | 1238 "type": "string" |
852 } | 1239 } |
853 }, | 1240 }, |
854 "type": "object" | 1241 "type": "object" |
855 }, | 1242 }, |
856 "CoverPhoto": { | 1243 "CoverPhoto": { |
857 "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.", | 1244 "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.", |
858 "id": "CoverPhoto", | 1245 "id": "CoverPhoto", |
859 "properties": { | 1246 "properties": { |
860 "metadata": { | 1247 "metadata": { |
861 "$ref": "FieldMetadata", | 1248 "$ref": "FieldMetadata", |
862 "description": "Metadata about the cover photo." | 1249 "description": "Metadata about the cover photo." |
863 }, | 1250 }, |
864 "default": { | 1251 "default": { |
865 "description": "True if the cover photo is the default cover
photo;\nfalse if the cover photo is a user-provided cover photo.", | 1252 "description": "True if the cover photo is the default cover
photo;\nfalse if the cover photo is a user-provided cover photo.", |
866 "type": "boolean" | 1253 "type": "boolean" |
867 }, | 1254 }, |
868 "url": { | 1255 "url": { |
869 "description": "The URL of the cover photo.", | 1256 "description": "The URL of the cover photo.", |
870 "type": "string" | 1257 "type": "string" |
871 } | 1258 } |
872 }, | 1259 }, |
873 "type": "object" | 1260 "type": "object" |
874 }, | 1261 }, |
| 1262 "ImClient": { |
| 1263 "description": "A person's instant messaging client.", |
| 1264 "id": "ImClient", |
| 1265 "properties": { |
| 1266 "formattedProtocol": { |
| 1267 "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.", |
| 1268 "type": "string" |
| 1269 }, |
| 1270 "formattedType": { |
| 1271 "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.", |
| 1272 "type": "string" |
| 1273 }, |
| 1274 "protocol": { |
| 1275 "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`", |
| 1276 "type": "string" |
| 1277 }, |
| 1278 "metadata": { |
| 1279 "$ref": "FieldMetadata", |
| 1280 "description": "Metadata about the IM client." |
| 1281 }, |
| 1282 "type": { |
| 1283 "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`", |
| 1284 "type": "string" |
| 1285 }, |
| 1286 "username": { |
| 1287 "description": "The user name used in the IM client.", |
| 1288 "type": "string" |
| 1289 } |
| 1290 }, |
| 1291 "type": "object" |
| 1292 }, |
875 "Interest": { | 1293 "Interest": { |
876 "description": "One of the person's interests.", | 1294 "description": "One of the person's interests.", |
877 "id": "Interest", | 1295 "id": "Interest", |
878 "properties": { | 1296 "properties": { |
879 "metadata": { | 1297 "metadata": { |
880 "$ref": "FieldMetadata", | 1298 "$ref": "FieldMetadata", |
881 "description": "Metadata about the interest." | 1299 "description": "Metadata about the interest." |
882 }, | 1300 }, |
883 "value": { | 1301 "value": { |
884 "description": "The interest; for example, `stargazing`.", | 1302 "description": "The interest; for example, `stargazing`.", |
885 "type": "string" | 1303 "type": "string" |
886 } | 1304 } |
887 }, | 1305 }, |
888 "type": "object" | 1306 "type": "object" |
889 }, | 1307 }, |
890 "ImClient": { | |
891 "description": "A person's instant messaging client.", | |
892 "id": "ImClient", | |
893 "properties": { | |
894 "formattedProtocol": { | |
895 "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.", | |
896 "type": "string" | |
897 }, | |
898 "formattedType": { | |
899 "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.", | |
900 "type": "string" | |
901 }, | |
902 "metadata": { | |
903 "$ref": "FieldMetadata", | |
904 "description": "Metadata about the IM client." | |
905 }, | |
906 "type": { | |
907 "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`", | |
908 "type": "string" | |
909 }, | |
910 "protocol": { | |
911 "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`", | |
912 "type": "string" | |
913 }, | |
914 "username": { | |
915 "description": "The user name used in the IM client.", | |
916 "type": "string" | |
917 } | |
918 }, | |
919 "type": "object" | |
920 }, | |
921 "Nickname": { | 1308 "Nickname": { |
922 "description": "A person's nickname.", | 1309 "description": "A person's nickname.", |
923 "id": "Nickname", | 1310 "id": "Nickname", |
924 "properties": { | 1311 "properties": { |
925 "metadata": { | 1312 "metadata": { |
926 "$ref": "FieldMetadata", | 1313 "$ref": "FieldMetadata", |
927 "description": "Metadata about the nickname." | 1314 "description": "Metadata about the nickname." |
928 }, | 1315 }, |
929 "type": { | 1316 "type": { |
930 "description": "The type of the nickname.", | 1317 "description": "The type of the nickname.", |
(...skipping 17 matching lines...) Expand all Loading... |
948 "description": "The nickname.", | 1335 "description": "The nickname.", |
949 "type": "string" | 1336 "type": "string" |
950 } | 1337 } |
951 }, | 1338 }, |
952 "type": "object" | 1339 "type": "object" |
953 }, | 1340 }, |
954 "EmailAddress": { | 1341 "EmailAddress": { |
955 "description": "A person's email address.", | 1342 "description": "A person's email address.", |
956 "id": "EmailAddress", | 1343 "id": "EmailAddress", |
957 "properties": { | 1344 "properties": { |
| 1345 "displayName": { |
| 1346 "description": "The display name of the email.", |
| 1347 "type": "string" |
| 1348 }, |
| 1349 "metadata": { |
| 1350 "$ref": "FieldMetadata", |
| 1351 "description": "Metadata about the email address." |
| 1352 }, |
| 1353 "type": { |
| 1354 "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`", |
| 1355 "type": "string" |
| 1356 }, |
958 "value": { | 1357 "value": { |
959 "description": "The email address.", | 1358 "description": "The email address.", |
960 "type": "string" | 1359 "type": "string" |
961 }, | 1360 }, |
962 "formattedType": { | 1361 "formattedType": { |
963 "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.", | 1362 "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.", |
964 "type": "string" | 1363 "type": "string" |
965 }, | |
966 "displayName": { | |
967 "description": "The display name of the email.", | |
968 "type": "string" | |
969 }, | |
970 "metadata": { | |
971 "$ref": "FieldMetadata", | |
972 "description": "Metadata about the email address." | |
973 }, | |
974 "type": { | |
975 "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`", | |
976 "type": "string" | |
977 } | 1364 } |
978 }, | 1365 }, |
979 "type": "object" | 1366 "type": "object" |
980 }, | 1367 }, |
981 "Skill": { | 1368 "Skill": { |
982 "description": "A skill that the person has.", | 1369 "description": "A skill that the person has.", |
983 "id": "Skill", | 1370 "id": "Skill", |
984 "properties": { | 1371 "properties": { |
985 "metadata": { | 1372 "metadata": { |
986 "$ref": "FieldMetadata", | 1373 "$ref": "FieldMetadata", |
987 "description": "Metadata about the skill." | 1374 "description": "Metadata about the skill." |
988 }, | 1375 }, |
989 "value": { | 1376 "value": { |
990 "description": "The skill; for example, `underwater basket w
eaving`.", | 1377 "description": "The skill; for example, `underwater basket w
eaving`.", |
991 "type": "string" | 1378 "type": "string" |
992 } | 1379 } |
993 }, | 1380 }, |
994 "type": "object" | 1381 "type": "object" |
995 }, | 1382 }, |
996 "DomainMembership": { | 1383 "DomainMembership": { |
997 "description": "A Google Apps Domain membership.", | 1384 "description": "A Google Apps Domain membership.", |
998 "id": "DomainMembership", | 1385 "id": "DomainMembership", |
999 "properties": { | 1386 "properties": { |
1000 "inViewerDomain": { | 1387 "inViewerDomain": { |
1001 "description": "True if the person is in the viewer's Google
Apps domain.", | 1388 "description": "True if the person is in the viewer's Google
Apps domain.", |
1002 "type": "boolean" | 1389 "type": "boolean" |
1003 } | 1390 } |
1004 }, | 1391 }, |
1005 "type": "object" | 1392 "type": "object" |
1006 }, | |
1007 "Membership": { | |
1008 "description": "A person's read-only membership in a group.", | |
1009 "id": "Membership", | |
1010 "properties": { | |
1011 "metadata": { | |
1012 "$ref": "FieldMetadata", | |
1013 "description": "Metadata about the membership." | |
1014 }, | |
1015 "contactGroupMembership": { | |
1016 "$ref": "ContactGroupMembership", | |
1017 "description": "The contact group membership." | |
1018 }, | |
1019 "domainMembership": { | |
1020 "$ref": "DomainMembership", | |
1021 "description": "The domain membership." | |
1022 } | |
1023 }, | |
1024 "type": "object" | |
1025 }, | |
1026 "RelationshipStatus": { | |
1027 "description": "A person's read-only relationship status.", | |
1028 "id": "RelationshipStatus", | |
1029 "properties": { | |
1030 "formattedValue": { | |
1031 "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.", | |
1032 "type": "string" | |
1033 }, | |
1034 "metadata": { | |
1035 "$ref": "FieldMetadata", | |
1036 "description": "Metadata about the relationship status." | |
1037 }, | |
1038 "value": { | |
1039 "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`", | |
1040 "type": "string" | |
1041 } | |
1042 }, | |
1043 "type": "object" | |
1044 }, | |
1045 "Tagline": { | |
1046 "description": "A read-only brief one-line description of the person
.", | |
1047 "id": "Tagline", | |
1048 "properties": { | |
1049 "value": { | |
1050 "description": "The tagline.", | |
1051 "type": "string" | |
1052 }, | |
1053 "metadata": { | |
1054 "$ref": "FieldMetadata", | |
1055 "description": "Metadata about the tagline." | |
1056 } | |
1057 }, | |
1058 "type": "object" | |
1059 }, | |
1060 "Date": { | |
1061 "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
.", | |
1062 "id": "Date", | |
1063 "properties": { | |
1064 "year": { | |
1065 "description": "Year of date. Must be from 1 to 9999, or 0 i
f specifying a date without\na year.", | |
1066 "format": "int32", | |
1067 "type": "integer" | |
1068 }, | |
1069 "day": { | |
1070 "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.", | |
1071 "format": "int32", | |
1072 "type": "integer" | |
1073 }, | |
1074 "month": { | |
1075 "description": "Month of year. Must be from 1 to 12.", | |
1076 "format": "int32", | |
1077 "type": "integer" | |
1078 } | |
1079 }, | |
1080 "type": "object" | |
1081 }, | |
1082 "Name": { | |
1083 "description": "A person's name. If the name is a mononym, the famil
y name is empty.", | |
1084 "id": "Name", | |
1085 "properties": { | |
1086 "honorificPrefix": { | |
1087 "description": "The honorific prefixes, such as `Mrs.` or `D
r.`", | |
1088 "type": "string" | |
1089 }, | |
1090 "phoneticHonorificSuffix": { | |
1091 "description": "The honorific suffixes spelled as they sound
.", | |
1092 "type": "string" | |
1093 }, | |
1094 "middleName": { | |
1095 "description": "The middle name(s).", | |
1096 "type": "string" | |
1097 }, | |
1098 "givenName": { | |
1099 "description": "The given name.", | |
1100 "type": "string" | |
1101 }, | |
1102 "phoneticHonorificPrefix": { | |
1103 "description": "The honorific prefixes spelled as they sound
.", | |
1104 "type": "string" | |
1105 }, | |
1106 "phoneticGivenName": { | |
1107 "description": "The given name spelled as it sounds.", | |
1108 "type": "string" | |
1109 }, | |
1110 "phoneticFamilyName": { | |
1111 "description": "The family name spelled as it sounds.", | |
1112 "type": "string" | |
1113 }, | |
1114 "familyName": { | |
1115 "description": "The family name.", | |
1116 "type": "string" | |
1117 }, | |
1118 "phoneticMiddleName": { | |
1119 "description": "The middle name(s) spelled as they sound.", | |
1120 "type": "string" | |
1121 }, | |
1122 "metadata": { | |
1123 "$ref": "FieldMetadata", | |
1124 "description": "Metadata about the name." | |
1125 }, | |
1126 "phoneticFullName": { | |
1127 "description": "The full name spelled as it sounds.", | |
1128 "type": "string" | |
1129 }, | |
1130 "displayNameLastFirst": { | |
1131 "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.", | |
1132 "type": "string" | |
1133 }, | |
1134 "displayName": { | |
1135 "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.", | |
1136 "type": "string" | |
1137 }, | |
1138 "honorificSuffix": { | |
1139 "description": "The honorific suffixes, such as `Jr.`", | |
1140 "type": "string" | |
1141 } | |
1142 }, | |
1143 "type": "object" | |
1144 }, | |
1145 "BraggingRights": { | |
1146 "description": "A person's bragging rights.", | |
1147 "id": "BraggingRights", | |
1148 "properties": { | |
1149 "metadata": { | |
1150 "$ref": "FieldMetadata", | |
1151 "description": "Metadata about the bragging rights." | |
1152 }, | |
1153 "value": { | |
1154 "description": "The bragging rights; for example, `climbed m
ount everest`.", | |
1155 "type": "string" | |
1156 } | |
1157 }, | |
1158 "type": "object" | |
1159 }, | |
1160 "Locale": { | |
1161 "description": "A person's locale preference.", | |
1162 "id": "Locale", | |
1163 "properties": { | |
1164 "metadata": { | |
1165 "$ref": "FieldMetadata", | |
1166 "description": "Metadata about the locale." | |
1167 }, | |
1168 "value": { | |
1169 "description": "The well-formed [IETF BCP 47](https://tools.
ietf.org/html/bcp47)\nlanguage tag representing the locale.", | |
1170 "type": "string" | |
1171 } | |
1172 }, | |
1173 "type": "object" | |
1174 }, | |
1175 "Organization": { | |
1176 "description": "A person's past or current organization. Overlapping
date ranges are\npermitted.", | |
1177 "id": "Organization", | |
1178 "properties": { | |
1179 "title": { | |
1180 "description": "The person's job title at the organization."
, | |
1181 "type": "string" | |
1182 }, | |
1183 "location": { | |
1184 "description": "The location of the organization office the
person works at.", | |
1185 "type": "string" | |
1186 }, | |
1187 "current": { | |
1188 "description": "True if the organization is the person's cur
rent organization;\nfalse if the organization is a past organization.", | |
1189 "type": "boolean" | |
1190 }, | |
1191 "startDate": { | |
1192 "$ref": "Date", | |
1193 "description": "The start date when the person joined the or
ganization." | |
1194 }, | |
1195 "formattedType": { | |
1196 "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.", | |
1197 "type": "string" | |
1198 }, | |
1199 "domain": { | |
1200 "description": "The domain name associated with the organiza
tion; for example, `google.com`.", | |
1201 "type": "string" | |
1202 }, | |
1203 "department": { | |
1204 "description": "The person's department at the organization.
", | |
1205 "type": "string" | |
1206 }, | |
1207 "type": { | |
1208 "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`", | |
1209 "type": "string" | |
1210 }, | |
1211 "phoneticName": { | |
1212 "description": "The phonetic name of the organization.", | |
1213 "type": "string" | |
1214 }, | |
1215 "jobDescription": { | |
1216 "description": "The person's job description at the organiza
tion.", | |
1217 "type": "string" | |
1218 }, | |
1219 "endDate": { | |
1220 "$ref": "Date", | |
1221 "description": "The end date when the person left the organi
zation." | |
1222 }, | |
1223 "symbol": { | |
1224 "description": "The symbol associated with the organization;
for example, a stock ticker\nsymbol, abbreviation, or acronym.", | |
1225 "type": "string" | |
1226 }, | |
1227 "name": { | |
1228 "description": "The name of the organization.", | |
1229 "type": "string" | |
1230 }, | |
1231 "metadata": { | |
1232 "$ref": "FieldMetadata", | |
1233 "description": "Metadata about the organization." | |
1234 } | |
1235 }, | |
1236 "type": "object" | |
1237 }, | |
1238 "Biography": { | |
1239 "description": "A person's short biography.", | |
1240 "id": "Biography", | |
1241 "properties": { | |
1242 "contentType": { | |
1243 "description": "The content type of the biography.", | |
1244 "enum": [ | |
1245 "CONTENT_TYPE_UNSPECIFIED", | |
1246 "TEXT_PLAIN", | |
1247 "TEXT_HTML" | |
1248 ], | |
1249 "enumDescriptions": [ | |
1250 "Unspecified.", | |
1251 "Plain text.", | |
1252 "HTML text." | |
1253 ], | |
1254 "type": "string" | |
1255 }, | |
1256 "metadata": { | |
1257 "$ref": "FieldMetadata", | |
1258 "description": "Metadata about the biography." | |
1259 }, | |
1260 "value": { | |
1261 "description": "The short biography.", | |
1262 "type": "string" | |
1263 } | |
1264 }, | |
1265 "type": "object" | |
1266 }, | |
1267 "AgeRangeType": { | |
1268 "description": "A person's age range.", | |
1269 "id": "AgeRangeType", | |
1270 "properties": { | |
1271 "metadata": { | |
1272 "$ref": "FieldMetadata", | |
1273 "description": "Metadata about the age range." | |
1274 }, | |
1275 "ageRange": { | |
1276 "description": "The age range.", | |
1277 "enum": [ | |
1278 "AGE_RANGE_UNSPECIFIED", | |
1279 "LESS_THAN_EIGHTEEN", | |
1280 "EIGHTEEN_TO_TWENTY", | |
1281 "TWENTY_ONE_OR_OLDER" | |
1282 ], | |
1283 "enumDescriptions": [ | |
1284 "Unspecified.", | |
1285 "Younger than eighteen.", | |
1286 "Between eighteen and twenty.", | |
1287 "Twenty-one and older." | |
1288 ], | |
1289 "type": "string" | |
1290 } | |
1291 }, | |
1292 "type": "object" | |
1293 }, | |
1294 "FieldMetadata": { | |
1295 "description": "Metadata about a field.", | |
1296 "id": "FieldMetadata", | |
1297 "properties": { | |
1298 "source": { | |
1299 "$ref": "Source", | |
1300 "description": "The source of the field." | |
1301 }, | |
1302 "verified": { | |
1303 "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.", | |
1304 "type": "boolean" | |
1305 }, | |
1306 "primary": { | |
1307 "description": "True if the field is the primary field; fals
e if the field is a secondary\nfield.", | |
1308 "type": "boolean" | |
1309 } | |
1310 }, | |
1311 "type": "object" | |
1312 }, | |
1313 "PersonResponse": { | |
1314 "description": "The response for a single person", | |
1315 "id": "PersonResponse", | |
1316 "properties": { | |
1317 "person": { | |
1318 "$ref": "Person", | |
1319 "description": "The person." | |
1320 }, | |
1321 "httpStatusCode": { | |
1322 "description": "[HTTP 1.1 status code](http://www.w3.org/Pro
tocols/rfc2616/rfc2616-sec10.html).", | |
1323 "format": "int32", | |
1324 "type": "integer" | |
1325 }, | |
1326 "requestedResourceName": { | |
1327 "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.", | |
1328 "type": "string" | |
1329 } | |
1330 }, | |
1331 "type": "object" | |
1332 }, | |
1333 "Source": { | |
1334 "description": "The source of a field.", | |
1335 "id": "Source", | |
1336 "properties": { | |
1337 "type": { | |
1338 "description": "The source type.", | |
1339 "enum": [ | |
1340 "SOURCE_TYPE_UNSPECIFIED", | |
1341 "ACCOUNT", | |
1342 "PROFILE", | |
1343 "DOMAIN_PROFILE", | |
1344 "CONTACT" | |
1345 ], | |
1346 "enumDescriptions": [ | |
1347 "Unspecified.", | |
1348 "[Google Account](https://accounts.google.com).", | |
1349 "[Google profile](https://profiles.google.com). You can
view the\nprofile at https://profiles.google.com/<id> where <id> is the source\n
id.", | |
1350 "[Google Apps domain profile](https://admin.google.com).
", | |
1351 "[Google contact](https://contacts.google.com). You can
view the\ncontact at https://contact.google.com/<id> where <id> is the source\ni
d." | |
1352 ], | |
1353 "type": "string" | |
1354 }, | |
1355 "etag": { | |
1356 "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.", | |
1357 "type": "string" | |
1358 }, | |
1359 "id": { | |
1360 "description": "The unique identifier within the source type
generated by the server.", | |
1361 "type": "string" | |
1362 }, | |
1363 "profileMetadata": { | |
1364 "$ref": "ProfileMetadata", | |
1365 "description": "Metadata about a source of type PROFILE." | |
1366 } | |
1367 }, | |
1368 "type": "object" | |
1369 }, | |
1370 "RelationshipInterest": { | |
1371 "description": "A person's read-only relationship interest .", | |
1372 "id": "RelationshipInterest", | |
1373 "properties": { | |
1374 "metadata": { | |
1375 "$ref": "FieldMetadata", | |
1376 "description": "Metadata about the relationship interest." | |
1377 }, | |
1378 "value": { | |
1379 "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`", | |
1380 "type": "string" | |
1381 }, | |
1382 "formattedValue": { | |
1383 "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.", | |
1384 "type": "string" | |
1385 } | |
1386 }, | |
1387 "type": "object" | |
1388 } | 1393 } |
1389 }, | 1394 }, |
1390 "servicePath": "", | 1395 "servicePath": "", |
1391 "title": "Google People API", | 1396 "title": "Google People API", |
1392 "version": "v1" | 1397 "version": "v1" |
1393 } | 1398 } |
OLD | NEW |