google_api_people v0.12.0 API Reference
Modules
API calls for all endpoints tagged ContactGroups
.
API calls for all endpoints tagged People
.
Handle Tesla connections for GoogleApi.People.V1.
A person's physical address. May be a P.O. box or street address. All fields are optional.
A person's age range.
The response to a batch get contact groups request.
A person's short biography.
A person's birthday. At least one of the date
and text
fields are
specified. The date
and text
fields typically represent the same
date, but are not guaranteed to.
A person's bragging rights.
A contact group.
A Google contact group membership.
The read-only metadata about a contact group.
The response for a specific contact group.
A person's read-only cover photo. A large image shown on the person's profile page that represents who they are or what they care about.
A request to create a new contact group.
Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. The day may be 0 to represent a year and month where the day is not significant. The year may be 0 to represent a month and day independent of year; for example, anniversary date.
The response for deleteing a contact's photo.
A read-only G Suite Domain membership.
A person's email address.
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance
An event related to the person.
Metadata about a field.
A person's gender.
A person's instant messaging client.
One of the person's interests.
Attributes
connections
(type:list(GoogleApi.People.V1.Model.Person.t)
, default:nil
) - The list of people that the requestor is connected to.nextPageToken
(type:String.t
, default:nil
) - The token that can be used to retrieve the next page of results.nextSyncToken
(type:String.t
, default:nil
) - The token that can be used to retrieve changes since the last request.totalItems
(type:integer()
, default:nil
) - The total number of items in the list without pagination.totalPeople
(type:integer()
, default:nil
) - DEPRECATED (Please use totalItems) The total number of people in the list without pagination.
The response to a list contact groups request.
A person's locale preference.
A person's membership in a group. Only contact group memberships can be modified.
A request to modify an existing contact group's members. Contacts can be removed from any group but they can only be added to a user group or "myContacts" or "starred" system groups.
The response to a modify contact group members request.
A person's name. If the name is a mononym, the family name is empty.
A person's nickname.
A person's occupation.
A person's past or current organization. Overlapping date ranges are permitted.
Information about a person merged from various data sources such as the authenticated user's contacts and profile data.
The read-only metadata about a person.
The response for a single person
A person's phone number.
A person's read-only photo. A picture shown next to the person's name to help others recognize the person.
The read-only metadata about a profile.
A person's relation to another person.
A person's read-only relationship interest .
A person's read-only relationship status.
A person's past or current residence.
A person's SIP address. Session Initial Protocol addresses are used for VoIP communications to make voice or video calls over the internet.
A skill that the person has.
The source of a field.
The Status
type defines a logical error model that is suitable for
different programming environments, including REST APIs and RPC APIs. It is
used by gRPC. Each Status
message contains
three pieces of data: error code, error message, and error details.
A read-only brief one-line description of the person.
A request to update an existing user contact group. All updated fields will be replaced.
A request to update an existing contact's photo. All requests must have a valid photo format: JPEG or PNG.
The response for updating a contact's photo.
A person's associated URLs.
Arbitrary user data that is populated by the end users.