REST Resource: people

Zasób: osoba

Informacje o osobie scalone z różnych źródeł danych, takich jak kontakty i dane profilowe uwierzytelnionego użytkownika.

Większość pól może zawierać wiele elementów. Kolejność elementów w polu nie jest gwarantowana, ale każde niepuste pole zawsze ma dokładnie 1 pole z atrybutem metadata.primary o wartości „true”.

Zapis JSON
{
  "resourceName": string,
  "etag": string,
  "metadata": {
    object (PersonMetadata)
  },
  "addresses": [
    {
      object (Address)
    }
  ],
  "ageRange": enum (AgeRange),
  "ageRanges": [
    {
      object (AgeRangeType)
    }
  ],
  "biographies": [
    {
      object (Biography)
    }
  ],
  "birthdays": [
    {
      object (Birthday)
    }
  ],
  "braggingRights": [
    {
      object (BraggingRights)
    }
  ],
  "calendarUrls": [
    {
      object (CalendarUrl)
    }
  ],
  "clientData": [
    {
      object (ClientData)
    }
  ],
  "coverPhotos": [
    {
      object (CoverPhoto)
    }
  ],
  "emailAddresses": [
    {
      object (EmailAddress)
    }
  ],
  "events": [
    {
      object (Event)
    }
  ],
  "externalIds": [
    {
      object (ExternalId)
    }
  ],
  "fileAses": [
    {
      object (FileAs)
    }
  ],
  "genders": [
    {
      object (Gender)
    }
  ],
  "imClients": [
    {
      object (ImClient)
    }
  ],
  "interests": [
    {
      object (Interest)
    }
  ],
  "locales": [
    {
      object (Locale)
    }
  ],
  "locations": [
    {
      object (Location)
    }
  ],
  "memberships": [
    {
      object (Membership)
    }
  ],
  "miscKeywords": [
    {
      object (MiscKeyword)
    }
  ],
  "names": [
    {
      object (Name)
    }
  ],
  "nicknames": [
    {
      object (Nickname)
    }
  ],
  "occupations": [
    {
      object (Occupation)
    }
  ],
  "organizations": [
    {
      object (Organization)
    }
  ],
  "phoneNumbers": [
    {
      object (PhoneNumber)
    }
  ],
  "photos": [
    {
      object (Photo)
    }
  ],
  "relations": [
    {
      object (Relation)
    }
  ],
  "relationshipInterests": [
    {
      object (RelationshipInterest)
    }
  ],
  "relationshipStatuses": [
    {
      object (RelationshipStatus)
    }
  ],
  "residences": [
    {
      object (Residence)
    }
  ],
  "sipAddresses": [
    {
      object (SipAddress)
    }
  ],
  "skills": [
    {
      object (Skill)
    }
  ],
  "taglines": [
    {
      object (Tagline)
    }
  ],
  "urls": [
    {
      object (Url)
    }
  ],
  "userDefined": [
    {
      object (UserDefined)
    }
  ]
}
Pola
resourceName

string

Nazwa zasobu dla osoby przypisana przez serwer. Ciąg ASCII w postaci people/{person_id}.

etag

string

Tag encji HTTP zasobu. Służy do sprawdzania poprawności pamięci podręcznej przeglądarki.

metadata

object (PersonMetadata)

Tylko dane wyjściowe. Metadane dotyczące osoby.

addresses[]

object (Address)

Adresy pocztowe osoby.

ageRange
(deprecated)

enum (AgeRange)

Tylko dane wyjściowe. WYCOFANE (zamiast tego użyj person.ageRanges)

Przedział wiekowy danej osoby.

ageRanges[]

object (AgeRangeType)

Tylko dane wyjściowe. Przedziały wiekowe danej osoby.

biographies[]

object (Biography)

Biografie danej osoby. To pole służy do oznaczania źródeł kontaktów.

birthdays[]

object (Birthday)

Urodziny danej osoby. To pole służy do oznaczania źródeł kontaktów.

braggingRights[]
(deprecated)

object (BraggingRights)

WYCOFANE: żadne dane tej osoby nie zostaną zwrócone.

calendarUrls[]

object (CalendarUrl)

Adresy URL kalendarza tej osoby.

clientData[]

object (ClientData)

Dane klienta tej osoby.

coverPhotos[]

object (CoverPhoto)

Tylko dane wyjściowe. Zdjęcia na okładkę tej osoby.

emailAddresses[]

object (EmailAddress)

Adresy e-mail tej osoby. W przypadku people.connections.list i otherContacts.list liczba adresów e-mail jest ograniczona do 100. Jeśli dana osoba ma więcej adresów e-mail, cały zestaw da się uzyskać, dzwoniąc pod numer people.getBatchGet.

events[]

object (Event)

Zdarzenia dotyczące tej osoby.

externalIds[]

object (ExternalId)

Zewnętrzne identyfikatory użytkownika.

fileAses[]

object (FileAs)

Asy plików danej osoby.

genders[]

object (Gender)

Płeć danej osoby. To pole służy do oznaczania źródeł kontaktów.

imClients[]

object (ImClient)

Klienty czatu tej osoby.

interests[]

object (Interest)

