REST Resource: people

Zadbaj o dobrą organizację dzięki kolekcji Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.

Zasób: osoba

Informacje o osobie połączone z różnymi źródłami danych, takimi jak kontakty i dane profilowe uwierzytelnionego użytkownika.

Większość pól może zawierać wiele elementów. Elementy w polu nie mają gwarantowanej kolejności, ale każde puste pole może mieć dokładnie jedno pole z wartością metadata.primary ustawioną na wartość true (prawda).

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 osoby przypisana przez serwer. Ciąg ASCII w formacie people/{person_id}.

etag

string

Tag jednostki HTTP zasobu. Służy do sprawdzania poprawności pamięci podręcznej.

metadata

object (PersonMetadata)

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

addresses[]

object (Address)

adresy pocztowy danej osoby;

ageRange
(deprecated)

enum (AgeRange)

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

Przedział wiekowy osoby.

ageRanges[]

object (AgeRangeType)

Tylko dane wyjściowe. Przedziały wiekowe użytkownika.

biographies[]

object (Biography)

Biografie tej osoby. To pole jest przeznaczone dla pojedynczych kontaktów.

birthdays[]

object (Birthday)

Urodziny tej osoby. To pole jest przeznaczone dla pojedynczych kontaktów.

braggingRights[]
(deprecated)

object (BraggingRights)

WYCOFANO: nie zostaną zwrócone żadne dane dotyczące takich osób.

calendarUrls[]

object (CalendarUrl)

Adresy URL kalendarza danej osoby.

clientData[]

object (ClientData)

Dane klienta.

coverPhotos[]

object (CoverPhoto)

Tylko dane wyjściowe. zdjęcia na okładkę danej osoby;

emailAddresses[]

object (EmailAddress)

Adresy e-mail. 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, możesz uzyskać dostęp do całego zestawu, wywołując people.getBatchGet.

events[]

object (Event)

Wydarzenia danej osoby.

externalIds[]

object (ExternalId)

Zewnętrzne identyfikatory osoby.

fileAses[]

object (FileAs)

Pliki użytkownika.

genders[]

object (Gender)

Płeć osoby. To pole jest przeznaczone dla pojedynczych kontaktów.

imClients[]

object (ImClient)

Klienty czatu.

interests[]

object (Interest)

Zainteresowania użytkownika.

locales[]

object (Locale)

Ustawienia regionalne użytkownika.

locations[]

object (Location)

Lokalizacje osoby.

memberships[]

object (Membership)

Członkostwa w grupie.

miscKeywords[]

object (MiscKeyword)

Inne słowa kluczowe.

names[]

object (Name)

imiona i nazwiska danej osoby; To pole jest przeznaczone dla pojedynczych kontaktów.

nicknames[]

object (Nickname)

pseudonimy danej osoby;

occupations[]

object (Occupation)

Zawód danej osoby.

organizations[]

object (Organization)

Poprzednie lub obecne organizacje osoby.

phoneNumbers[]

object (PhoneNumber)

numery telefonów danej osoby; W przypadku people.connections.list i otherContacts.list liczba numerów telefonu jest ograniczona do 100. Jeśli dana osoba ma więcej numerów telefonów, możesz uzyskać dostęp do całego zestawu, dzwoniąc pod numer people.getBatchGet.

photos[]

object (Photo)

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

relations[]

object (Relation)

Relacja tej osoby.

relationshipInterests[]
(deprecated)

object (RelationshipInterest)

Tylko dane wyjściowe. WYCOFANO: nie zostaną zwrócone żadne dane dotyczące zainteresowań.

relationshipStatuses[]
(deprecated)

object (RelationshipStatus)

Tylko dane wyjściowe. WYCOFANO: informacje o stanie związku użytkownika nie są zwracane.

residences[]
(deprecated)

object (Residence)

WYCOFANO: zamiast tego użyj person.locations.

sipAddresses[]

object (SipAddress)

Adresy SIP osoby.

skills[]

object (Skill)

Umiejętności danej osoby.

taglines[]
(deprecated)

object (Tagline)

Tylko dane wyjściowe. WYCOFANO: slogany danej osoby nie będą zwracane.

urls[]

object (Url)

powiązane adresy URL danej osoby;

userDefined[]

object (UserDefined)

