blob: 9e4638eafd424166914b89fb07c48f3b79d6232e [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -04001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="plus_v1.html">Google+ API</a> . <a href="plus_v1.people.html">people</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#get">get(userId)</a></code></p>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -040079<p class="firstline">Get a person's profile.</p>
John Asmuth614db982014-04-24 15:46:26 -040080<p class="toc_element">
81 <code><a href="#listByActivity">listByActivity(activityId, collection, pageToken=None, maxResults=None)</a></code></p>
82<p class="firstline">List all of the people in the specified collection for a particular activity.</p>
83<p class="toc_element">
84 <code><a href="#listByActivity_next">listByActivity_next(previous_request, previous_response)</a></code></p>
85<p class="firstline">Retrieves the next page of results.</p>
86<p class="toc_element">
John Asmuth614db982014-04-24 15:46:26 -040087 <code><a href="#search">search(query, pageToken=None, language=None, maxResults=None)</a></code></p>
88<p class="firstline">Search all public profiles.</p>
89<p class="toc_element">
90 <code><a href="#search_next">search_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<h3>Method Details</h3>
93<div class="method">
94 <code class="details" id="get">get(userId)</code>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -040095 <pre>Get a person's profile.
John Asmuth614db982014-04-24 15:46:26 -040096
97Args:
98 userId: string, The ID of the person to get the profile for. The special value "me" can be used to indicate the authenticated user. (required)
99
100Returns:
101 An object of the form:
102
103 {
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400104 "relationshipStatus": "A String", # The person's relationship status. Possible values are:
John Asmuth614db982014-04-24 15:46:26 -0400105 # - "single" - Person is single.
106 # - "in_a_relationship" - Person is in a relationship.
107 # - "engaged" - Person is engaged.
108 # - "married" - Person is married.
109 # - "its_complicated" - The relationship is complicated.
110 # - "open_relationship" - Person is in an open relationship.
111 # - "widowed" - Person is widowed.
112 # - "in_domestic_partnership" - Person is in a domestic partnership.
113 # - "in_civil_union" - Person is in a civil union.
John Asmuth614db982014-04-24 15:46:26 -0400114 "organizations": [ # A list of current or past organizations with which this person is associated.
115 {
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400116 "startDate": "A String", # The date the person joined this organization.
117 "endDate": "A String", # The date the person left this organization.
118 "description": "A String", # A short description of the person's role in this organization.
John Asmuth614db982014-04-24 15:46:26 -0400119 "title": "A String", # The person's job title or role within the organization.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400120 "primary": True or False, # If "true", indicates this organization is the person's primary one (typically interpreted as current one).
121 "location": "A String", # The location of this organization.
122 "department": "A String", # The department within the organization.
123 "type": "A String", # The type of organization. Possible values are:
John Asmuth614db982014-04-24 15:46:26 -0400124 # - "work" - Work.
125 # - "school" - School.
126 "name": "A String", # The name of the organization.
127 },
128 ],
129 "kind": "plus#person", # Identifies this resource as a person. Value: "plus#person".
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400130 "displayName": "A String", # The name of this person, suitable for display.
John Asmuth614db982014-04-24 15:46:26 -0400131 "name": { # An object representation of the individual components of a person's name.
132 "honorificPrefix": "A String", # The honorific prefixes (such as "Dr." or "Mrs.") for this person.
133 "middleName": "A String", # The middle name of this person.
134 "familyName": "A String", # The family name (last name) of this person.
135 "formatted": "A String", # The full name of this person, including middle names, suffixes, etc.
136 "givenName": "A String", # The given name (first name) of this person.
137 "honorificSuffix": "A String", # The honorific suffixes (such as "Jr.") for this person.
138 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400139 "url": "A String", # The URL of this person's profile.
140 "gender": "A String", # The person's gender. Possible values are:
John Asmuth614db982014-04-24 15:46:26 -0400141 # - "male" - Male gender.
142 # - "female" - Female gender.
143 # - "other" - Other.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400144 "aboutMe": "A String", # A short biography for this person.
145 "tagline": "A String", # The brief description (tagline) of this person.
146 "placesLived": [ # A list of places where this person has lived.
147 {
148 "primary": True or False, # If "true", this place of residence is this person's primary residence.
149 "value": "A String", # A place where this person has lived. For example: "Seattle, WA", "Near Toronto".
John Asmuth614db982014-04-24 15:46:26 -0400150 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400151 ],
152 "emails": [ # A list of email addresses for this person.
153 {
154 "type": "A String", # The type of address. Possible values are:
155 # - "home" - Home email address.
156 # - "work" - Work email address.
157 # - "other" - Other.
158 "primary": True or False, # If "true", indicates this email address is the person's primary one.
159 "value": "A String", # The email address.
John Asmuth614db982014-04-24 15:46:26 -0400160 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400161 ],
162 "nickname": "A String", # The nickname of this person.
163 "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
John Asmuth614db982014-04-24 15:46:26 -0400164 "urls": [ # A list of URLs for this person.
165 {
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400166 "type": "A String", # The type of URL. Possible values are:
167 # - "home" - URL for home.
168 # - "work" - URL for work.
169 # - "blog" - URL for blog.
170 # - "profile" - URL for profile.
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700171 # - "other" - Other.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400172 "primary": True or False, # If "true", this URL is the person's primary URL.
173 "value": "A String", # The URL value.
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700174 },
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700175 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400176 "image": { # The representation of the person's profile photo.
177 "url": "A String", # The URL of the person's profile photo. To re-size the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
178 },
179 "hasApp": True or False, # If "true", indicates that the person has installed the app that is making the request and has chosen to expose this install state to the caller. A value of "false" indicates that the install state cannot be determined (it is either not installed or the person has chosen to keep this information private).
180 "id": "A String", # The ID of this person.
181 "languagesSpoken": [ # The languages spoken by this person.
182 "A String",
183 ],
184 "currentLocation": "A String", # The current location for this person.
John Asmuth614db982014-04-24 15:46:26 -0400185 }</pre>
186</div>
187
188<div class="method">
189 <code class="details" id="listByActivity">listByActivity(activityId, collection, pageToken=None, maxResults=None)</code>
190 <pre>List all of the people in the specified collection for a particular activity.
191
192Args:
193 activityId: string, The ID of the activity to get the list of people for. (required)
194 collection: string, The collection of people to list. (required)
195 Allowed values
196 plusoners - List all people who have +1'd this activity.
197 resharers - List all people who have reshared this activity.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400198 pageToken: string, The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response.
199 maxResults: integer, The maximum number of people to include in the response, used for paging. For any response, the actual number returned may be less than the specified maxResults.
John Asmuth614db982014-04-24 15:46:26 -0400200
201Returns:
202 An object of the form:
203
204 {
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400205 "nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
206 "items": [ # The people in this page of results. Each item will include the id, displayName, image, and url for the person. To retrieve additional profile data, see the people.get method.
John Asmuth614db982014-04-24 15:46:26 -0400207 {
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400208 "relationshipStatus": "A String", # The person's relationship status. Possible values are:
John Asmuth614db982014-04-24 15:46:26 -0400209 # - "single" - Person is single.
210 # - "in_a_relationship" - Person is in a relationship.
211 # - "engaged" - Person is engaged.
212 # - "married" - Person is married.
213 # - "its_complicated" - The relationship is complicated.
214 # - "open_relationship" - Person is in an open relationship.
215 # - "widowed" - Person is widowed.
216 # - "in_domestic_partnership" - Person is in a domestic partnership.
217 # - "in_civil_union" - Person is in a civil union.
John Asmuth614db982014-04-24 15:46:26 -0400218 "organizations": [ # A list of current or past organizations with which this person is associated.
219 {
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400220 "startDate": "A String", # The date the person joined this organization.
221 "endDate": "A String", # The date the person left this organization.
222 "description": "A String", # A short description of the person's role in this organization.
John Asmuth614db982014-04-24 15:46:26 -0400223 "title": "A String", # The person's job title or role within the organization.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400224 "primary": True or False, # If "true", indicates this organization is the person's primary one (typically interpreted as current one).
225 "location": "A String", # The location of this organization.
226 "department": "A String", # The department within the organization.
227 "type": "A String", # The type of organization. Possible values are:
John Asmuth614db982014-04-24 15:46:26 -0400228 # - "work" - Work.
229 # - "school" - School.
230 "name": "A String", # The name of the organization.
231 },
232 ],
233 "kind": "plus#person", # Identifies this resource as a person. Value: "plus#person".
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400234 "displayName": "A String", # The name of this person, suitable for display.
John Asmuth614db982014-04-24 15:46:26 -0400235 "name": { # An object representation of the individual components of a person's name.
236 "honorificPrefix": "A String", # The honorific prefixes (such as "Dr." or "Mrs.") for this person.
237 "middleName": "A String", # The middle name of this person.
238 "familyName": "A String", # The family name (last name) of this person.
239 "formatted": "A String", # The full name of this person, including middle names, suffixes, etc.
240 "givenName": "A String", # The given name (first name) of this person.
241 "honorificSuffix": "A String", # The honorific suffixes (such as "Jr.") for this person.
242 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400243 "url": "A String", # The URL of this person's profile.
244 "gender": "A String", # The person's gender. Possible values are:
John Asmuth614db982014-04-24 15:46:26 -0400245 # - "male" - Male gender.
246 # - "female" - Female gender.
247 # - "other" - Other.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400248 "aboutMe": "A String", # A short biography for this person.
249 "tagline": "A String", # The brief description (tagline) of this person.
250 "placesLived": [ # A list of places where this person has lived.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700251 {
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400252 "primary": True or False, # If "true", this place of residence is this person's primary residence.
253 "value": "A String", # A place where this person has lived. For example: "Seattle, WA", "Near Toronto".
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700254 },
255 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400256 "emails": [ # A list of email addresses for this person.
257 {
258 "type": "A String", # The type of address. Possible values are:
259 # - "home" - Home email address.
260 # - "work" - Work email address.
261 # - "other" - Other.
262 "primary": True or False, # If "true", indicates this email address is the person's primary one.
263 "value": "A String", # The email address.
264 },
265 ],
266 "nickname": "A String", # The nickname of this person.
267 "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
268 "urls": [ # A list of URLs for this person.
269 {
270 "type": "A String", # The type of URL. Possible values are:
271 # - "home" - URL for home.
272 # - "work" - URL for work.
273 # - "blog" - URL for blog.
274 # - "profile" - URL for profile.
275 # - "other" - Other.
276 "primary": True or False, # If "true", this URL is the person's primary URL.
277 "value": "A String", # The URL value.
278 },
279 ],
280 "image": { # The representation of the person's profile photo.
281 "url": "A String", # The URL of the person's profile photo. To re-size the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
John Asmuth614db982014-04-24 15:46:26 -0400282 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400283 "hasApp": True or False, # If "true", indicates that the person has installed the app that is making the request and has chosen to expose this install state to the caller. A value of "false" indicates that the install state cannot be determined (it is either not installed or the person has chosen to keep this information private).
284 "id": "A String", # The ID of this person.
285 "languagesSpoken": [ # The languages spoken by this person.
286 "A String",
287 ],
288 "currentLocation": "A String", # The current location for this person.
John Asmuth614db982014-04-24 15:46:26 -0400289 },
290 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400291 "kind": "plus#peopleFeed", # Identifies this resource as a collection of people. Value: "plus#peopleFeed".
John Asmuth614db982014-04-24 15:46:26 -0400292 "selfLink": "A String", # Link to this resource.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400293 "title": "A String", # The title of this collection of people.
John Asmuth614db982014-04-24 15:46:26 -0400294 }</pre>
295</div>
296
297<div class="method">
298 <code class="details" id="listByActivity_next">listByActivity_next(previous_request, previous_response)</code>
299 <pre>Retrieves the next page of results.
300
301Args:
302 previous_request: The request for the previous page. (required)
303 previous_response: The response from the request for the previous page. (required)
304
305Returns:
306 A request object that you can call 'execute()' on to request the next
307 page. Returns None if there are no more items in the collection.
308 </pre>
309</div>
310
311<div class="method">
John Asmuth614db982014-04-24 15:46:26 -0400312 <code class="details" id="search">search(query, pageToken=None, language=None, maxResults=None)</code>
313 <pre>Search all public profiles.
314
315Args:
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400316 query: string, Full-text search query string. (required)
317 pageToken: string, The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response. This token may be of any length.
318 language: string, Specify the preferred language to search with. See Language Codes for available values.
319 maxResults: integer, The maximum number of people to include in the response, used for paging. For any response, the actual number returned may be less than the specified maxResults.
John Asmuth614db982014-04-24 15:46:26 -0400320
321Returns:
322 An object of the form:
323
324 {
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400325 "nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
326 "items": [ # The people in this page of results. Each item will include the id, displayName, image, and url for the person. To retrieve additional profile data, see the people.get method.
John Asmuth614db982014-04-24 15:46:26 -0400327 {
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400328 "relationshipStatus": "A String", # The person's relationship status. Possible values are:
John Asmuth614db982014-04-24 15:46:26 -0400329 # - "single" - Person is single.
330 # - "in_a_relationship" - Person is in a relationship.
331 # - "engaged" - Person is engaged.
332 # - "married" - Person is married.
333 # - "its_complicated" - The relationship is complicated.
334 # - "open_relationship" - Person is in an open relationship.
335 # - "widowed" - Person is widowed.
336 # - "in_domestic_partnership" - Person is in a domestic partnership.
337 # - "in_civil_union" - Person is in a civil union.
John Asmuth614db982014-04-24 15:46:26 -0400338 "organizations": [ # A list of current or past organizations with which this person is associated.
339 {
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400340 "startDate": "A String", # The date the person joined this organization.
341 "endDate": "A String", # The date the person left this organization.
342 "description": "A String", # A short description of the person's role in this organization.
John Asmuth614db982014-04-24 15:46:26 -0400343 "title": "A String", # The person's job title or role within the organization.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400344 "primary": True or False, # If "true", indicates this organization is the person's primary one (typically interpreted as current one).
345 "location": "A String", # The location of this organization.
346 "department": "A String", # The department within the organization.
347 "type": "A String", # The type of organization. Possible values are:
John Asmuth614db982014-04-24 15:46:26 -0400348 # - "work" - Work.
349 # - "school" - School.
350 "name": "A String", # The name of the organization.
351 },
352 ],
353 "kind": "plus#person", # Identifies this resource as a person. Value: "plus#person".
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400354 "displayName": "A String", # The name of this person, suitable for display.
John Asmuth614db982014-04-24 15:46:26 -0400355 "name": { # An object representation of the individual components of a person's name.
356 "honorificPrefix": "A String", # The honorific prefixes (such as "Dr." or "Mrs.") for this person.
357 "middleName": "A String", # The middle name of this person.
358 "familyName": "A String", # The family name (last name) of this person.
359 "formatted": "A String", # The full name of this person, including middle names, suffixes, etc.
360 "givenName": "A String", # The given name (first name) of this person.
361 "honorificSuffix": "A String", # The honorific suffixes (such as "Jr.") for this person.
362 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400363 "url": "A String", # The URL of this person's profile.
364 "gender": "A String", # The person's gender. Possible values are:
John Asmuth614db982014-04-24 15:46:26 -0400365 # - "male" - Male gender.
366 # - "female" - Female gender.
367 # - "other" - Other.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400368 "aboutMe": "A String", # A short biography for this person.
369 "tagline": "A String", # The brief description (tagline) of this person.
370 "placesLived": [ # A list of places where this person has lived.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700371 {
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400372 "primary": True or False, # If "true", this place of residence is this person's primary residence.
373 "value": "A String", # A place where this person has lived. For example: "Seattle, WA", "Near Toronto".
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700374 },
375 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400376 "emails": [ # A list of email addresses for this person.
377 {
378 "type": "A String", # The type of address. Possible values are:
379 # - "home" - Home email address.
380 # - "work" - Work email address.
381 # - "other" - Other.
382 "primary": True or False, # If "true", indicates this email address is the person's primary one.
383 "value": "A String", # The email address.
384 },
385 ],
386 "nickname": "A String", # The nickname of this person.
387 "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
388 "urls": [ # A list of URLs for this person.
389 {
390 "type": "A String", # The type of URL. Possible values are:
391 # - "home" - URL for home.
392 # - "work" - URL for work.
393 # - "blog" - URL for blog.
394 # - "profile" - URL for profile.
395 # - "other" - Other.
396 "primary": True or False, # If "true", this URL is the person's primary URL.
397 "value": "A String", # The URL value.
398 },
399 ],
400 "image": { # The representation of the person's profile photo.
401 "url": "A String", # The URL of the person's profile photo. To re-size the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
John Asmuth614db982014-04-24 15:46:26 -0400402 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400403 "hasApp": True or False, # If "true", indicates that the person has installed the app that is making the request and has chosen to expose this install state to the caller. A value of "false" indicates that the install state cannot be determined (it is either not installed or the person has chosen to keep this information private).
404 "id": "A String", # The ID of this person.
405 "languagesSpoken": [ # The languages spoken by this person.
406 "A String",
407 ],
408 "currentLocation": "A String", # The current location for this person.
John Asmuth614db982014-04-24 15:46:26 -0400409 },
410 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400411 "kind": "plus#peopleFeed", # Identifies this resource as a collection of people. Value: "plus#peopleFeed".
John Asmuth614db982014-04-24 15:46:26 -0400412 "selfLink": "A String", # Link to this resource.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400413 "title": "A String", # The title of this collection of people.
John Asmuth614db982014-04-24 15:46:26 -0400414 }</pre>
415</div>
416
417<div class="method">
418 <code class="details" id="search_next">search_next(previous_request, previous_response)</code>
419 <pre>Retrieves the next page of results.
420
421Args:
422 previous_request: The request for the previous page. (required)
423 previous_response: The response from the request for the previous page. (required)
424
425Returns:
426 A request object that you can call 'execute()' on to request the next
427 page. Returns None if there are no more items in the collection.
428 </pre>
429</div>
430
431</body></html>