Interfejs People API umożliwia:
- Odczytywanie kontaktów uwierzytelnionego użytkownika i zarządzanie nimi
- Przeczytaj i skopiuj Inne kontakty uwierzytelnionego użytkownika
- Odczytywanie informacji profilowych uwierzytelnionych użytkowników i ich kontaktów
- Odczytywanie profili domen i kontaktów
Załóżmy na przykład, że uwierzytelniony użytkownik Janina ma Fabian i Ranjith w swoich kontaktach prywatnych. Gdy aplikacja wywołuje metodę people.connections.list
, by odczytać listę jej połączeń, Jenneka widzi ekran zgody z prośbą o przyznanie aplikacji dostępu do listy. Jeśli Jen wyrazi zgodę, aplikacja odczytuje listę zawierającą person resources
dla Fabian i Ranjith.
Jeśli aplikacja potrzebuje informacji o określonej osobie, może następnie wywołać metodę people.get
, przekazując nazwę zasobu, aby uzyskać dostęp do person resource
tej osoby.
Aplikacja może również zarządzać kontaktami, tworząc nowe kontakty za pomocą people.createContact
, aktualizując istniejące kontakty, które odczytała z people.connections.list
przy użyciu people.updateContact
, a także usuwając kontakty za pomocą people.deleteContact
.
Użytkownicy Google Workspace mogą też utworzyć listę profili domen i kontaktów w domenie przy użyciu people.listDirectoryPeople
lub wyszukać je za pomocą people.searchDirectoryPeople
.
Połączony widok informacji o osobach
Informacje o użytkownikach odczytywane przez People API są scalane z różnych źródeł w zależności od tych warunków:
Źródło | Warunek |
---|---|
Publiczne dane profili Google | Zawsze. |
Dane profilowe domeny Google Workspace | Administrator domeny włączył zewnętrzne udostępnianie kontaktów i profili danych ograniczonych do domeny oraz zakresdirectory.readonly został przyznany. |
Prywatne informacje profilowe uwierzytelnionego użytkownika | Przyznano jeden z zakresów profile . |
Kontakty uwierzytelnionego użytkownika | Zakrescontacts został przyznany. |
Omówienie scalonych danych osób
Dane o osobie pochodzą z jednego głównego typu źródła. Dane z innych źródeł są łączone z tymi danymi, jeśli źródła są połączone za pomocą zweryfikowanych adresów e-mail, numerów telefonów lub adresów URL profili. Oto, jak może być skomponowana osoba:
Główne źródło | Kontakty | Profile | Profile domen Google Workspace | Kontakty z domeny Google Workspace | Wykorzystanie |
---|---|---|---|---|---|
Kontakt | 1 | 0+ | 0+ | 0+ | Zwracany w przypadku większości punktów końcowych |
Profil | 0+ | 1 | 0 lub 1 | 0 | Zwracany w people.get , gdy służy do pobrania danego użytkownika lub użytkownika konta Google innego użytkownika. |
Kontakt domeny | 0+ | 0 | 0 | 1 | Zwrot w terminie people.listDirectoryPeople lub people.searchDirectoryPeople . |
Punkty końcowe mutacji mogą modyfikować tylko osoby oparte na kontaktach. Mutacje profilów i domen kontaktów nie są obsługiwane.