People

People is a list of person resources, each of which represents a Google+ user. People methods enable your application to get a person's profile, search through profiles, and list all of the people who have +1'd or reshared a particular activity. Each person has an uniquely identifying ID.

For a list of methods for this resource, see the end of this page.

Resource representations

A person is represented in the Google+ API as a JSON data structure, as shown below, that is sent in the body of a request, or received in the body of a response. This representation is the set of all possible fields a person can contain.

A person has a name, photo image, profile URL, and other properties that make up its profile.

{
  "kind": "plus#person",
  "etag": etag,
  "nickname": string,
  "occupation": string,
  "skills": string,
  "birthday": string,
  "gender": string,
  "emails": [
    {
      "value": string,
      "type": string
    }
  ],
  "urls": [
    {
      "value": string,
      "type": string,
      "label": string
    }
  ],
  "objectType": string,
  "id": string,
  "displayName": string,
  "name": {
    "formatted": string,
    "familyName": string,
    "givenName": string,
    "middleName": string,
    "honorificPrefix": string,
    "honorificSuffix": string
  },
  "tagline": string,
  "braggingRights": string,
  "aboutMe": string,
  "relationshipStatus": string,
  "url": string,
  "image": {
    "url": string,

  },
  "organizations": [
    {
      "name": string,
      "department": string,
      "title": string,
      "type": string,
      "startDate": string,
      "endDate": string,
      "location": string,
      "description": string,
      "primary": boolean
    }
  ],
  "placesLived": [
    {
      "value": string,
      "primary": boolean
    }
  ],
  "isPlusUser": boolean,
  "language": string,
  "ageRange": {
    "min": integer,
    "max": integer
  },
  "plusOneCount": integer,
  "circledByCount": integer,
  "verified": boolean,
  "cover": {
    "layout": string,
    "coverPhoto": {
      "url": string,
      "height": integer,
      "width": integer
    },
    "coverInfo": {
      "topImageOffset": integer,
      "leftImageOffset": integer
    }
  },
  "domain": string
}

