OLD | NEW |
1 { | 1 { |
2 "auth": { | 2 "auth": { |
3 "oauth2": { | 3 "oauth2": { |
4 "scopes": { | 4 "scopes": { |
| 5 "https://www.googleapis.com/auth/user.birthday.read": { |
| 6 "description": "View your complete date of birth" |
| 7 }, |
| 8 "https://www.googleapis.com/auth/contacts.readonly": { |
| 9 "description": "View your contacts" |
| 10 }, |
5 "https://www.googleapis.com/auth/plus.login": { | 11 "https://www.googleapis.com/auth/plus.login": { |
6 "description": "Know the list of people in your circles, you
r age range, and language" | 12 "description": "Know the list of people in your circles, you
r age range, and language" |
7 }, | 13 }, |
8 "https://www.googleapis.com/auth/userinfo.profile": { | 14 "https://www.googleapis.com/auth/userinfo.profile": { |
9 "description": "View your basic profile info" | 15 "description": "View your basic profile info" |
10 }, | 16 }, |
11 "https://www.googleapis.com/auth/user.addresses.read": { | 17 "https://www.googleapis.com/auth/user.emails.read": { |
12 "description": "View your street addresses" | 18 "description": "View your email addresses" |
13 }, | 19 }, |
14 "https://www.googleapis.com/auth/contacts": { | 20 "https://www.googleapis.com/auth/contacts": { |
15 "description": "Manage your contacts" | 21 "description": "Manage your contacts" |
16 }, | 22 }, |
17 "https://www.googleapis.com/auth/user.emails.read": { | 23 "https://www.googleapis.com/auth/user.addresses.read": { |
18 "description": "View your email addresses" | 24 "description": "View your street addresses" |
19 }, | 25 }, |
20 "https://www.googleapis.com/auth/user.phonenumbers.read": { | 26 "https://www.googleapis.com/auth/user.phonenumbers.read": { |
21 "description": "View your phone numbers" | 27 "description": "View your phone numbers" |
22 }, | 28 }, |
23 "https://www.googleapis.com/auth/userinfo.email": { | 29 "https://www.googleapis.com/auth/userinfo.email": { |
24 "description": "View your email address" | 30 "description": "View your email address" |
25 }, | |
26 "https://www.googleapis.com/auth/user.birthday.read": { | |
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 "canonicalName": "People Service", | 38 "canonicalName": "People Service", |
39 "description": "Provides access to information about profiles and contacts."
, | 39 "description": "Provides access to information about profiles and contacts."
, |
40 "discoveryVersion": "v1", | 40 "discoveryVersion": "v1", |
41 "documentationLink": "https://developers.google.com/people/", | 41 "documentationLink": "https://developers.google.com/people/", |
42 "icons": { | 42 "icons": { |
43 "x16": "http://www.google.com/images/icons/product/search-16.gif", | 43 "x16": "http://www.google.com/images/icons/product/search-16.gif", |
44 "x32": "http://www.google.com/images/icons/product/search-32.gif" | 44 "x32": "http://www.google.com/images/icons/product/search-32.gif" |
45 }, | 45 }, |
46 "id": "people:v1", | 46 "id": "people:v1", |
47 "kind": "discovery#restDescription", | 47 "kind": "discovery#restDescription", |
48 "name": "people", | 48 "name": "people", |
49 "ownerDomain": "google.com", | 49 "ownerDomain": "google.com", |
50 "ownerName": "Google", | 50 "ownerName": "Google", |
51 "parameters": { | 51 "parameters": { |
52 "bearer_token": { | |
53 "description": "OAuth bearer token.", | |
54 "location": "query", | |
55 "type": "string" | |
56 }, | |
57 "oauth_token": { | |
58 "description": "OAuth 2.0 token for the current user.", | |
59 "location": "query", | |
60 "type": "string" | |
61 }, | |
62 "upload_protocol": { | 52 "upload_protocol": { |
63 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", | 53 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
64 "location": "query", | 54 "location": "query", |
65 "type": "string" | 55 "type": "string" |
66 }, | 56 }, |
67 "prettyPrint": { | 57 "prettyPrint": { |
68 "default": "true", | 58 "default": "true", |
69 "description": "Returns response with indentations and line breaks."
, | 59 "description": "Returns response with indentations and line breaks."
, |
70 "location": "query", | 60 "location": "query", |
71 "type": "boolean" | 61 "type": "boolean" |
72 }, | 62 }, |
| 63 "uploadType": { |
| 64 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", |
| 65 "location": "query", |
| 66 "type": "string" |
| 67 }, |
73 "fields": { | 68 "fields": { |
74 "description": "Selector specifying which fields to include in a par
tial response.", | 69 "description": "Selector specifying which fields to include in a par
tial response.", |
75 "location": "query", | 70 "location": "query", |
76 "type": "string" | 71 "type": "string" |
77 }, | 72 }, |
78 "uploadType": { | 73 "callback": { |
79 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", | 74 "description": "JSONP", |
80 "location": "query", | 75 "location": "query", |
81 "type": "string" | 76 "type": "string" |
82 }, | 77 }, |
83 "$.xgafv": { | 78 "$.xgafv": { |
84 "description": "V1 error format.", | 79 "description": "V1 error format.", |
85 "enum": [ | 80 "enum": [ |
86 "1", | 81 "1", |
87 "2" | 82 "2" |
88 ], | 83 ], |
89 "enumDescriptions": [ | 84 "enumDescriptions": [ |
90 "v1 error format", | 85 "v1 error format", |
91 "v2 error format" | 86 "v2 error format" |
92 ], | 87 ], |
93 "location": "query", | 88 "location": "query", |
94 "type": "string" | 89 "type": "string" |
95 }, | 90 }, |
96 "callback": { | |
97 "description": "JSONP", | |
98 "location": "query", | |
99 "type": "string" | |
100 }, | |
101 "alt": { | 91 "alt": { |
102 "default": "json", | 92 "default": "json", |
103 "description": "Data format for response.", | 93 "description": "Data format for response.", |
104 "enum": [ | 94 "enum": [ |
105 "json", | 95 "json", |
106 "media", | 96 "media", |
107 "proto" | 97 "proto" |
108 ], | 98 ], |
109 "enumDescriptions": [ | 99 "enumDescriptions": [ |
110 "Responses with Content-Type of application/json", | 100 "Responses with Content-Type of application/json", |
111 "Media download with context-dependent Content-Type", | 101 "Media download with context-dependent Content-Type", |
112 "Responses with Content-Type of application/x-protobuf" | 102 "Responses with Content-Type of application/x-protobuf" |
113 ], | 103 ], |
114 "location": "query", | 104 "location": "query", |
115 "type": "string" | 105 "type": "string" |
116 }, | 106 }, |
| 107 "key": { |
| 108 "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.", |
| 109 "location": "query", |
| 110 "type": "string" |
| 111 }, |
117 "access_token": { | 112 "access_token": { |
118 "description": "OAuth access token.", | 113 "description": "OAuth access token.", |
119 "location": "query", | 114 "location": "query", |
120 "type": "string" | 115 "type": "string" |
121 }, | 116 }, |
122 "key": { | |
123 "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.", | |
124 "location": "query", | |
125 "type": "string" | |
126 }, | |
127 "quotaUser": { | 117 "quotaUser": { |
128 "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 "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.", |
129 "location": "query", | 119 "location": "query", |
130 "type": "string" | 120 "type": "string" |
131 }, | 121 }, |
132 "pp": { | 122 "pp": { |
133 "default": "true", | 123 "default": "true", |
134 "description": "Pretty-print response.", | 124 "description": "Pretty-print response.", |
135 "location": "query", | 125 "location": "query", |
136 "type": "boolean" | 126 "type": "boolean" |
| 127 }, |
| 128 "bearer_token": { |
| 129 "description": "OAuth bearer token.", |
| 130 "location": "query", |
| 131 "type": "string" |
| 132 }, |
| 133 "oauth_token": { |
| 134 "description": "OAuth 2.0 token for the current user.", |
| 135 "location": "query", |
| 136 "type": "string" |
137 } | 137 } |
138 }, | 138 }, |
139 "protocol": "rest", | 139 "protocol": "rest", |
140 "resources": { | 140 "resources": { |
141 "contactGroups": { | 141 "people": { |
142 "methods": { | 142 "methods": { |
143 "get": { | 143 "updateContact": { |
144 "description": "Get a specific contact group owned by the au
thenticated user by specifying\na contact group resource name.", | 144 "description": "Update contact data for an existing contact
person. Any non-contact data\nwill not be modified.\n\nThe request throws a 400
error if `updatePersonFields` is not specified.\n<br>\nThe request throws a 400
error if `person.metadata.sources` is not\nspecified for the contact to be updat
ed.\n<br>\nThe request throws a 412 error if `person.metadata.sources.etag` is\n
different than the contact's etag, which indicates the contact has changed\nsinc
e its data was read. Clients should get the latest person and re-apply\ntheir up
dates to the latest person.", |
145 "httpMethod": "GET", | 145 "httpMethod": "PATCH", |
146 "id": "people.contactGroups.get", | 146 "id": "people.people.updateContact", |
147 "parameterOrder": [ | |
148 "resourceName" | |
149 ], | |
150 "parameters": { | |
151 "maxMembers": { | |
152 "description": "Specifies the maximum number of memb
ers to return.", | |
153 "format": "int32", | |
154 "location": "query", | |
155 "type": "integer" | |
156 }, | |
157 "resourceName": { | |
158 "description": "The resource name of the contact gro
up to get.", | |
159 "location": "path", | |
160 "pattern": "^contactGroups/[^/]+$", | |
161 "required": true, | |
162 "type": "string" | |
163 } | |
164 }, | |
165 "path": "v1/{+resourceName}", | |
166 "response": { | |
167 "$ref": "ContactGroup" | |
168 }, | |
169 "scopes": [ | |
170 "https://www.googleapis.com/auth/contacts", | |
171 "https://www.googleapis.com/auth/contacts.readonly" | |
172 ] | |
173 }, | |
174 "update": { | |
175 "description": "Update the name of an existing contact group
owned by the authenticated\nuser.", | |
176 "httpMethod": "PUT", | |
177 "id": "people.contactGroups.update", | |
178 "parameterOrder": [ | 147 "parameterOrder": [ |
179 "resourceName" | 148 "resourceName" |
180 ], | 149 ], |
181 "parameters": { | 150 "parameters": { |
182 "resourceName": { | 151 "resourceName": { |
183 "description": "The resource name for the contact gr
oup, assigned by the server. An ASCII\nstring, in the form of `contactGroups/`<v
ar>contact_group_id</var>.", | 152 "description": "The resource name for the person, as
signed by the server. An ASCII string\nwith a max length of 27 characters, in th
e form of\n`people/`<var>person_id</var>.", |
184 "location": "path", | 153 "location": "path", |
185 "pattern": "^contactGroups/[^/]+$", | 154 "pattern": "^people/[^/]+$", |
186 "required": true, | 155 "required": true, |
187 "type": "string" | 156 "type": "string" |
| 157 }, |
| 158 "updatePersonFields": { |
| 159 "description": "**Required.** A field mask to restri
ct which fields on the person are\nupdated. Valid values are:\n\n* addresses\n*
biographies\n* birthdays\n* braggingRights\n* emailAddresses\n* events\n* gender
s\n* imClients\n* interests\n* locales\n* names\n* nicknames\n* occupations\n* o
rganizations\n* phoneNumbers\n* relations\n* residences\n* skills\n* urls", |
| 160 "format": "google-fieldmask", |
| 161 "location": "query", |
| 162 "type": "string" |
188 } | 163 } |
189 }, | 164 }, |
190 "path": "v1/{+resourceName}", | 165 "path": "v1/{+resourceName}:updateContact", |
191 "request": { | 166 "request": { |
192 "$ref": "UpdateContactGroupRequest" | 167 "$ref": "Person" |
193 }, | 168 }, |
194 "response": { | 169 "response": { |
195 "$ref": "ContactGroup" | 170 "$ref": "Person" |
196 }, | 171 }, |
197 "scopes": [ | 172 "scopes": [ |
198 "https://www.googleapis.com/auth/contacts" | 173 "https://www.googleapis.com/auth/contacts" |
199 ] | 174 ] |
200 }, | 175 }, |
201 "batchGet": { | 176 "createContact": { |
202 "description": "Get a list of contact groups owned by the au
thenticated user by specifying\na list of contact group resource names.", | 177 "description": "Create a new contact and return the person r
esource for that contact.", |
203 "httpMethod": "GET", | 178 "httpMethod": "POST", |
204 "id": "people.contactGroups.batchGet", | 179 "id": "people.people.createContact", |
205 "parameterOrder": [], | 180 "parameterOrder": [], |
206 "parameters": { | 181 "parameters": { |
207 "maxMembers": { | 182 "parent": { |
208 "description": "Specifies the maximum number of memb
ers to return for each group.", | 183 "description": "The resource name of the owning pers
on resource.", |
209 "format": "int32", | |
210 "location": "query", | 184 "location": "query", |
211 "type": "integer" | |
212 }, | |
213 "resourceNames": { | |
214 "description": "The resource names of the contact gr
oups to get.", | |
215 "location": "query", | |
216 "repeated": true, | |
217 "type": "string" | 185 "type": "string" |
218 } | 186 } |
219 }, | 187 }, |
220 "path": "v1/contactGroups:batchGet", | 188 "path": "v1/people:createContact", |
| 189 "request": { |
| 190 "$ref": "Person" |
| 191 }, |
221 "response": { | 192 "response": { |
222 "$ref": "BatchGetContactGroupsResponse" | 193 "$ref": "Person" |
223 }, | 194 }, |
224 "scopes": [ | 195 "scopes": [ |
225 "https://www.googleapis.com/auth/contacts", | 196 "https://www.googleapis.com/auth/contacts" |
226 "https://www.googleapis.com/auth/contacts.readonly" | |
227 ] | 197 ] |
228 }, | 198 }, |
229 "delete": { | 199 "deleteContact": { |
230 "description": "Delete an existing contact group owned by th
e authenticated user by\nspecifying a contact group resource name.", | 200 "description": "Delete a contact person. Any non-contact dat
a will not be deleted.", |
231 "httpMethod": "DELETE", | 201 "httpMethod": "DELETE", |
232 "id": "people.contactGroups.delete", | 202 "id": "people.people.deleteContact", |
233 "parameterOrder": [ | 203 "parameterOrder": [ |
234 "resourceName" | 204 "resourceName" |
235 ], | 205 ], |
236 "parameters": { | 206 "parameters": { |
237 "deleteContacts": { | |
238 "description": "Set to true to also delete the conta
cts in the specified group.", | |
239 "location": "query", | |
240 "type": "boolean" | |
241 }, | |
242 "resourceName": { | 207 "resourceName": { |
243 "description": "The resource name of the contact gro
up to delete.", | 208 "description": "The resource name of the contact to
delete.", |
244 "location": "path", | 209 "location": "path", |
245 "pattern": "^contactGroups/[^/]+$", | 210 "pattern": "^people/[^/]+$", |
246 "required": true, | 211 "required": true, |
247 "type": "string" | 212 "type": "string" |
248 } | 213 } |
249 }, | 214 }, |
250 "path": "v1/{+resourceName}", | 215 "path": "v1/{+resourceName}:deleteContact", |
251 "response": { | 216 "response": { |
252 "$ref": "Empty" | 217 "$ref": "Empty" |
253 }, | 218 }, |
254 "scopes": [ | 219 "scopes": [ |
255 "https://www.googleapis.com/auth/contacts" | 220 "https://www.googleapis.com/auth/contacts" |
256 ] | 221 ] |
257 }, | 222 }, |
258 "list": { | 223 "getBatchGet": { |
259 "description": "List all contact groups owned by the authent
icated user. Members of the\ncontact groups are not populated.", | 224 "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.\n<br>\nThe request throws a 400 error if 'perso
nFields' is not specified.", |
260 "httpMethod": "GET", | 225 "httpMethod": "GET", |
261 "id": "people.contactGroups.list", | 226 "id": "people.people.getBatchGet", |
262 "parameterOrder": [], | 227 "parameterOrder": [], |
263 "parameters": { | 228 "parameters": { |
264 "pageToken": { | 229 "personFields": { |
265 "description": "The next_page_token value returned f
rom a previous call to\n[ListContactGroups](/people/api/rest/v1/contactgroups/li
st).\nRequests the next page of resources.", | 230 "description": "**Required.** A field mask to restri
ct which fields on each person are\nreturned. Valid values are:\n\n* addresses\n
* ageRanges\n* biographies\n* birthdays\n* braggingRights\n* coverPhotos\n* emai
lAddresses\n* events\n* genders\n* imClients\n* interests\n* locales\n* membersh
ips\n* metadata\n* names\n* nicknames\n* occupations\n* organizations\n* phoneNu
mbers\n* photos\n* relations\n* relationshipInterests\n* relationshipStatuses\n*
residences\n* skills\n* taglines\n* urls", |
266 "location": "query", | 231 "format": "google-fieldmask", |
267 "type": "string" | 232 "location": "query", |
268 }, | 233 "type": "string" |
269 "pageSize": { | 234 }, |
270 "description": "The maximum number of resources to r
eturn.", | 235 "requestMask.includeField": { |
271 "format": "int32", | 236 "description": "**Required.** Comma-separated list o
f person fields to be included in the\nresponse. Each path should start with `pe
rson.`: for example,\n`person.names` or `person.photos`.", |
272 "location": "query", | 237 "format": "google-fieldmask", |
273 "type": "integer" | 238 "location": "query", |
274 }, | 239 "type": "string" |
275 "syncToken": { | 240 }, |
276 "description": "A sync token, returned by a previous
call to `contactgroups.list`.\nOnly resources changed since the sync token was
created will be returned.", | 241 "resourceNames": { |
277 "location": "query", | 242 "description": "The resource names of the people to
provide information about.\n\n- To get information about the authenticated user,
specify `people/me`.\n- To get information about a google account, specify\n `
people/`<var>account_id</var>.\n- To get information about a contact, specify th
e resource name that\n identifies the contact as returned by\n[`people.connecti
ons.list`](/people/api/rest/v1/people.connections/list).\n\nYou can include up t
o 50 resource names in one request.", |
278 "type": "string" | 243 "location": "query", |
279 } | 244 "repeated": true, |
280 }, | 245 "type": "string" |
281 "path": "v1/contactGroups", | 246 } |
282 "response": { | 247 }, |
283 "$ref": "ListContactGroupsResponse" | 248 "path": "v1/people:batchGet", |
| 249 "response": { |
| 250 "$ref": "GetPeopleResponse" |
284 }, | 251 }, |
285 "scopes": [ | 252 "scopes": [ |
286 "https://www.googleapis.com/auth/contacts", | 253 "https://www.googleapis.com/auth/contacts", |
287 "https://www.googleapis.com/auth/contacts.readonly" | 254 "https://www.googleapis.com/auth/contacts.readonly", |
| 255 "https://www.googleapis.com/auth/plus.login", |
| 256 "https://www.googleapis.com/auth/user.addresses.read", |
| 257 "https://www.googleapis.com/auth/user.birthday.read", |
| 258 "https://www.googleapis.com/auth/user.emails.read", |
| 259 "https://www.googleapis.com/auth/user.phonenumbers.read"
, |
| 260 "https://www.googleapis.com/auth/userinfo.email", |
| 261 "https://www.googleapis.com/auth/userinfo.profile" |
288 ] | 262 ] |
289 }, | 263 }, |
290 "create": { | 264 "get": { |
291 "description": "Create a new contact group owned by the auth
enticated user.", | 265 "description": "Provides information about a person by speci
fying a resource name. Use\n`people/me` to indicate the authenticated user.\n<br
>\nThe request throws a 400 error if 'personFields' is not specified.", |
292 "httpMethod": "POST", | 266 "httpMethod": "GET", |
293 "id": "people.contactGroups.create", | 267 "id": "people.people.get", |
294 "parameterOrder": [], | 268 "parameterOrder": [ |
295 "parameters": {}, | 269 "resourceName" |
296 "path": "v1/contactGroups", | 270 ], |
297 "request": { | 271 "parameters": { |
298 "$ref": "CreateContactGroupRequest" | 272 "resourceName": { |
299 }, | 273 "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 a google account, specify\n `pe
ople/`<var>account_id</var>.\n- To get information about a contact, specify the
resource name that\n identifies the contact as returned by\n[`people.connection
s.list`](/people/api/rest/v1/people.connections/list).", |
300 "response": { | 274 "location": "path", |
301 "$ref": "ContactGroup" | 275 "pattern": "^people/[^/]+$", |
| 276 "required": true, |
| 277 "type": "string" |
| 278 }, |
| 279 "personFields": { |
| 280 "description": "**Required.** A field mask to restri
ct which fields on the person are\nreturned. Valid values are:\n\n* addresses\n*
ageRanges\n* biographies\n* birthdays\n* braggingRights\n* coverPhotos\n* email
Addresses\n* events\n* genders\n* imClients\n* interests\n* locales\n* membershi
ps\n* metadata\n* names\n* nicknames\n* occupations\n* organizations\n* phoneNum
bers\n* photos\n* relations\n* relationshipInterests\n* relationshipStatuses\n*
residences\n* skills\n* taglines\n* urls", |
| 281 "format": "google-fieldmask", |
| 282 "location": "query", |
| 283 "type": "string" |
| 284 }, |
| 285 "requestMask.includeField": { |
| 286 "description": "**Required.** Comma-separated list o
f person fields to be included in the\nresponse. Each path should start with `pe
rson.`: for example,\n`person.names` or `person.photos`.", |
| 287 "format": "google-fieldmask", |
| 288 "location": "query", |
| 289 "type": "string" |
| 290 } |
| 291 }, |
| 292 "path": "v1/{+resourceName}", |
| 293 "response": { |
| 294 "$ref": "Person" |
302 }, | 295 }, |
303 "scopes": [ | 296 "scopes": [ |
304 "https://www.googleapis.com/auth/contacts" | 297 "https://www.googleapis.com/auth/contacts", |
| 298 "https://www.googleapis.com/auth/contacts.readonly", |
| 299 "https://www.googleapis.com/auth/plus.login", |
| 300 "https://www.googleapis.com/auth/user.addresses.read", |
| 301 "https://www.googleapis.com/auth/user.birthday.read", |
| 302 "https://www.googleapis.com/auth/user.emails.read", |
| 303 "https://www.googleapis.com/auth/user.phonenumbers.read"
, |
| 304 "https://www.googleapis.com/auth/userinfo.email", |
| 305 "https://www.googleapis.com/auth/userinfo.profile" |
305 ] | 306 ] |
306 } | 307 } |
307 }, | 308 }, |
308 "resources": { | 309 "resources": { |
309 "members": { | 310 "connections": { |
310 "methods": { | 311 "methods": { |
311 "modify": { | 312 "list": { |
312 "description": "Modify the members of a contact grou
p owned by the authenticated user.", | 313 "description": "Provides a list of the authenticated
user's contacts merged with any\nconnected profiles.\n<br>\nThe request throws
a 400 error if 'personFields' is not specified.", |
313 "httpMethod": "POST", | 314 "httpMethod": "GET", |
314 "id": "people.contactGroups.members.modify", | 315 "id": "people.people.connections.list", |
315 "parameterOrder": [ | 316 "parameterOrder": [ |
316 "resourceName" | 317 "resourceName" |
317 ], | 318 ], |
318 "parameters": { | 319 "parameters": { |
| 320 "sortOrder": { |
| 321 "description": "The order in which the conne
ctions should be sorted. Defaults to\n`LAST_MODIFIED_ASCENDING`.", |
| 322 "enum": [ |
| 323 "LAST_MODIFIED_ASCENDING", |
| 324 "FIRST_NAME_ASCENDING", |
| 325 "LAST_NAME_ASCENDING" |
| 326 ], |
| 327 "location": "query", |
| 328 "type": "string" |
| 329 }, |
| 330 "requestSyncToken": { |
| 331 "description": "Whether the response should
include a sync token, which can be used to get\nall changes since the last reque
st.", |
| 332 "location": "query", |
| 333 "type": "boolean" |
| 334 }, |
319 "resourceName": { | 335 "resourceName": { |
320 "description": "The resource name of the con
tact group to modify.", | 336 "description": "The resource name to return
connections for. Only `people/me` is valid.", |
321 "location": "path", | 337 "location": "path", |
322 "pattern": "^contactGroups/[^/]+$", | 338 "pattern": "^people/[^/]+$", |
323 "required": true, | 339 "required": true, |
324 "type": "string" | 340 "type": "string" |
| 341 }, |
| 342 "pageToken": { |
| 343 "description": "The token of the page to be
returned.", |
| 344 "location": "query", |
| 345 "type": "string" |
| 346 }, |
| 347 "pageSize": { |
| 348 "description": "The number of connections to
include in the response. Valid values are\nbetween 1 and 2000, inclusive. Defau
lts to 100.", |
| 349 "format": "int32", |
| 350 "location": "query", |
| 351 "type": "integer" |
| 352 }, |
| 353 "requestMask.includeField": { |
| 354 "description": "**Required.** Comma-separate
d list of person fields to be included in the\nresponse. Each path should start
with `person.`: for example,\n`person.names` or `person.photos`.", |
| 355 "format": "google-fieldmask", |
| 356 "location": "query", |
| 357 "type": "string" |
| 358 }, |
| 359 "syncToken": { |
| 360 "description": "A sync token, returned by a
previous call to `people.connections.list`.\nOnly resources changed since the sy
nc token was created will be returned.", |
| 361 "location": "query", |
| 362 "type": "string" |
| 363 }, |
| 364 "personFields": { |
| 365 "description": "**Required.** A field mask t
o restrict which fields on each person are\nreturned. Valid values are:\n\n* add
resses\n* ageRanges\n* biographies\n* birthdays\n* braggingRights\n* coverPhotos
\n* emailAddresses\n* events\n* genders\n* imClients\n* interests\n* locales\n*
memberships\n* metadata\n* names\n* nicknames\n* occupations\n* organizations\n*
phoneNumbers\n* photos\n* relations\n* relationshipInterests\n* relationshipSta
tuses\n* residences\n* skills\n* taglines\n* urls", |
| 366 "format": "google-fieldmask", |
| 367 "location": "query", |
| 368 "type": "string" |
325 } | 369 } |
326 }, | 370 }, |
327 "path": "v1/{+resourceName}/members:modify", | 371 "path": "v1/{+resourceName}/connections", |
328 "request": { | |
329 "$ref": "ModifyContactGroupMembersRequest" | |
330 }, | |
331 "response": { | 372 "response": { |
332 "$ref": "ModifyContactGroupMembersResponse" | 373 "$ref": "ListConnectionsResponse" |
333 }, | 374 }, |
334 "scopes": [ | 375 "scopes": [ |
335 "https://www.googleapis.com/auth/contacts" | 376 "https://www.googleapis.com/auth/contacts", |
| 377 "https://www.googleapis.com/auth/contacts.readon
ly" |
336 ] | 378 ] |
337 } | 379 } |
338 } | 380 } |
339 } | 381 } |
340 } | 382 } |
341 }, | 383 }, |
342 "people": { | 384 "contactGroups": { |
343 "methods": { | 385 "methods": { |
344 "deleteContact": { | 386 "batchGet": { |
345 "description": "Delete a contact person. Any non-contact dat
a will not be deleted.", | 387 "description": "Get a list of contact groups owned by the au
thenticated user by specifying\na list of contact group resource names.", |
| 388 "httpMethod": "GET", |
| 389 "id": "people.contactGroups.batchGet", |
| 390 "parameterOrder": [], |
| 391 "parameters": { |
| 392 "maxMembers": { |
| 393 "description": "Specifies the maximum number of memb
ers to return for each group.", |
| 394 "format": "int32", |
| 395 "location": "query", |
| 396 "type": "integer" |
| 397 }, |
| 398 "resourceNames": { |
| 399 "description": "The resource names of the contact gr
oups to get.", |
| 400 "location": "query", |
| 401 "repeated": true, |
| 402 "type": "string" |
| 403 } |
| 404 }, |
| 405 "path": "v1/contactGroups:batchGet", |
| 406 "response": { |
| 407 "$ref": "BatchGetContactGroupsResponse" |
| 408 }, |
| 409 "scopes": [ |
| 410 "https://www.googleapis.com/auth/contacts", |
| 411 "https://www.googleapis.com/auth/contacts.readonly" |
| 412 ] |
| 413 }, |
| 414 "delete": { |
| 415 "description": "Delete an existing contact group owned by th
e authenticated user by\nspecifying a contact group resource name.", |
346 "httpMethod": "DELETE", | 416 "httpMethod": "DELETE", |
347 "id": "people.people.deleteContact", | 417 "id": "people.contactGroups.delete", |
348 "parameterOrder": [ | 418 "parameterOrder": [ |
349 "resourceName" | 419 "resourceName" |
350 ], | 420 ], |
351 "parameters": { | 421 "parameters": { |
352 "resourceName": { | 422 "resourceName": { |
353 "description": "The resource name of the contact to
delete.", | 423 "description": "The resource name of the contact gro
up to delete.", |
354 "location": "path", | 424 "location": "path", |
355 "pattern": "^people/[^/]+$", | 425 "pattern": "^contactGroups/[^/]+$", |
356 "required": true, | 426 "required": true, |
357 "type": "string" | 427 "type": "string" |
358 } | 428 }, |
359 }, | 429 "deleteContacts": { |
360 "path": "v1/{+resourceName}:deleteContact", | 430 "description": "Set to true to also delete the conta
cts in the specified group.", |
| 431 "location": "query", |
| 432 "type": "boolean" |
| 433 } |
| 434 }, |
| 435 "path": "v1/{+resourceName}", |
361 "response": { | 436 "response": { |
362 "$ref": "Empty" | 437 "$ref": "Empty" |
363 }, | 438 }, |
364 "scopes": [ | 439 "scopes": [ |
365 "https://www.googleapis.com/auth/contacts" | 440 "https://www.googleapis.com/auth/contacts" |
366 ] | 441 ] |
367 }, | 442 }, |
368 "getBatchGet": { | 443 "list": { |
369 "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.\n<br>\nThe request throws a 400 error if 'perso
nFields' is not specified.", | 444 "description": "List all contact groups owned by the authent
icated user. Members of the\ncontact groups are not populated.", |
370 "httpMethod": "GET", | 445 "httpMethod": "GET", |
371 "id": "people.people.getBatchGet", | 446 "id": "people.contactGroups.list", |
372 "parameterOrder": [], | 447 "parameterOrder": [], |
373 "parameters": { | 448 "parameters": { |
374 "requestMask.includeField": { | 449 "syncToken": { |
375 "description": "**Required.** Comma-separated list o
f person fields to be included in the\nresponse. Each path should start with `pe
rson.`: for example,\n`person.names` or `person.photos`.", | 450 "description": "A sync token, returned by a previous
call to `contactgroups.list`.\nOnly resources changed since the sync token was
created will be returned.", |
376 "format": "google-fieldmask", | |
377 "location": "query", | 451 "location": "query", |
378 "type": "string" | 452 "type": "string" |
379 }, | 453 }, |
380 "resourceNames": { | 454 "pageToken": { |
381 "description": "The resource names of the people to
provide information about.\n\n- To get information about the authenticated user,
specify `people/me`.\n- To get information about a google account, specify\n `
people/`<var>account_id</var>.\n- To get information about a contact, specify th
e resource name that\n identifies the contact as returned by\n[`people.connecti
ons.list`](/people/api/rest/v1/people.connections/list).\n\nYou can include up t
o 50 resource names in one request.", | 455 "description": "The next_page_token value returned f
rom a previous call to\n[ListContactGroups](/people/api/rest/v1/contactgroups/li
st).\nRequests the next page of resources.", |
382 "location": "query", | 456 "location": "query", |
383 "repeated": true, | |
384 "type": "string" | 457 "type": "string" |
385 }, | 458 }, |
386 "personFields": { | 459 "pageSize": { |
387 "description": "**Required.** A field mask to restri
ct which fields on each person are\nreturned. Valid values are:\n\n* addresses\n
* ageRanges\n* biographies\n* birthdays\n* braggingRights\n* coverPhotos\n* emai
lAddresses\n* events\n* genders\n* imClients\n* interests\n* locales\n* membersh
ips\n* metadata\n* names\n* nicknames\n* occupations\n* organizations\n* phoneNu
mbers\n* photos\n* relations\n* relationshipInterests\n* relationshipStatuses\n*
residences\n* skills\n* taglines\n* urls", | 460 "description": "The maximum number of resources to r
eturn.", |
388 "format": "google-fieldmask", | 461 "format": "int32", |
389 "location": "query", | 462 "location": "query", |
390 "type": "string" | 463 "type": "integer" |
391 } | 464 } |
392 }, | 465 }, |
393 "path": "v1/people:batchGet", | 466 "path": "v1/contactGroups", |
394 "response": { | 467 "response": { |
395 "$ref": "GetPeopleResponse" | 468 "$ref": "ListContactGroupsResponse" |
396 }, | 469 }, |
397 "scopes": [ | 470 "scopes": [ |
398 "https://www.googleapis.com/auth/contacts", | 471 "https://www.googleapis.com/auth/contacts", |
399 "https://www.googleapis.com/auth/contacts.readonly", | 472 "https://www.googleapis.com/auth/contacts.readonly" |
400 "https://www.googleapis.com/auth/plus.login", | 473 ] |
401 "https://www.googleapis.com/auth/user.addresses.read", | 474 }, |
402 "https://www.googleapis.com/auth/user.birthday.read", | 475 "create": { |
403 "https://www.googleapis.com/auth/user.emails.read", | 476 "description": "Create a new contact group owned by the auth
enticated user.", |
404 "https://www.googleapis.com/auth/user.phonenumbers.read"
, | 477 "httpMethod": "POST", |
405 "https://www.googleapis.com/auth/userinfo.email", | 478 "id": "people.contactGroups.create", |
406 "https://www.googleapis.com/auth/userinfo.profile" | 479 "parameterOrder": [], |
| 480 "parameters": {}, |
| 481 "path": "v1/contactGroups", |
| 482 "request": { |
| 483 "$ref": "CreateContactGroupRequest" |
| 484 }, |
| 485 "response": { |
| 486 "$ref": "ContactGroup" |
| 487 }, |
| 488 "scopes": [ |
| 489 "https://www.googleapis.com/auth/contacts" |
407 ] | 490 ] |
408 }, | 491 }, |
409 "get": { | 492 "get": { |
410 "description": "Provides information about a person by speci
fying a resource name. Use\n`people/me` to indicate the authenticated user.\n<br
>\nThe request throws a 400 error if 'personFields' is not specified.", | 493 "description": "Get a specific contact group owned by the au
thenticated user by specifying\na contact group resource name.", |
411 "httpMethod": "GET", | 494 "httpMethod": "GET", |
412 "id": "people.people.get", | 495 "id": "people.contactGroups.get", |
413 "parameterOrder": [ | 496 "parameterOrder": [ |
414 "resourceName" | 497 "resourceName" |
415 ], | 498 ], |
416 "parameters": { | 499 "parameters": { |
417 "requestMask.includeField": { | 500 "maxMembers": { |
418 "description": "**Required.** Comma-separated list o
f person fields to be included in the\nresponse. Each path should start with `pe
rson.`: for example,\n`person.names` or `person.photos`.", | 501 "description": "Specifies the maximum number of memb
ers to return.", |
419 "format": "google-fieldmask", | 502 "format": "int32", |
420 "location": "query", | 503 "location": "query", |
421 "type": "string" | 504 "type": "integer" |
422 }, | |
423 "personFields": { | |
424 "description": "**Required.** A field mask to restri
ct which fields on the person are\nreturned. Valid values are:\n\n* addresses\n*
ageRanges\n* biographies\n* birthdays\n* braggingRights\n* coverPhotos\n* email
Addresses\n* events\n* genders\n* imClients\n* interests\n* locales\n* membershi
ps\n* metadata\n* names\n* nicknames\n* occupations\n* organizations\n* phoneNum
bers\n* photos\n* relations\n* relationshipInterests\n* relationshipStatuses\n*
residences\n* skills\n* taglines\n* urls", | |
425 "format": "google-fieldmask", | |
426 "location": "query", | |
427 "type": "string" | |
428 }, | 505 }, |
429 "resourceName": { | 506 "resourceName": { |
430 "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 a google account, specify\n `pe
ople/`<var>account_id</var>.\n- To get information about a contact, specify the
resource name that\n identifies the contact as returned by\n[`people.connection
s.list`](/people/api/rest/v1/people.connections/list).", | 507 "description": "The resource name of the contact gro
up to get.", |
431 "location": "path", | 508 "location": "path", |
432 "pattern": "^people/[^/]+$", | 509 "pattern": "^contactGroups/[^/]+$", |
433 "required": true, | 510 "required": true, |
434 "type": "string" | 511 "type": "string" |
435 } | 512 } |
436 }, | 513 }, |
437 "path": "v1/{+resourceName}", | 514 "path": "v1/{+resourceName}", |
438 "response": { | 515 "response": { |
439 "$ref": "Person" | 516 "$ref": "ContactGroup" |
440 }, | 517 }, |
441 "scopes": [ | 518 "scopes": [ |
442 "https://www.googleapis.com/auth/contacts", | 519 "https://www.googleapis.com/auth/contacts", |
443 "https://www.googleapis.com/auth/contacts.readonly", | 520 "https://www.googleapis.com/auth/contacts.readonly" |
444 "https://www.googleapis.com/auth/plus.login", | |
445 "https://www.googleapis.com/auth/user.addresses.read", | |
446 "https://www.googleapis.com/auth/user.birthday.read", | |
447 "https://www.googleapis.com/auth/user.emails.read", | |
448 "https://www.googleapis.com/auth/user.phonenumbers.read"
, | |
449 "https://www.googleapis.com/auth/userinfo.email", | |
450 "https://www.googleapis.com/auth/userinfo.profile" | |
451 ] | 521 ] |
452 }, | 522 }, |
453 "updateContact": { | 523 "update": { |
454 "description": "Update contact data for an existing contact
person. Any non-contact data\nwill not be modified.\n\nThe request throws a 400
error if `updatePersonFields` is not specified.\n<br>\nThe request throws a 400
error if `person.metadata.sources` is not\nspecified for the contact to be updat
ed.\n<br>\nThe request throws a 412 error if `person.metadata.sources.etag` is\n
different than the contact's etag, which indicates the contact has changed\nsinc
e its data was read. Clients should get the latest person and re-apply\ntheir up
dates to the latest person.", | 524 "description": "Update the name of an existing contact group
owned by the authenticated\nuser.", |
455 "httpMethod": "PATCH", | 525 "httpMethod": "PUT", |
456 "id": "people.people.updateContact", | 526 "id": "people.contactGroups.update", |
457 "parameterOrder": [ | 527 "parameterOrder": [ |
458 "resourceName" | 528 "resourceName" |
459 ], | 529 ], |
460 "parameters": { | 530 "parameters": { |
461 "updatePersonFields": { | |
462 "description": "**Required.** A field mask to restri
ct which fields on the person are\nupdated. Valid values are:\n\n* addresses\n*
biographies\n* birthdays\n* braggingRights\n* emailAddresses\n* events\n* gender
s\n* imClients\n* interests\n* locales\n* names\n* nicknames\n* occupations\n* o
rganizations\n* phoneNumbers\n* relations\n* residences\n* skills\n* urls", | |
463 "format": "google-fieldmask", | |
464 "location": "query", | |
465 "type": "string" | |
466 }, | |
467 "resourceName": { | 531 "resourceName": { |
468 "description": "The resource name for the person, as
signed by the server. An ASCII string\nwith a max length of 27 characters, in th
e form of\n`people/`<var>person_id</var>.", | 532 "description": "The resource name for the contact gr
oup, assigned by the server. An ASCII\nstring, in the form of `contactGroups/`<v
ar>contact_group_id</var>.", |
469 "location": "path", | 533 "location": "path", |
470 "pattern": "^people/[^/]+$", | 534 "pattern": "^contactGroups/[^/]+$", |
471 "required": true, | 535 "required": true, |
472 "type": "string" | 536 "type": "string" |
473 } | 537 } |
474 }, | 538 }, |
475 "path": "v1/{+resourceName}:updateContact", | 539 "path": "v1/{+resourceName}", |
476 "request": { | 540 "request": { |
477 "$ref": "Person" | 541 "$ref": "UpdateContactGroupRequest" |
478 }, | 542 }, |
479 "response": { | 543 "response": { |
480 "$ref": "Person" | 544 "$ref": "ContactGroup" |
481 }, | 545 }, |
482 "scopes": [ | 546 "scopes": [ |
483 "https://www.googleapis.com/auth/contacts" | 547 "https://www.googleapis.com/auth/contacts" |
484 ] | |
485 }, | |
486 "createContact": { | |
487 "description": "Create a new contact and return the person r
esource for that contact.", | |
488 "httpMethod": "POST", | |
489 "id": "people.people.createContact", | |
490 "parameterOrder": [], | |
491 "parameters": { | |
492 "parent": { | |
493 "description": "The resource name of the owning pers
on resource.", | |
494 "location": "query", | |
495 "type": "string" | |
496 } | |
497 }, | |
498 "path": "v1/people:createContact", | |
499 "request": { | |
500 "$ref": "Person" | |
501 }, | |
502 "response": { | |
503 "$ref": "Person" | |
504 }, | |
505 "scopes": [ | |
506 "https://www.googleapis.com/auth/contacts" | |
507 ] | 548 ] |
508 } | 549 } |
509 }, | 550 }, |
510 "resources": { | 551 "resources": { |
511 "connections": { | 552 "members": { |
512 "methods": { | 553 "methods": { |
513 "list": { | 554 "modify": { |
514 "description": "Provides a list of the authenticated
user's contacts merged with any\nconnected profiles.\n<br>\nThe request throws
a 400 error if 'personFields' is not specified.", | 555 "description": "Modify the members of a contact grou
p owned by the authenticated user.", |
515 "httpMethod": "GET", | 556 "httpMethod": "POST", |
516 "id": "people.people.connections.list", | 557 "id": "people.contactGroups.members.modify", |
517 "parameterOrder": [ | 558 "parameterOrder": [ |
518 "resourceName" | 559 "resourceName" |
519 ], | 560 ], |
520 "parameters": { | 561 "parameters": { |
521 "personFields": { | |
522 "description": "**Required.** A field mask t
o restrict which fields on each person are\nreturned. Valid values are:\n\n* add
resses\n* ageRanges\n* biographies\n* birthdays\n* braggingRights\n* coverPhotos
\n* emailAddresses\n* events\n* genders\n* imClients\n* interests\n* locales\n*
memberships\n* metadata\n* names\n* nicknames\n* occupations\n* organizations\n*
phoneNumbers\n* photos\n* relations\n* relationshipInterests\n* relationshipSta
tuses\n* residences\n* skills\n* taglines\n* urls", | |
523 "format": "google-fieldmask", | |
524 "location": "query", | |
525 "type": "string" | |
526 }, | |
527 "sortOrder": { | |
528 "description": "The order in which the conne
ctions should be sorted. Defaults to\n`LAST_MODIFIED_ASCENDING`.", | |
529 "enum": [ | |
530 "LAST_MODIFIED_ASCENDING", | |
531 "FIRST_NAME_ASCENDING", | |
532 "LAST_NAME_ASCENDING" | |
533 ], | |
534 "location": "query", | |
535 "type": "string" | |
536 }, | |
537 "requestSyncToken": { | |
538 "description": "Whether the response should
include a sync token, which can be used to get\nall changes since the last reque
st.", | |
539 "location": "query", | |
540 "type": "boolean" | |
541 }, | |
542 "pageToken": { | |
543 "description": "The token of the page to be
returned.", | |
544 "location": "query", | |
545 "type": "string" | |
546 }, | |
547 "resourceName": { | 562 "resourceName": { |
548 "description": "The resource name to return
connections for. Only `people/me` is valid.", | 563 "description": "The resource name of the con
tact group to modify.", |
549 "location": "path", | 564 "location": "path", |
550 "pattern": "^people/[^/]+$", | 565 "pattern": "^contactGroups/[^/]+$", |
551 "required": true, | 566 "required": true, |
552 "type": "string" | 567 "type": "string" |
553 }, | |
554 "requestMask.includeField": { | |
555 "description": "**Required.** Comma-separate
d list of person fields to be included in the\nresponse. Each path should start
with `person.`: for example,\n`person.names` or `person.photos`.", | |
556 "format": "google-fieldmask", | |
557 "location": "query", | |
558 "type": "string" | |
559 }, | |
560 "pageSize": { | |
561 "description": "The number of connections to
include in the response. Valid values are\nbetween 1 and 2000, inclusive. Defau
lts to 100.", | |
562 "format": "int32", | |
563 "location": "query", | |
564 "type": "integer" | |
565 }, | |
566 "syncToken": { | |
567 "description": "A sync token, returned by a
previous call to `people.connections.list`.\nOnly resources changed since the sy
nc token was created will be returned.", | |
568 "location": "query", | |
569 "type": "string" | |
570 } | 568 } |
571 }, | 569 }, |
572 "path": "v1/{+resourceName}/connections", | 570 "path": "v1/{+resourceName}/members:modify", |
| 571 "request": { |
| 572 "$ref": "ModifyContactGroupMembersRequest" |
| 573 }, |
573 "response": { | 574 "response": { |
574 "$ref": "ListConnectionsResponse" | 575 "$ref": "ModifyContactGroupMembersResponse" |
575 }, | 576 }, |
576 "scopes": [ | 577 "scopes": [ |
577 "https://www.googleapis.com/auth/contacts", | 578 "https://www.googleapis.com/auth/contacts" |
578 "https://www.googleapis.com/auth/contacts.readon
ly" | |
579 ] | 579 ] |
580 } | 580 } |
581 } | 581 } |
582 } | 582 } |
583 } | 583 } |
584 } | 584 } |
585 }, | 585 }, |
586 "revision": "20170817", | 586 "revision": "20170907", |
587 "rootUrl": "https://people.googleapis.com/", | 587 "rootUrl": "https://people.googleapis.com/", |
588 "schemas": { | 588 "schemas": { |
| 589 "ImClient": { |
| 590 "description": "A person's instant messaging client.", |
| 591 "id": "ImClient", |
| 592 "properties": { |
| 593 "formattedProtocol": { |
| 594 "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.", |
| 595 "type": "string" |
| 596 }, |
| 597 "formattedType": { |
| 598 "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.", |
| 599 "type": "string" |
| 600 }, |
| 601 "metadata": { |
| 602 "$ref": "FieldMetadata", |
| 603 "description": "Metadata about the IM client." |
| 604 }, |
| 605 "type": { |
| 606 "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`", |
| 607 "type": "string" |
| 608 }, |
| 609 "protocol": { |
| 610 "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`", |
| 611 "type": "string" |
| 612 }, |
| 613 "username": { |
| 614 "description": "The user name used in the IM client.", |
| 615 "type": "string" |
| 616 } |
| 617 }, |
| 618 "type": "object" |
| 619 }, |
589 "DomainMembership": { | 620 "DomainMembership": { |
590 "description": "A Google Apps Domain membership.", | 621 "description": "A Google Apps Domain membership.", |
591 "id": "DomainMembership", | 622 "id": "DomainMembership", |
592 "properties": { | 623 "properties": { |
593 "inViewerDomain": { | 624 "inViewerDomain": { |
594 "description": "True if the person is in the viewer's Google
Apps domain.", | 625 "description": "True if the person is in the viewer's Google
Apps domain.", |
595 "type": "boolean" | 626 "type": "boolean" |
596 } | 627 } |
597 }, | 628 }, |
598 "type": "object" | 629 "type": "object" |
599 }, | 630 }, |
| 631 "Membership": { |
| 632 "description": "A person's read-only membership in a group.", |
| 633 "id": "Membership", |
| 634 "properties": { |
| 635 "contactGroupMembership": { |
| 636 "$ref": "ContactGroupMembership", |
| 637 "description": "The contact group membership." |
| 638 }, |
| 639 "domainMembership": { |
| 640 "$ref": "DomainMembership", |
| 641 "description": "The domain membership." |
| 642 }, |
| 643 "metadata": { |
| 644 "$ref": "FieldMetadata", |
| 645 "description": "Metadata about the membership." |
| 646 } |
| 647 }, |
| 648 "type": "object" |
| 649 }, |
600 "BatchGetContactGroupsResponse": { | 650 "BatchGetContactGroupsResponse": { |
601 "description": "The response to a batch get contact groups request."
, | 651 "description": "The response to a batch get contact groups request."
, |
602 "id": "BatchGetContactGroupsResponse", | 652 "id": "BatchGetContactGroupsResponse", |
603 "properties": { | 653 "properties": { |
604 "responses": { | 654 "responses": { |
605 "description": "The list of responses for each requested con
tact group resource.", | 655 "description": "The list of responses for each requested con
tact group resource.", |
606 "items": { | 656 "items": { |
607 "$ref": "ContactGroupResponse" | 657 "$ref": "ContactGroupResponse" |
608 }, | 658 }, |
609 "type": "array" | 659 "type": "array" |
610 } | 660 } |
611 }, | 661 }, |
612 "type": "object" | 662 "type": "object" |
613 }, | 663 }, |
614 "Membership": { | |
615 "description": "A person's read-only membership in a group.", | |
616 "id": "Membership", | |
617 "properties": { | |
618 "metadata": { | |
619 "$ref": "FieldMetadata", | |
620 "description": "Metadata about the membership." | |
621 }, | |
622 "domainMembership": { | |
623 "$ref": "DomainMembership", | |
624 "description": "The domain membership." | |
625 }, | |
626 "contactGroupMembership": { | |
627 "$ref": "ContactGroupMembership", | |
628 "description": "The contact group membership." | |
629 } | |
630 }, | |
631 "type": "object" | |
632 }, | |
633 "RelationshipStatus": { | 664 "RelationshipStatus": { |
634 "description": "A person's read-only relationship status.", | 665 "description": "A person's read-only relationship status.", |
635 "id": "RelationshipStatus", | 666 "id": "RelationshipStatus", |
636 "properties": { | 667 "properties": { |
637 "value": { | |
638 "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`", | |
639 "type": "string" | |
640 }, | |
641 "formattedValue": { | 668 "formattedValue": { |
642 "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.", | 669 "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.", |
643 "type": "string" | 670 "type": "string" |
644 }, | 671 }, |
645 "metadata": { | 672 "metadata": { |
646 "$ref": "FieldMetadata", | 673 "$ref": "FieldMetadata", |
647 "description": "Metadata about the relationship status." | 674 "description": "Metadata about the relationship status." |
| 675 }, |
| 676 "value": { |
| 677 "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`", |
| 678 "type": "string" |
648 } | 679 } |
649 }, | 680 }, |
650 "type": "object" | 681 "type": "object" |
651 }, | 682 }, |
652 "BraggingRights": { | 683 "BraggingRights": { |
653 "description": "A person's bragging rights.", | 684 "description": "A person's bragging rights.", |
654 "id": "BraggingRights", | 685 "id": "BraggingRights", |
655 "properties": { | 686 "properties": { |
656 "metadata": { | 687 "metadata": { |
657 "$ref": "FieldMetadata", | 688 "$ref": "FieldMetadata", |
658 "description": "Metadata about the bragging rights." | 689 "description": "Metadata about the bragging rights." |
659 }, | 690 }, |
660 "value": { | 691 "value": { |
661 "description": "The bragging rights; for example, `climbed m
ount everest`.", | 692 "description": "The bragging rights; for example, `climbed m
ount everest`.", |
662 "type": "string" | 693 "type": "string" |
663 } | 694 } |
664 }, | 695 }, |
665 "type": "object" | 696 "type": "object" |
666 }, | 697 }, |
667 "Organization": { | 698 "Organization": { |
668 "description": "A person's past or current organization. Overlapping
date ranges are\npermitted.", | 699 "description": "A person's past or current organization. Overlapping
date ranges are\npermitted.", |
669 "id": "Organization", | 700 "id": "Organization", |
670 "properties": { | 701 "properties": { |
| 702 "startDate": { |
| 703 "$ref": "Date", |
| 704 "description": "The start date when the person joined the or
ganization." |
| 705 }, |
| 706 "formattedType": { |
| 707 "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.", |
| 708 "type": "string" |
| 709 }, |
| 710 "domain": { |
| 711 "description": "The domain name associated with the organiza
tion; for example, `google.com`.", |
| 712 "type": "string" |
| 713 }, |
| 714 "department": { |
| 715 "description": "The person's department at the organization.
", |
| 716 "type": "string" |
| 717 }, |
| 718 "phoneticName": { |
| 719 "description": "The phonetic name of the organization.", |
| 720 "type": "string" |
| 721 }, |
| 722 "type": { |
| 723 "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`", |
| 724 "type": "string" |
| 725 }, |
| 726 "jobDescription": { |
| 727 "description": "The person's job description at the organiza
tion.", |
| 728 "type": "string" |
| 729 }, |
671 "endDate": { | 730 "endDate": { |
672 "$ref": "Date", | 731 "$ref": "Date", |
673 "description": "The end date when the person left the organi
zation." | 732 "description": "The end date when the person left the organi
zation." |
674 }, | 733 }, |
675 "symbol": { | 734 "symbol": { |
676 "description": "The symbol associated with the organization;
for example, a stock ticker\nsymbol, abbreviation, or acronym.", | 735 "description": "The symbol associated with the organization;
for example, a stock ticker\nsymbol, abbreviation, or acronym.", |
677 "type": "string" | 736 "type": "string" |
678 }, | 737 }, |
679 "name": { | 738 "name": { |
680 "description": "The name of the organization.", | 739 "description": "The name of the organization.", |
681 "type": "string" | 740 "type": "string" |
682 }, | 741 }, |
683 "metadata": { | 742 "metadata": { |
684 "$ref": "FieldMetadata", | 743 "$ref": "FieldMetadata", |
685 "description": "Metadata about the organization." | 744 "description": "Metadata about the organization." |
686 }, | 745 }, |
| 746 "title": { |
| 747 "description": "The person's job title at the organization."
, |
| 748 "type": "string" |
| 749 }, |
687 "location": { | 750 "location": { |
688 "description": "The location of the organization office the
person works at.", | 751 "description": "The location of the organization office the
person works at.", |
689 "type": "string" | 752 "type": "string" |
690 }, | 753 }, |
691 "title": { | |
692 "description": "The person's job title at the organization."
, | |
693 "type": "string" | |
694 }, | |
695 "current": { | 754 "current": { |
696 "description": "True if the organization is the person's cur
rent organization;\nfalse if the organization is a past organization.", | 755 "description": "True if the organization is the person's cur
rent organization;\nfalse if the organization is a past organization.", |
697 "type": "boolean" | 756 "type": "boolean" |
698 }, | |
699 "formattedType": { | |
700 "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.", | |
701 "type": "string" | |
702 }, | |
703 "startDate": { | |
704 "$ref": "Date", | |
705 "description": "The start date when the person joined the or
ganization." | |
706 }, | |
707 "domain": { | |
708 "description": "The domain name associated with the organiza
tion; for example, `google.com`.", | |
709 "type": "string" | |
710 }, | |
711 "department": { | |
712 "description": "The person's department at the organization.
", | |
713 "type": "string" | |
714 }, | |
715 "type": { | |
716 "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`", | |
717 "type": "string" | |
718 }, | |
719 "phoneticName": { | |
720 "description": "The phonetic name of the organization.", | |
721 "type": "string" | |
722 }, | |
723 "jobDescription": { | |
724 "description": "The person's job description at the organiza
tion.", | |
725 "type": "string" | |
726 } | 757 } |
727 }, | 758 }, |
728 "type": "object" | 759 "type": "object" |
729 }, | 760 }, |
730 "AgeRangeType": { | 761 "AgeRangeType": { |
731 "description": "A person's age range.", | 762 "description": "A person's age range.", |
732 "id": "AgeRangeType", | 763 "id": "AgeRangeType", |
733 "properties": { | 764 "properties": { |
734 "metadata": { | 765 "metadata": { |
735 "$ref": "FieldMetadata", | 766 "$ref": "FieldMetadata", |
(...skipping 26 matching lines...) Expand all Loading... |
762 "description": "The list of contact groups. Members of the c
ontact groups are not\npopulated.", | 793 "description": "The list of contact groups. Members of the c
ontact groups are not\npopulated.", |
763 "items": { | 794 "items": { |
764 "$ref": "ContactGroup" | 795 "$ref": "ContactGroup" |
765 }, | 796 }, |
766 "type": "array" | 797 "type": "array" |
767 }, | 798 }, |
768 "nextPageToken": { | 799 "nextPageToken": { |
769 "description": "The token that can be used to retrieve the n
ext page of results.", | 800 "description": "The token that can be used to retrieve the n
ext page of results.", |
770 "type": "string" | 801 "type": "string" |
771 }, | 802 }, |
772 "nextSyncToken": { | |
773 "description": "The token that can be used to retrieve chang
es since the last request.", | |
774 "type": "string" | |
775 }, | |
776 "totalItems": { | 803 "totalItems": { |
777 "description": "The total number of items in the list withou
t pagination.", | 804 "description": "The total number of items in the list withou
t pagination.", |
778 "format": "int32", | 805 "format": "int32", |
779 "type": "integer" | 806 "type": "integer" |
| 807 }, |
| 808 "nextSyncToken": { |
| 809 "description": "The token that can be used to retrieve chang
es since the last request.", |
| 810 "type": "string" |
780 } | 811 } |
781 }, | 812 }, |
782 "type": "object" | 813 "type": "object" |
783 }, | 814 }, |
784 "PersonResponse": { | 815 "PersonResponse": { |
785 "description": "The response for a single person", | 816 "description": "The response for a single person", |
786 "id": "PersonResponse", | 817 "id": "PersonResponse", |
787 "properties": { | 818 "properties": { |
788 "person": { | 819 "person": { |
789 "$ref": "Person", | 820 "$ref": "Person", |
(...skipping 12 matching lines...) Expand all Loading... |
802 "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.", | 833 "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.", |
803 "type": "string" | 834 "type": "string" |
804 } | 835 } |
805 }, | 836 }, |
806 "type": "object" | 837 "type": "object" |
807 }, | 838 }, |
808 "Relation": { | 839 "Relation": { |
809 "description": "A person's relation to another person.", | 840 "description": "A person's relation to another person.", |
810 "id": "Relation", | 841 "id": "Relation", |
811 "properties": { | 842 "properties": { |
812 "type": { | 843 "person": { |
813 "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`", | 844 "description": "The name of the other person this relation r
efers to.", |
| 845 "type": "string" |
| 846 }, |
| 847 "formattedType": { |
| 848 "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.", |
814 "type": "string" | 849 "type": "string" |
815 }, | 850 }, |
816 "metadata": { | 851 "metadata": { |
817 "$ref": "FieldMetadata", | 852 "$ref": "FieldMetadata", |
818 "description": "Metadata about the relation." | 853 "description": "Metadata about the relation." |
819 }, | 854 }, |
820 "formattedType": { | 855 "type": { |
821 "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.", | 856 "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`", |
822 "type": "string" | |
823 }, | |
824 "person": { | |
825 "description": "The name of the other person this relation r
efers to.", | |
826 "type": "string" | 857 "type": "string" |
827 } | 858 } |
828 }, | 859 }, |
829 "type": "object" | 860 "type": "object" |
830 }, | 861 }, |
831 "Occupation": { | 862 "Occupation": { |
832 "description": "A person's occupation.", | 863 "description": "A person's occupation.", |
833 "id": "Occupation", | 864 "id": "Occupation", |
834 "properties": { | 865 "properties": { |
835 "metadata": { | 866 "metadata": { |
836 "$ref": "FieldMetadata", | 867 "$ref": "FieldMetadata", |
837 "description": "Metadata about the occupation." | 868 "description": "Metadata about the occupation." |
838 }, | 869 }, |
839 "value": { | 870 "value": { |
840 "description": "The occupation; for example, `carpenter`.", | 871 "description": "The occupation; for example, `carpenter`.", |
841 "type": "string" | 872 "type": "string" |
842 } | 873 } |
843 }, | 874 }, |
844 "type": "object" | 875 "type": "object" |
845 }, | 876 }, |
846 "ContactGroup": { | 877 "ContactGroup": { |
847 "description": "A contact group.", | 878 "description": "A contact group.", |
848 "id": "ContactGroup", | 879 "id": "ContactGroup", |
849 "properties": { | 880 "properties": { |
850 "memberCount": { | |
851 "description": "The total number of contacts in the group ir
respective of max members in\nspecified in the request.", | |
852 "format": "int32", | |
853 "type": "integer" | |
854 }, | |
855 "metadata": { | |
856 "$ref": "ContactGroupMetadata", | |
857 "description": "Metadata about the contact group." | |
858 }, | |
859 "resourceName": { | 881 "resourceName": { |
860 "description": "The resource name for the contact group, ass
igned by the server. An ASCII\nstring, in the form of `contactGroups/`<var>conta
ct_group_id</var>.", | 882 "description": "The resource name for the contact group, ass
igned by the server. An ASCII\nstring, in the form of `contactGroups/`<var>conta
ct_group_id</var>.", |
861 "type": "string" | 883 "type": "string" |
862 }, | 884 }, |
863 "etag": { | 885 "etag": { |
864 "description": "The [HTTP entity tag](https://en.wikipedia.o
rg/wiki/HTTP_ETag) of the\nresource. Used for web cache validation.", | 886 "description": "The [HTTP entity tag](https://en.wikipedia.o
rg/wiki/HTTP_ETag) of the\nresource. Used for web cache validation.", |
865 "type": "string" | 887 "type": "string" |
866 }, | 888 }, |
867 "formattedName": { | 889 "formattedName": { |
868 "description": "The read-only name translated and formatted
in the viewer's account locale\nor the `Accept-Language` HTTP header locale for
system groups names.\nGroup names set by the owner are the same as name.", | 890 "description": "The read-only name translated and formatted
in the viewer's account locale\nor the `Accept-Language` HTTP header locale for
system groups names.\nGroup names set by the owner are the same as name.", |
869 "type": "string" | 891 "type": "string" |
870 }, | 892 }, |
871 "groupType": { | 893 "groupType": { |
872 "description": "The read-only contact group type.", | 894 "description": "The read-only contact group type.", |
873 "enum": [ | 895 "enum": [ |
874 "GROUP_TYPE_UNSPECIFIED", | 896 "GROUP_TYPE_UNSPECIFIED", |
875 "USER_CONTACT_GROUP", | 897 "USER_CONTACT_GROUP", |
876 "SYSTEM_CONTACT_GROUP" | 898 "SYSTEM_CONTACT_GROUP" |
877 ], | 899 ], |
878 "enumDescriptions": [ | 900 "enumDescriptions": [ |
879 "Unspecified.", | 901 "Unspecified.", |
880 "User defined contact group.", | 902 "User defined contact group.", |
881 "System defined contact group." | 903 "System defined contact group." |
882 ], | 904 ], |
883 "type": "string" | 905 "type": "string" |
884 }, | 906 }, |
| 907 "name": { |
| 908 "description": "The contact group name set by the group owne
r or a system provided name\nfor system groups.", |
| 909 "type": "string" |
| 910 }, |
885 "memberResourceNames": { | 911 "memberResourceNames": { |
886 "description": "The list of contact person resource names th
at are members of the contact\ngroup. The field is not populated for LIST reques
ts and can only be updated\nthrough the\n[ModifyContactGroupMembers](/people/api
/rest/v1/contactgroups/members/modify).", | 912 "description": "The list of contact person resource names th
at are members of the contact\ngroup. The field is not populated for LIST reques
ts and can only be updated\nthrough the\n[ModifyContactGroupMembers](/people/api
/rest/v1/contactgroups/members/modify).", |
887 "items": { | 913 "items": { |
888 "type": "string" | 914 "type": "string" |
889 }, | 915 }, |
890 "type": "array" | 916 "type": "array" |
891 }, | 917 }, |
892 "name": { | 918 "metadata": { |
893 "description": "The contact group name set by the group owne
r or a system provided name\nfor system groups.", | 919 "$ref": "ContactGroupMetadata", |
894 "type": "string" | 920 "description": "Metadata about the contact group." |
| 921 }, |
| 922 "memberCount": { |
| 923 "description": "The total number of contacts in the group ir
respective of max members in\nspecified in the request.", |
| 924 "format": "int32", |
| 925 "type": "integer" |
895 } | 926 } |
896 }, | 927 }, |
897 "type": "object" | 928 "type": "object" |
898 }, | 929 }, |
899 "Person": { | 930 "Person": { |
900 "description": "Information about a person merged from various data
sources such as the\nauthenticated user's contacts and profile data.\n\nMost fie
lds can have multiple items. The items in a field have no guaranteed\norder, but
each non-empty field is guaranteed to have exactly one field with\n`metadata.pr
imary` set to true.", | 931 "description": "Information about a person merged from various data
sources such as the\nauthenticated user's contacts and profile data.\n\nMost fie
lds can have multiple items. The items in a field have no guaranteed\norder, but
each non-empty field is guaranteed to have exactly one field with\n`metadata.pr
imary` set to true.", |
901 "id": "Person", | 932 "id": "Person", |
902 "properties": { | 933 "properties": { |
903 "coverPhotos": { | |
904 "description": "The person's read-only cover photos.", | |
905 "items": { | |
906 "$ref": "CoverPhoto" | |
907 }, | |
908 "type": "array" | |
909 }, | |
910 "imClients": { | |
911 "description": "The person's instant messaging clients.", | |
912 "items": { | |
913 "$ref": "ImClient" | |
914 }, | |
915 "type": "array" | |
916 }, | |
917 "birthdays": { | 934 "birthdays": { |
918 "description": "The person's birthdays.", | 935 "description": "The person's birthdays.", |
919 "items": { | 936 "items": { |
920 "$ref": "Birthday" | 937 "$ref": "Birthday" |
921 }, | 938 }, |
922 "type": "array" | 939 "type": "array" |
923 }, | 940 }, |
| 941 "userDefined": { |
| 942 "description": "The person's user defined data.", |
| 943 "items": { |
| 944 "$ref": "UserDefined" |
| 945 }, |
| 946 "type": "array" |
| 947 }, |
924 "locales": { | 948 "locales": { |
925 "description": "The person's locale preferences.", | 949 "description": "The person's locale preferences.", |
926 "items": { | 950 "items": { |
927 "$ref": "Locale" | 951 "$ref": "Locale" |
928 }, | 952 }, |
929 "type": "array" | 953 "type": "array" |
930 }, | 954 }, |
931 "relationshipInterests": { | 955 "relationshipInterests": { |
932 "description": "The person's read-only relationship interest
s.", | 956 "description": "The person's read-only relationship interest
s.", |
933 "items": { | 957 "items": { |
(...skipping 72 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1006 }, | 1030 }, |
1007 "type": "array" | 1031 "type": "array" |
1008 }, | 1032 }, |
1009 "genders": { | 1033 "genders": { |
1010 "description": "The person's genders.", | 1034 "description": "The person's genders.", |
1011 "items": { | 1035 "items": { |
1012 "$ref": "Gender" | 1036 "$ref": "Gender" |
1013 }, | 1037 }, |
1014 "type": "array" | 1038 "type": "array" |
1015 }, | 1039 }, |
| 1040 "resourceName": { |
| 1041 "description": "The resource name for the person, assigned b
y the server. An ASCII string\nwith a max length of 27 characters, in the form o
f\n`people/`<var>person_id</var>.", |
| 1042 "type": "string" |
| 1043 }, |
1016 "interests": { | 1044 "interests": { |
1017 "description": "The person's interests.", | 1045 "description": "The person's interests.", |
1018 "items": { | 1046 "items": { |
1019 "$ref": "Interest" | 1047 "$ref": "Interest" |
1020 }, | 1048 }, |
1021 "type": "array" | 1049 "type": "array" |
1022 }, | 1050 }, |
1023 "resourceName": { | |
1024 "description": "The resource name for the person, assigned b
y the server. An ASCII string\nwith a max length of 27 characters, in the form o
f\n`people/`<var>person_id</var>.", | |
1025 "type": "string" | |
1026 }, | |
1027 "biographies": { | 1051 "biographies": { |
1028 "description": "The person's biographies.", | 1052 "description": "The person's biographies.", |
1029 "items": { | 1053 "items": { |
1030 "$ref": "Biography" | 1054 "$ref": "Biography" |
1031 }, | 1055 }, |
1032 "type": "array" | 1056 "type": "array" |
1033 }, | 1057 }, |
1034 "skills": { | 1058 "skills": { |
1035 "description": "The person's skills.", | 1059 "description": "The person's skills.", |
1036 "items": { | 1060 "items": { |
(...skipping 65 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1102 "$ref": "Membership" | 1126 "$ref": "Membership" |
1103 }, | 1127 }, |
1104 "type": "array" | 1128 "type": "array" |
1105 }, | 1129 }, |
1106 "phoneNumbers": { | 1130 "phoneNumbers": { |
1107 "description": "The person's phone numbers.", | 1131 "description": "The person's phone numbers.", |
1108 "items": { | 1132 "items": { |
1109 "$ref": "PhoneNumber" | 1133 "$ref": "PhoneNumber" |
1110 }, | 1134 }, |
1111 "type": "array" | 1135 "type": "array" |
| 1136 }, |
| 1137 "coverPhotos": { |
| 1138 "description": "The person's read-only cover photos.", |
| 1139 "items": { |
| 1140 "$ref": "CoverPhoto" |
| 1141 }, |
| 1142 "type": "array" |
| 1143 }, |
| 1144 "imClients": { |
| 1145 "description": "The person's instant messaging clients.", |
| 1146 "items": { |
| 1147 "$ref": "ImClient" |
| 1148 }, |
| 1149 "type": "array" |
1112 } | 1150 } |
1113 }, | 1151 }, |
1114 "type": "object" | 1152 "type": "object" |
1115 }, | 1153 }, |
1116 "UpdateContactGroupRequest": { | 1154 "UpdateContactGroupRequest": { |
1117 "description": "A request to update an existing contact group. Only
the name can be updated.", | 1155 "description": "A request to update an existing contact group. Only
the name can be updated.", |
1118 "id": "UpdateContactGroupRequest", | 1156 "id": "UpdateContactGroupRequest", |
1119 "properties": { | 1157 "properties": { |
1120 "contactGroup": { | 1158 "contactGroup": { |
1121 "$ref": "ContactGroup", | 1159 "$ref": "ContactGroup", |
(...skipping 15 matching lines...) Expand all Loading... |
1137 "description": "True if the contact group resource has been
deleted. Populated only for\n[`ListContactGroups`](/people/api/rest/v1/contactgr
oups/list) requests\nthat include a sync token.", | 1175 "description": "True if the contact group resource has been
deleted. Populated only for\n[`ListContactGroups`](/people/api/rest/v1/contactgr
oups/list) requests\nthat include a sync token.", |
1138 "type": "boolean" | 1176 "type": "boolean" |
1139 } | 1177 } |
1140 }, | 1178 }, |
1141 "type": "object" | 1179 "type": "object" |
1142 }, | 1180 }, |
1143 "Residence": { | 1181 "Residence": { |
1144 "description": "A person's past or current residence.", | 1182 "description": "A person's past or current residence.", |
1145 "id": "Residence", | 1183 "id": "Residence", |
1146 "properties": { | 1184 "properties": { |
| 1185 "metadata": { |
| 1186 "$ref": "FieldMetadata", |
| 1187 "description": "Metadata about the residence." |
| 1188 }, |
1147 "current": { | 1189 "current": { |
1148 "description": "True if the residence is the person's curren
t residence;\nfalse if the residence is a past residence.", | 1190 "description": "True if the residence is the person's curren
t residence;\nfalse if the residence is a past residence.", |
1149 "type": "boolean" | 1191 "type": "boolean" |
1150 }, | 1192 }, |
1151 "metadata": { | |
1152 "$ref": "FieldMetadata", | |
1153 "description": "Metadata about the residence." | |
1154 }, | |
1155 "value": { | 1193 "value": { |
1156 "description": "The address of the residence.", | 1194 "description": "The address of the residence.", |
1157 "type": "string" | 1195 "type": "string" |
1158 } | 1196 } |
1159 }, | 1197 }, |
1160 "type": "object" | 1198 "type": "object" |
1161 }, | 1199 }, |
1162 "Event": { | 1200 "Event": { |
1163 "description": "An event related to the person.", | 1201 "description": "An event related to the person.", |
1164 "id": "Event", | 1202 "id": "Event", |
1165 "properties": { | 1203 "properties": { |
| 1204 "metadata": { |
| 1205 "$ref": "FieldMetadata", |
| 1206 "description": "Metadata about the event." |
| 1207 }, |
| 1208 "type": { |
| 1209 "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`", |
| 1210 "type": "string" |
| 1211 }, |
1166 "date": { | 1212 "date": { |
1167 "$ref": "Date", | 1213 "$ref": "Date", |
1168 "description": "The date of the event." | 1214 "description": "The date of the event." |
1169 }, | 1215 }, |
1170 "formattedType": { | 1216 "formattedType": { |
1171 "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.", | 1217 "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.", |
1172 "type": "string" | 1218 "type": "string" |
1173 }, | |
1174 "type": { | |
1175 "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`", | |
1176 "type": "string" | |
1177 }, | |
1178 "metadata": { | |
1179 "$ref": "FieldMetadata", | |
1180 "description": "Metadata about the event." | |
1181 } | 1219 } |
1182 }, | 1220 }, |
1183 "type": "object" | 1221 "type": "object" |
1184 }, | 1222 }, |
1185 "ModifyContactGroupMembersResponse": { | 1223 "ModifyContactGroupMembersResponse": { |
1186 "description": "The response to a modify contact group members reque
st.", | 1224 "description": "The response to a modify contact group members reque
st.", |
1187 "id": "ModifyContactGroupMembersResponse", | 1225 "id": "ModifyContactGroupMembersResponse", |
1188 "properties": { | 1226 "properties": { |
1189 "notFoundResourceNames": { | 1227 "notFoundResourceNames": { |
1190 "description": "The contact people resource names that were
not found.", | 1228 "description": "The contact people resource names that were
not found.", |
1191 "items": { | 1229 "items": { |
1192 "type": "string" | 1230 "type": "string" |
1193 }, | 1231 }, |
1194 "type": "array" | 1232 "type": "array" |
1195 } | 1233 } |
1196 }, | 1234 }, |
1197 "type": "object" | 1235 "type": "object" |
1198 }, | 1236 }, |
1199 "ProfileMetadata": { | 1237 "ProfileMetadata": { |
1200 "description": "The read-only metadata about a profile.", | 1238 "description": "The read-only metadata about a profile.", |
1201 "id": "ProfileMetadata", | 1239 "id": "ProfileMetadata", |
1202 "properties": { | 1240 "properties": { |
1203 "objectType": { | |
1204 "description": "The profile object type.", | |
1205 "enum": [ | |
1206 "OBJECT_TYPE_UNSPECIFIED", | |
1207 "PERSON", | |
1208 "PAGE" | |
1209 ], | |
1210 "enumDescriptions": [ | |
1211 "Unspecified.", | |
1212 "Person.", | |
1213 "[Google+ Page.](http://www.google.com/+/brands/)" | |
1214 ], | |
1215 "type": "string" | |
1216 }, | |
1217 "userTypes": { | 1241 "userTypes": { |
1218 "description": "The user types.", | 1242 "description": "The user types.", |
1219 "enumDescriptions": [ | 1243 "enumDescriptions": [ |
1220 "The user type is not known.", | 1244 "The user type is not known.", |
1221 "The user is a Google user.", | 1245 "The user is a Google user.", |
1222 "The user is a Google+ user.", | 1246 "The user is a Google+ user.", |
1223 "The user is a Google Apps for Work user." | 1247 "The user is a Google Apps for Work user." |
1224 ], | 1248 ], |
1225 "items": { | 1249 "items": { |
1226 "enum": [ | 1250 "enum": [ |
1227 "USER_TYPE_UNKNOWN", | 1251 "USER_TYPE_UNKNOWN", |
1228 "GOOGLE_USER", | 1252 "GOOGLE_USER", |
1229 "GPLUS_USER", | 1253 "GPLUS_USER", |
1230 "GOOGLE_APPS_USER" | 1254 "GOOGLE_APPS_USER" |
1231 ], | 1255 ], |
1232 "type": "string" | 1256 "type": "string" |
1233 }, | 1257 }, |
1234 "type": "array" | 1258 "type": "array" |
| 1259 }, |
| 1260 "objectType": { |
| 1261 "description": "The profile object type.", |
| 1262 "enum": [ |
| 1263 "OBJECT_TYPE_UNSPECIFIED", |
| 1264 "PERSON", |
| 1265 "PAGE" |
| 1266 ], |
| 1267 "enumDescriptions": [ |
| 1268 "Unspecified.", |
| 1269 "Person.", |
| 1270 "[Google+ Page.](http://www.google.com/+/brands/)" |
| 1271 ], |
| 1272 "type": "string" |
1235 } | 1273 } |
1236 }, | 1274 }, |
1237 "type": "object" | 1275 "type": "object" |
1238 }, | 1276 }, |
1239 "Gender": { | 1277 "Gender": { |
1240 "description": "A person's gender.", | 1278 "description": "A person's gender.", |
1241 "id": "Gender", | 1279 "id": "Gender", |
1242 "properties": { | 1280 "properties": { |
| 1281 "formattedValue": { |
| 1282 "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.", |
| 1283 "type": "string" |
| 1284 }, |
1243 "metadata": { | 1285 "metadata": { |
1244 "$ref": "FieldMetadata", | 1286 "$ref": "FieldMetadata", |
1245 "description": "Metadata about the gender." | 1287 "description": "Metadata about the gender." |
1246 }, | 1288 }, |
1247 "value": { | 1289 "value": { |
1248 "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`", | 1290 "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`", |
1249 "type": "string" | 1291 "type": "string" |
1250 }, | |
1251 "formattedValue": { | |
1252 "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.", | |
1253 "type": "string" | |
1254 } | 1292 } |
1255 }, | 1293 }, |
1256 "type": "object" | 1294 "type": "object" |
1257 }, | 1295 }, |
1258 "CoverPhoto": { | 1296 "CoverPhoto": { |
1259 "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.", | 1297 "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.", |
1260 "id": "CoverPhoto", | 1298 "id": "CoverPhoto", |
1261 "properties": { | 1299 "properties": { |
1262 "url": { | 1300 "metadata": { |
1263 "description": "The URL of the cover photo.", | 1301 "$ref": "FieldMetadata", |
1264 "type": "string" | 1302 "description": "Metadata about the cover photo." |
1265 }, | 1303 }, |
1266 "default": { | 1304 "default": { |
1267 "description": "True if the cover photo is the default cover
photo;\nfalse if the cover photo is a user-provided cover photo.", | 1305 "description": "True if the cover photo is the default cover
photo;\nfalse if the cover photo is a user-provided cover photo.", |
1268 "type": "boolean" | 1306 "type": "boolean" |
1269 }, | 1307 }, |
1270 "metadata": { | 1308 "url": { |
1271 "$ref": "FieldMetadata", | 1309 "description": "The URL of the cover photo.", |
1272 "description": "Metadata about the cover photo." | 1310 "type": "string" |
1273 } | 1311 } |
1274 }, | 1312 }, |
1275 "type": "object" | 1313 "type": "object" |
1276 }, | 1314 }, |
1277 "Interest": { | 1315 "Interest": { |
1278 "description": "One of the person's interests.", | 1316 "description": "One of the person's interests.", |
1279 "id": "Interest", | 1317 "id": "Interest", |
1280 "properties": { | 1318 "properties": { |
1281 "metadata": { | 1319 "metadata": { |
1282 "$ref": "FieldMetadata", | 1320 "$ref": "FieldMetadata", |
1283 "description": "Metadata about the interest." | 1321 "description": "Metadata about the interest." |
1284 }, | 1322 }, |
1285 "value": { | 1323 "value": { |
1286 "description": "The interest; for example, `stargazing`.", | 1324 "description": "The interest; for example, `stargazing`.", |
1287 "type": "string" | 1325 "type": "string" |
1288 } | 1326 } |
1289 }, | 1327 }, |
1290 "type": "object" | 1328 "type": "object" |
1291 }, | 1329 }, |
1292 "EmailAddress": { | 1330 "EmailAddress": { |
1293 "description": "A person's email address.", | 1331 "description": "A person's email address.", |
1294 "id": "EmailAddress", | 1332 "id": "EmailAddress", |
1295 "properties": { | 1333 "properties": { |
| 1334 "displayName": { |
| 1335 "description": "The display name of the email.", |
| 1336 "type": "string" |
| 1337 }, |
| 1338 "metadata": { |
| 1339 "$ref": "FieldMetadata", |
| 1340 "description": "Metadata about the email address." |
| 1341 }, |
| 1342 "type": { |
| 1343 "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`", |
| 1344 "type": "string" |
| 1345 }, |
1296 "value": { | 1346 "value": { |
1297 "description": "The email address.", | 1347 "description": "The email address.", |
1298 "type": "string" | 1348 "type": "string" |
1299 }, | 1349 }, |
1300 "formattedType": { | 1350 "formattedType": { |
1301 "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.", | 1351 "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.", |
1302 "type": "string" | 1352 "type": "string" |
1303 }, | |
1304 "displayName": { | |
1305 "description": "The display name of the email.", | |
1306 "type": "string" | |
1307 }, | |
1308 "type": { | |
1309 "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`", | |
1310 "type": "string" | |
1311 }, | |
1312 "metadata": { | |
1313 "$ref": "FieldMetadata", | |
1314 "description": "Metadata about the email address." | |
1315 } | 1353 } |
1316 }, | 1354 }, |
1317 "type": "object" | 1355 "type": "object" |
1318 }, | 1356 }, |
1319 "Nickname": { | 1357 "Nickname": { |
1320 "description": "A person's nickname.", | 1358 "description": "A person's nickname.", |
1321 "id": "Nickname", | 1359 "id": "Nickname", |
1322 "properties": { | 1360 "properties": { |
| 1361 "metadata": { |
| 1362 "$ref": "FieldMetadata", |
| 1363 "description": "Metadata about the nickname." |
| 1364 }, |
1323 "type": { | 1365 "type": { |
1324 "description": "The type of the nickname.", | 1366 "description": "The type of the nickname.", |
1325 "enum": [ | 1367 "enum": [ |
1326 "DEFAULT", | 1368 "DEFAULT", |
1327 "MAIDEN_NAME", | 1369 "MAIDEN_NAME", |
1328 "INITIALS", | 1370 "INITIALS", |
1329 "GPLUS", | 1371 "GPLUS", |
1330 "OTHER_NAME" | 1372 "OTHER_NAME" |
1331 ], | 1373 ], |
1332 "enumDescriptions": [ | 1374 "enumDescriptions": [ |
1333 "Generic nickname.", | 1375 "Generic nickname.", |
1334 "Maiden name or birth family name. Used when the person'
s family name has\nchanged as a result of marriage.", | 1376 "Maiden name or birth family name. Used when the person'
s family name has\nchanged as a result of marriage.", |
1335 "Initials.", | 1377 "Initials.", |
1336 "Google+ profile nickname.", | 1378 "Google+ profile nickname.", |
1337 "A professional affiliation or other name; for example,
`Dr. Smith.`" | 1379 "A professional affiliation or other name; for example,
`Dr. Smith.`" |
1338 ], | 1380 ], |
1339 "type": "string" | 1381 "type": "string" |
1340 }, | 1382 }, |
1341 "metadata": { | |
1342 "$ref": "FieldMetadata", | |
1343 "description": "Metadata about the nickname." | |
1344 }, | |
1345 "value": { | 1383 "value": { |
1346 "description": "The nickname.", | 1384 "description": "The nickname.", |
1347 "type": "string" | 1385 "type": "string" |
1348 } | 1386 } |
1349 }, | 1387 }, |
1350 "type": "object" | 1388 "type": "object" |
1351 }, | 1389 }, |
1352 "Skill": { | 1390 "Skill": { |
1353 "description": "A skill that the person has.", | 1391 "description": "A skill that the person has.", |
1354 "id": "Skill", | 1392 "id": "Skill", |
(...skipping 21 matching lines...) Expand all Loading... |
1376 "description": "The tagline.", | 1414 "description": "The tagline.", |
1377 "type": "string" | 1415 "type": "string" |
1378 } | 1416 } |
1379 }, | 1417 }, |
1380 "type": "object" | 1418 "type": "object" |
1381 }, | 1419 }, |
1382 "Date": { | 1420 "Date": { |
1383 "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
.", | 1421 "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
.", |
1384 "id": "Date", | 1422 "id": "Date", |
1385 "properties": { | 1423 "properties": { |
1386 "month": { | 1424 "year": { |
1387 "description": "Month of year. Must be from 1 to 12.", | 1425 "description": "Year of date. Must be from 1 to 9999, or 0 i
f specifying a date without\na year.", |
1388 "format": "int32", | 1426 "format": "int32", |
1389 "type": "integer" | 1427 "type": "integer" |
1390 }, | 1428 }, |
1391 "day": { | 1429 "day": { |
1392 "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.", | 1430 "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.", |
1393 "format": "int32", | 1431 "format": "int32", |
1394 "type": "integer" | 1432 "type": "integer" |
1395 }, | 1433 }, |
1396 "year": { | 1434 "month": { |
1397 "description": "Year of date. Must be from 1 to 9999, or 0 i
f specifying a date without\na year.", | 1435 "description": "Month of year. Must be from 1 to 12.", |
1398 "format": "int32", | 1436 "format": "int32", |
1399 "type": "integer" | 1437 "type": "integer" |
1400 } | 1438 } |
1401 }, | 1439 }, |
1402 "type": "object" | 1440 "type": "object" |
1403 }, | 1441 }, |
1404 "Name": { | 1442 "Name": { |
1405 "description": "A person's name. If the name is a mononym, the famil
y name is empty.", | 1443 "description": "A person's name. If the name is a mononym, the famil
y name is empty.", |
1406 "id": "Name", | 1444 "id": "Name", |
1407 "properties": { | 1445 "properties": { |
1408 "displayName": { | 1446 "middleName": { |
1409 "description": "The read-only display name formatted accordi
ng to the locale specified by\nthe viewer's account or the `Accept-Language` HTT
P header.", | 1447 "description": "The middle name(s).", |
1410 "type": "string" | |
1411 }, | |
1412 "honorificSuffix": { | |
1413 "description": "The honorific suffixes, such as `Jr.`", | |
1414 "type": "string" | |
1415 }, | |
1416 "honorificPrefix": { | |
1417 "description": "The honorific prefixes, such as `Mrs.` or `D
r.`", | |
1418 "type": "string" | |
1419 }, | |
1420 "phoneticHonorificSuffix": { | |
1421 "description": "The honorific suffixes spelled as they sound
.", | |
1422 "type": "string" | 1448 "type": "string" |
1423 }, | 1449 }, |
1424 "givenName": { | 1450 "givenName": { |
1425 "description": "The given name.", | 1451 "description": "The given name.", |
1426 "type": "string" | 1452 "type": "string" |
1427 }, | 1453 }, |
1428 "middleName": { | |
1429 "description": "The middle name(s).", | |
1430 "type": "string" | |
1431 }, | |
1432 "phoneticHonorificPrefix": { | 1454 "phoneticHonorificPrefix": { |
1433 "description": "The honorific prefixes spelled as they sound
.", | 1455 "description": "The honorific prefixes spelled as they sound
.", |
1434 "type": "string" | 1456 "type": "string" |
1435 }, | 1457 }, |
1436 "phoneticGivenName": { | 1458 "phoneticGivenName": { |
1437 "description": "The given name spelled as it sounds.", | 1459 "description": "The given name spelled as it sounds.", |
1438 "type": "string" | 1460 "type": "string" |
1439 }, | 1461 }, |
1440 "phoneticFamilyName": { | 1462 "phoneticFamilyName": { |
1441 "description": "The family name spelled as it sounds.", | 1463 "description": "The family name spelled as it sounds.", |
(...skipping 11 matching lines...) Expand all Loading... |
1453 "$ref": "FieldMetadata", | 1475 "$ref": "FieldMetadata", |
1454 "description": "Metadata about the name." | 1476 "description": "Metadata about the name." |
1455 }, | 1477 }, |
1456 "phoneticFullName": { | 1478 "phoneticFullName": { |
1457 "description": "The full name spelled as it sounds.", | 1479 "description": "The full name spelled as it sounds.", |
1458 "type": "string" | 1480 "type": "string" |
1459 }, | 1481 }, |
1460 "displayNameLastFirst": { | 1482 "displayNameLastFirst": { |
1461 "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`Accept-Language` HTTP header.", | 1483 "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`Accept-Language` HTTP header.", |
1462 "type": "string" | 1484 "type": "string" |
| 1485 }, |
| 1486 "displayName": { |
| 1487 "description": "The read-only display name formatted accordi
ng to the locale specified by\nthe viewer's account or the `Accept-Language` HTT
P header.", |
| 1488 "type": "string" |
| 1489 }, |
| 1490 "honorificSuffix": { |
| 1491 "description": "The honorific suffixes, such as `Jr.`", |
| 1492 "type": "string" |
| 1493 }, |
| 1494 "honorificPrefix": { |
| 1495 "description": "The honorific prefixes, such as `Mrs.` or `D
r.`", |
| 1496 "type": "string" |
| 1497 }, |
| 1498 "phoneticHonorificSuffix": { |
| 1499 "description": "The honorific suffixes spelled as they sound
.", |
| 1500 "type": "string" |
1463 } | 1501 } |
1464 }, | 1502 }, |
1465 "type": "object" | 1503 "type": "object" |
1466 }, | 1504 }, |
1467 "Locale": { | 1505 "Locale": { |
1468 "description": "A person's locale preference.", | 1506 "description": "A person's locale preference.", |
1469 "id": "Locale", | 1507 "id": "Locale", |
1470 "properties": { | 1508 "properties": { |
1471 "metadata": { | 1509 "metadata": { |
1472 "$ref": "FieldMetadata", | 1510 "$ref": "FieldMetadata", |
1473 "description": "Metadata about the locale." | 1511 "description": "Metadata about the locale." |
1474 }, | 1512 }, |
1475 "value": { | 1513 "value": { |
1476 "description": "The well-formed [IETF BCP 47](https://tools.
ietf.org/html/bcp47)\nlanguage tag representing the locale.", | 1514 "description": "The well-formed [IETF BCP 47](https://tools.
ietf.org/html/bcp47)\nlanguage tag representing the locale.", |
1477 "type": "string" | 1515 "type": "string" |
1478 } | 1516 } |
1479 }, | 1517 }, |
1480 "type": "object" | 1518 "type": "object" |
1481 }, | 1519 }, |
1482 "Empty": { | 1520 "Empty": { |
1483 "description": "A generic empty message that you can re-use to avoid
defining duplicated\nempty messages in your APIs. A typical example is to use i
t as the request\nor the response type of an API method. For instance:\n\n se
rvice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty
);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.", | 1521 "description": "A generic empty message that you can re-use to avoid
defining duplicated\nempty messages in your APIs. A typical example is to use i
t as the request\nor the response type of an API method. For instance:\n\n se
rvice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty
);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.", |
1484 "id": "Empty", | 1522 "id": "Empty", |
1485 "properties": {}, | 1523 "properties": {}, |
1486 "type": "object" | 1524 "type": "object" |
1487 }, | 1525 }, |
| 1526 "UserDefined": { |
| 1527 "description": "Arbitrary user data that is populated by the end use
rs.", |
| 1528 "id": "UserDefined", |
| 1529 "properties": { |
| 1530 "metadata": { |
| 1531 "$ref": "FieldMetadata", |
| 1532 "description": "Metadata about the user defined data." |
| 1533 }, |
| 1534 "value": { |
| 1535 "description": "The end user specified value of the user def
ined data.", |
| 1536 "type": "string" |
| 1537 }, |
| 1538 "key": { |
| 1539 "description": "The end user specified key of the user defin
ed data.", |
| 1540 "type": "string" |
| 1541 } |
| 1542 }, |
| 1543 "type": "object" |
| 1544 }, |
1488 "Biography": { | 1545 "Biography": { |
1489 "description": "A person's short biography.", | 1546 "description": "A person's short biography.", |
1490 "id": "Biography", | 1547 "id": "Biography", |
1491 "properties": { | 1548 "properties": { |
1492 "contentType": { | 1549 "contentType": { |
1493 "description": "The content type of the biography.", | 1550 "description": "The content type of the biography.", |
1494 "enum": [ | 1551 "enum": [ |
1495 "CONTENT_TYPE_UNSPECIFIED", | 1552 "CONTENT_TYPE_UNSPECIFIED", |
1496 "TEXT_PLAIN", | 1553 "TEXT_PLAIN", |
1497 "TEXT_HTML" | 1554 "TEXT_HTML" |
(...skipping 32 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1530 "$ref": "Source", | 1587 "$ref": "Source", |
1531 "description": "The source of the field." | 1588 "description": "The source of the field." |
1532 } | 1589 } |
1533 }, | 1590 }, |
1534 "type": "object" | 1591 "type": "object" |
1535 }, | 1592 }, |
1536 "Source": { | 1593 "Source": { |
1537 "description": "The source of a field.", | 1594 "description": "The source of a field.", |
1538 "id": "Source", | 1595 "id": "Source", |
1539 "properties": { | 1596 "properties": { |
1540 "etag": { | |
1541 "description": "**Only populated in `person.metadata.sources
`.**\n\nThe [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the\ns
ource. Used for web cache validation.", | |
1542 "type": "string" | |
1543 }, | |
1544 "id": { | |
1545 "description": "The unique identifier within the source type
generated by the server.", | |
1546 "type": "string" | |
1547 }, | |
1548 "profileMetadata": { | |
1549 "$ref": "ProfileMetadata", | |
1550 "description": "**Only populated in `person.metadata.sources
`.**\n\nMetadata about a source of type PROFILE." | |
1551 }, | |
1552 "updateTime": { | |
1553 "description": "**Only populated in `person.metadata.sources
`.**\n\nLast update timestamp of this source.", | |
1554 "format": "google-datetime", | |
1555 "type": "string" | |
1556 }, | |
1557 "type": { | 1597 "type": { |
1558 "description": "The source type.", | 1598 "description": "The source type.", |
1559 "enum": [ | 1599 "enum": [ |
1560 "SOURCE_TYPE_UNSPECIFIED", | 1600 "SOURCE_TYPE_UNSPECIFIED", |
1561 "ACCOUNT", | 1601 "ACCOUNT", |
1562 "PROFILE", | 1602 "PROFILE", |
1563 "DOMAIN_PROFILE", | 1603 "DOMAIN_PROFILE", |
1564 "CONTACT" | 1604 "CONTACT" |
1565 ], | 1605 ], |
1566 "enumDescriptions": [ | 1606 "enumDescriptions": [ |
1567 "Unspecified.", | 1607 "Unspecified.", |
1568 "[Google Account](https://accounts.google.com).", | 1608 "[Google Account](https://accounts.google.com).", |
1569 "[Google profile](https://profiles.google.com). You can
view the\nprofile at https://profiles.google.com/<var>id</var> where\n<var>id</v
ar> is the source id.", | 1609 "[Google profile](https://profiles.google.com). You can
view the\nprofile at https://profiles.google.com/<var>id</var> where\n<var>id</v
ar> is the source id.", |
1570 "[Google Apps domain profile](https://admin.google.com).
", | 1610 "[Google Apps domain profile](https://admin.google.com).
", |
1571 "[Google contact](https://contacts.google.com). You can
view the\ncontact at https://contact.google.com/<var>id</var> where <var>id</var
>\nis the source id." | 1611 "[Google contact](https://contacts.google.com). You can
view the\ncontact at https://contact.google.com/<var>id</var> where <var>id</var
>\nis the source id." |
1572 ], | 1612 ], |
1573 "type": "string" | 1613 "type": "string" |
| 1614 }, |
| 1615 "etag": { |
| 1616 "description": "**Only populated in `person.metadata.sources
`.**\n\nThe [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the\ns
ource. Used for web cache validation.", |
| 1617 "type": "string" |
| 1618 }, |
| 1619 "id": { |
| 1620 "description": "The unique identifier within the source type
generated by the server.", |
| 1621 "type": "string" |
| 1622 }, |
| 1623 "profileMetadata": { |
| 1624 "$ref": "ProfileMetadata", |
| 1625 "description": "**Only populated in `person.metadata.sources
`.**\n\nMetadata about a source of type PROFILE." |
| 1626 }, |
| 1627 "updateTime": { |
| 1628 "description": "**Only populated in `person.metadata.sources
`.**\n\nLast update timestamp of this source.", |
| 1629 "format": "google-datetime", |
| 1630 "type": "string" |
1574 } | 1631 } |
1575 }, | 1632 }, |
1576 "type": "object" | 1633 "type": "object" |
1577 }, | 1634 }, |
1578 "RelationshipInterest": { | 1635 "RelationshipInterest": { |
1579 "description": "A person's read-only relationship interest .", | 1636 "description": "A person's read-only relationship interest .", |
1580 "id": "RelationshipInterest", | 1637 "id": "RelationshipInterest", |
1581 "properties": { | 1638 "properties": { |
1582 "formattedValue": { | 1639 "formattedValue": { |
1583 "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.", | 1640 "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.", |
(...skipping 16 matching lines...) Expand all Loading... |
1600 "responses": { | 1657 "responses": { |
1601 "description": "The response for each requested resource nam
e.", | 1658 "description": "The response for each requested resource nam
e.", |
1602 "items": { | 1659 "items": { |
1603 "$ref": "PersonResponse" | 1660 "$ref": "PersonResponse" |
1604 }, | 1661 }, |
1605 "type": "array" | 1662 "type": "array" |
1606 } | 1663 } |
1607 }, | 1664 }, |
1608 "type": "object" | 1665 "type": "object" |
1609 }, | 1666 }, |
1610 "Photo": { | |
1611 "description": "A person's read-only photo. A picture shown next to
the person's name to\nhelp others recognize the person.", | |
1612 "id": "Photo", | |
1613 "properties": { | |
1614 "metadata": { | |
1615 "$ref": "FieldMetadata", | |
1616 "description": "Metadata about the photo." | |
1617 }, | |
1618 "url": { | |
1619 "description": "The URL of the photo. You can change the des
ired size by appending a query\nparameter `sz=`<var>size</var> at the end of the
url. Example:\n`https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAA
AAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50`", | |
1620 "type": "string" | |
1621 } | |
1622 }, | |
1623 "type": "object" | |
1624 }, | |
1625 "PhoneNumber": { | 1667 "PhoneNumber": { |
1626 "description": "A person's phone number.", | 1668 "description": "A person's phone number.", |
1627 "id": "PhoneNumber", | 1669 "id": "PhoneNumber", |
1628 "properties": { | 1670 "properties": { |
| 1671 "value": { |
| 1672 "description": "The phone number.", |
| 1673 "type": "string" |
| 1674 }, |
1629 "formattedType": { | 1675 "formattedType": { |
1630 "description": "The read-only type of the phone number trans
lated and formatted in the\nviewer's account locale or the `Accept-Language` HTT
P header locale.", | 1676 "description": "The read-only type of the phone number trans
lated and formatted in the\nviewer's account locale or the `Accept-Language` HTT
P header locale.", |
1631 "type": "string" | 1677 "type": "string" |
1632 }, | 1678 }, |
1633 "canonicalForm": { | 1679 "canonicalForm": { |
1634 "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.", | 1680 "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.", |
1635 "type": "string" | 1681 "type": "string" |
1636 }, | 1682 }, |
1637 "type": { | |
1638 "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`", | |
1639 "type": "string" | |
1640 }, | |
1641 "metadata": { | 1683 "metadata": { |
1642 "$ref": "FieldMetadata", | 1684 "$ref": "FieldMetadata", |
1643 "description": "Metadata about the phone number." | 1685 "description": "Metadata about the phone number." |
1644 }, | 1686 }, |
1645 "value": { | 1687 "type": { |
1646 "description": "The phone number.", | 1688 "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`", |
1647 "type": "string" | 1689 "type": "string" |
1648 } | 1690 } |
1649 }, | 1691 }, |
| 1692 "type": "object" |
| 1693 }, |
| 1694 "Photo": { |
| 1695 "description": "A person's read-only photo. A picture shown next to
the person's name to\nhelp others recognize the person.", |
| 1696 "id": "Photo", |
| 1697 "properties": { |
| 1698 "metadata": { |
| 1699 "$ref": "FieldMetadata", |
| 1700 "description": "Metadata about the photo." |
| 1701 }, |
| 1702 "url": { |
| 1703 "description": "The URL of the photo. You can change the des
ired size by appending a query\nparameter `sz=`<var>size</var> at the end of the
url. Example:\n`https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAA
AAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50`", |
| 1704 "type": "string" |
| 1705 } |
| 1706 }, |
1650 "type": "object" | 1707 "type": "object" |
1651 }, | 1708 }, |
1652 "ListConnectionsResponse": { | 1709 "ListConnectionsResponse": { |
1653 "id": "ListConnectionsResponse", | 1710 "id": "ListConnectionsResponse", |
1654 "properties": { | 1711 "properties": { |
| 1712 "totalPeople": { |
| 1713 "description": "**DEPRECATED** (Please use totalItems)\nThe
total number of people in the list without pagination.", |
| 1714 "format": "int32", |
| 1715 "type": "integer" |
| 1716 }, |
1655 "nextPageToken": { | 1717 "nextPageToken": { |
1656 "description": "The token that can be used to retrieve the n
ext page of results.", | 1718 "description": "The token that can be used to retrieve the n
ext page of results.", |
1657 "type": "string" | 1719 "type": "string" |
1658 }, | 1720 }, |
1659 "totalItems": { | |
1660 "description": "The total number of items in the list withou
t pagination.", | |
1661 "format": "int32", | |
1662 "type": "integer" | |
1663 }, | |
1664 "nextSyncToken": { | |
1665 "description": "The token that can be used to retrieve chang
es since the last request.", | |
1666 "type": "string" | |
1667 }, | |
1668 "connections": { | 1721 "connections": { |
1669 "description": "The list of people that the requestor is con
nected to.", | 1722 "description": "The list of people that the requestor is con
nected to.", |
1670 "items": { | 1723 "items": { |
1671 "$ref": "Person" | 1724 "$ref": "Person" |
1672 }, | 1725 }, |
1673 "type": "array" | 1726 "type": "array" |
1674 }, | 1727 }, |
1675 "totalPeople": { | 1728 "nextSyncToken": { |
1676 "description": "**DEPRECATED** (Please use totalItems)\nThe
total number of people in the list without pagination.", | 1729 "description": "The token that can be used to retrieve chang
es since the last request.", |
| 1730 "type": "string" |
| 1731 }, |
| 1732 "totalItems": { |
| 1733 "description": "The total number of items in the list withou
t pagination.", |
1677 "format": "int32", | 1734 "format": "int32", |
1678 "type": "integer" | 1735 "type": "integer" |
1679 } | 1736 } |
1680 }, | 1737 }, |
1681 "type": "object" | 1738 "type": "object" |
1682 }, | 1739 }, |
1683 "Birthday": { | 1740 "Birthday": { |
1684 "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.", | 1741 "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.", |
1685 "id": "Birthday", | 1742 "id": "Birthday", |
1686 "properties": { | 1743 "properties": { |
| 1744 "metadata": { |
| 1745 "$ref": "FieldMetadata", |
| 1746 "description": "Metadata about the birthday." |
| 1747 }, |
1687 "text": { | 1748 "text": { |
1688 "description": "A free-form string representing the user's b
irthday.", | 1749 "description": "A free-form string representing the user's b
irthday.", |
1689 "type": "string" | 1750 "type": "string" |
1690 }, | 1751 }, |
1691 "metadata": { | |
1692 "$ref": "FieldMetadata", | |
1693 "description": "Metadata about the birthday." | |
1694 }, | |
1695 "date": { | 1752 "date": { |
1696 "$ref": "Date", | 1753 "$ref": "Date", |
1697 "description": "The date of the birthday." | 1754 "description": "The date of the birthday." |
1698 } | 1755 } |
1699 }, | 1756 }, |
1700 "type": "object" | 1757 "type": "object" |
1701 }, | 1758 }, |
1702 "CreateContactGroupRequest": { | 1759 "CreateContactGroupRequest": { |
1703 "description": "A request to create a new contact group.", | 1760 "description": "A request to create a new contact group.", |
1704 "id": "CreateContactGroupRequest", | 1761 "id": "CreateContactGroupRequest", |
1705 "properties": { | 1762 "properties": { |
1706 "contactGroup": { | 1763 "contactGroup": { |
1707 "$ref": "ContactGroup", | 1764 "$ref": "ContactGroup", |
1708 "description": "The contact group to create." | 1765 "description": "The contact group to create." |
1709 } | 1766 } |
1710 }, | 1767 }, |
1711 "type": "object" | 1768 "type": "object" |
1712 }, | 1769 }, |
1713 "Address": { | 1770 "Address": { |
1714 "description": "A person's physical address. May be a P.O. box or st
reet address. All fields\nare optional.", | 1771 "description": "A person's physical address. May be a P.O. box or st
reet address. All fields\nare optional.", |
1715 "id": "Address", | 1772 "id": "Address", |
1716 "properties": { | 1773 "properties": { |
1717 "extendedAddress": { | |
1718 "description": "The extended address of the address; for exa
mple, the apartment number.", | |
1719 "type": "string" | |
1720 }, | |
1721 "poBox": { | |
1722 "description": "The P.O. box of the address.", | |
1723 "type": "string" | |
1724 }, | |
1725 "postalCode": { | |
1726 "description": "The postal code of the address.", | |
1727 "type": "string" | |
1728 }, | |
1729 "region": { | |
1730 "description": "The region of the address; for example, the
state or province.", | |
1731 "type": "string" | |
1732 }, | |
1733 "streetAddress": { | |
1734 "description": "The street address.", | |
1735 "type": "string" | |
1736 }, | |
1737 "metadata": { | |
1738 "$ref": "FieldMetadata", | |
1739 "description": "Metadata about the address." | |
1740 }, | |
1741 "countryCode": { | 1774 "countryCode": { |
1742 "description": "The [ISO 3166-1 alpha-2](http://www.iso.org/
iso/country_codes.htm) country\ncode of the address.", | 1775 "description": "The [ISO 3166-1 alpha-2](http://www.iso.org/
iso/country_codes.htm) country\ncode of the address.", |
1743 "type": "string" | 1776 "type": "string" |
1744 }, | 1777 }, |
1745 "formattedType": { | 1778 "formattedType": { |
1746 "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.", | 1779 "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.", |
1747 "type": "string" | 1780 "type": "string" |
1748 }, | 1781 }, |
1749 "city": { | 1782 "city": { |
1750 "description": "The city of the address.", | 1783 "description": "The city of the address.", |
1751 "type": "string" | 1784 "type": "string" |
1752 }, | 1785 }, |
1753 "formattedValue": { | 1786 "formattedValue": { |
1754 "description": "The unstructured value of the address. If th
is is not set by the user it\nwill be automatically constructed from structured
values.", | 1787 "description": "The unstructured value of the address. If th
is is not set by the user it\nwill be automatically constructed from structured
values.", |
1755 "type": "string" | 1788 "type": "string" |
1756 }, | 1789 }, |
1757 "country": { | 1790 "country": { |
1758 "description": "The country of the address.", | 1791 "description": "The country of the address.", |
1759 "type": "string" | 1792 "type": "string" |
1760 }, | 1793 }, |
1761 "type": { | 1794 "type": { |
1762 "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`", | 1795 "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`", |
1763 "type": "string" | 1796 "type": "string" |
| 1797 }, |
| 1798 "extendedAddress": { |
| 1799 "description": "The extended address of the address; for exa
mple, the apartment number.", |
| 1800 "type": "string" |
| 1801 }, |
| 1802 "poBox": { |
| 1803 "description": "The P.O. box of the address.", |
| 1804 "type": "string" |
| 1805 }, |
| 1806 "postalCode": { |
| 1807 "description": "The postal code of the address.", |
| 1808 "type": "string" |
| 1809 }, |
| 1810 "region": { |
| 1811 "description": "The region of the address; for example, the
state or province.", |
| 1812 "type": "string" |
| 1813 }, |
| 1814 "streetAddress": { |
| 1815 "description": "The street address.", |
| 1816 "type": "string" |
| 1817 }, |
| 1818 "metadata": { |
| 1819 "$ref": "FieldMetadata", |
| 1820 "description": "Metadata about the address." |
1764 } | 1821 } |
1765 }, | 1822 }, |
1766 "type": "object" | 1823 "type": "object" |
1767 }, | |
1768 "ContactGroupMembership": { | |
1769 "description": "A Google contact group membership.", | |
1770 "id": "ContactGroupMembership", | |
1771 "properties": { | |
1772 "contactGroupId": { | |
1773 "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.", | |
1774 "type": "string" | |
1775 } | |
1776 }, | |
1777 "type": "object" | |
1778 }, | 1824 }, |
1779 "Status": { | 1825 "Status": { |
1780 "description": "The `Status` type defines a logical error model that
is suitable for different\nprogramming environments, including REST APIs and RP
C APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is desig
ned to be:\n\n- Simple to use and understand for most users\n- Flexible enough t
o meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pie
ces of data: error code, error message,\nand error details. The error code shoul
d be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes
if needed. The\nerror message should be a developer-facing English message tha
t helps\ndevelopers *understand* and *resolve* the error. If a localized user-fa
cing\nerror message is needed, put the localized message in the error details or
\nlocalize it in the client. The optional error details may contain arbitrary\ni
nformation about the error. There is a predefined set of error detail types\nin
the package `google.rpc` that can be used for common error conditions.\n\n# Lang
uage mapping\n\nThe `Status` message is the logical representation of the error
model, but it\nis not necessarily the actual wire format. When the `Status` mess
age is\nexposed in different client libraries and different wire protocols, it c
an be\nmapped differently. For example, it will likely be mapped to some excepti
ons\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n
\nThe error model and the `Status` message can be used in a variety of\nenvironm
ents, either with or without APIs, to provide a\nconsistent developer experience
across different environments.\n\nExample uses of this error model include:\n\n
- Partial errors. If a service needs to return partial errors to the client,\n
it may embed the `Status` in the normal response to indicate the partial\n
errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step m
ay\n have a `Status` message for error reporting.\n\n- Batch operations. If a
client uses batch request and batch response, the\n `Status` message should
be used directly inside batch response, one for\n each error sub-response.\n\
n- Asynchronous operations. If an API call embeds asynchronous operation\n re
sults in its response, the status of those operations should be\n represented
directly using the `Status` message.\n\n- Logging. If some API errors are store
d in logs, the message `Status` could\n be used directly after any stripping
needed for security/privacy reasons.", | 1826 "description": "The `Status` type defines a logical error model that
is suitable for different\nprogramming environments, including REST APIs and RP
C APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is desig
ned to be:\n\n- Simple to use and understand for most users\n- Flexible enough t
o meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pie
ces of data: error code, error message,\nand error details. The error code shoul
d be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes
if needed. The\nerror message should be a developer-facing English message tha
t helps\ndevelopers *understand* and *resolve* the error. If a localized user-fa
cing\nerror message is needed, put the localized message in the error details or
\nlocalize it in the client. The optional error details may contain arbitrary\ni
nformation about the error. There is a predefined set of error detail types\nin
the package `google.rpc` that can be used for common error conditions.\n\n# Lang
uage mapping\n\nThe `Status` message is the logical representation of the error
model, but it\nis not necessarily the actual wire format. When the `Status` mess
age is\nexposed in different client libraries and different wire protocols, it c
an be\nmapped differently. For example, it will likely be mapped to some excepti
ons\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n
\nThe error model and the `Status` message can be used in a variety of\nenvironm
ents, either with or without APIs, to provide a\nconsistent developer experience
across different environments.\n\nExample uses of this error model include:\n\n
- Partial errors. If a service needs to return partial errors to the client,\n
it may embed the `Status` in the normal response to indicate the partial\n
errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step m
ay\n have a `Status` message for error reporting.\n\n- Batch operations. If a
client uses batch request and batch response, the\n `Status` message should
be used directly inside batch response, one for\n each error sub-response.\n\
n- Asynchronous operations. If an API call embeds asynchronous operation\n re
sults in its response, the status of those operations should be\n represented
directly using the `Status` message.\n\n- Logging. If some API errors are store
d in logs, the message `Status` could\n be used directly after any stripping
needed for security/privacy reasons.", |
1781 "id": "Status", | 1827 "id": "Status", |
1782 "properties": { | 1828 "properties": { |
1783 "code": { | |
1784 "description": "The status code, which should be an enum val
ue of google.rpc.Code.", | |
1785 "format": "int32", | |
1786 "type": "integer" | |
1787 }, | |
1788 "message": { | |
1789 "description": "A developer-facing error message, which shou
ld be in English. Any\nuser-facing error message should be localized and sent in
the\ngoogle.rpc.Status.details field, or localized by the client.", | |
1790 "type": "string" | |
1791 }, | |
1792 "details": { | 1829 "details": { |
1793 "description": "A list of messages that carry the error deta
ils. There is a common set of\nmessage types for APIs to use.", | 1830 "description": "A list of messages that carry the error deta
ils. There is a common set of\nmessage types for APIs to use.", |
1794 "items": { | 1831 "items": { |
1795 "additionalProperties": { | 1832 "additionalProperties": { |
1796 "description": "Properties of the object. Contains f
ield @type with type URL.", | 1833 "description": "Properties of the object. Contains f
ield @type with type URL.", |
1797 "type": "any" | 1834 "type": "any" |
1798 }, | 1835 }, |
1799 "type": "object" | 1836 "type": "object" |
1800 }, | 1837 }, |
1801 "type": "array" | 1838 "type": "array" |
| 1839 }, |
| 1840 "code": { |
| 1841 "description": "The status code, which should be an enum val
ue of google.rpc.Code.", |
| 1842 "format": "int32", |
| 1843 "type": "integer" |
| 1844 }, |
| 1845 "message": { |
| 1846 "description": "A developer-facing error message, which shou
ld be in English. Any\nuser-facing error message should be localized and sent in
the\ngoogle.rpc.Status.details field, or localized by the client.", |
| 1847 "type": "string" |
1802 } | 1848 } |
1803 }, | 1849 }, |
1804 "type": "object" | 1850 "type": "object" |
| 1851 }, |
| 1852 "ContactGroupMembership": { |
| 1853 "description": "A Google contact group membership.", |
| 1854 "id": "ContactGroupMembership", |
| 1855 "properties": { |
| 1856 "contactGroupId": { |
| 1857 "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.", |
| 1858 "type": "string" |
| 1859 } |
| 1860 }, |
| 1861 "type": "object" |
1805 }, | 1862 }, |
1806 "PersonMetadata": { | 1863 "PersonMetadata": { |
1807 "description": "The read-only metadata about a person.", | 1864 "description": "The read-only metadata about a person.", |
1808 "id": "PersonMetadata", | 1865 "id": "PersonMetadata", |
1809 "properties": { | 1866 "properties": { |
1810 "previousResourceNames": { | 1867 "linkedPeopleResourceNames": { |
1811 "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.", | 1868 "description": "Resource names of people linked to this reso
urce.", |
1812 "items": { | 1869 "items": { |
1813 "type": "string" | 1870 "type": "string" |
1814 }, | 1871 }, |
1815 "type": "array" | 1872 "type": "array" |
1816 }, | 1873 }, |
1817 "sources": { | 1874 "sources": { |
1818 "description": "The sources of data for the person.", | 1875 "description": "The sources of data for the person.", |
1819 "items": { | 1876 "items": { |
1820 "$ref": "Source" | 1877 "$ref": "Source" |
1821 }, | 1878 }, |
1822 "type": "array" | 1879 "type": "array" |
1823 }, | 1880 }, |
| 1881 "previousResourceNames": { |
| 1882 "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.", |
| 1883 "items": { |
| 1884 "type": "string" |
| 1885 }, |
| 1886 "type": "array" |
| 1887 }, |
1824 "deleted": { | 1888 "deleted": { |
1825 "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.", | 1889 "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.", |
1826 "type": "boolean" | 1890 "type": "boolean" |
1827 }, | 1891 }, |
1828 "objectType": { | 1892 "objectType": { |
1829 "description": "**DEPRECATED** (Please use\n`person.metadata
.sources.profileMetadata.objectType` instead)\n\nThe type of the person object."
, | 1893 "description": "**DEPRECATED** (Please use\n`person.metadata
.sources.profileMetadata.objectType` instead)\n\nThe type of the person object."
, |
1830 "enum": [ | 1894 "enum": [ |
1831 "OBJECT_TYPE_UNSPECIFIED", | 1895 "OBJECT_TYPE_UNSPECIFIED", |
1832 "PERSON", | 1896 "PERSON", |
1833 "PAGE" | 1897 "PAGE" |
1834 ], | 1898 ], |
1835 "enumDescriptions": [ | 1899 "enumDescriptions": [ |
1836 "Unspecified.", | 1900 "Unspecified.", |
1837 "Person.", | 1901 "Person.", |
1838 "[Google+ Page.](http://www.google.com/+/brands/)" | 1902 "[Google+ Page.](http://www.google.com/+/brands/)" |
1839 ], | 1903 ], |
1840 "type": "string" | 1904 "type": "string" |
1841 }, | |
1842 "linkedPeopleResourceNames": { | |
1843 "description": "Resource names of people linked to this reso
urce.", | |
1844 "items": { | |
1845 "type": "string" | |
1846 }, | |
1847 "type": "array" | |
1848 } | 1905 } |
1849 }, | 1906 }, |
1850 "type": "object" | 1907 "type": "object" |
1851 }, | 1908 }, |
1852 "ModifyContactGroupMembersRequest": { | 1909 "ModifyContactGroupMembersRequest": { |
1853 "description": "A request to modify an existing contact group's memb
ers.", | 1910 "description": "A request to modify an existing contact group's memb
ers.", |
1854 "id": "ModifyContactGroupMembersRequest", | 1911 "id": "ModifyContactGroupMembersRequest", |
1855 "properties": { | 1912 "properties": { |
| 1913 "resourceNamesToAdd": { |
| 1914 "description": "The resource names of the contact people to
add in the form of in the form\n`people/`<var>person_id</var>.", |
| 1915 "items": { |
| 1916 "type": "string" |
| 1917 }, |
| 1918 "type": "array" |
| 1919 }, |
1856 "resourceNamesToRemove": { | 1920 "resourceNamesToRemove": { |
1857 "description": "The resource names of the contact people to
remove in the form of in the\nform of `people/`<var>person_id</var>.", | 1921 "description": "The resource names of the contact people to
remove in the form of in the\nform of `people/`<var>person_id</var>.", |
1858 "items": { | 1922 "items": { |
1859 "type": "string" | 1923 "type": "string" |
1860 }, | 1924 }, |
1861 "type": "array" | |
1862 }, | |
1863 "resourceNamesToAdd": { | |
1864 "description": "The resource names of the contact people to
add in the form of in the form\n`people/`<var>person_id</var>.", | |
1865 "items": { | |
1866 "type": "string" | |
1867 }, | |
1868 "type": "array" | 1925 "type": "array" |
1869 } | 1926 } |
1870 }, | 1927 }, |
1871 "type": "object" | 1928 "type": "object" |
1872 }, | 1929 }, |
1873 "ContactGroupResponse": { | 1930 "ContactGroupResponse": { |
1874 "description": "The response for a specific contact group.", | 1931 "description": "The response for a specific contact group.", |
1875 "id": "ContactGroupResponse", | 1932 "id": "ContactGroupResponse", |
1876 "properties": { | 1933 "properties": { |
1877 "status": { | |
1878 "$ref": "Status", | |
1879 "description": "The status of the response." | |
1880 }, | |
1881 "requestedResourceName": { | 1934 "requestedResourceName": { |
1882 "description": "The original requested resource name.", | 1935 "description": "The original requested resource name.", |
1883 "type": "string" | 1936 "type": "string" |
1884 }, | 1937 }, |
1885 "contactGroup": { | 1938 "contactGroup": { |
1886 "$ref": "ContactGroup", | 1939 "$ref": "ContactGroup", |
1887 "description": "The contact group." | 1940 "description": "The contact group." |
| 1941 }, |
| 1942 "status": { |
| 1943 "$ref": "Status", |
| 1944 "description": "The status of the response." |
1888 } | 1945 } |
1889 }, | 1946 }, |
1890 "type": "object" | 1947 "type": "object" |
1891 }, | 1948 }, |
1892 "Url": { | 1949 "Url": { |
1893 "description": "A person's associated URLs.", | 1950 "description": "A person's associated URLs.", |
1894 "id": "Url", | 1951 "id": "Url", |
1895 "properties": { | 1952 "properties": { |
1896 "formattedType": { | 1953 "metadata": { |
1897 "description": "The read-only type of the URL translated and
formatted in the viewer's\naccount locale or the `Accept-Language` HTTP header
locale.", | 1954 "$ref": "FieldMetadata", |
1898 "type": "string" | 1955 "description": "Metadata about the URL." |
1899 }, | 1956 }, |
1900 "type": { | 1957 "type": { |
1901 "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`", | 1958 "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`", |
1902 "type": "string" | 1959 "type": "string" |
1903 }, | 1960 }, |
1904 "metadata": { | |
1905 "$ref": "FieldMetadata", | |
1906 "description": "Metadata about the URL." | |
1907 }, | |
1908 "value": { | 1961 "value": { |
1909 "description": "The URL.", | 1962 "description": "The URL.", |
1910 "type": "string" | 1963 "type": "string" |
1911 } | |
1912 }, | |
1913 "type": "object" | |
1914 }, | |
1915 "ImClient": { | |
1916 "description": "A person's instant messaging client.", | |
1917 "id": "ImClient", | |
1918 "properties": { | |
1919 "protocol": { | |
1920 "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`", | |
1921 "type": "string" | |
1922 }, | |
1923 "metadata": { | |
1924 "$ref": "FieldMetadata", | |
1925 "description": "Metadata about the IM client." | |
1926 }, | |
1927 "type": { | |
1928 "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`", | |
1929 "type": "string" | |
1930 }, | |
1931 "username": { | |
1932 "description": "The user name used in the IM client.", | |
1933 "type": "string" | |
1934 }, | |
1935 "formattedProtocol": { | |
1936 "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.", | |
1937 "type": "string" | |
1938 }, | 1964 }, |
1939 "formattedType": { | 1965 "formattedType": { |
1940 "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.", | 1966 "description": "The read-only type of the URL translated and
formatted in the viewer's\naccount locale or the `Accept-Language` HTTP header
locale.", |
1941 "type": "string" | 1967 "type": "string" |
1942 } | 1968 } |
1943 }, | 1969 }, |
1944 "type": "object" | 1970 "type": "object" |
1945 } | 1971 } |
1946 }, | 1972 }, |
1947 "servicePath": "", | 1973 "servicePath": "", |
1948 "title": "Google People API", | 1974 "title": "Google People API", |
1949 "version": "v1" | 1975 "version": "v1" |
1950 } | 1976 } |
OLD | NEW |