Zainteresowania osoby.

locales[]

object (Locale)

Preferencje dotyczące języka użytkownika.

locations[]

object (Location)

Lokalizacje osoby.

memberships[]

object (Membership)

Członkostwa tej osoby w grupach.

miscKeywords[]

object (MiscKeyword)

Różne słowa kluczowe użytkownika.

names[]

object (Name)

Imiona i nazwiska osoby. To pole służy do oznaczania źródeł kontaktów.

nicknames[]

object (Nickname)

Pseudonimy danej osoby.

occupations[]

object (Occupation)

Zawody wykonywane przez tę osobę.

organizations[]

object (Organization)

Poprzednia lub obecna organizacja danej osoby.

phoneNumbers[]

object (PhoneNumber)

Numery telefonów tej osoby. W przypadku usług people.connections.list i otherContacts.list liczba numerów telefonu jest ograniczona do 100. Jeśli ta osoba ma więcej numerów telefonu, cały zestaw da się uzyskać, dzwoniąc pod numer people.getBatchGet.

photos[]

object (Photo)

Tylko dane wyjściowe. Zdjęcia danej osoby.

relations[]

object (Relation)

Relacje danej osoby.

relationshipInterests[]
(deprecated)

object (RelationshipInterest)

Tylko dane wyjściowe. WYCOFANE: nie zostaną zwrócone żadne dane dotyczące interesów tej osoby.

relationshipStatuses[]
(deprecated)

object (RelationshipStatus)

Tylko dane wyjściowe. WYCOFANE: informacje o relacjach danej osoby nie będą zwracane.

residences[]
(deprecated)

object (Residence)

WYCOFANE: (zamiast tego użyj person.locations) Domy osoby.

sipAddresses[]

object (SipAddress)

Adresy SIP osoby.

skills[]

object (Skill)

Umiejętności danej osoby.

taglines[]
(deprecated)

object (Tagline)

Tylko dane wyjściowe. WYCOFANE: slogany tej osoby nie będą zwracane.

urls[]

object (Url)

Powiązane adresy URL dotyczące tej osoby.

userDefined[]

object (UserDefined)

Dane zdefiniowane przez użytkownika.

PersonMetadata

Metadane dotyczące osoby.

Zapis JSON
{
  "sources": [
    {
      object (Source)
    }
  ],
  "previousResourceNames": [
    string
  ],
  "linkedPeopleResourceNames": [
    string
  ],
  "deleted": boolean,
  "objectType": enum (ObjectType)
}
Pola
sources[]

object (Source)

Źródła danych dotyczących danej osoby.

previousResourceNames[]

string

Tylko dane wyjściowe. Wszelkie dawne nazwy zasobów, które miała ta osoba. Wartość podawana tylko w przypadku żądań people.connections.list zawierających token synchronizacji.

Nazwa zasobu może się zmienić podczas dodawania lub usuwania pól łączących kontakt i profil, takich jak zweryfikowany adres e-mail, zweryfikowany numer telefonu czy URL profilu.

linkedPeopleResourceNames[]

string

Tylko dane wyjściowe. Nazwy zasobów osób powiązanych z tym zasobem.

deleted

boolean

Tylko dane wyjściowe. Prawda, jeśli zasób osoby został usunięty. Wartość podawana tylko w przypadku żądań synchronizacji people.connections.list i otherContacts.list.

objectType
(deprecated)

enum (ObjectType)

Tylko dane wyjściowe. WYCOFANE (zamiast tego użyj person.metadata.sources.profileMetadata.objectType)

Typ obiektu osoby.

Źródło

Źródło pola.

Zapis JSON
{
  "type": enum (SourceType),
  "id": string,
  "etag": string,
  "updateTime": string,

  // Union field metadata can be only one of the following:
  "profileMetadata": {
    object (ProfileMetadata)
  }
  // End of list of possible types for union field metadata.
}
Pola
type

enum (SourceType)

Typ źródła.

id

string

Unikalny identyfikator w obrębie typu źródła wygenerowany przez serwer.

etag

string

Dane używane tylko w regionie person.metadata.sources.

Tag encji HTTP źródła. Służy do sprawdzania poprawności pamięci podręcznej przeglądarki.

updateTime

string (Timestamp format)

Tylko dane wyjściowe. Dane używane tylko w regionie person.metadata.sources.

Sygnatura czasowa ostatniej aktualizacji tego źródła.

Sygnatura czasowa w formacie „Zulu” RFC3339 UTC z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".

Pole sumy metadata. Dane używane tylko w regionie person.metadata.sources.

Metadane dotyczące źródła. metadata może być tylko jedną z tych wartości:

profileMetadata

object (ProfileMetadata)

Tylko dane wyjściowe. Dane używane tylko w regionie person.metadata.sources.

Metadane dotyczące źródła typu PROFILE.

SourceType

Typ źródła.

Wartości w polu enum
SOURCE_TYPE_UNSPECIFIED Nie określono.
ACCOUNT Konto Google.
PROFILE Profil Google. Profil możesz zobaczyć na https://profiles.google.com/{id}, gdzie {id} to identyfikator źródła.
DOMAIN_PROFILE Profil domeny Google Workspace.
CONTACT Kontakt w Google. Kontakt możesz zobaczyć na https://contact.google.com/{id}, gdzie {id} to identyfikator źródła.
OTHER_CONTACT „Inny kontakt” Google.
DOMAIN_CONTACT Kontakt udostępniony w domenie Google Workspace.