Dane użytkownika.

Metadane osoby

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. Wszystkie wcześniejsze nazwy zasobów, które ta osoba miała. Wartość wypełniana tylko w przypadku people.connections.list żądań zawierających token synchronizacji.

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

linkedPeopleResourceNames[]

string

Tylko dane wyjściowe. Nazwy zasobów osób połączonych z tym zasobem.

deleted

boolean

Tylko dane wyjściowe. Wartość „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. WYCOFANO (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,
  "profileMetadata": {
    object (ProfileMetadata)
  }
}
Pola
type

enum (SourceType)

Typ źródła.

id

string

Unikalny identyfikator typu źródła wygenerowany przez serwer.

etag

string

Wypełnianie tylko w języku: person.metadata.sources.

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

updateTime

string (Timestamp format)

Tylko dane wyjściowe. Wypełnianie tylko w języku: person.metadata.sources.

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

Sygnatura czasowa w formacie „Zulu” UTC3339, z rozdzielczością nanosekundą i maksymalnie 9 cyframi. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".

profileMetadata

object (ProfileMetadata)

Tylko dane wyjściowe. Wypełnianie tylko w języku: person.metadata.sources.

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

Typ źródła

Typ źródła.

Wartości w polu enum
SOURCE_TYPE_UNSPECIFIED Nie określono.
ACCOUNT Konto Google.
PROFILE Profil Google. Możesz go sprawdzić pod adresem 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 wyświetlić na stronie https://contact.google.com/{id}, gdzie {id} to identyfikator źródła.
OTHER_CONTACT Inne kontakty Google.
DOMAIN_CONTACT Kontakt udostępniony domeny Google Workspace.

Metadane profilu

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. Typy użytkowników.

Typ obiektu

Typ obiektu osoby.

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

Typ użytkownika

Typ użytkownika.

Wartości w polu enum
USER_TYPE_UNKNOWN Typ użytkownika jest nieznany.
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 danej 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

Nieustrukturyzowana wartość adresu. Jeśli tego nie zrobisz, element zostanie utworzony automatycznie na podstawie wartości strukturalnych.

type

string

Typ adresu. Typ może być niestandardowy lub jedna z tych wstępnie zdefiniowanych wartości:

  • home
  • work
  • other
formattedType

string

Tylko dane wyjściowe. Typ adresu przetłumaczonego i sformatowanego w języku regionalnym konta użytkownika lub w nagłówku HTTP Accept-Language.

poBox

string

Skrytka pocztowa adresu.

streetAddress

string

Ulica i numer.

extendedAddress

string

Dłuższy adres, np. numer mieszkania.

city

string

Miasto adresu.

region

string

Region adresu, na przykład województwo lub region.

postalCode

string

Kod pocztowy adresu.

country

string

Kraj adresu.

countryCode

string

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

Metadane pola

Metadane pola.

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

boolean

Tylko dane wyjściowe. Wartość to „prawda”, jeśli to pole jest podstawowym polem dla wszystkich źródeł w danej osobie. W przypadku każdej osoby pole primary ma wartość „true” (prawda).

sourcePrimary

boolean

Wartość to „prawda”, jeśli to pole jest podstawowe w przypadku pola source. Każde źródło może mieć co najmniej jedno pole z wartością sourcePrimary ustawioną na „true”.

verified

boolean

Tylko dane wyjściowe. Wartość „prawda”, jeśli pole jest zweryfikowane, „fałsz”, jeśli pole jest niezweryfikowane. Zwykle chodzi o imię i nazwisko, adres e-mail, numer telefonu lub witrynę, której własność została potwierdzona.

source

object (Source)

Źródło pola.

Zakres wieku

WYCOFANO (zamiast tego użyj person.ageRanges)

Przedział wiekowy osoby.

Wartości w polu enum
AGE_RANGE_UNSPECIFIED Nie określono.
LESS_THAN_EIGHTEEN Mniej niż 18 lat.
EIGHTEEN_TO_TWENTY Między 18 a 20.
TWENTY_ONE_OR_OLDER Dwadzieścia jeden i więcej.

Typ przedziału wiekowego

Przedział wiekowy 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 osoby.

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

object (FieldMetadata)

Metadane biografii.

value

string

Krótka biografia.

contentType

enum (ContentType)

