REST Resource: people

Zasób: Person

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

Większość pól może zawierać wiele elementów. Elementy w polu nie mają gwarantowanej kolejności, ale każde niepuste pole musi zawierać dokładnie 1 pole z wartością metadata.primary ustawioną na 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 osoby przypisana przez serwer. Ciąg ASCII w formacie people/{person_id}.

etag

string

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

metadata

object (PersonMetadata)

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

addresses[]

object (Address)

Adres pocztowy osoby.

ageRange
(deprecated)

enum (AgeRange)

Tylko dane wyjściowe. WYCOFANY (zamiast niego użyj person.ageRanges)

Przedział wiekowy osoby.

ageRanges[]

object (AgeRangeType)

Tylko dane wyjściowe. Przedział wiekowy osoby.

biographies[]

object (Biography)

Biografie osoby. To pole jest pojedynczym elementem dla źródeł kontaktów.

birthdays[]

object (Birthday)

Urodziny tej osoby. To pole jest pojedynczym elementem dla źródeł kontaktów.

braggingRights[]
(deprecated)

object (BraggingRights)

WYCOFANY: żadne dane nie zostaną zwrócone użytkownikowi, którym może się pochwalić.

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ę danej osoby.

emailAddresses[]

object (EmailAddress)

Adresy e-mail osoby. W przypadku people.connections.list i otherContacts.list liczba adresów e-mail jest ograniczona do 100. Jeśli osoba ma więcej adresów e-mail, cały zestaw można uzyskać, wywołując funkcję people.getBatchGet.

events[]

object (Event)

Zdarzenia dotyczące tej osoby.

externalIds[]

object (ExternalId)

Zewnętrzne identyfikatory tej osoby.

fileAses[]

object (FileAs)

Pliki referencyjne tej osoby.

genders[]

object (Gender)

Płeć osoby. To pole jest pojedynczym elementem dla źródeł kontaktów.

imClients[]

object (ImClient)

Klienty komunikatora internetowego danej osoby.

interests[]

object (Interest)

Zainteresowania danej osoby.

locales[]

object (Locale)

Ustawienia regionalne tej osoby.

locations[]

object (Location)

Lokalizacje użytkownika.

memberships[]

object (Membership)

Członkostwa w grupach tej osoby.

miscKeywords[]

object (MiscKeyword)

Różne słowa kluczowe tej osoby.

names[]

object (Name)

Imiona i nazwiska osoby. To pole jest pojedynczym elementem dla źródeł kontaktów.

nicknames[]

object (Nickname)

Pseudonimy osoby.

occupations[]

object (Occupation)

Zawody danej osoby.

organizations[]

object (Organization)

Wcześniejsze lub obecne organizacje tej osoby.

phoneNumbers[]

object (PhoneNumber)

Numery telefonów tej osoby. W przypadku people.connections.list i otherContacts.list liczba numerów telefonu jest ograniczona do 100. Jeśli osoba ma więcej numerów telefonów, cały zestaw można 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. WYCOFANY: nie zostaną zwrócone żadne zainteresowania tej osoby w relacjach.

relationshipStatuses[]
(deprecated)

object (RelationshipStatus)

Tylko dane wyjściowe. WYCOFANY: nie zostaną zwrócone żadne dane o stanie relacji tej osoby.

residences[]
(deprecated)

object (Residence)

WYCOFANE: (Zamiast tego użyj person.locations) Domki, w których znajduje się osoba.

sipAddresses[]

object (SipAddress)

Adresy SIP danej osoby.

skills[]

object (Skill)

Umiejętności danej osoby.

taglines[]
(deprecated)

object (Tagline)

Tylko dane wyjściowe. WYCOFANY: slogany tej osoby nie zostaną zwrócone.

urls[]

object (Url)

Powiązane adresy URL 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 osoby.

previousResourceNames[]

string

