GoogleApi.People.V1.Model.Person (google_api_people v0.37.5) View Source

Information about a person merged from various data sources such as the authenticated user's contacts and profile data. Most fields can have multiple items. The items in a field have no guaranteed order, but each non-empty field is guaranteed to have exactly one field with metadata.primary set to true.


  • relationshipStatuses (type: list(GoogleApi.People.V1.Model.RelationshipStatus.t), default: nil) - Output only. DEPRECATED: No data will be returned The person's relationship statuses.
  • genders (type: list(GoogleApi.People.V1.Model.Gender.t), default: nil) - The person's genders. This field is a singleton for contact sources.
  • biographies (type: list(GoogleApi.People.V1.Model.Biography.t), default: nil) - The person's biographies. This field is a singleton for contact sources.
  • etag (type: String.t, default: nil) - The HTTP entity tag of the resource. Used for web cache validation.
  • names (type: list(GoogleApi.People.V1.Model.Name.t), default: nil) - The person's names. This field is a singleton for contact sources.
  • taglines (type: list(GoogleApi.People.V1.Model.Tagline.t), default: nil) - Output only. DEPRECATED: No data will be returned The person's taglines.
  • residences (type: list(GoogleApi.People.V1.Model.Residence.t), default: nil) - DEPRECATED: (Please use person.locations instead) The person's residences.
  • sipAddresses (type: list(GoogleApi.People.V1.Model.SipAddress.t), default: nil) - The person's SIP addresses.
  • externalIds (type: list(GoogleApi.People.V1.Model.ExternalId.t), default: nil) - The person's external IDs.
  • metadata (type: GoogleApi.People.V1.Model.PersonMetadata.t, default: nil) - Output only. Metadata about the person.
  • occupations (type: list(GoogleApi.People.V1.Model.Occupation.t), default: nil) - The person's occupations.
  • imClients (type: list(GoogleApi.People.V1.Model.ImClient.t), default: nil) - The person's instant messaging clients.
  • addresses (type: list(GoogleApi.People.V1.Model.Address.t), default: nil) - The person's street addresses.
  • clientData (type: list(GoogleApi.People.V1.Model.ClientData.t), default: nil) - The person's client data.
  • skills (type: list(GoogleApi.People.V1.Model.Skill.t), default: nil) - The person's skills.
  • phoneNumbers (type: list(GoogleApi.People.V1.Model.PhoneNumber.t), default: nil) - The person's phone numbers.
  • relations (type: list(GoogleApi.People.V1.Model.Relation.t), default: nil) - The person's relations.
  • ageRanges (type: list(GoogleApi.People.V1.Model.AgeRangeType.t), default: nil) - Output only. The person's age ranges.
  • coverPhotos (type: list(GoogleApi.People.V1.Model.CoverPhoto.t), default: nil) - Output only. The person's cover photos.
  • birthdays (type: list(GoogleApi.People.V1.Model.Birthday.t), default: nil) - The person's birthdays. This field is a singleton for contact sources.
  • calendarUrls (type: list(GoogleApi.People.V1.Model.CalendarUrl.t), default: nil) - The person's calendar URLs.
  • locales (type: list(GoogleApi.People.V1.Model.Locale.t), default: nil) - The person's locale preferences.
  • locations (type: list(GoogleApi.People.V1.Model.Location.t), default: nil) - The person's locations.
  • interests (type: list(GoogleApi.People.V1.Model.Interest.t), default: nil) - The person's interests.
  • nicknames (type: list(GoogleApi.People.V1.Model.Nickname.t), default: nil) - The person's nicknames.
  • braggingRights (type: list(GoogleApi.People.V1.Model.BraggingRights.t), default: nil) - DEPRECATED: No data will be returned The person's bragging rights.
  • fileAses (type: list(GoogleApi.People.V1.Model.FileAs.t), default: nil) - The person's file-ases.
  • photos (type: list(GoogleApi.People.V1.Model.Photo.t), default: nil) - Output only. The person's photos.
  • events (type: list(GoogleApi.People.V1.Model.Event.t), default: nil) - The person's events.
  • userDefined (type: list(GoogleApi.People.V1.Model.UserDefined.t), default: nil) - The person's user defined data.
  • relationshipInterests (type: list(GoogleApi.People.V1.Model.RelationshipInterest.t), default: nil) - Output only. DEPRECATED: No data will be returned The person's relationship interests.
  • memberships (type: list(GoogleApi.People.V1.Model.Membership.t), default: nil) - The person's group memberships.
  • emailAddresses (type: list(GoogleApi.People.V1.Model.EmailAddress.t), default: nil) - The person's email addresses.
  • ageRange (type: String.t, default: nil) - Output only. DEPRECATED (Please use person.ageRanges instead) The person's age range.
  • urls (type: list(GoogleApi.People.V1.Model.Url.t), default: nil) - The person's associated URLs.
  • resourceName (type: String.t, default: nil) - The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters, in the form of people/{person_id}.
  • miscKeywords (type: list(GoogleApi.People.V1.Model.MiscKeyword.t), default: nil) - The person's miscellaneous keywords.
  • organizations (type: list(GoogleApi.People.V1.Model.Organization.t), default: nil) - The person's past or current organizations.