ProfileMetadata

Metadane profilu.

Zapis JSON
{
  "objectType": enum (ObjectType),
  "userTypes": [
    enum (UserType)
  ]
}
Pola
objectType

enum (ObjectType)

Tylko dane wyjściowe. Typ obiektu profilu.

userTypes[]

enum (UserType)

Tylko dane wyjściowe. Wybiera typ użytkownika.

ObjectType

Typ obiektu osoby.

Wartości w polu enum
OBJECT_TYPE_UNSPECIFIED Nie określono.
PERSON Osoba.
PAGE Strona Currents.

UserType

Typ użytkownika.

Wartości w polu enum
USER_TYPE_UNKNOWN Nieznany typ użytkownika.
GOOGLE_USER Użytkownik jest użytkownikiem Google.
GPLUS_USER Użytkownik jest użytkownikiem Currents.
GOOGLE_APPS_USER Użytkownik jest użytkownikiem Google Workspace.

Adres

Adres pocztowy osoby. Może to być skrytka pocztowa lub adres. Wszystkie pola są opcjonalne.

Zapis JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "formattedValue": string,
  "type": string,
  "formattedType": string,
  "poBox": string,
  "streetAddress": string,
  "extendedAddress": string,
  "city": string,
  "region": string,
  "postalCode": string,
  "country": string,
  "countryCode": string
}
Pola
metadata

object (FieldMetadata)

Metadane dotyczące adresu.

formattedValue

string

Wartość adresu w nieuporządkowanych danych. Jeśli użytkownik nie ustawi tej wartości, zostanie ona utworzona automatycznie na podstawie uporządkowanych wartości.

type

string

Typ adresu. Typ może być wartością niestandardową lub jedną z tych wstępnie zdefiniowanych wartości:

  • home
  • work
  • other
formattedType

string

Tylko dane wyjściowe. Typ adresu przetłumaczonego i sformatowanego zgodnie z językiem konta użytkownika lub językiem nagłówka HTTP Accept-Language.

poBox

string

Skrytka pocztowa.

streetAddress

string

Ulica i numer.

extendedAddress

string

Rozszerzony adres adresu; na przykład numer mieszkania.

city

string

Miasto, w którym znajduje się adres.

region

string

Region adresu, na przykład stan lub prowincja.

postalCode

string

Kod pocztowy adresu.

country

string

Kraj podany w adresie.

countryCode

string

Kod kraju w formacie ISO 3166-1 alfa-2.

FieldMetadata

Metadane pola.

Zapis JSON
{
  "primary": boolean,
  "sourcePrimary": boolean,
  "verified": boolean,
  "source": {
    object (Source)
  }
}
Pola
primary

boolean

Tylko dane wyjściowe. Prawda, jeśli pole jest polem podstawowym dla wszystkich źródeł w danej osobie. Każda osoba będzie mieć maksymalnie jedno pole z atrybutem primary ustawionym na wartość prawda.

sourcePrimary

boolean

Prawda, jeśli pole jest polem podstawowym dla source. Każde źródło może mieć maksymalnie 1 pole z atrybutem sourcePrimary o wartości „true”.

verified

boolean

Tylko dane wyjściowe. Prawda, jeśli pole jest zweryfikowane, lub false, jeśli nie jest zweryfikowane. Zweryfikowane pole to zwykle imię i nazwisko, adres e-mail, numer telefonu lub strona internetowa, których własność została potwierdzona.

source

object (Source)

Źródło pola.

AgeRange

WYCOFANE (zamiast tego użyj person.ageRanges)

Przedział wiekowy osoby.

Wartości w polu enum
AGE_RANGE_UNSPECIFIED Nie określono.
LESS_THAN_EIGHTEEN Ma mniej niż 18 lat.
EIGHTEEN_TO_TWENTY Od 18 do 20.
TWENTY_ONE_OR_OLDER Dwadzieścia jeden lat i więcej.

AgeRangeType

Przedział wiekowy danej osoby.

Zapis JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "ageRange": enum (AgeRange)
}
Pola
metadata

object (FieldMetadata)

Metadane dotyczące przedziału wiekowego.

ageRange

enum (AgeRange)

Przedział wiekowy.

Biografia

Krótka biografia danej osoby.

Zapis JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "contentType": enum (ContentType)
}
Pola
metadata

object (FieldMetadata)

Metadane dotyczące biografii.

value

string

Krótka biografia.

contentType

enum (ContentType)

Typ treści biografii.

ContentType

Typ treści.

Wartości w polu enum
CONTENT_TYPE_UNSPECIFIED Nie określono.
TEXT_PLAIN Zwykły tekst.
TEXT_HTML Tekst HTML.

Urodziny

Urodziny danej osoby. Określono co najmniej jedno z pól date i text. Pola date i text zwykle podają tę samą datę, ale nie jest to gwarantowane. Podczas mutowania urodzin klienci zawsze powinni ustawiać pole date.