Typ treści biografii.

Typ treści

Typ treści.

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

Data urodzenia

Urodziny danej osoby. Określono co najmniej jedno z pól date i text. Pola date i text zazwyczaj wskazują tę samą datę, ale nie możemy zagwarantować, że będą takie same. Klienci powinni zawsze ustawiać pole date podczas modyfikacji urodzin.

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

object (FieldMetadata)

Metadane dotyczące urodzin.

date

object (Date)

Uporządkowana data urodzenia.

text
(deprecated)

string

Wolisz korzystać z pola date, jeśli jest ustawione.

Dowolny ciąg znaków reprezentujący urodziny użytkownika. Ta wartość nie jest zweryfikowana.

Data

Określa pełną lub częściową datę kalendarza, na przykład datę urodzenia. Pora dnia i strefa czasowa są podane w innym miejscu lub nie mają znaczenia. Data jest określana względem kalendarza gregorijskiego. Może to być jedna z tych wartości:

  • Pełna data z wartościami innymi niż rok, miesiąc i dzień.
  • Miesiąc i dzień z zerowym rokiem (np. rocznicą).
  • Rok, w którym każdy miesiąc ma zerowy czas i zero dni.
  • Rok i miesiąc z zerową datą (na przykład datą ważności karty kredytowej).

Powiązane typy:

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

integer

Rok daty. Do określenia daty bez roku musi mieścić się w zakresie 1–9999 lub 0.

month

integer

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

day

integer

Dzień miesiąca. Wartość musi mieścić się w przedziale od 1 do 31 i być ważna dla roku i miesiąca lub 0 w celu wybrania roku lub samego miesiąca i miesiąca, w którym dzień nie jest istotny.

Tym mogę się pochwalić

WYCOFANO: nie zostaną zwrócone żadne dane dotyczące Tym mogę się pochwalić.

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

object (FieldMetadata)

Metadane na temat tego, czym się chwala.

value

string

Tym mogę się pochwalić, np. climbed mount everest.

KalendarzUrl

Adres URL kalendarza danej osoby.

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

object (FieldMetadata)

Metadane adresu URL kalendarza.

url

string

Adres URL kalendarza.

type

string

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

  • home
  • freeBusy
  • work
formattedType

string

Tylko dane wyjściowe. Typ adresu URL kalendarza przetłumaczony i sformatowany w ustawieniach regionalnych konta użytkownika lub w nagłówku HTTP Accept-Language.

Dane klienta

Dowolne dane klienta, które są wypełniane przez klientów. Zduplikowane klucze i wartości są dozwolone.

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

object (FieldMetadata)

Metadane dotyczące danych klienta.

key

string

Klucz klienta określony przez klienta.

value

string

Określona przez klienta wartość danych klienta.

Zdjęcie w tle

Zdjęcie na okładkę danej osoby. Duży obraz wyświetlany na stronie profilu danej osoby, który informuje, kim jest lub co jest ważne dla danej osoby.

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ę; „fałsz”, jeśli zdjęcie na okładkę to zdjęcie na okładkę dostarczone przez użytkownika.

EmailAddress (adres e-mail)

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ć niestandardowy lub jedna z tych wstępnie zdefiniowanych wartości:

  • home
  • work
  • other
formattedType

string

Tylko dane wyjściowe. Typ adresu e-mail przetłumaczony i sformatowany w ustawieniach regionalnych konta przeglądającego lub w nagłówku HTTP Accept-Language.

displayName

string

Wyświetlana nazwa e-maila.

Zdarzenie

Wydarzenie związane z daną 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ć niestandardowy lub jedna z tych wstępnie zdefiniowanych wartości:

  • anniversary
  • other
formattedType

string

Tylko dane wyjściowe. Typ zdarzenia przetłumaczony i sformatowany w ustawieniach regionalnych konta użytkownika lub w nagłówku HTTP Accept-Language.

Identyfikator zewnętrzny

Identyfikator podmiotu zewnętrznego powiązany 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ść zewnętrznego identyfikatora.

type

string

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

  • account
  • customer
  • loginId
  • network
  • organization
formattedType

string

Tylko dane wyjściowe. Typ zdarzenia przetłumaczony i sformatowany w ustawieniach regionalnych konta użytkownika lub w nagłówku HTTP Accept-Language.

