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