Zapis JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "date": {
    object (Date)
  },
  "text": string
}
Pola
metadata

object (FieldMetadata)

Metadane dotyczące daty urodzin.

date

object (Date)

Uporządkowana data urodzenia.

text
(deprecated)

string

Wolę używać pola date, jeśli jest ustawione.

Swobodny ciąg znaków reprezentujący datę urodzenia użytkownika. Ta wartość nie została zweryfikowana.

Data

Reprezentuje całość lub część daty kalendarzowej, na przykład urodziny. Pora dnia i strefa czasowa są podane w innym miejscu lub są nieistotne. Data jest podana w kalendarzu gregoriańskim. Może to być:

  • Pełna data oraz wartości inne niż zero, rok, miesiąc i dzień.
  • Miesiąc i dzień z zerowym rokiem (np. rocznica).
  • Jeden rok z zerowym miesiącem i zerowym dniem.
  • Rok i miesiąc z zerowym dniem (na przykład data ważności karty kredytowej).

Podobne typy:

Zapis JSON
{
  "year": integer,
  "month": integer,
  "day": integer
}
Pola
year

integer

Rok daty. Wartość musi mieścić się w przedziale od 1 do 9999 lub 0, jeśli chcesz określić datę bez roku.

month

integer

Miesiąc roku. Należy podać wartość z zakresu od 1 do 12 lub 0, aby określić rok bez miesiąca i dnia.

day

integer

Dzień miesiąca. Musi mieć wartość od 1 do 31 i być prawidłową w przypadku roku i miesiąca. Możesz też podać 0, aby określić rok lub miesiąc i miesiąc, w których dzień nie ma znaczenia.

BraggingRights

WYCOFANE: użytkownik nie otrzyma żadnych danych, aby się chwalić.

Zapis JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
Pola
metadata

object (FieldMetadata)

Metadane dotyczące tego, na czym można się pochwalić.

value

string

Tym nie mogę się pochwalić, na przykład climbed mount everest.

CalendarUrl

Adres URL kalendarza danej osoby.

Zapis JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "url": string,
  "type": string,
  "formattedType": string
}
Pola
metadata

object (FieldMetadata)

Metadane dotyczące adresu URL kalendarza.

url

string

Adres URL kalendarza.

type

string

Typ adresu URL kalendarza. Typ może być wartością niestandardową lub jedną z tych wstępnie zdefiniowanych wartości:

  • home
  • freeBusy
  • work
formattedType

string

Tylko dane wyjściowe. Typ adresu URL kalendarza przetłumaczonego i sformatowanego zgodnie z językiem konta użytkownika lub językiem nagłówka HTTP Accept-Language.

ClientData

Dowolne dane klientów wypełniane przez klientów. Klucze i wartości mogą się powtarzać.

Zapis JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "key": string,
  "value": string
}
Pola
metadata

object (FieldMetadata)

Metadane dotyczące danych klienta.

key

string

Klient określił klucz danych klienta.

value

string

Klient określił wartość danych klienta.

CoverPhoto

Zdjęcie na okładkę danej osoby. Duży obraz wyświetlany na stronie profilu danej osoby, który przedstawia, kim jest lub na czym jej zależy.

Zapis JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "url": string,
  "default": boolean
}
Pola
metadata

object (FieldMetadata)

Metadane dotyczące zdjęcia na okładkę.

url

string

Adres URL zdjęcia na okładkę.

default

boolean

Wartość prawda, jeśli zdjęcie na okładkę jest domyślnym zdjęciem na okładkę, a wartość fałsz, jeśli zdjęcie główne zostało dostarczone przez użytkownika.

EmailAddress

Adres e-mail danej osoby.

Zapis JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": string,
  "formattedType": string,
  "displayName": string
}
Pola
metadata

object (FieldMetadata)

Metadane dotyczące adresu e-mail.

value

string

Adres e-mail.

type

string

Typ adresu e-mail. Typ może być wartością niestandardową lub jedną z tych wstępnie zdefiniowanych wartości:

  • home
  • work
  • other
formattedType

string

Tylko dane wyjściowe. Typ adresu e-mail przetłumaczonego i sformatowanego zgodnie z językiem konta użytkownika lub językiem nagłówka HTTP Accept-Language.

displayName

string

Wyświetlana nazwa e-maila.

Zdarzenie

Zdarzenie związane z osobą.

Zapis JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "date": {
    object (Date)
  },
  "type": string,
  "formattedType": string
}
Pola
metadata

object (FieldMetadata)

Metadane zdarzenia.

date

object (Date)

Data wydarzenia.

type

string

Typ zdarzenia. Typ może być wartością niestandardową lub jedną z tych wstępnie zdefiniowanych wartości:

  • anniversary
  • other
formattedType

string

Tylko dane wyjściowe. Typ zdarzenia przetłumaczony i sformatowany zgodnie z językiem konta użytkownika lub językiem nagłówka HTTP Accept-Language.

ExternalId

Identyfikator od podmiotu zewnętrznego powiązanego z daną osobą.

Zapis JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": string,
  "formattedType": string
}
Pola
metadata