Tylko dane wyjściowe. Wszelkie poprzednie nazwy zasobów, które ta osoba używała. 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. WYCOFANY (zamiast niego 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 ramach typu źródła wygenerowanego przez serwer.

etag

string

Podawane tylko w person.metadata.sources.

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

updateTime

string (Timestamp format)

Tylko dane wyjściowe. Podawane tylko w person.metadata.sources.

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

Sygnatura czasowa w RFC3339 UTC „Zulu” 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. Podawane tylko w person.metadata.sources.

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

profileMetadata

object (ProfileMetadata)

Tylko dane wyjściowe. Podawane tylko w 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 wyświetlić na stronie 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 Google „Inny kontakt”.
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. Pismo wpisywane przez 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 korzysta z Currents.
GOOGLE_APPS_USER Użytkownik jest użytkownikiem Google Workspace.

Adres

Fizyczny adres danej osoby. To może być adres pocztowy skrytki lub adresu pocztowego. 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 użytkownik nie ustawi tej wartości, zostanie on automatycznie utworzony na podstawie uporządkowanych wartości.

type

string

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

  • home
  • work
  • other
formattedType

string

Tylko dane wyjściowe. Typ przetłumaczonego i sformatowanego adresu zgodnie z ustawieniami języka konta przeglądającego lub w języku nagłówka HTTP Accept-Language.

poBox

string

Pocztówki w polu adresu.

streetAddress

string

Ulica i numer.

extendedAddress

string

rozszerzony adres, na przykład numer mieszkania.

city

string

Miasto w adresie.

region

string

region adresu; na przykład region.

postalCode

string

Kod pocztowy w adresie.

country

string

Kraj 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 głównym dla wszystkich źródeł w danej osobie. Każda osoba może mieć maksymalnie 1 pole z wartością primary ustawioną na true.

sourcePrimary

boolean

Prawda, jeśli pole jest głównym polem funkcji source. Każde źródło może mieć maksymalnie 1 pole z wartością sourcePrimary ustawioną na true.

verified

boolean

Tylko dane wyjściowe. Prawda, jeśli pole jest zweryfikowane; Wartość false, jeśli pole nie jest zweryfikowane. Pole zweryfikowane to zazwyczaj imię i nazwisko, adres e-mail, numer telefonu lub adres strony, co do których mamy potwierdzenie, że dana osoba należy do danej osoby.

source

object (Source)

Źródło pola.

ZakresWieku

WYCOFANY (zamiast niego użyj person.ageRanges)

Przedział wiekowy osoby.

Wartości w polu enum
AGE_RANGE_UNSPECIFIED Nie określono.
LESS_THAN_EIGHTEEN Poniżej 18 lat.
EIGHTEEN_TO_TWENTY Od 18 do 20.
TWENTY_ONE_OR_OLDER Mieć 21 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.

Biograficzny

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)

Rodzaj 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 1 z pól date i text. Pola date i text zwykle zawierają tę samą datę, ale nie jest to gwarantowane. Podczas mutowania urodzin klienci powinni zawsze ustawiać pole date.

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

object (FieldMetadata)

Metadane dotyczące urodzin.

date

object (Date)