Plik jako

Nazwa, która powinna być używana do sortowania osoby na liście.

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

object (FieldMetadata)

Metadane dotyczące pliku.

value

string

Wartość pliku jako

Płeć

Płeć danej 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łumaczonej i sformatowana w regionie konta użytkownika lub w nagłówku HTTP Accept-Language. Nieokreślone lub niestandardowe wartości nie są zlokalizowane.

addressMeAs

string

Pole tekstowe na zaimki, które powinno być używane do zwracania się do osoby. Typowe wartości:

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

Klient

Klient czatu.

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

object (FieldMetadata)

Metadane dotyczące klienta czatu.

username

string

Nazwa użytkownika używana w kliencie czatu.

type

string

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

  • home
  • work
  • other
formattedType

string

Tylko dane wyjściowe. Typ klienta komunikatora przetłumaczony i sformatowany w ustawieniach regionalnych konta przeglądającego lub w nagłówku HTTP Accept-Language.

protocol

string

Protokół klienta czatu. Protokół może być niestandardowy 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 w formacie regionalnym konta użytkownika lub w nagłówku 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, np. stargazing.

Język

Ustawienie regionalne użytkownika.

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

object (FieldMetadata)

Metadane dotyczące ustawień regionalnych.

value

string

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

lokalizacja,

Lokalizacja danej osoby.

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ć niestandardowy lub jedna z tych wstępnie zdefiniowanych wartości:

  • desk
  • grewUp
current

boolean

Określa, czy jest to bieżąca lokalizacja.

buildingId

string

Identyfikator budynku.

floor

string

Nazwa lub numer piętra.

floorSection

string

Obszar piętra: floor_name.

deskCode

string

lokalizacja pojedynczego biurka,

Wspieranie

Przynależność użytkownika do grupy. Można modyfikować tylko członkostwo w grupach 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. Członkostwo. membership może mieć tylko jedną z tych wartości:
contactGroupMembership

object (ContactGroupMembership)

Przynależność do grupy kontaktów.

domainMembership

object (DomainMembership)

Tylko dane wyjściowe. Przynależność do domeny.

Członkostwo w grupie kontaktów

Przynależność do grupy kontaktów Google.

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

string

Tylko dane wyjściowe. Identyfikator grupy kontaktów związanej z członkostwem w grupie kontaktów.

contactGroupResourceName

string

Nazwa zasobu grupy kontaktów przypisana przez serwer. Ciąg ASCII w formacie contactGroups/{contactGroupId}. Do modyfikowania członkostwa można używać tylko contactGroupResourceName. Członkostwo w grupach kontaktów można usunąć, ale można dodać tylko grupy użytkowników, grupy systemowe „moje kontakty” lub „gwiazdki”. Kontakt musi mieć co najmniej 1 członkostwo w grupie kontaktów.

Członkostwo w domenie

Subskrypcja domeny Google Workspace.

Zapis JSON
{
  "inViewerDomain": boolean
}
Pola
inViewerDomain

boolean

Prawda, jeśli osoba znajduje się w domenie Google Workspace użytkownika.

Różne słowo kluczowe

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

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

object (FieldMetadata)

Metadane o innym słowie kluczowym.

value

string

Wartość innego słowa kluczowego.

type

enum (KeywordType)

Inne typy słów kluczowych.

formattedType

string

Tylko dane wyjściowe. Typ innego słowa kluczowego przetłumaczonego i sformatowanego w regionie konta użytkownika lub w nagłówku HTTP Accept-Language.

Typ słowa kluczowego

Typ innego słowa kluczowego.

Wartości w polu enum
TYPE_UNSPECIFIED Nie określono.
OUTLOOK_BILLING_INFORMATION Pole Outlooka dotyczące informacji rozliczeniowych.
OUTLOOK_DIRECTORY_SERVER Pole Outlooka na serwer katalogu.
OUTLOOK_KEYWORD Pole Outlooka dla słowa kluczowego.
OUTLOOK_MILEAGE Pole Outlooka dotyczące przebiegu.
OUTLOOK_PRIORITY Pole Outlook o priorytecie.
OUTLOOK_SENSITIVITY Pole Outlooka dotyczące poufności.
OUTLOOK_SUBJECT Pole Outlooka dla tematu.
OUTLOOK_USER Pole Outlooka dla użytkownika.
HOME Dom.
WORK Praca.
OTHER Inne.

