Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / e912d185eef03392f095881d407c0c78f7633d5e / . / docs / dyn / plus_v1.people.html
blob: a4f1a68fd4bf6c11b33d8bc8e0547a0f6bb94722 [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>
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]79<p class="firstline">Get a person's profile. If your app uses scope https://www.googleapis.com/auth/plus.login, this method is guaranteed to return ageRange and language.</p>
80<p class="toc_element">
81 <code><a href="#list">list(userId, collection, orderBy=None, pageToken=None, maxResults=None)</a></code></p>
82<p class="firstline">List all of the people in the specified collection.</p>
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]83<p class="toc_element">
84 <code><a href="#listByActivity">listByActivity(activityId, collection, pageToken=None, maxResults=None)</a></code></p>
85<p class="firstline">List all of the people in the specified collection for a particular activity.</p>
86<p class="toc_element">
87 <code><a href="#listByActivity_next">listByActivity_next(previous_request, previous_response)</a></code></p>
88<p class="firstline">Retrieves the next page of results.</p>
89<p class="toc_element">
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<p class="toc_element">
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]93 <code><a href="#search">search(query, pageToken=None, language=None, maxResults=None)</a></code></p>
94<p class="firstline">Search all public profiles.</p>
95<p class="toc_element">
96 <code><a href="#search_next">search_next(previous_request, previous_response)</a></code></p>
97<p class="firstline">Retrieves the next page of results.</p>
98<h3>Method Details</h3>
99<div class="method">
100 <code class="details" id="get">get(userId)</code>
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]101 <pre>Get a person's profile. If your app uses scope https://www.googleapis.com/auth/plus.login, this method is guaranteed to return ageRange and language.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]102
103Args:
104 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)
105
106Returns:
107 An object of the form:
108
109 {
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]110 "braggingRights": "A String", # The "bragging rights" line of this person.
111 "image": { # The representation of the person's profile photo.
112 "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.
113 },
114 "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).
115 "id": "A String", # The ID of this person.
116 "objectType": "A String", # Type of person within Google+. Possible values are:
117 # - "person" - represents an actual person.
118 # - "page" - represents a page.
119 "verified": True or False, # Whether the person or Google+ Page has been verified.
120 "tagline": "A String", # The brief description (tagline) of this person.
121 "currentLocation": "A String", # The current location for this person.
122 "etag": "A String", # ETag of this response for caching purposes.
123 "circledByCount": 42, # If a Google+ Page and for followers who are visible, the number of people who have added this page to a circle.
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]124 "relationshipStatus": "A String", # The person's relationship status. Possible values are:
125 # - "single" - Person is single.
126 # - "in_a_relationship" - Person is in a relationship.
127 # - "engaged" - Person is engaged.
128 # - "married" - Person is married.
129 # - "its_complicated" - The relationship is complicated.
130 # - "open_relationship" - Person is in an open relationship.
131 # - "widowed" - Person is widowed.
132 # - "in_domestic_partnership" - Person is in a domestic partnership.
133 # - "in_civil_union" - Person is in a civil union.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]134 "aboutMe": "A String", # A short biography for this person.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]135 "placesLived": [ # A list of places where this person has lived.
136 {
137 "primary": True or False, # If "true", this place of residence is this person's primary residence.
138 "value": "A String", # A place where this person has lived. For example: "Seattle, WA", "Near Toronto".
139 },
140 ],
141 "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
142 "nickname": "A String", # The nickname of this person.
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]143 "emails": [ # A list of email addresses that this person has set to public on their Google+ profile. You can also use the userinfo.email scope to retrieve an authenticated user's email address.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]144 {
145 "type": "A String", # The type of address. Possible values are:
146 # - "home" - Home email address.
147 # - "work" - Work email address.
148 # - "other" - Other.
149 "primary": True or False, # If "true", indicates this email address is the person's primary one.
150 "value": "A String", # The email address.
151 },
152 ],
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]153 "organizations": [ # A list of current or past organizations with which this person is associated.
154 {
155 "startDate": "A String", # The date the person joined this organization.
156 "endDate": "A String", # The date the person left this organization.
157 "description": "A String", # A short description of the person's role in this organization. Deprecated.
158 "title": "A String", # The person's job title or role within the organization.
159 "primary": True or False, # If "true", indicates this organization is the person's primary one (typically interpreted as current one).
160 "location": "A String", # The location of this organization. Deprecated.
161 "department": "A String", # The department within the organization. Deprecated.
162 "type": "A String", # The type of organization. Possible values are:
163 # - "work" - Work.
164 # - "school" - School.
165 "name": "A String", # The name of the organization.
166 },
167 ],
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]168 "kind": "plus#person", # Identifies this resource as a person. Value: "plus#person".
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]169 "displayName": "A String", # The name of this person, suitable for display.
170 "name": { # An object representation of the individual components of a person's name.
171 "honorificPrefix": "A String", # The honorific prefixes (such as "Dr." or "Mrs.") for this person.
172 "middleName": "A String", # The middle name of this person.
173 "familyName": "A String", # The family name (last name) of this person.
174 "formatted": "A String", # The full name of this person, including middle names, suffixes, etc.
175 "givenName": "A String", # The given name (first name) of this person.
176 "honorificSuffix": "A String", # The honorific suffixes (such as "Jr.") for this person.
177 },
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]178 "language": "A String", # The user's preferred language for rendering.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]179 "url": "A String", # The URL of this person's profile.
180 "gender": "A String", # The person's gender. Possible values are:
181 # - "male" - Male gender.
182 # - "female" - Female gender.
183 # - "other" - Other.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]184 "cover": { # The cover photo content.
185 "layout": "A String", # The layout of the cover art. Possible values are:
186 # - "banner" - One large image banner.
187 "coverInfo": { # Extra information about the cover photo.
188 "leftImageOffset": 42, # The difference between the left position of the image cover and the actual displayed cover image. Only valid for BANNER layout.
189 "topImageOffset": 42, # The difference between the top position of the image cover and the actual displayed cover image. Only valid for BANNER layout.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]190 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]191 "coverPhoto": { # The person's primary cover image.
192 "url": "A String", # The url to the image.
193 "width": 42, # The width to the image.
194 "height": 42, # The height to the image.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]195 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]196 },
197 "isPlusUser": True or False, # Whether this user has signed up for Google+.
198 "plusOneCount": 42, # If a Google+ Page, the number of people who have +1'ed this page.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]199 "urls": [ # A list of URLs for this person.
200 {
201 "type": "A String", # The type of URL. Possible values are:
202 # - "home" - URL for home.
203 # - "work" - URL for work.
204 # - "blog" - URL for blog.
205 # - "profile" - URL for profile.
206 # - "other" - Other.
207 "primary": True or False, # If "true", this URL is the person's primary URL.
208 "value": "A String", # The URL value.
209 },
210 ],
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]211 "ageRange": { # The age range of the person.
212 "max": 42, # The age range's upper bound, if any.
213 "min": 42, # The age range's lower bound, if any.
214 },
215 }</pre>
216</div>
217
218<div class="method">
219 <code class="details" id="list">list(userId, collection, orderBy=None, pageToken=None, maxResults=None)</code>
220 <pre>List all of the people in the specified collection.
221
222Args:
223 userId: string, Get the collection of people for the person identified. Use "me" to indicate the authenticated user. (required)
224 collection: string, The collection of people to list. (required)
225 Allowed values
226 visible - The list of people who this user has added to one or more circles, limited to the circles visible to the requesting application.
227 orderBy: string, The order to return people in.
228 Allowed values
229 alphabetical - Order the people by their display name.
230 best - Order people based on the relevence to the viewer.
231 pageToken: string, The continuation token, which is 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.
232 maxResults: integer, The maximum number of people to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.
233
234Returns:
235 An object of the form:
236
237 {
238 "nextPageToken": "A String", # The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
239 "kind": "plus#peopleFeed", # Identifies this resource as a collection of people. Value: "plus#peopleFeed".
240 "title": "A String", # The title of this collection of people.
241 "items": [ # The people in this page of results. Each item includes the id, displayName, image, and url for the person. To retrieve additional profile data, see the people.get method.
242 {
243 "braggingRights": "A String", # The "bragging rights" line of this person.
244 "image": { # The representation of the person's profile photo.
245 "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.
246 },
247 "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).
248 "id": "A String", # The ID of this person.
249 "objectType": "A String", # Type of person within Google+. Possible values are:
250 # - "person" - represents an actual person.
251 # - "page" - represents a page.
252 "verified": True or False, # Whether the person or Google+ Page has been verified.
253 "tagline": "A String", # The brief description (tagline) of this person.
254 "currentLocation": "A String", # The current location for this person.
255 "etag": "A String", # ETag of this response for caching purposes.
256 "circledByCount": 42, # If a Google+ Page and for followers who are visible, the number of people who have added this page to a circle.
257 "relationshipStatus": "A String", # The person's relationship status. Possible values are:
258 # - "single" - Person is single.
259 # - "in_a_relationship" - Person is in a relationship.
260 # - "engaged" - Person is engaged.
261 # - "married" - Person is married.
262 # - "its_complicated" - The relationship is complicated.
263 # - "open_relationship" - Person is in an open relationship.
264 # - "widowed" - Person is widowed.
265 # - "in_domestic_partnership" - Person is in a domestic partnership.
266 # - "in_civil_union" - Person is in a civil union.
267 "aboutMe": "A String", # A short biography for this person.
268 "placesLived": [ # A list of places where this person has lived.
269 {
270 "primary": True or False, # If "true", this place of residence is this person's primary residence.
271 "value": "A String", # A place where this person has lived. For example: "Seattle, WA", "Near Toronto".
272 },
273 ],
274 "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
275 "nickname": "A String", # The nickname of this person.
276 "emails": [ # A list of email addresses that this person has set to public on their Google+ profile. You can also use the userinfo.email scope to retrieve an authenticated user's email address.
277 {
278 "type": "A String", # The type of address. Possible values are:
279 # - "home" - Home email address.
280 # - "work" - Work email address.
281 # - "other" - Other.
282 "primary": True or False, # If "true", indicates this email address is the person's primary one.
283 "value": "A String", # The email address.
284 },
285 ],
286 "organizations": [ # A list of current or past organizations with which this person is associated.
287 {
288 "startDate": "A String", # The date the person joined this organization.
289 "endDate": "A String", # The date the person left this organization.
290 "description": "A String", # A short description of the person's role in this organization. Deprecated.
291 "title": "A String", # The person's job title or role within the organization.
292 "primary": True or False, # If "true", indicates this organization is the person's primary one (typically interpreted as current one).
293 "location": "A String", # The location of this organization. Deprecated.
294 "department": "A String", # The department within the organization. Deprecated.
295 "type": "A String", # The type of organization. Possible values are:
296 # - "work" - Work.
297 # - "school" - School.
298 "name": "A String", # The name of the organization.
299 },
300 ],
301 "kind": "plus#person", # Identifies this resource as a person. Value: "plus#person".
302 "displayName": "A String", # The name of this person, suitable for display.
303 "name": { # An object representation of the individual components of a person's name.
304 "honorificPrefix": "A String", # The honorific prefixes (such as "Dr." or "Mrs.") for this person.
305 "middleName": "A String", # The middle name of this person.
306 "familyName": "A String", # The family name (last name) of this person.
307 "formatted": "A String", # The full name of this person, including middle names, suffixes, etc.
308 "givenName": "A String", # The given name (first name) of this person.
309 "honorificSuffix": "A String", # The honorific suffixes (such as "Jr.") for this person.
310 },
311 "language": "A String", # The user's preferred language for rendering.
312 "url": "A String", # The URL of this person's profile.
313 "gender": "A String", # The person's gender. Possible values are:
314 # - "male" - Male gender.
315 # - "female" - Female gender.
316 # - "other" - Other.
317 "cover": { # The cover photo content.
318 "layout": "A String", # The layout of the cover art. Possible values are:
319 # - "banner" - One large image banner.
320 "coverInfo": { # Extra information about the cover photo.
321 "leftImageOffset": 42, # The difference between the left position of the image cover and the actual displayed cover image. Only valid for BANNER layout.
322 "topImageOffset": 42, # The difference between the top position of the image cover and the actual displayed cover image. Only valid for BANNER layout.
323 },
324 "coverPhoto": { # The person's primary cover image.
325 "url": "A String", # The url to the image.
326 "width": 42, # The width to the image.
327 "height": 42, # The height to the image.
328 },
329 },
330 "isPlusUser": True or False, # Whether this user has signed up for Google+.
331 "plusOneCount": 42, # If a Google+ Page, the number of people who have +1'ed this page.
332 "urls": [ # A list of URLs for this person.
333 {
334 "type": "A String", # The type of URL. Possible values are:
335 # - "home" - URL for home.
336 # - "work" - URL for work.
337 # - "blog" - URL for blog.
338 # - "profile" - URL for profile.
339 # - "other" - Other.
340 "primary": True or False, # If "true", this URL is the person's primary URL.
341 "value": "A String", # The URL value.
342 },
343 ],
344 "ageRange": { # The age range of the person.
345 "max": 42, # The age range's upper bound, if any.
346 "min": 42, # The age range's lower bound, if any.
347 },
348 },
349 ],
350 "etag": "A String", # ETag of this response for caching purposes.
351 "totalItems": 42, # The total number of people available in this list. The number of people in a response might be smaller due to paging. This might not be set for all collections.
352 "selfLink": "A String", # Link to this resource.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]353 }</pre>
354</div>
355
356<div class="method">
357 <code class="details" id="listByActivity">listByActivity(activityId, collection, pageToken=None, maxResults=None)</code>
358 <pre>List all of the people in the specified collection for a particular activity.
359
360Args:
361 activityId: string, The ID of the activity to get the list of people for. (required)
362 collection: string, The collection of people to list. (required)
363 Allowed values
364 plusoners - List all people who have +1'd this activity.
365 resharers - List all people who have reshared this activity.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]366 pageToken: string, The continuation token, which is 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.
367 maxResults: integer, The maximum number of people to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]368
369Returns:
370 An object of the form:
371
372 {
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]373 "nextPageToken": "A String", # The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]374 "kind": "plus#peopleFeed", # Identifies this resource as a collection of people. Value: "plus#peopleFeed".
375 "title": "A String", # The title of this collection of people.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]376 "items": [ # The people in this page of results. Each item includes the id, displayName, image, and url for the person. To retrieve additional profile data, see the people.get method.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]377 {
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]378 "braggingRights": "A String", # The "bragging rights" line of this person.
379 "image": { # The representation of the person's profile photo.
380 "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.
381 },
382 "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).
383 "id": "A String", # The ID of this person.
384 "objectType": "A String", # Type of person within Google+. Possible values are:
385 # - "person" - represents an actual person.
386 # - "page" - represents a page.
387 "verified": True or False, # Whether the person or Google+ Page has been verified.
388 "tagline": "A String", # The brief description (tagline) of this person.
389 "currentLocation": "A String", # The current location for this person.
390 "etag": "A String", # ETag of this response for caching purposes.
391 "circledByCount": 42, # If a Google+ Page and for followers who are visible, the number of people who have added this page to a circle.
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]392 "relationshipStatus": "A String", # The person's relationship status. Possible values are:
393 # - "single" - Person is single.
394 # - "in_a_relationship" - Person is in a relationship.
395 # - "engaged" - Person is engaged.
396 # - "married" - Person is married.
397 # - "its_complicated" - The relationship is complicated.
398 # - "open_relationship" - Person is in an open relationship.
399 # - "widowed" - Person is widowed.
400 # - "in_domestic_partnership" - Person is in a domestic partnership.
401 # - "in_civil_union" - Person is in a civil union.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]402 "aboutMe": "A String", # A short biography for this person.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]403 "placesLived": [ # A list of places where this person has lived.
404 {
405 "primary": True or False, # If "true", this place of residence is this person's primary residence.
406 "value": "A String", # A place where this person has lived. For example: "Seattle, WA", "Near Toronto".
407 },
408 ],
409 "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
410 "nickname": "A String", # The nickname of this person.
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]411 "emails": [ # A list of email addresses that this person has set to public on their Google+ profile. You can also use the userinfo.email scope to retrieve an authenticated user's email address.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]412 {
413 "type": "A String", # The type of address. Possible values are:
414 # - "home" - Home email address.
415 # - "work" - Work email address.
416 # - "other" - Other.
417 "primary": True or False, # If "true", indicates this email address is the person's primary one.
418 "value": "A String", # The email address.
419 },
420 ],
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]421 "organizations": [ # A list of current or past organizations with which this person is associated.
422 {
423 "startDate": "A String", # The date the person joined this organization.
424 "endDate": "A String", # The date the person left this organization.
425 "description": "A String", # A short description of the person's role in this organization. Deprecated.
426 "title": "A String", # The person's job title or role within the organization.
427 "primary": True or False, # If "true", indicates this organization is the person's primary one (typically interpreted as current one).
428 "location": "A String", # The location of this organization. Deprecated.
429 "department": "A String", # The department within the organization. Deprecated.
430 "type": "A String", # The type of organization. Possible values are:
431 # - "work" - Work.
432 # - "school" - School.
433 "name": "A String", # The name of the organization.
434 },
435 ],
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]436 "kind": "plus#person", # Identifies this resource as a person. Value: "plus#person".
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]437 "displayName": "A String", # The name of this person, suitable for display.
438 "name": { # An object representation of the individual components of a person's name.
439 "honorificPrefix": "A String", # The honorific prefixes (such as "Dr." or "Mrs.") for this person.
440 "middleName": "A String", # The middle name of this person.
441 "familyName": "A String", # The family name (last name) of this person.
442 "formatted": "A String", # The full name of this person, including middle names, suffixes, etc.
443 "givenName": "A String", # The given name (first name) of this person.
444 "honorificSuffix": "A String", # The honorific suffixes (such as "Jr.") for this person.
445 },
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]446 "language": "A String", # The user's preferred language for rendering.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]447 "url": "A String", # The URL of this person's profile.
448 "gender": "A String", # The person's gender. Possible values are:
449 # - "male" - Male gender.
450 # - "female" - Female gender.
451 # - "other" - Other.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]452 "cover": { # The cover photo content.
453 "layout": "A String", # The layout of the cover art. Possible values are:
454 # - "banner" - One large image banner.
455 "coverInfo": { # Extra information about the cover photo.
456 "leftImageOffset": 42, # The difference between the left position of the image cover and the actual displayed cover image. Only valid for BANNER layout.
457 "topImageOffset": 42, # The difference between the top position of the image cover and the actual displayed cover image. Only valid for BANNER layout.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]458 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]459 "coverPhoto": { # The person's primary cover image.
460 "url": "A String", # The url to the image.
461 "width": 42, # The width to the image.
462 "height": 42, # The height to the image.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]463 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]464 },
465 "isPlusUser": True or False, # Whether this user has signed up for Google+.
466 "plusOneCount": 42, # If a Google+ Page, the number of people who have +1'ed this page.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]467 "urls": [ # A list of URLs for this person.
468 {
469 "type": "A String", # The type of URL. Possible values are:
470 # - "home" - URL for home.
471 # - "work" - URL for work.
472 # - "blog" - URL for blog.
473 # - "profile" - URL for profile.
474 # - "other" - Other.
475 "primary": True or False, # If "true", this URL is the person's primary URL.
476 "value": "A String", # The URL value.
477 },
478 ],
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]479 "ageRange": { # The age range of the person.
480 "max": 42, # The age range's upper bound, if any.
481 "min": 42, # The age range's lower bound, if any.
482 },
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]483 },
484 ],
485 "etag": "A String", # ETag of this response for caching purposes.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]486 "totalItems": 42, # The total number of people available in this list. The number of people in a response might be smaller due to paging. This might not be set for all collections.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]487 "selfLink": "A String", # Link to this resource.
488 }</pre>
489</div>
490
491<div class="method">
492 <code class="details" id="listByActivity_next">listByActivity_next(previous_request, previous_response)</code>
493 <pre>Retrieves the next page of results.
494
495Args:
496 previous_request: The request for the previous page. (required)
497 previous_response: The response from the request for the previous page. (required)
498
499Returns:
500 A request object that you can call 'execute()' on to request the next
501 page. Returns None if there are no more items in the collection.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]502 </pre>
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]503</div>
504
505<div class="method">
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]506 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
507 <pre>Retrieves the next page of results.
508
509Args:
510 previous_request: The request for the previous page. (required)
511 previous_response: The response from the request for the previous page. (required)
512
513Returns:
514 A request object that you can call 'execute()' on to request the next
515 page. Returns None if there are no more items in the collection.
516 </pre>
517</div>
518
519<div class="method">
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]520 <code class="details" id="search">search(query, pageToken=None, language=None, maxResults=None)</code>
521 <pre>Search all public profiles.
522
523Args:
524 query: string, Specify a query string for full text search of public text in all profiles. (required)
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]525 pageToken: string, The continuation token, which is 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 can be of any length.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]526 language: string, Specify the preferred language to search with. See search language codes for available values.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]527 maxResults: integer, The maximum number of people to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]528
529Returns:
530 An object of the form:
531
532 {
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]533 "nextPageToken": "A String", # The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]534 "kind": "plus#peopleFeed", # Identifies this resource as a collection of people. Value: "plus#peopleFeed".
535 "title": "A String", # The title of this collection of people.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]536 "items": [ # The people in this page of results. Each item includes the id, displayName, image, and url for the person. To retrieve additional profile data, see the people.get method.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]537 {
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]538 "braggingRights": "A String", # The "bragging rights" line of this person.
539 "image": { # The representation of the person's profile photo.
540 "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.
541 },
542 "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).
543 "id": "A String", # The ID of this person.
544 "objectType": "A String", # Type of person within Google+. Possible values are:
545 # - "person" - represents an actual person.
546 # - "page" - represents a page.
547 "verified": True or False, # Whether the person or Google+ Page has been verified.
548 "tagline": "A String", # The brief description (tagline) of this person.
549 "currentLocation": "A String", # The current location for this person.
550 "etag": "A String", # ETag of this response for caching purposes.
551 "circledByCount": 42, # If a Google+ Page and for followers who are visible, the number of people who have added this page to a circle.
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]552 "relationshipStatus": "A String", # The person's relationship status. Possible values are:
553 # - "single" - Person is single.
554 # - "in_a_relationship" - Person is in a relationship.
555 # - "engaged" - Person is engaged.
556 # - "married" - Person is married.
557 # - "its_complicated" - The relationship is complicated.
558 # - "open_relationship" - Person is in an open relationship.
559 # - "widowed" - Person is widowed.
560 # - "in_domestic_partnership" - Person is in a domestic partnership.
561 # - "in_civil_union" - Person is in a civil union.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]562 "aboutMe": "A String", # A short biography for this person.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]563 "placesLived": [ # A list of places where this person has lived.
564 {
565 "primary": True or False, # If "true", this place of residence is this person's primary residence.
566 "value": "A String", # A place where this person has lived. For example: "Seattle, WA", "Near Toronto".
567 },
568 ],
569 "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
570 "nickname": "A String", # The nickname of this person.
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]571 "emails": [ # A list of email addresses that this person has set to public on their Google+ profile. You can also use the userinfo.email scope to retrieve an authenticated user's email address.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]572 {
573 "type": "A String", # The type of address. Possible values are:
574 # - "home" - Home email address.
575 # - "work" - Work email address.
576 # - "other" - Other.
577 "primary": True or False, # If "true", indicates this email address is the person's primary one.
578 "value": "A String", # The email address.
579 },
580 ],
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]581 "organizations": [ # A list of current or past organizations with which this person is associated.
582 {
583 "startDate": "A String", # The date the person joined this organization.
584 "endDate": "A String", # The date the person left this organization.
585 "description": "A String", # A short description of the person's role in this organization. Deprecated.
586 "title": "A String", # The person's job title or role within the organization.
587 "primary": True or False, # If "true", indicates this organization is the person's primary one (typically interpreted as current one).
588 "location": "A String", # The location of this organization. Deprecated.
589 "department": "A String", # The department within the organization. Deprecated.
590 "type": "A String", # The type of organization. Possible values are:
591 # - "work" - Work.
592 # - "school" - School.
593 "name": "A String", # The name of the organization.
594 },
595 ],
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]596 "kind": "plus#person", # Identifies this resource as a person. Value: "plus#person".
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]597 "displayName": "A String", # The name of this person, suitable for display.
598 "name": { # An object representation of the individual components of a person's name.
599 "honorificPrefix": "A String", # The honorific prefixes (such as "Dr." or "Mrs.") for this person.
600 "middleName": "A String", # The middle name of this person.
601 "familyName": "A String", # The family name (last name) of this person.
602 "formatted": "A String", # The full name of this person, including middle names, suffixes, etc.
603 "givenName": "A String", # The given name (first name) of this person.
604 "honorificSuffix": "A String", # The honorific suffixes (such as "Jr.") for this person.
605 },
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]606 "language": "A String", # The user's preferred language for rendering.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]607 "url": "A String", # The URL of this person's profile.
608 "gender": "A String", # The person's gender. Possible values are:
609 # - "male" - Male gender.
610 # - "female" - Female gender.
611 # - "other" - Other.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]612 "cover": { # The cover photo content.
613 "layout": "A String", # The layout of the cover art. Possible values are:
614 # - "banner" - One large image banner.
615 "coverInfo": { # Extra information about the cover photo.
616 "leftImageOffset": 42, # The difference between the left position of the image cover and the actual displayed cover image. Only valid for BANNER layout.
617 "topImageOffset": 42, # The difference between the top position of the image cover and the actual displayed cover image. Only valid for BANNER layout.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]618 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]619 "coverPhoto": { # The person's primary cover image.
620 "url": "A String", # The url to the image.
621 "width": 42, # The width to the image.
622 "height": 42, # The height to the image.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]623 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]624 },
625 "isPlusUser": True or False, # Whether this user has signed up for Google+.
626 "plusOneCount": 42, # If a Google+ Page, the number of people who have +1'ed this page.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]627 "urls": [ # A list of URLs for this person.
628 {
629 "type": "A String", # The type of URL. Possible values are:
630 # - "home" - URL for home.
631 # - "work" - URL for work.
632 # - "blog" - URL for blog.
633 # - "profile" - URL for profile.
634 # - "other" - Other.
635 "primary": True or False, # If "true", this URL is the person's primary URL.
636 "value": "A String", # The URL value.
637 },
638 ],
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]639 "ageRange": { # The age range of the person.
640 "max": 42, # The age range's upper bound, if any.
641 "min": 42, # The age range's lower bound, if any.
642 },
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]643 },
644 ],
645 "etag": "A String", # ETag of this response for caching purposes.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]646 "totalItems": 42, # The total number of people available in this list. The number of people in a response might be smaller due to paging. This might not be set for all collections.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]647 "selfLink": "A String", # Link to this resource.
648 }</pre>
649</div>
650
651<div class="method">
652 <code class="details" id="search_next">search_next(previous_request, previous_response)</code>
653 <pre>Retrieves the next page of results.
654
655Args:
656 previous_request: The request for the previous page. (required)
657 previous_response: The response from the request for the previous page. (required)
658
659Returns:
660 A request object that you can call 'execute()' on to request the next
661 page. Returns None if there are no more items in the collection.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]662 </pre>
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]663</div>
664
665</body></html>