Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 075572b86b87d93810e12170f57bcbf72ab4c507 / . / docs / dyn / plus_v1.people.html
blob: 08f6212dd8d6dfc128c3886ba84aa5db3bf48812 [file] [log] [blame]
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame^]1<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>
79<p class="firstline">Get a person's profile.</p>
80<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">
87 <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>
95 <pre>Get a person's profile.
96
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 {
104 "relationshipStatus": "A String", # The person's relationship status. Possible values are:
105 # - "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.
114 "organizations": [ # A list of current or past organizations with which this person is associated.
115 {
116 "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. Deprecated.
119 "title": "A String", # The person's job title or role within the organization.
120 "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. Deprecated.
122 "department": "A String", # The department within the organization. Deprecated.
123 "type": "A String", # The type of organization. Possible values are:
124 # - "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".
130 "displayName": "A String", # The name of this person, suitable for display.
131 "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 },
139 "url": "A String", # The URL of this person's profile.
140 "gender": "A String", # The person's gender. Possible values are:
141 # - "male" - Male gender.
142 # - "female" - Female gender.
143 # - "other" - Other.
144 "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".
150 },
151 ],
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.
160 },
161 ],
162 "nickname": "A String", # The nickname of this person.
163 "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
164 "etag": "A String", # ETag of this response for caching purposes.
165 "image": { # The representation of the person's profile photo.
166 "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.
167 },
168 "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).
169 "id": "A String", # The ID of this person.
170 "urls": [ # A list of URLs for this person.
171 {
172 "type": "A String", # The type of URL. Possible values are:
173 # - "home" - URL for home.
174 # - "work" - URL for work.
175 # - "blog" - URL for blog.
176 # - "profile" - URL for profile.
177 # - "other" - Other.
178 "primary": True or False, # If "true", this URL is the person's primary URL.
179 "value": "A String", # The URL value.
180 },
181 ],
182 "languagesSpoken": [ # The languages spoken by this person.
183 "A String",
184 ],
185 "currentLocation": "A String", # The current location for this person.
186 "objectType": "A String", # Type of person within Google+. Possible values are:
187 # - "person" - represents an actual person.
188 # - "page" - represents a page.
189 }</pre>
190</div>
191
192<div class="method">
193 <code class="details" id="listByActivity">listByActivity(activityId, collection, pageToken=None, maxResults=None)</code>
194 <pre>List all of the people in the specified collection for a particular activity.
195
196Args:
197 activityId: string, The ID of the activity to get the list of people for. (required)
198 collection: string, The collection of people to list. (required)
199 Allowed values
200 plusoners - List all people who have +1'd this activity.
201 resharers - List all people who have reshared this activity.
202 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.
203 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.
204
205Returns:
206 An object of the form:
207
208 {
209 "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.
210 "kind": "plus#peopleFeed", # Identifies this resource as a collection of people. Value: "plus#peopleFeed".
211 "title": "A String", # The title of this collection of people.
212 "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.
213 {
214 "relationshipStatus": "A String", # The person's relationship status. Possible values are:
215 # - "single" - Person is single.
216 # - "in_a_relationship" - Person is in a relationship.
217 # - "engaged" - Person is engaged.
218 # - "married" - Person is married.
219 # - "its_complicated" - The relationship is complicated.
220 # - "open_relationship" - Person is in an open relationship.
221 # - "widowed" - Person is widowed.
222 # - "in_domestic_partnership" - Person is in a domestic partnership.
223 # - "in_civil_union" - Person is in a civil union.
224 "organizations": [ # A list of current or past organizations with which this person is associated.
225 {
226 "startDate": "A String", # The date the person joined this organization.
227 "endDate": "A String", # The date the person left this organization.
228 "description": "A String", # A short description of the person's role in this organization. Deprecated.
229 "title": "A String", # The person's job title or role within the organization.
230 "primary": True or False, # If "true", indicates this organization is the person's primary one (typically interpreted as current one).
231 "location": "A String", # The location of this organization. Deprecated.
232 "department": "A String", # The department within the organization. Deprecated.
233 "type": "A String", # The type of organization. Possible values are:
234 # - "work" - Work.
235 # - "school" - School.
236 "name": "A String", # The name of the organization.
237 },
238 ],
239 "kind": "plus#person", # Identifies this resource as a person. Value: "plus#person".
240 "displayName": "A String", # The name of this person, suitable for display.
241 "name": { # An object representation of the individual components of a person's name.
242 "honorificPrefix": "A String", # The honorific prefixes (such as "Dr." or "Mrs.") for this person.
243 "middleName": "A String", # The middle name of this person.
244 "familyName": "A String", # The family name (last name) of this person.
245 "formatted": "A String", # The full name of this person, including middle names, suffixes, etc.
246 "givenName": "A String", # The given name (first name) of this person.
247 "honorificSuffix": "A String", # The honorific suffixes (such as "Jr.") for this person.
248 },
249 "url": "A String", # The URL of this person's profile.
250 "gender": "A String", # The person's gender. Possible values are:
251 # - "male" - Male gender.
252 # - "female" - Female gender.
253 # - "other" - Other.
254 "aboutMe": "A String", # A short biography for this person.
255 "tagline": "A String", # The brief description (tagline) of this person.
256 "placesLived": [ # A list of places where this person has lived.
257 {
258 "primary": True or False, # If "true", this place of residence is this person's primary residence.
259 "value": "A String", # A place where this person has lived. For example: "Seattle, WA", "Near Toronto".
260 },
261 ],
262 "emails": [ # A list of email addresses for this person.
263 {
264 "type": "A String", # The type of address. Possible values are:
265 # - "home" - Home email address.
266 # - "work" - Work email address.
267 # - "other" - Other.
268 "primary": True or False, # If "true", indicates this email address is the person's primary one.
269 "value": "A String", # The email address.
270 },
271 ],
272 "nickname": "A String", # The nickname of this person.
273 "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
274 "etag": "A String", # ETag of this response for caching purposes.
275 "image": { # The representation of the person's profile photo.
276 "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.
277 },
278 "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).
279 "id": "A String", # The ID of this person.
280 "urls": [ # A list of URLs for this person.
281 {
282 "type": "A String", # The type of URL. Possible values are:
283 # - "home" - URL for home.
284 # - "work" - URL for work.
285 # - "blog" - URL for blog.
286 # - "profile" - URL for profile.
287 # - "other" - Other.
288 "primary": True or False, # If "true", this URL is the person's primary URL.
289 "value": "A String", # The URL value.
290 },
291 ],
292 "languagesSpoken": [ # The languages spoken by this person.
293 "A String",
294 ],
295 "currentLocation": "A String", # The current location for this person.
296 "objectType": "A String", # Type of person within Google+. Possible values are:
297 # - "person" - represents an actual person.
298 # - "page" - represents a page.
299 },
300 ],
301 "etag": "A String", # ETag of this response for caching purposes.
302 "selfLink": "A String", # Link to this resource.
303 }</pre>
304</div>
305
306<div class="method">
307 <code class="details" id="listByActivity_next">listByActivity_next(previous_request, previous_response)</code>
308 <pre>Retrieves the next page of results.
309
310Args:
311 previous_request: The request for the previous page. (required)
312 previous_response: The response from the request for the previous page. (required)
313
314Returns:
315 A request object that you can call 'execute()' on to request the next
316 page. Returns None if there are no more items in the collection.
317 </pre>
318</div>
319
320<div class="method">
321 <code class="details" id="search">search(query, pageToken=None, language=None, maxResults=None)</code>
322 <pre>Search all public profiles.
323
324Args:
325 query: string, Specify a query string for full text search of public text in all profiles. (required)
326 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.
327 language: string, Specify the preferred language to search with. See search language codes for available values.
328 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.
329
330Returns:
331 An object of the form:
332
333 {
334 "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.
335 "kind": "plus#peopleFeed", # Identifies this resource as a collection of people. Value: "plus#peopleFeed".
336 "title": "A String", # The title of this collection of people.
337 "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.
338 {
339 "relationshipStatus": "A String", # The person's relationship status. Possible values are:
340 # - "single" - Person is single.
341 # - "in_a_relationship" - Person is in a relationship.
342 # - "engaged" - Person is engaged.
343 # - "married" - Person is married.
344 # - "its_complicated" - The relationship is complicated.
345 # - "open_relationship" - Person is in an open relationship.
346 # - "widowed" - Person is widowed.
347 # - "in_domestic_partnership" - Person is in a domestic partnership.
348 # - "in_civil_union" - Person is in a civil union.
349 "organizations": [ # A list of current or past organizations with which this person is associated.
350 {
351 "startDate": "A String", # The date the person joined this organization.
352 "endDate": "A String", # The date the person left this organization.
353 "description": "A String", # A short description of the person's role in this organization. Deprecated.
354 "title": "A String", # The person's job title or role within the organization.
355 "primary": True or False, # If "true", indicates this organization is the person's primary one (typically interpreted as current one).
356 "location": "A String", # The location of this organization. Deprecated.
357 "department": "A String", # The department within the organization. Deprecated.
358 "type": "A String", # The type of organization. Possible values are:
359 # - "work" - Work.
360 # - "school" - School.
361 "name": "A String", # The name of the organization.
362 },
363 ],
364 "kind": "plus#person", # Identifies this resource as a person. Value: "plus#person".
365 "displayName": "A String", # The name of this person, suitable for display.
366 "name": { # An object representation of the individual components of a person's name.
367 "honorificPrefix": "A String", # The honorific prefixes (such as "Dr." or "Mrs.") for this person.
368 "middleName": "A String", # The middle name of this person.
369 "familyName": "A String", # The family name (last name) of this person.
370 "formatted": "A String", # The full name of this person, including middle names, suffixes, etc.
371 "givenName": "A String", # The given name (first name) of this person.
372 "honorificSuffix": "A String", # The honorific suffixes (such as "Jr.") for this person.
373 },
374 "url": "A String", # The URL of this person's profile.
375 "gender": "A String", # The person's gender. Possible values are:
376 # - "male" - Male gender.
377 # - "female" - Female gender.
378 # - "other" - Other.
379 "aboutMe": "A String", # A short biography for this person.
380 "tagline": "A String", # The brief description (tagline) of this person.
381 "placesLived": [ # A list of places where this person has lived.
382 {
383 "primary": True or False, # If "true", this place of residence is this person's primary residence.
384 "value": "A String", # A place where this person has lived. For example: "Seattle, WA", "Near Toronto".
385 },
386 ],
387 "emails": [ # A list of email addresses for this person.
388 {
389 "type": "A String", # The type of address. Possible values are:
390 # - "home" - Home email address.
391 # - "work" - Work email address.
392 # - "other" - Other.
393 "primary": True or False, # If "true", indicates this email address is the person's primary one.
394 "value": "A String", # The email address.
395 },
396 ],
397 "nickname": "A String", # The nickname of this person.
398 "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
399 "etag": "A String", # ETag of this response for caching purposes.
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.
402 },
403 "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 "urls": [ # A list of URLs for this person.
406 {
407 "type": "A String", # The type of URL. Possible values are:
408 # - "home" - URL for home.
409 # - "work" - URL for work.
410 # - "blog" - URL for blog.
411 # - "profile" - URL for profile.
412 # - "other" - Other.
413 "primary": True or False, # If "true", this URL is the person's primary URL.
414 "value": "A String", # The URL value.
415 },
416 ],
417 "languagesSpoken": [ # The languages spoken by this person.
418 "A String",
419 ],
420 "currentLocation": "A String", # The current location for this person.
421 "objectType": "A String", # Type of person within Google+. Possible values are:
422 # - "person" - represents an actual person.
423 # - "page" - represents a page.
424 },
425 ],
426 "etag": "A String", # ETag of this response for caching purposes.
427 "selfLink": "A String", # Link to this resource.
428 }</pre>
429</div>
430
431<div class="method">
432 <code class="details" id="search_next">search_next(previous_request, previous_response)</code>
433 <pre>Retrieves the next page of results.
434
435Args:
436 previous_request: The request for the previous page. (required)
437 previous_response: The response from the request for the previous page. (required)
438
439Returns:
440 A request object that you can call 'execute()' on to request the next
441 page. Returns None if there are no more items in the collection.
442 </pre>
443</div>
444
445</body></html>