Property name	Value	Description
`kind`	`string`	Identifies this resource as a person. Value: "`plus#person`".
`id`	`string`	The ID of this person.
`displayName`	`string`	The name of this person, which is suitable for display.
`name`	`object`	An object representation of the individual components of a person's name.
`name.formatted`	`string`	The full name of this person, including middle names, suffixes, etc.
`name.familyName`	`string`	The family name (last name) of this person.
`name.givenName`	`string`	The given name (first name) of this person.
`name.middleName`	`string`	The middle name of this person.
`name.honorificPrefix`	`string`	The honorific prefixes (such as "`Dr.`" or "`Mrs.`") for this person.
`name.honorificSuffix`	`string`	The honorific suffixes (such as "`Jr.`") for this person.
`nickname`	`string`	The nickname of this person.
`birthday`	`string`	The person's date of birth, represented as YYYY-MM-DD.
`gender`	`string`	The person's gender. Possible values include, but are not limited to, the following values: "`male`" - Male gender. "`female`" - Female gender. "`other`" - Other.
`url`	`string`	The URL of this person's profile.
`image`	`object`	The representation of the person's profile photo.
`image.url`	`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.
`aboutMe`	`string`	A short biography for this person.
`relationshipStatus`	`string`	The person's relationship status. Possible values include, but are not limited to, the following values: "`single`" - Person is single. "`in_a_relationship`" - Person is in a relationship. "`engaged`" - Person is engaged. "`married`" - Person is married. "`its_complicated`" - The relationship is complicated. "`open_relationship`" - Person is in an open relationship. "`widowed`" - Person is widowed. "`in_domestic_partnership`" - Person is in a domestic partnership. "`in_civil_union`" - Person is in a civil union.
`urls[]`	`list`	A list of URLs for this person.
`urls[].label`	`string`	The label of the URL.
`urls[].value`	`string`	The URL value.
`urls[].type`	`string`	The type of URL. Possible values include, but are not limited to, the following values: "`otherProfile`" - URL for another profile. "`contributor`" - URL to a site for which this person is a contributor. "`website`" - URL for this Google+ Page's primary website. "`other`" - Other URL.
`organizations[]`	`list`	A list of current or past organizations with which this person is associated.
`organizations[].name`	`string`	The name of the organization.
`organizations[].department`	`string`	The department within the organization. Deprecated.
`organizations[].title`	`string`	The person's job title or role within the organization.
`organizations[].type`	`string`	The type of organization. Possible values include, but are not limited to, the following values: "`work`" - Work. "`school`" - School.
`organizations[].startDate`	`string`	The date that the person joined this organization.
`organizations[].endDate`	`string`	The date that the person left this organization.
`organizations[].location`	`string`	The location of this organization. Deprecated.
`organizations[].description`	`string`	A short description of the person's role in this organization. Deprecated.
`organizations[].primary`	`boolean`	If "`true`", indicates this organization is the person's primary one, which is typically interpreted as the current one.
`placesLived[]`	`list`	A list of places where this person has lived.
`placesLived[].value`	`string`	A place where this person has lived. For example: "`Seattle, WA`", "`Near Toronto`".
`placesLived[].primary`	`boolean`	If "`true`", this place of residence is this person's primary residence.
`tagline`	`string`	The brief description (tagline) of this person.
`objectType`	`string`	Type of person within Google+. Possible values include, but are not limited to, the following values: "`person`" - represents an actual person. "`page`" - represents a page.
`etag`	`etag`	ETag of this response for caching purposes.
`isPlusUser`	`boolean`	Whether this user has signed up for Google+.
`braggingRights`	`string`	The "bragging rights" line of this person.
`plusOneCount`	`integer`	If a Google+ Page, the number of people who have +1'd this page.
`circledByCount`	`integer`	For followers who are visible, the number of people who have added this person or page to a circle.
`verified`	`boolean`	Whether the person or Google+ Page has been verified. This is used only for pages with a higher risk of being impersonated or similar. This flag will not be present on most profiles.
`cover`	`object`	The cover photo content.
`cover.layout`	`string`	The layout of the cover art. Possible values include, but are not limited to, the following values: "`banner`" - One large image banner.
`cover.coverPhoto`	`object`	The person's primary cover image.
`cover.coverPhoto.url`	`string`	The URL of the image.
`cover.coverPhoto.height`	`integer`	The height of the image.
`cover.coverPhoto.width`	`integer`	The width of the image.
`cover.coverInfo`	`object`	Extra information about the cover photo.
`cover.coverInfo.topImageOffset`	`integer`	The difference between the top position of the cover image and the actual displayed cover image. Only valid for `banner` layout.
`cover.coverInfo.leftImageOffset`	`integer`	The difference between the left position of the cover image and the actual displayed cover image. Only valid for `banner` layout.
`language`	`string`	The user's preferred language for rendering.
`ageRange`	`object`	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.
`ageRange.min`	`integer`	The age range's lower bound, if any. Possible values include, but are not limited to, the following: "`21`" - for age 21 "`18`" - for age 18
`ageRange.max`	`integer`	The age range's upper bound, if any. Possible values include, but are not limited to, the following: "`17`" - for age 17 "`20`" - for age 20
`emails[]`	`list`	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.
`emails[].value`	`string`	The email address.
`emails[].type`	`string`	The type of address. Possible values include, but are not limited to, the following values: "`account`" - Google account email address. "`home`" - Home email address. "`work`" - Work email address. "`other`" - Other.
`domain`	`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.
`occupation`	`string`	The occupation of this person.
`skills`	`string`	The person's skills.

Methods

get: 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.
search: Search all public profiles.
listByActivity: List all of the people in the specified collection for a particular activity.
list: List all of the people in the specified collection.

Resource representations

Methods

Send feedback about...