object (FieldMetadata)

Metadane dotyczące identyfikatora zewnętrznego.

value

string

Wartość identyfikatora zewnętrznego.

type

string

Typ identyfikatora zewnętrznego. Typ może być wartością niestandardową lub jedną z tych wstępnie zdefiniowanych wartości:

  • account
  • customer
  • loginId
  • network
  • organization
formattedType

string

Tylko dane wyjściowe. Typ zdarzenia przetłumaczony i sformatowany zgodnie z językiem konta użytkownika lub językiem nagłówka HTTP Accept-Language.

FileAs

Nazwa, która powinna służyć do sortowania osoby na liście.

Zapis JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
Pola
metadata

object (FieldMetadata)

Metadane dotyczące plików.

value

string

Wartość „file-as”

Płeć

Płeć osoby.

Zapis JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "formattedValue": string,
  "addressMeAs": string
}
Pola
metadata

object (FieldMetadata)

Metadane dotyczące płci.

value

string

Płeć danej osoby. Płeć może być niestandardowa lub jedna z tych wstępnie zdefiniowanych wartości:

  • male
  • female
  • unspecified
formattedValue

string

Tylko dane wyjściowe. Wartość płci przetłumaczona i sformatowana zgodnie z językiem konta użytkownika lub językiem nagłówka HTTP Accept-Language. Nieokreślone lub niestandardowe wartości nie są lokalizowane.

addressMeAs

string

Pole tekstowe na dowolne zaimki, których należy używać do zwracania się do osoby. Typowe wartości to:

  • he/him
  • she/her
  • they/them

ImClient

Klient czatu użytkownika.

Zapis JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "username": string,
  "type": string,
  "formattedType": string,
  "protocol": string,
  "formattedProtocol": string
}
Pola
metadata

object (FieldMetadata)

Metadane dotyczące klienta komunikatora internetowego.

username

string

Nazwa użytkownika używana w kliencie czatu.

type

string

Typ klienta czatu. Typ może być wartością niestandardową lub jedną z tych wstępnie zdefiniowanych wartości:

  • home
  • work
  • other
formattedType

string

Tylko dane wyjściowe. Typ klienta komunikatora przetłumaczony i sformatowany zgodnie z językiem konta użytkownika lub nagłówkiem HTTP Accept-Language.

protocol

string

Protokół klienta czatu. Protokół może mieć wartość niestandardową lub jedną z tych wstępnie zdefiniowanych wartości:

  • aim
  • msn
  • yahoo
  • skype
  • qq
  • googleTalk
  • icq
  • jabber
  • netMeeting
formattedProtocol

string

Tylko dane wyjściowe. Protokół klienta czatu sformatowanego w języku konta użytkownika lub języka nagłówka HTTP Accept-Language.

Zainteresowanie

Jedno z zainteresowań danej osoby.

Zapis JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
Pola
metadata

object (FieldMetadata)

Metadane dotyczące zainteresowania.

value

string

Zainteresowanie, na przykład stargazing.

Język

Preferencje użytkownika dotyczące regionu.

Zapis JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
Pola
metadata

object (FieldMetadata)

Metadane dotyczące regionu.

value

string

Prawidłowo sformatowany tag języka IETF BCP 47 reprezentujący język.

Lokalizacja

Lokalizacja użytkownika.

Zapis JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": string,
  "current": boolean,
  "buildingId": string,
  "floor": string,
  "floorSection": string,
  "deskCode": string
}
Pola
metadata

object (FieldMetadata)

Metadane dotyczące lokalizacji.

value

string

Swobodna wartość lokalizacji.

type

string

Typ lokalizacji. Typ może być wartością niestandardową lub jedną z tych wstępnie zdefiniowanych wartości:

  • desk
  • grewUp
current

boolean

Wskazuje, czy lokalizacja jest bieżącą.

buildingId

string

Identyfikator budynku.

floor

string

Nazwa lub numer piętra.

floorSection

string

Część piętra w budynku floor_name.

deskCode

string

Lokalizacja danego biurka.

Członkostwo

Członkostwo danej osoby w grupie. Można modyfikować tylko członkostwo w grupie kontaktów.

Zapis JSON
{
  "metadata": {
    object (FieldMetadata)
  },

  // Union field membership can be only one of the following:
  "contactGroupMembership": {
    object (ContactGroupMembership)
  },
  "domainMembership": {
    object (DomainMembership)
  }
  // End of list of possible types for union field membership.
}
Pola
metadata

object (FieldMetadata)

Metadane dotyczące subskrypcji.

Pole sumy membership. Subskrypcja. membership może być tylko jedną z tych wartości:
contactGroupMembership

object (ContactGroupMembership)

Członkostwo w grupie kontaktów.

domainMembership

object (DomainMembership)

Tylko dane wyjściowe. Członkostwo w domenie.

ContactGroupMembership

Członkostwo w grupie kontaktów Google.

Zapis JSON
{
  "contactGroupId": string,
  "contactGroupResourceName": string
}
Pola
contactGroupId
(deprecated)

string

Tylko dane wyjściowe. Identyfikator grupy kontaktów na potrzeby członkostwa w grupie kontaktów.

contactGroupResourceName