Nazwa

Imię i nazwisko danej osoby. Jeśli imię jest monotonne, ta nazwa 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 powinna być sformatowana zgodnie z językiem określonym na koncie osoby przeglądającej lub w nagłówku HTTP Accept-Language.

displayNameLastFirst

string

Tylko dane wyjściowe. Wyświetlana nazwa musi mieć format najpierw zgodny z językiem ustawionym na koncie osoby przeglądającej lub w nagłówku HTTP Accept-Language.

unstructuredName

string

Wartość nazwy swobodnej.

familyName

string

Nazwisko.

givenName

string

Imię.

middleName

string

Drugie imię.

honorificPrefix

string

honorowe prefiksy, np. Mrs. lub Dr..

honorificSuffix

string

Imponujące sufiksy, na przykład Jr.

phoneticFullName

string

Imię i nazwisko zapisane na głos.

phoneticFamilyName

string

Nazwisko zapisane na głos.

phoneticGivenName

string

Imię zostało zapisane na głos.

phoneticMiddleName

string

Drugie imię zapisane na głos.

phoneticHonorificPrefix

string

Imponujące prefiksy zapisane z dźwiękiem.

phoneticHonorificSuffix

string

Wyrazy poprawnie brzmiące.

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.

Rodzaj pseudonimu

Typ pseudonimu.

Wartości w polu enum
DEFAULT Pseudonim ogólny.
MAIDEN_NAME

Nazwisko panieńskie lub rodzinne. Używany, gdy imię i nazwisko osoby uległy zmianie w wyniku małżeństwa.

INITIALS

Inicjały.

GPLUS

Pseudonim profilu Google+.

OTHER_NAME

Nazwa organizacji zawodowej lub inna nazwa, np. Dr. Smith.

ALTERNATE_NAME Alternatywna nazwa osoby, którą znasz.
SHORT_NAME

Krótsza nazwa osoby.

Occupation

Zawód danej osoby.

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

object (FieldMetadata)

Metadane zawodu.

value

string

Zawód, na przykład carpenter.

Organizacja

Wcześniejsza lub obecna organizacja użytkownika. Pokrywają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 organizacji.

type

string

Typ organizacji. Typ może być niestandardowy lub jedna z tych wstępnie zdefiniowanych wartości:

  • work
  • school
formattedType

string

Tylko dane wyjściowe. Typ organizacji przetłumaczony i sformatowany w ustawieniach regionalnych konta użytkownika lub w nagłówku HTTP Accept-Language.

startDate

object (Date)

Data rozpoczęcia dołączania przez użytkownika do organizacji.

endDate

object (Date)

Dzień, w którym użytkownik opuścił organizację.

current

boolean

Wartość „prawda”, jeśli organizacja jest obecną organizacją danej osoby, „fałsz”, jeśli organizacja jest już w przeszłości.

name

string

Nazwa organizacji.

phoneticName

string

Fonetyczna nazwa organizacji.

department

string

Dział osoby w organizacji.

title

string

Stanowisko danej osoby w organizacji.

jobDescription

string

Opis stanowiska pracy 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 dana osoba.

costCenter

string

Centrum kosztów danej osoby w organizacji.

fullTimeEquivalentMillipercent

integer

Równoważnik pełnoetatowy danej osoby w organizacji (100 000 = 100%).

Numer telefonu

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 ITU-T E.164.

type

string

Typ numeru telefonu. Typ może być niestandardowy lub jedna 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 w ustawieniach języka konta przeglądającego lub w nagłówku HTTP Accept-Language.

Zdjęcie

Zdjęcie danej osoby. Zdjęcie wyświetlane obok imienia i nazwiska tej osoby, aby pomóc innym ją rozpoznać.

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ć wybrany rozmiar, dodając parametr zapytania sz={size} na końcu adresu URL, gdzie {size} to rozmiar w pikselach. Przykład: https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50

default

boolean

Prawda, jeśli zdjęcie jest domyślne, lub fałsz, jeśli jest to zdjęcie przekazane przez użytkownika.

Relacja

Relacja danej osoby z inną osobą.

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

object (FieldMetadata)

Metadane relacji.

person

