people/v1 library
People API - v1
Provides access to information about profiles and contacts.
For more information, see developers.google.com/people/
Create an instance of PeopleServiceApi to access these resources:
Classes
- Address
- A person's physical address.
- AgeRangeType
- A person's age range.
- BatchCreateContactsRequest
- A request to create a batch of contacts.
- BatchCreateContactsResponse
- If not successful, returns BatchCreateContactsErrorDetails which contains a list of errors for each invalid contact.
- BatchDeleteContactsRequest
- A request to delete a batch of existing contacts.
- BatchGetContactGroupsResponse
- The response to a batch get contact groups request.
- BatchUpdateContactsRequest
- A request to update a batch of contacts.
- BatchUpdateContactsResponse
- If not successful, returns BatchUpdateContactsErrorDetails, a list of errors corresponding to each contact.
- Biography
- A person's short biography.
- Birthday
- A person's birthday.
- BraggingRights
- DEPRECATED: No data will be returned A person's bragging rights.
- CalendarUrl
- A person's calendar URL.
- ClientData
- Arbitrary client data that is populated by clients.
- ContactGroup
- A contact group.
- ContactGroupMembership
- A Google contact group membership.
- ContactGroupMetadata
- The metadata about a contact group.
- ContactGroupResponse
- The response for a specific contact group.
- ContactGroupsMembersResource
- ContactGroupsResource
- ContactToCreate
- A wrapper that contains the person data to populate a newly created source.
- CopyOtherContactToMyContactsGroupRequest
- A request to copy an "Other contact" to my contacts group.
- CoverPhoto
- A person's cover photo.
- CreateContactGroupRequest
- A request to create a new contact group.
- DeleteContactPhotoResponse
- The response for deleting a contact's photo.
- DomainMembership
- A Google Workspace Domain membership.
- EmailAddress
- A person's email address.
- Event
- An event related to the person.
- ExternalId
- An identifier from an external entity related to the person.
- FieldMetadata
- Metadata about a field.
- FileAs
- The name that should be used to sort the person in a list.
- Gender
- A person's gender.
- GetPeopleResponse
- The response to a get request for a list of people by resource name.
- GroupClientData
- Arbitrary client data that is populated by clients.
- ImClient
- A person's instant messaging client.
- Interest
- One of the person's interests.
- ListConnectionsResponse
- The response to a request for the authenticated user's connections.
- ListContactGroupsResponse
- The response to a list contact groups request.
- ListDirectoryPeopleResponse
- The response to a request for the authenticated user's domain directory.
- ListOtherContactsResponse
- The response to a request for the authenticated user's "Other contacts".
- Locale
- A person's locale preference.
- Location
- A person's location.
- Membership
- A person's membership in a group.
- MiscKeyword
- A person's miscellaneous keyword.
- ModifyContactGroupMembersRequest
- A request to modify an existing contact group's members.
- ModifyContactGroupMembersResponse
- The response to a modify contact group members request.
- Name
- A person's name.
- Nickname
- A person's nickname.
- Occupation
- A person's occupation.
- Organization
- A person's past or current organization.
- OtherContactsResource
- PeopleConnectionsResource
- PeopleResource
- PeopleServiceApi
- Provides access to information about profiles and contacts.
- Person
- Information about a person merged from various data sources such as the authenticated user's contacts and profile data.
- PersonMetadata
- The metadata about a person.
- PersonResponse
- The response for a single person
- PhoneNumber
- A person's phone number.
- Photo
- A person's photo.
- ProfileMetadata
- The metadata about a profile.
- Relation
- A person's relation to another person.
- RelationshipInterest
- DEPRECATED: No data will be returned A person's relationship interest .
- RelationshipStatus
- DEPRECATED: No data will be returned A person's relationship status.
- Residence
-
DEPRECATED: Please use
person.locationsinstead. - SearchDirectoryPeopleResponse
- The response to a request for people in the authenticated user's domain directory that match the specified query.
- SearchResponse
- The response to a search request for the authenticated user, given a query.
- SearchResult
- A result of a search query.
- SipAddress
- A person's SIP address.
- Skill
- A skill that the person has.
- Source
- The source of a field.
- Tagline
- DEPRECATED: No data will be returned A brief one-line description of the person.
- UpdateContactGroupRequest
- A request to update an existing user contact group.
- UpdateContactPhotoRequest
- A request to update an existing contact's photo.
- UpdateContactPhotoResponse
- The response for updating a contact's photo.
- Url
- A person's associated URLs.
- UserDefined
- Arbitrary user data that is populated by the end users.
Typedefs
- Date = $Date
- Represents a whole or partial calendar date, such as a birthday.
- Empty = $Empty
- A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs.
- Status = $Status
-
The
Statustype defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs.
Exceptions / Errors
- ApiRequestError
- Represents a general error reported by the API endpoint.
- DetailedApiRequestError
- Represents a specific error reported by the API endpoint.