string

Nazwa zasobu grupy kontaktów przypisana przez serwer. Ciąg ASCII w postaci contactGroups/{contactGroupId}. Do modyfikowania członkostwa można używać tylko contactGroupResourceName. Każde członkostwo w grupie kontaktów można usunąć, ale można dodać tylko członkostwo w grupach użytkowników lub „mojeKontakty” lub „oznaczone gwiazdką”. Kontakt musi zawsze mieć co najmniej jedno członkostwo w grupie kontaktów.

DomainMembership

Subskrypcja domeny Google Workspace.

Zapis JSON
{
  "inViewerDomain": boolean
}
Pola
inViewerDomain

boolean

Prawda, jeśli osoba jest w domenie Google Workspace widza.

MiscKeyword

Różne słowo kluczowe danej osoby.

Zapis JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": enum (KeywordType),
  "formattedType": string
}
Pola
metadata

object (FieldMetadata)

Metadane dotyczące różnych słów kluczowych.

value

string

Wartość różnych słów kluczowych.

type

enum (KeywordType)

Inny typ słowa kluczowego.

formattedType

string

Tylko dane wyjściowe. Typ różnych słów kluczowych przetłumaczony i sformatowany zgodnie z językiem konta użytkownika lub językiem nagłówka HTTP Accept-Language.

KeywordType

Typ różnych słów kluczowych.

Wartości w polu enum
TYPE_UNSPECIFIED Nie określono.
OUTLOOK_BILLING_INFORMATION Pole Outlooka na informacje rozliczeniowe.
OUTLOOK_DIRECTORY_SERVER Pole Outlooka dla serwera katalogowego.
OUTLOOK_KEYWORD Pole Outlooka na słowo kluczowe.
OUTLOOK_MILEAGE Pole Outlooka na przebieg.
OUTLOOK_PRIORITY Pole Outlooka z priorytetem.
OUTLOOK_SENSITIVITY Pole w Outlooku do informacji poufnych.
OUTLOOK_SUBJECT Pole tematu w Outlooku.
OUTLOOK_USER Pole Outlooka dla użytkownika.
HOME Start
WORK Praca.
OTHER Inne.

Nazwa

Imię i nazwisko osoby. Jeśli nazwa jest jednoznacznym pseudonimem, nazwa rodziny jest pusta.

Zapis JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "displayName": string,
  "displayNameLastFirst": string,
  "unstructuredName": string,
  "familyName": string,
  "givenName": string,
  "middleName": string,
  "honorificPrefix": string,
  "honorificSuffix": string,
  "phoneticFullName": string,
  "phoneticFamilyName": string,
  "phoneticGivenName": string,
  "phoneticMiddleName": string,
  "phoneticHonorificPrefix": string,
  "phoneticHonorificSuffix": string
}
Pola
metadata

object (FieldMetadata)

Metadane dotyczące nazwy.

displayName

string

Tylko dane wyjściowe. Wyświetlana nazwa sformatowana zgodnie z językiem określonym przez konto użytkownika wyświetlającego lub nagłówek HTTP Accept-Language.

displayNameLastFirst

string

Tylko dane wyjściowe. Wyświetlana nazwa zawierająca nazwisko najpierw sformatowana zgodnie z językiem określonym przez konto użytkownika lub nagłówek HTTP Accept-Language.

unstructuredName

string

Wartość nazwy swobodnej.

familyName

string

Nazwisko.

givenName

string

Imię.

middleName

string

Drugie imię.

honorificPrefix

string

Prefiksy honorowe, na przykład Mrs. lub Dr.

honorificSuffix

string

sufiksy honorowe, np. Jr.

phoneticFullName

string

Pełne imię i nazwisko zapisane.

phoneticFamilyName

string

Nazwisko napisane jak brzmi.

phoneticGivenName

string

Imię przeliterowane.

phoneticMiddleName

string

Drugie imię zapisane zgodnie z zapisem.

phoneticHonorificPrefix

string

Prefiksy honorowe są zapisywane na głos.

phoneticHonorificSuffix

string

Sufiksy honorowe są zapisywane w formie dźwiękowej.

Pseudonim

Pseudonim danej osoby.

Zapis JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": enum (NicknameType)
}
Pola
metadata

object (FieldMetadata)

Metadane dotyczące pseudonimu.

value

string

pseudonim,

type

enum (NicknameType)

Typ pseudonimu.

NicknameType

Rodzaj pseudonimu.

Wartości w polu enum
DEFAULT Zwykły pseudonim.
MAIDEN_NAME

Nazwisko panieńskie lub nazwisko porodowe. Jest używana, gdy nazwisko danej osoby zmieni się w wyniku zawarcia małżeństwa.

INITIALS

Inicjały.

GPLUS

Pseudonim profilu Google+.

OTHER_NAME

tytuł zawodu lub inna nazwa, np. Dr. Smith.

ALTERNATE_NAME Alternatywne nazwisko osoby znane jest.
SHORT_NAME

Krótsza wersja imienia i nazwiska osoby.

Zawód

Zawód danej osoby.

Zapis JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
Pola
metadata

object (FieldMetadata)

Metadane dotyczące wykonywanego zawodu.