Link to this section Summary


Unwrap a decoded JSON object into its complex fields.

Link to this section Types


t() :: %GoogleApi.People.V1.Model.Person{
  addresses: [GoogleApi.People.V1.Model.Address.t()] | nil,
  ageRange: String.t() | nil,
  ageRanges: [GoogleApi.People.V1.Model.AgeRangeType.t()] | nil,
  biographies: [GoogleApi.People.V1.Model.Biography.t()] | nil,
  birthdays: [GoogleApi.People.V1.Model.Birthday.t()] | nil,
  braggingRights: [GoogleApi.People.V1.Model.BraggingRights.t()] | nil,
  calendarUrls: [GoogleApi.People.V1.Model.CalendarUrl.t()] | nil,
  clientData: [GoogleApi.People.V1.Model.ClientData.t()] | nil,
  coverPhotos: [GoogleApi.People.V1.Model.CoverPhoto.t()] | nil,
  emailAddresses: [GoogleApi.People.V1.Model.EmailAddress.t()] | nil,
  etag: String.t() | nil,
  events: [GoogleApi.People.V1.Model.Event.t()] | nil,
  externalIds: [GoogleApi.People.V1.Model.ExternalId.t()] | nil,
  fileAses: [GoogleApi.People.V1.Model.FileAs.t()] | nil,
  genders: [GoogleApi.People.V1.Model.Gender.t()] | nil,
  imClients: [GoogleApi.People.V1.Model.ImClient.t()] | nil,
  interests: [GoogleApi.People.V1.Model.Interest.t()] | nil,
  locales: [GoogleApi.People.V1.Model.Locale.t()] | nil,
  locations: [GoogleApi.People.V1.Model.Location.t()] | nil,
  memberships: [GoogleApi.People.V1.Model.Membership.t()] | nil,
  metadata: GoogleApi.People.V1.Model.PersonMetadata.t() | nil,
  miscKeywords: [GoogleApi.People.V1.Model.MiscKeyword.t()] | nil,
  names: [GoogleApi.People.V1.Model.Name.t()] | nil,
  nicknames: [GoogleApi.People.V1.Model.Nickname.t()] | nil,
  occupations: [GoogleApi.People.V1.Model.Occupation.t()] | nil,
  organizations: [GoogleApi.People.V1.Model.Organization.t()] | nil,
  phoneNumbers: [GoogleApi.People.V1.Model.PhoneNumber.t()] | nil,
  photos: [GoogleApi.People.V1.Model.Photo.t()] | nil,
  relations: [GoogleApi.People.V1.Model.Relation.t()] | nil,
    [GoogleApi.People.V1.Model.RelationshipInterest.t()] | nil,
    [GoogleApi.People.V1.Model.RelationshipStatus.t()] | nil,
  residences: [GoogleApi.People.V1.Model.Residence.t()] | nil,
  resourceName: String.t() | nil,
  sipAddresses: [GoogleApi.People.V1.Model.SipAddress.t()] | nil,
  skills: [GoogleApi.People.V1.Model.Skill.t()] | nil,
  taglines: [GoogleApi.People.V1.Model.Tagline.t()] | nil,
  urls: [GoogleApi.People.V1.Model.Url.t()] | nil,
  userDefined: [GoogleApi.People.V1.Model.UserDefined.t()] | nil

Link to this section Functions


decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.