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