value

string

Zawód, na przykład carpenter.

Organizacja

Wcześniejsza lub bieżąca organizacja użytkownika. Nakładające się zakresy dat są dozwolone.

Zapis JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "type": string,
  "formattedType": string,
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  },
  "current": boolean,
  "name": string,
  "phoneticName": string,
  "department": string,
  "title": string,
  "jobDescription": string,
  "symbol": string,
  "domain": string,
  "location": string,
  "costCenter": string,
  "fullTimeEquivalentMillipercent": integer
}
Pola
metadata

object (FieldMetadata)

Metadane dotyczące organizacji.

type

string

Typ organizacji. Typ może być wartością niestandardową lub jedną z tych wstępnie zdefiniowanych wartości:

  • work
  • school
formattedType

string

Tylko dane wyjściowe. Typ organizacji przetłumaczony i sformatowany zgodnie z językiem konta użytkownika lub językiem nagłówka HTTP Accept-Language.

startDate

object (Date)

Data rozpoczęcia dołączenia przez daną osobę do organizacji.

endDate

object (Date)

Data końcowa opuszczenia organizacji przez użytkownika.

current

boolean

Wartość to „prawda”, jeśli organizacja jest obecną organizacją użytkownika. Wartość fałsz, jeśli organizacja należy do przeszłości.

name

string

Nazwa organizacji.

phoneticName

string

Nazwa fonetyczna organizacji.

department

string

Dział danej osoby w organizacji.

title

string

Stanowisko tej osoby w organizacji.

jobDescription

string

Opis stanowiska danej osoby w organizacji.

symbol

string

Symbol powiązany z organizacją, na przykład symbol giełdowy, skrót lub akronim.

domain

string

Nazwa domeny powiązana z organizacją, na przykład google.com.

location

string

Lokalizacja biura organizacji, w którym pracuje ta osoba.

costCenter

string

Centrum kosztów danej osoby w organizacji.

fullTimeEquivalentMillipercent

integer

Procentowy odsetek osób w pełnym wymiarze godzin w organizacji (100 000 = 100%).

PhoneNumber

Numer telefonu danej osoby.

Zapis JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "canonicalForm": string,
  "type": string,
  "formattedType": string
}
Pola
metadata

object (FieldMetadata)

Metadane dotyczące numeru telefonu.

value

string

Numer telefonu.

canonicalForm

string

Tylko dane wyjściowe. Wersja kanoniczna numeru telefonu w formacie ITU-T E.164.

type

string

Typ numeru telefonu. Typ może być wartością niestandardową lub jedną z tych wstępnie zdefiniowanych wartości:

  • home
  • work
  • mobile
  • homeFax
  • workFax
  • otherFax
  • pager
  • workMobile
  • workPager
  • main
  • googleVoice
  • other
formattedType

string

Tylko dane wyjściowe. Typ numeru telefonu przetłumaczony i sformatowany zgodnie z językiem konta użytkownika lub językiem nagłówka HTTP Accept-Language.

Zdjęcie

Zdjęcie osoby. Obraz wyświetlany obok nazwy osoby, aby ułatwić innym jej rozpoznanie.

Zapis JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "url": string,
  "default": boolean
}
Pola
metadata

object (FieldMetadata)

Metadane zdjęcia.

url

string

Adres URL zdjęcia. Możesz zmienić odpowiedni rozmiar, dodając na końcu adresu URL parametr zapytania sz={size}, gdzie {size} to rozmiar w pikselach. Przykład: https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50

default

boolean

Wartość prawda, jeśli zdjęcie jest zdjęciem domyślnym, lub wartość fałsz, jeśli jest to zdjęcie udostępnione przez użytkownika.

Relacja

Związek między osobą.

Zapis JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "person": string,
  "type": string,
  "formattedType": string
}
Pola
metadata

object (FieldMetadata)

Metadane dotyczące relacji.

person

string

Imię i nazwisko osoby, której dotyczy dany związek.

type

string

Stosunek osoby do drugiej osoby. Typ może być wartością niestandardową lub jedną z tych wstępnie zdefiniowanych wartości:

  • spouse
  • child
  • mother
  • father
  • parent
  • brother
  • sister
  • friend
  • relative
  • domesticPartner
  • manager
  • assistant
  • referredBy
  • partner
formattedType

string

Tylko dane wyjściowe. Typ relacji przetłumaczony i sformatowany zgodnie z językiem konta użytkownika lub regionem określonym w nagłówku HTTP Accept-Language.

RelationshipInterest

WYCOFANE: nie zostaną zwrócone żadne dane dotyczące relacji między użytkownikiem .

Zapis JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "formattedValue": string
}
Pola
metadata

object (FieldMetadata)

Metadane dotyczące zainteresowania w związku.

value

string

Rodzaj relacji, jakiej szuka dana osoba. Wartość może być wartością niestandardową lub jedną z następujących wstępnie zdefiniowanych wartości:

  • friend
  • date
  • relationship
  • networking
formattedValue

string

Tylko dane wyjściowe. Wartość udziału w relacji przetłumaczona i sformatowana zgodnie z językiem konta użytkownika lub regionem określonym w nagłówku HTTP Accept-Language.

