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="plusDomains_v1.html">Google+ Domains API</a> . <a href="plusDomains_v1.people.html">people</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#get">get(userId)</a></code></p> 79<p class="firstline">Get a person's profile.</p> 80<p class="toc_element"> 81 <code><a href="#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">Shut down. See https://developers.google.com/+/api-shutdown for more details.</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<h3>Method Details</h3> 93<div class="method"> 94 <code class="details" id="get">get(userId)</code> 95 <pre>Get a person's profile. 96 97Args: 98 userId: string, The ID of the person to get the profile for. The special value "me" can be used to indicate the authenticated user. (required) 99 100Returns: 101 An object of the form: 102 103 { 104 "braggingRights": "A String", # The "bragging rights" line of this person. 105 "image": { # The representation of the person's profile photo. 106 "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. 107 "isDefault": True or False, # Whether the person's profile photo is the default one 108 }, 109 "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. 110 "id": "A String", # The ID of this person. 111 "occupation": "A String", # The occupation of this person. 112 "verified": True or False, # Whether the person or Google+ Page has been verified. 113 "tagline": "A String", # The brief description (tagline) of this person. 114 "currentLocation": "A String", # (this field is not currently used) 115 "etag": "A String", # ETag of this response for caching purposes. 116 "circledByCount": 42, # For followers who are visible, the number of people who have added this person or page to a circle. 117 "objectType": "A String", # Type of person within Google+. Possible values include, but are not limited to, the following values: 118 # - "person" - represents an actual person. 119 # - "page" - represents a page. 120 "relationshipStatus": "A String", # The person's relationship status. Possible values include, but are not limited to, the following values: 121 # - "single" - Person is single. 122 # - "in_a_relationship" - Person is in a relationship. 123 # - "engaged" - Person is engaged. 124 # - "married" - Person is married. 125 # - "its_complicated" - The relationship is complicated. 126 # - "open_relationship" - Person is in an open relationship. 127 # - "widowed" - Person is widowed. 128 # - "in_domestic_partnership" - Person is in a domestic partnership. 129 # - "in_civil_union" - Person is in a civil union. 130 "aboutMe": "A String", # A short biography for this person. 131 "placesLived": [ # A list of places where this person has lived. 132 { 133 "primary": True or False, # If "true", this place of residence is this person's primary residence. 134 "value": "A String", # A place where this person has lived. For example: "Seattle, WA", "Near Toronto". 135 }, 136 ], 137 "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD. 138 "nickname": "A String", # The nickname of this person. 139 "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. 140 { 141 "type": "A String", # The type of address. Possible values include, but are not limited to, the following values: 142 # - "account" - Google account email address. 143 # - "home" - Home email address. 144 # - "work" - Work email address. 145 # - "other" - Other. 146 "value": "A String", # The email address. 147 }, 148 ], 149 "organizations": [ # A list of current or past organizations with which this person is associated. 150 { 151 "startDate": "A String", # The date that the person joined this organization. 152 "endDate": "A String", # The date that the person left this organization. 153 "description": "A String", # A short description of the person's role in this organization. Deprecated. 154 "title": "A String", # The person's job title or role within the organization. 155 "primary": True or False, # If "true", indicates this organization is the person's primary one, which is typically interpreted as the current one. 156 "location": "A String", # The location of this organization. Deprecated. 157 "department": "A String", # The department within the organization. Deprecated. 158 "type": "A String", # The type of organization. Possible values include, but are not limited to, the following values: 159 # - "work" - Work. 160 # - "school" - School. 161 "name": "A String", # The name of the organization. 162 }, 163 ], 164 "kind": "plus#person", # Identifies this resource as a person. Value: "plus#person". 165 "displayName": "A String", # The name of this person, which is suitable for display. 166 "name": { # An object representation of the individual components of a person's name. 167 "honorificPrefix": "A String", # The honorific prefixes (such as "Dr." or "Mrs.") for this person. 168 "middleName": "A String", # The middle name of this person. 169 "familyName": "A String", # The family name (last name) of this person. 170 "formatted": "A String", # The full name of this person, including middle names, suffixes, etc. 171 "givenName": "A String", # The given name (first name) of this person. 172 "honorificSuffix": "A String", # The honorific suffixes (such as "Jr.") for this person. 173 }, 174 "skills": "A String", # The person's skills. 175 "gender": "A String", # The person's gender. Possible values include, but are not limited to, the following values: 176 # - "male" - Male gender. 177 # - "female" - Female gender. 178 # - "other" - Other. 179 "cover": { # The cover photo content. 180 "layout": "A String", # The layout of the cover art. Possible values include, but are not limited to, the following values: 181 # - "banner" - One large image banner. 182 "coverInfo": { # Extra information about the cover photo. 183 "leftImageOffset": 42, # The difference between the left position of the cover image and the actual displayed cover image. Only valid for banner layout. 184 "topImageOffset": 42, # The difference between the top position of the cover image and the actual displayed cover image. Only valid for banner layout. 185 }, 186 "coverPhoto": { # The person's primary cover image. 187 "url": "A String", # The URL of the image. 188 "width": 42, # The width of the image. 189 "height": 42, # The height of the image. 190 }, 191 }, 192 "url": "A String", # The URL of this person's profile. 193 "isPlusUser": True or False, # Whether this user has signed up for Google+. 194 "plusOneCount": 42, # If a Google+ Page, the number of people who have +1'd this page. 195 "urls": [ # A list of URLs for this person. 196 { 197 "type": "A String", # The type of URL. Possible values include, but are not limited to, the following values: 198 # - "otherProfile" - URL for another profile. 199 # - "contributor" - URL to a site for which this person is a contributor. 200 # - "website" - URL for this Google+ Page's primary website. 201 # - "other" - Other URL. 202 "value": "A String", # The URL value. 203 "label": "A String", # The label of the URL. 204 }, 205 ], 206 }</pre> 207</div> 208 209<div class="method"> 210 <code class="details" id="list">list(userId, collection, orderBy=None, pageToken=None, maxResults=None)</code> 211 <pre>List all of the people in the specified collection. 212 213Args: 214 userId: string, Get the collection of people for the person identified. Use "me" to indicate the authenticated user. (required) 215 collection: string, The collection of people to list. (required) 216 Allowed values 217 circled - The list of people who this user has added to one or more circles. 218 orderBy: string, The order to return people in. 219 Allowed values 220 alphabetical - Order the people by their display name. 221 best - Order people based on the relevence to the viewer. 222 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. 223 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. 224 225Returns: 226 An object of the form: 227 228 { 229 "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. 230 "kind": "plus#peopleFeed", # Identifies this resource as a collection of people. Value: "plus#peopleFeed". 231 "title": "A String", # The title of this collection of people. 232 "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. 233 { 234 "braggingRights": "A String", # The "bragging rights" line of this person. 235 "image": { # The representation of the person's profile photo. 236 "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. 237 "isDefault": True or False, # Whether the person's profile photo is the default one 238 }, 239 "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. 240 "id": "A String", # The ID of this person. 241 "occupation": "A String", # The occupation of this person. 242 "verified": True or False, # Whether the person or Google+ Page has been verified. 243 "tagline": "A String", # The brief description (tagline) of this person. 244 "currentLocation": "A String", # (this field is not currently used) 245 "etag": "A String", # ETag of this response for caching purposes. 246 "circledByCount": 42, # For followers who are visible, the number of people who have added this person or page to a circle. 247 "objectType": "A String", # Type of person within Google+. Possible values include, but are not limited to, the following values: 248 # - "person" - represents an actual person. 249 # - "page" - represents a page. 250 "relationshipStatus": "A String", # The person's relationship status. Possible values include, but are not limited to, the following values: 251 # - "single" - Person is single. 252 # - "in_a_relationship" - Person is in a relationship. 253 # - "engaged" - Person is engaged. 254 # - "married" - Person is married. 255 # - "its_complicated" - The relationship is complicated. 256 # - "open_relationship" - Person is in an open relationship. 257 # - "widowed" - Person is widowed. 258 # - "in_domestic_partnership" - Person is in a domestic partnership. 259 # - "in_civil_union" - Person is in a civil union. 260 "aboutMe": "A String", # A short biography for this person. 261 "placesLived": [ # A list of places where this person has lived. 262 { 263 "primary": True or False, # If "true", this place of residence is this person's primary residence. 264 "value": "A String", # A place where this person has lived. For example: "Seattle, WA", "Near Toronto". 265 }, 266 ], 267 "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD. 268 "nickname": "A String", # The nickname of this person. 269 "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. 270 { 271 "type": "A String", # The type of address. Possible values include, but are not limited to, the following values: 272 # - "account" - Google account email address. 273 # - "home" - Home email address. 274 # - "work" - Work email address. 275 # - "other" - Other. 276 "value": "A String", # The email address. 277 }, 278 ], 279 "organizations": [ # A list of current or past organizations with which this person is associated. 280 { 281 "startDate": "A String", # The date that the person joined this organization. 282 "endDate": "A String", # The date that the person left this organization. 283 "description": "A String", # A short description of the person's role in this organization. Deprecated. 284 "title": "A String", # The person's job title or role within the organization. 285 "primary": True or False, # If "true", indicates this organization is the person's primary one, which is typically interpreted as the current one. 286 "location": "A String", # The location of this organization. Deprecated. 287 "department": "A String", # The department within the organization. Deprecated. 288 "type": "A String", # The type of organization. Possible values include, but are not limited to, the following values: 289 # - "work" - Work. 290 # - "school" - School. 291 "name": "A String", # The name of the organization. 292 }, 293 ], 294 "kind": "plus#person", # Identifies this resource as a person. Value: "plus#person". 295 "displayName": "A String", # The name of this person, which is suitable for display. 296 "name": { # An object representation of the individual components of a person's name. 297 "honorificPrefix": "A String", # The honorific prefixes (such as "Dr." or "Mrs.") for this person. 298 "middleName": "A String", # The middle name of this person. 299 "familyName": "A String", # The family name (last name) of this person. 300 "formatted": "A String", # The full name of this person, including middle names, suffixes, etc. 301 "givenName": "A String", # The given name (first name) of this person. 302 "honorificSuffix": "A String", # The honorific suffixes (such as "Jr.") for this person. 303 }, 304 "skills": "A String", # The person's skills. 305 "gender": "A String", # The person's gender. Possible values include, but are not limited to, the following values: 306 # - "male" - Male gender. 307 # - "female" - Female gender. 308 # - "other" - Other. 309 "cover": { # The cover photo content. 310 "layout": "A String", # The layout of the cover art. Possible values include, but are not limited to, the following values: 311 # - "banner" - One large image banner. 312 "coverInfo": { # Extra information about the cover photo. 313 "leftImageOffset": 42, # The difference between the left position of the cover image and the actual displayed cover image. Only valid for banner layout. 314 "topImageOffset": 42, # The difference between the top position of the cover image and the actual displayed cover image. Only valid for banner layout. 315 }, 316 "coverPhoto": { # The person's primary cover image. 317 "url": "A String", # The URL of the image. 318 "width": 42, # The width of the image. 319 "height": 42, # The height of the image. 320 }, 321 }, 322 "url": "A String", # The URL of this person's profile. 323 "isPlusUser": True or False, # Whether this user has signed up for Google+. 324 "plusOneCount": 42, # If a Google+ Page, the number of people who have +1'd this page. 325 "urls": [ # A list of URLs for this person. 326 { 327 "type": "A String", # The type of URL. Possible values include, but are not limited to, the following values: 328 # - "otherProfile" - URL for another profile. 329 # - "contributor" - URL to a site for which this person is a contributor. 330 # - "website" - URL for this Google+ Page's primary website. 331 # - "other" - Other URL. 332 "value": "A String", # The URL value. 333 "label": "A String", # The label of the URL. 334 }, 335 ], 336 }, 337 ], 338 "etag": "A String", # ETag of this response for caching purposes. 339 "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. 340 "selfLink": "A String", # Link to this resource. 341 }</pre> 342</div> 343 344<div class="method"> 345 <code class="details" id="listByActivity">listByActivity(activityId, collection, pageToken=None, maxResults=None)</code> 346 <pre>Shut down. See https://developers.google.com/+/api-shutdown for more details. 347 348Args: 349 activityId: string, The ID of the activity to get the list of people for. (required) 350 collection: string, The collection of people to list. (required) 351 Allowed values 352 plusoners - List all people who have +1'd this activity. 353 resharers - List all people who have reshared this activity. 354 sharedto - List all people who this activity was shared to. 355 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. 356 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. 357 358Returns: 359 An object of the form: 360 361 { 362 "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. 363 "kind": "plus#peopleFeed", # Identifies this resource as a collection of people. Value: "plus#peopleFeed". 364 "title": "A String", # The title of this collection of people. 365 "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. 366 { 367 "braggingRights": "A String", # The "bragging rights" line of this person. 368 "image": { # The representation of the person's profile photo. 369 "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. 370 "isDefault": True or False, # Whether the person's profile photo is the default one 371 }, 372 "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. 373 "id": "A String", # The ID of this person. 374 "occupation": "A String", # The occupation of this person. 375 "verified": True or False, # Whether the person or Google+ Page has been verified. 376 "tagline": "A String", # The brief description (tagline) of this person. 377 "currentLocation": "A String", # (this field is not currently used) 378 "etag": "A String", # ETag of this response for caching purposes. 379 "circledByCount": 42, # For followers who are visible, the number of people who have added this person or page to a circle. 380 "objectType": "A String", # Type of person within Google+. Possible values include, but are not limited to, the following values: 381 # - "person" - represents an actual person. 382 # - "page" - represents a page. 383 "relationshipStatus": "A String", # The person's relationship status. Possible values include, but are not limited to, the following values: 384 # - "single" - Person is single. 385 # - "in_a_relationship" - Person is in a relationship. 386 # - "engaged" - Person is engaged. 387 # - "married" - Person is married. 388 # - "its_complicated" - The relationship is complicated. 389 # - "open_relationship" - Person is in an open relationship. 390 # - "widowed" - Person is widowed. 391 # - "in_domestic_partnership" - Person is in a domestic partnership. 392 # - "in_civil_union" - Person is in a civil union. 393 "aboutMe": "A String", # A short biography for this person. 394 "placesLived": [ # A list of places where this person has lived. 395 { 396 "primary": True or False, # If "true", this place of residence is this person's primary residence. 397 "value": "A String", # A place where this person has lived. For example: "Seattle, WA", "Near Toronto". 398 }, 399 ], 400 "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD. 401 "nickname": "A String", # The nickname of this person. 402 "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. 403 { 404 "type": "A String", # The type of address. Possible values include, but are not limited to, the following values: 405 # - "account" - Google account email address. 406 # - "home" - Home email address. 407 # - "work" - Work email address. 408 # - "other" - Other. 409 "value": "A String", # The email address. 410 }, 411 ], 412 "organizations": [ # A list of current or past organizations with which this person is associated. 413 { 414 "startDate": "A String", # The date that the person joined this organization. 415 "endDate": "A String", # The date that the person left this organization. 416 "description": "A String", # A short description of the person's role in this organization. Deprecated. 417 "title": "A String", # The person's job title or role within the organization. 418 "primary": True or False, # If "true", indicates this organization is the person's primary one, which is typically interpreted as the current one. 419 "location": "A String", # The location of this organization. Deprecated. 420 "department": "A String", # The department within the organization. Deprecated. 421 "type": "A String", # The type of organization. Possible values include, but are not limited to, the following values: 422 # - "work" - Work. 423 # - "school" - School. 424 "name": "A String", # The name of the organization. 425 }, 426 ], 427 "kind": "plus#person", # Identifies this resource as a person. Value: "plus#person". 428 "displayName": "A String", # The name of this person, which is suitable for display. 429 "name": { # An object representation of the individual components of a person's name. 430 "honorificPrefix": "A String", # The honorific prefixes (such as "Dr." or "Mrs.") for this person. 431 "middleName": "A String", # The middle name of this person. 432 "familyName": "A String", # The family name (last name) of this person. 433 "formatted": "A String", # The full name of this person, including middle names, suffixes, etc. 434 "givenName": "A String", # The given name (first name) of this person. 435 "honorificSuffix": "A String", # The honorific suffixes (such as "Jr.") for this person. 436 }, 437 "skills": "A String", # The person's skills. 438 "gender": "A String", # The person's gender. Possible values include, but are not limited to, the following values: 439 # - "male" - Male gender. 440 # - "female" - Female gender. 441 # - "other" - Other. 442 "cover": { # The cover photo content. 443 "layout": "A String", # The layout of the cover art. Possible values include, but are not limited to, the following values: 444 # - "banner" - One large image banner. 445 "coverInfo": { # Extra information about the cover photo. 446 "leftImageOffset": 42, # The difference between the left position of the cover image and the actual displayed cover image. Only valid for banner layout. 447 "topImageOffset": 42, # The difference between the top position of the cover image and the actual displayed cover image. Only valid for banner layout. 448 }, 449 "coverPhoto": { # The person's primary cover image. 450 "url": "A String", # The URL of the image. 451 "width": 42, # The width of the image. 452 "height": 42, # The height of the image. 453 }, 454 }, 455 "url": "A String", # The URL of this person's profile. 456 "isPlusUser": True or False, # Whether this user has signed up for Google+. 457 "plusOneCount": 42, # If a Google+ Page, the number of people who have +1'd this page. 458 "urls": [ # A list of URLs for this person. 459 { 460 "type": "A String", # The type of URL. Possible values include, but are not limited to, the following values: 461 # - "otherProfile" - URL for another profile. 462 # - "contributor" - URL to a site for which this person is a contributor. 463 # - "website" - URL for this Google+ Page's primary website. 464 # - "other" - Other URL. 465 "value": "A String", # The URL value. 466 "label": "A String", # The label of the URL. 467 }, 468 ], 469 }, 470 ], 471 "etag": "A String", # ETag of this response for caching purposes. 472 "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. 473 "selfLink": "A String", # Link to this resource. 474 }</pre> 475</div> 476 477<div class="method"> 478 <code class="details" id="listByActivity_next">listByActivity_next(previous_request, previous_response)</code> 479 <pre>Retrieves the next page of results. 480 481Args: 482 previous_request: The request for the previous page. (required) 483 previous_response: The response from the request for the previous page. (required) 484 485Returns: 486 A request object that you can call 'execute()' on to request the next 487 page. Returns None if there are no more items in the collection. 488 </pre> 489</div> 490 491<div class="method"> 492 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 493 <pre>Retrieves the next page of results. 494 495Args: 496 previous_request: The request for the previous page. (required) 497 previous_response: The response from the request for the previous page. (required) 498 499Returns: 500 A request object that you can call 'execute()' on to request the next 501 page. Returns None if there are no more items in the collection. 502 </pre> 503</div> 504 505</body></html>