Uporządkowana data urodzin.

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łą datę lub jej część, na przykład datę urodzin. Pora dnia i strefa czasowa zostały określone w innym miejscu lub są nieistotne. Data zależy od kalendarza gregoriańskiego. Może to być jedna z tych wartości:

  • Pełna data z wartościami niezerowymi dotyczącymi roku, miesiąca i dnia.
  • Miesiąc i dzień bez roku (np. rocznica).
  • Sam rok z zerowym miesiącem i zerowym dniem.
  • Rok i miesiąc z zerową datą ważności (np. 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 zakresie od 1 do 9999 lub od 0 do określenia daty bez roku.

month

integer

Miesiąc w roku. Musi mieścić się w zakresie od 1 do 12 lub 0, jeśli chcesz określić rok bez miesiąca i dnia.

day

integer

Dzień miesiąca. Wartość musi należeć do zakresu od 1 do 31 i jest ważna dla roku i miesiąca. Wartość 0 pozwala określić pojedynczy rok lub rok i miesiąc, w którym dzień nie jest istotny.

BraggingRights

WYCOFANY: żadne dane nie zostaną zwrócone użytkownikowi, którym może się pochwalić.

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

object (FieldMetadata)

Metadane dotyczące Tym, czym chcesz się pochwalić.

value

string

Tym 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. Może to być wartość niestandardowa lub jedna z tych wartości zdefiniowanych wstępnie:

  • home
  • freeBusy
  • work
formattedType

string

Tylko dane wyjściowe. Typ przetłumaczonego i sformatowanego adresu URL kalendarza zgodnie z ustawieniami regionalnymi konta osoby przeglądającej lub językiem nagłówka HTTP Accept-Language.

ClientData

Dane dowolnych klientów 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

Klient określił klucz danych klienta.

value

string

Określona przez klienta wartość danych klienta.

CoverPhoto

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

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

object (FieldMetadata)

Metadane zdjęcia na okładkę.

url

string

Adres URL zdjęcia na okładkę.

default

boolean

Prawda, jeśli zdjęcie na okładkę jest domyślnym zdjęciem na okładkę; false, jeśli zdjęcie na okładkę jest zdjęciem na okładkę przesłanym 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. Może to być wartość niestandardowa lub jedna z tych wartości zdefiniowanych wstępnie:

  • home
  • work
  • other
formattedType

string

Tylko dane wyjściowe. Typ adresu e-mail przetłumaczonego i sformatowanego zgodnie z ustawieniami języka konta przeglądającego lub w języku nagłówka HTTP Accept-Language.

displayName

string

Wyświetlana nazwa e-maila.

Zdarzenie

Zdarzenie związane z daną osobą.

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

object (FieldMetadata)

Metadane dotyczące wydarzenia.

date

object (Date)

Data zdarzenia.

type

string

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

  • anniversary
  • other
formattedType

string

Tylko dane wyjściowe. Typ zdarzenia przetłumaczonego i sformatowanego zgodnie z językiem konta wyświetlającego lub język nagłówka HTTP Accept-Language.

Identyfikator zewnętrzny

Identyfikator podmiotu zewnętrznego powiązanego z 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. Może to być wartość niestandardowa lub jedna z tych wartości zdefiniowanych wstępnie:

  • account
  • customer
  • loginId
  • network
  • organization
formattedType

string

Tylko dane wyjściowe. Typ zdarzenia przetłumaczonego i sformatowanego zgodnie z językiem konta wyświetlającego lub język nagłówka HTTP Accept-Language.

FileAs

Imię i nazwisko, które służy do sortowania osób na liście.

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

object (FieldMetadata)

Metadane dotyczące pliku jako.

value

string

Wartość pliku jako

Płeć

Płeć użytkownika.

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

  • male
  • female
  • unspecified
formattedValue

string

Tylko dane wyjściowe. Wartość płci przetłumaczonej i sformatowanej zgodnie z ustawieniami języka konta przeglądającego lub w języku nagłówka HTTP Accept-Language. Wartości nieokreślone lub niestandardowe nie są lokalizowane.

addressMeAs

string

Pole tekstowe do wpisania zaimków, które mają być używane do zwracania się do osoby. Typowe wartości to:

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

ImClient

Klient komunikatora internetowego 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

username

string

Nazwa użytkownika używana w kliencie czatu.

type

string

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

  • home
  • work
  • other
formattedType

string

Tylko dane wyjściowe. Typ klienta komunikatora przetłumaczonego i sformatowanego zgodnie z językiem konta przeglądającego lub język nagłówka HTTP Accept-Language.

protocol

string

Protokół klienta komunikatora. 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 komunikatora sformatowany zgodnie z językiem konta wyświetlającego lub język nagłówka HTTP Accept-Language.

Zainteresowanie

Jeden z zainteresowań tej 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

Preferowany język użytkownika.

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 region.

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. Może to być wartość niestandardowa lub jedna z tych wartości zdefiniowanych wstępnie:

  • desk
  • grewUp
current

boolean

Określa, czy lokalizacja jest bieżącą lokalizacją.

buildingId

string

Identyfikator budynku.

floor

string

Nazwa lub numer piętra.

floorSection

string

Obszar piętra w: floor_name.

deskCode

string

Lokalizacja pojedynczego biurka.

Członkostwo

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. Subskrypcja. 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. Subskrypcja domeny.

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 formacie contactGroups/{contactGroupId}. Do modyfikowania członkostwa można używać tylko contactGroupResourceName. Można usunąć każde członkostwo w grupie kontaktów, ale tylko grupa użytkowników lub „myContacts” lub „oznaczone gwiazdką” Członkostwa w grupach systemowych. Kontakt musi zawsze należeć do co najmniej jednej grupy kontaktów.

DomainMembership

subskrypcję domeny Google Workspace.

Zapis JSON
{
  "inViewerDomain": boolean
}
Pola
inViewerDomain

boolean

Wartość to „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ść innego słowa kluczowego.

type

enum (KeywordType)

Różne typy słów kluczowych.

formattedType

string

Tylko dane wyjściowe. Rodzaj przetłumaczonego i sformatowanego słowa kluczowego określonego na koncie użytkownika wyświetlającego lub w języku nagłówka HTTP Accept-Language.

KeywordType

Rodzaj innego słowa kluczowego.

Wartości w polu enum
TYPE_UNSPECIFIED Nie określono.
OUTLOOK_BILLING_INFORMATION Pole na informacje rozliczeniowe w Outlooku.
OUTLOOK_DIRECTORY_SERVER Pole programu Outlook dla serwera katalogowego.
OUTLOOK_KEYWORD Pole Outlooka na słowo kluczowe.
OUTLOOK_MILEAGE Pole Outlooka dotyczące przebiegu.
OUTLOOK_PRIORITY Pole Outlook na potrzeby priorytetu.
OUTLOOK_SENSITIVITY Pole Outlooka dotyczące poufności.
OUTLOOK_SUBJECT Pole tematu w Outlooku.
OUTLOOK_USER Pole Outlooka użytkownika.
HOME Start
WORK Praca.
OTHER Inne.

Nazwa

Imię i nazwisko danej osoby. Jeśli imię i nazwisko jest jednoznaczne, pole jest puste.

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 nazwy.

displayName

string

Tylko dane wyjściowe. Wyświetlana nazwa sformatowana zgodnie z językiem określonym przez konto przeglądającego lub w nagłówku HTTP Accept-Language.

displayNameLastFirst

string

Tylko dane wyjściowe. Wyświetlana nazwa z nazwiskiem sformatowana najpierw zgodnie z językiem określonym przez konto przeglądającego lub w nagłówku HTTP Accept-Language.

unstructuredName

string

Wartość nazwy eksploracji swobodnej.

familyName

string

Nazwisko.

givenName

string

Podane imię.

middleName

string

Drugie imię.

honorificPrefix

string

Prefiksy honorowe, takie jak Mrs. lub Dr.

honorificSuffix

string

sufiksy honorowe, na przykład Jr.;

phoneticFullName

string

Pełne imię i nazwisko zapisane w sposób, w jaki może brzmieć.

phoneticFamilyName

string

Nazwisko zapisane zgodnie z jej brzmieniem.

phoneticGivenName

string

Imię zapisane tak, jak się wymawia.

phoneticMiddleName

string

Drugie imię zapisane zgodnie z ich brzmieniem.

phoneticHonorificPrefix

string

Honorowe prefiksy napisane w taki sposób, w jaki się wymawia.

phoneticHonorificSuffix

string

Sufiksy honorowe zapisywane w taki sposób, w jaki się wymawia.

Pseudonim

Pseudonim 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

Typ pseudonimu.

Wartości w polu enum
DEFAULT Ogólny pseudonim.
MAIDEN_NAME

Nazwisko panieńskie lub rodzinne nazwisko. Używany, gdy nazwisko osoby zostało zmienione w wyniku zawarcia małżeństwa.

INITIALS

Inicjały.

GPLUS

Pseudonim profilu Google+.

OTHER_NAME

tytuł zawodowy lub inna nazwa; na przykład: Dr. Smith.

ALTERNATE_NAME Alternatywne imię i nazwisko osoby jest znane.
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 zatrudnienia.

value

string

zawód; na przykład carpenter.

Organizacja

Przeszła lub obecna 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. Może to być wartość niestandardowa lub jedna z tych wartości zdefiniowanych wstępnie:

  • work
  • school
formattedType

string

Tylko dane wyjściowe. Typ organizacji przetłumaczony i sformatowany zgodnie z ustawieniami języka konta przeglądającego lub w języku nagłówka HTTP Accept-Language.

startDate

object (Date)

Data rozpoczęcia, kiedy dana osoba dołączyła do organizacji.

endDate

object (Date)

Data zakończenia, kiedy dana osoba opuściła organizację.

current

boolean

Wartość to „prawda”, jeśli organizacja jest bieżącą organizacją danej osoby. Wartość false, jeśli organizacja należy do przeszłości.

name

string

Nazwa organizacji.

phoneticName

string

Fonetyczna nazwa organizacji.

department

string

Dział osoby w organizacji.

title

string

Stanowisko tej osoby w organizacji.

jobDescription

string

Opis stanowiska osoby w organizacji.

symbol

string

symbol powiązany z organizacją; na przykład symbol spółki giełdowej, skrót lub akronim.

domain

string

nazwa domeny powiązana z organizacją; na przykład google.com.

location

string

Lokalizacja biura organizacji, w której pracuje dana osoba.

costCenter

string

Centrum kosztów danej osoby w organizacji.

fullTimeEquivalentMillipercent

integer

Równowartość pełnoetatowa 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. Kanoniczna postać numeru telefonu ITU-T E.164.

type

string

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

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

string

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

Zdjęcie

Zdjęcie danej osoby. Obraz wyświetlany obok imienia i nazwiska 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ć żądany 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

Prawda, jeśli zdjęcie jest zdjęciem domyślnym; false, jeśli zdjęcie zostało udostępnione przez użytkownika.

Relacja

Związek między daną osobą a inną 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 drugiej osoby, do której odnosi się to powiązanie.

type

string

Związek danej osoby z drugą osobą. Może to być wartość niestandardowa lub jedna z tych wartości zdefiniowanych wstępnie:

  • 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 na podstawie ustawień regionalnych konta użytkownika lub regionu określonego w nagłówku HTTP Accept-Language.

RelationshipInterest

WYCOFANE: nie będą zwracane żadne dane dotyczące zainteresowań danej osoby w relacjach .

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

object (FieldMetadata)

Metadane dotyczące zainteresowania relacjami.

value

string

Rodzaj relacji szukanej przez daną osobę. Może to być wartość niestandardowa lub jedna z tych wstępnie zdefiniowanych wartości:

  • friend
  • date
  • relationship
  • networking
formattedValue

string

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

RelationshipStatus

WYCOFANY: nie zostaną zwrócone żadne dane o stanie relacji użytkownika.

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

object (FieldMetadata)

Metadane dotyczące stanu relacji.

value

string

Związki. Może to być wartość 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 na język konta wyświetlającego lub na język nagłówka HTTP Accept-Language.

Miejsce zamieszkania

WYCOFANY: zamiast niego użyj person.locations. wcześniejsze 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 miejsca zamieszkania.

current

boolean

„prawda”, jeśli miejsce zamieszkania jest aktualnym miejscem zamieszkania danej osoby; Wartość false, jeśli miejsce zamieszkania to wcześniejsze mieszkanie.

SipAddress

Adres SIP danej osoby. Adresy Session Initial Protocol służą do komunikacji VoIP w celu nawiązywania połączeń głosowych i 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 identyfikatora SIP URI RFC 3261 19.1.

type

string

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

  • home
  • work
  • mobile
  • other
formattedType

string

Tylko dane wyjściowe. Typ adresu SIP przetłumaczonego i sformatowanego zgodnie z ustawieniami języka konta przeglądającego lub dla regionu nagłówka 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

WYCOFANY: nie zostaną zwrócone żadne dane; krótki, jednowierszowy opis osoby.

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

object (FieldMetadata)

Metadane dotyczące sloganu.

value

string

Slogan.

URL

Powiązane adresy URL użytkownika.

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. Może to być wartość niestandardowa lub jedna z tych wartości zdefiniowanych wstępnie:

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

string

Tylko dane wyjściowe. Typ przetłumaczonego i sformatowanego adresu URL zgodnie z ustawieniami języka konta przeglądającego lub w języku nagłówka HTTP Accept-Language.

UserDefined

Dane dowolnych 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

Określony przez użytkownika klucz danych zdefiniowanych przez użytkownika.

value

string

Określona przez użytkownika wartość danych zdefiniowanych przez użytkownika.

Metody

batchCreateContacts

Utwórz grupę nowych kontaktów i zwracaj PersonResponses dla nowych

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

batchDeleteContacts

usunąć grupę kontaktów,

batchUpdateContacts

Aktualizuj grupę kontaktów i zwracaj mapę nazw zasobów dla zaktualizowanych kontaktów w odpowiedzi PersonResponses.

createContact

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

deleteContact

Usuń osobę kontaktową.

deleteContactPhoto

Usuwanie zdjęcia kontaktu.

get

Zawiera informacje o osobie przez podanie nazwy zasobu.

getBatchGet

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

listDirectoryPeople

Zawiera listę profili domeny 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

Zaktualizuj dane istniejącej osoby kontaktowej.

updateContactPhoto

Zaktualizuj zdjęcie kontaktu.