RelationshipStatus

WYCOFANE: informacje o związku użytkownika nie będą zwracane.

Zapis JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "formattedValue": string
}
Pola
metadata

object (FieldMetadata)

Metadane dotyczące relacji.

value

string

Informacje o związku. Wartość może być wartością niestandardową lub jedną z następujących wstępnie zdefiniowanych wartości:

  • single
  • inARelationship
  • engaged
  • married
  • itsComplicated
  • openRelationship
  • widowed
  • inDomesticPartnership
  • inCivilUnion
formattedValue

string

Tylko dane wyjściowe. Wartość stanu relacji przetłumaczona i sformatowana zgodnie z językiem konta użytkownika lub językiem nagłówka HTTP Accept-Language.

Miejsce zamieszkania

WYCOFANE: użyj person.locations. Poprzednie lub obecne miejsce zamieszkania danej osoby.

Zapis JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "current": boolean
}
Pola
metadata

object (FieldMetadata)

Metadane dotyczące miejsca zamieszkania.

value

string

Adres zamieszkania.

current

boolean

Prawda, jeśli miejsce zamieszkania jest obecnym miejscem zamieszkania danej osoby; false, jeśli miejsce zamieszkania jest wcześniejszym miejscem zamieszkania.

SipAddress

Adres SIP użytkownika. Adresy IP sesji służą do nawiązywania połączeń głosowych i wideo przez internet w ramach komunikacji VoIP.

Zapis JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": string,
  "formattedType": string
}
Pola
metadata

object (FieldMetadata)

Metadane dotyczące adresu SIP.

value

string

Adres SIP w formacie SIP URI RFC 3261 19.1.

type

string

Typ adresu SIP. Typ może być wartością niestandardową lub jedną z tych wstępnie zdefiniowanych wartości:

  • home
  • work
  • mobile
  • other
formattedType

string

Tylko dane wyjściowe. Typ adresu SIP przetłumaczonego i sformatowanego zgodnie z językiem konta użytkownika lub językiem nagłówka HTTP Accept-Language.

Umiejętność

Umiejętność posiadana przez daną osobę.

Zapis JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
Pola
metadata

object (FieldMetadata)

Metadane dotyczące umiejętności.

value

string

Umiejętność, np. underwater basket weaving.

Opis

WYCOFANE: nie będą zwracane dane. Krótki, jednowierszowy opis osoby.

Zapis JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
Pola
metadata

object (FieldMetadata)

Metadane sloganu.

value

string

Slogan.

Adres URL

Powiązane adresy URL.

Zapis JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": string,
  "formattedType": string
}
Pola
metadata

object (FieldMetadata)

Metadane dotyczące adresu URL.

value

string

Adres URL.

type

string

Typ adresu URL. Typ może być wartością niestandardową lub jedną z tych wstępnie zdefiniowanych wartości:

  • home
  • work
  • blog
  • profile
  • homePage
  • ftp
  • reservations
  • appInstallPage: witryna aplikacji Currents.
  • other
formattedType

string

Tylko dane wyjściowe. Typ adresu URL przetłumaczonego i sformatowanego zgodnie z językiem konta użytkownika lub językiem nagłówka HTTP Accept-Language.

UserDefined

Dowolne dane użytkowników wypełniane przez użytkowników.

Zapis JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "key": string,
  "value": string
}
Pola
metadata

object (FieldMetadata)

Metadane dotyczące danych zdefiniowanych przez użytkownika.

key

string

Użytkownik określił klucz danych zdefiniowanych przez użytkownika.

value

string

Wartość danych zdefiniowanych przez użytkownika została określona przez użytkownika.

Metody

batchCreateContacts

Utwórz grupę nowych kontaktów i zwróć wartości PersonResponse dla nowo

Żądania mutacji dotyczące tego samego użytkownika powinny być wysyłane po kolei, aby uniknąć wydłużenia czasu oczekiwania i niepowodzeń.

batchDeleteContacts

usunąć grupę kontaktów,

batchUpdateContacts

Zaktualizuj grupę kontaktów i zwróć mapę nazw zasobów do PersonResponses w przypadku zaktualizowanych kontaktów.

createContact

Utwórz nowy kontakt i zwróć dla niego zasób osoby.

deleteContact

usunąć osobę kontaktową,

deleteContactPhoto

Usuń zdjęcie kontaktu.

get

Zawiera informacje o osobie, określając nazwę zasobu.

getBatchGet

Zawiera informacje o liście konkretnych osób przez określenie listy żądanych nazw zasobów.

listDirectoryPeople

Udostępnia listę profili domen i kontaktów w domenie w katalogu domeny uwierzytelnionego użytkownika.

searchContacts

Wyświetla listę kontaktów w zgrupowanych kontaktach uwierzytelnionego użytkownika, które pasują do zapytania.

searchDirectoryPeople

Udostępnia listę profili domen i kontaktów w domenie w katalogu domeny uwierzytelnionego użytkownika, które pasują do zapytania.

updateContact

Aktualizowanie danych dotychczasowej osoby kontaktowej.

updateContactPhoto

Zaktualizuj zdjęcie kontaktu.