string

Imię i nazwisko osoby, do której odnosi się ten związek.

type

string

Relacja tej osoby z drugą osobą. Typ może być niestandardowy lub jedna 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 w języku konta użytkownika lub regionie podanym w nagłówku HTTP Accept-Language.

Związki

WYCOFANO: żadne dane nie będą zwracane przez zainteresowanie daną osobą .

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

object (FieldMetadata)

Metadane dotyczące zainteresowania relacją.

value

string

Typ relacji, której szuka osoba. Wartością może być niestandardowa lub jedna z tych wstępnie zdefiniowanych wartości:

  • friend
  • date
  • relationship
  • networking
formattedValue

string

Tylko dane wyjściowe. Wartość zainteresowania relacją przetłumaczona i sformatowana w języku konta użytkownika lub w języku określonym w nagłówku HTTP Accept-Language.

Związki

WYCOFANO: informacje o stanie związku użytkownika nie są zwracane.

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

object (FieldMetadata)

Metadane dotyczące stanu relacji.

value

string

Związki. Wartością może być niestandardowa lub jedna z tych wstępnie zdefiniowanych wartości:

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

string

Tylko dane wyjściowe. Wartość stanu relacji została przetłumaczona i sformatowana w regionie konta użytkownika lub w nagłówku HTTP Accept-Language.

Miejsce zamieszkania

WYCOFANO: 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

Wartość to „prawda”, jeśli miejsce zamieszkania to aktualne miejsce zamieszkania danej osoby.

Adres Sip

Adres SIP danej osoby. Adresy początkowe sesji są używane do komunikacji przez VoIP w celu nawiązywania połączeń głosowych lub wideo przez internet.

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 RFC 3261 19.1 identyfikatora URI SIP.

type

string

Typ adresu SIP. Może to być wartość niestandardowa lub jedna z tych wstępnie zdefiniowanych wartości:

  • home
  • work
  • mobile
  • other
formattedType

string

Tylko dane wyjściowe. Typ adresu SIP przetłumaczony i sformatowany w ustawieniach regionalnych konta użytkownika lub w nagłówku HTTP Accept-Language.

Umiejętność

Umiejętność, którą ma dana osoba.

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

object (FieldMetadata)

Metadane dotyczące umiejętności.

value

string

Umiejętność, na przykład underwater basket weaving.

Opis

WYCOFANO: nie zostaną zwrócone żadne dane dotyczące krótkiego, jednowierszowego opisu osoby.

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

object (FieldMetadata)

Metadane dotyczące sloganu.

value

string

Opis.

Adres URL

powiązane adresy URL osób,

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

object (FieldMetadata)

Metadane adresu URL.

value

string

Adres URL.

type

string

Typ adresu URL. Typ może być niestandardowy lub jedna 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łumaczony i sformatowany w ustawieniach regionalnych konta użytkownika lub w nagłówku HTTP Accept-Language.

Zdefiniowane przez użytkownika

Dowolne dane użytkownika, które są 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

Klucz określony przez użytkownika dla danych zdefiniowanych przez użytkownika.

value

string

Wartość użytkownika określona przez użytkownika.

Metody

batchCreateContacts

Utwórz grupę nowych kontaktów i zwróć odpowiedzi dla nowych osób

Żądania mutacji tego samego użytkownika powinny być przesyłane po kolei, co pozwoli uniknąć opóźnień i niepowodzeń.

batchDeleteContacts

Usuń grupę kontaktów.

batchUpdateContacts

Zaktualizuj grupę kontaktów i zwróć mapę z nazwami zasobów do opcji PersonResponse w przypadku zaktualizowanych kontaktów.

createContact

Utwórz nowy kontakt i zwróć zasoby tej osoby.

deleteContact

Usuń 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, określając listę żądanych nazw zasobów.

listDirectoryPeople

Zawiera listę profili domen i kontaktów z domeny w katalogu domeny uwierzytelnionego użytkownika.

searchContacts

Udostępnia listę kontaktów w zgrupowanych kontaktach uwierzytelnionego użytkownika, które pasują do zapytania.

searchDirectoryPeople

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

updateContact

Aktualizowanie danych kontaktowych istniejącej osoby kontaktowej.

updateContactPhoto

Zaktualizuj zdjęcie kontaktu.