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