People API umożliwia:
- Odczytywanie kontaktów uwierzytelnionego użytkownika i zarządzanie nimi
- Odczytywanie i kopiowanie sekcji „Inne kontakty” uwierzytelnionego użytkownika.
- Odczytywanie informacji o profilach uwierzytelnionych użytkowników i ich kontaktów
- Odczytywanie profili i kontaktów domeny
Załóżmy na przykład, że uwierzytelniony użytkownik, Jan, ma w kontaktach prywatnych Fabiana i Ranjitha. Gdy aplikacja wywołuje metodę people.connections.list, aby odczytać listę swoich połączeń, Jen wyświetla ekran zgody z prośbą o przyznanie jej dostępu do listy. Jeśli Joanna wyrazi zgodę, aplikacja odczytuje listę zawierającą
person resources dla Fabiana i Ranjitha.
Jeśli aplikacja potrzebuje informacji dotyczących konkretnej osoby, może wywołać metodę people.get, podając nazwę zasobu, aby pobrać person resource dla tej osoby.
Aplikacja może też zarządzać kontaktami przez tworzenie nowych kontaktów w people.createContact, aktualizować kontakty odczytane z people.connections.list za pomocą people.updateContact oraz usuwać kontakty za pomocą people.deleteContact.
Użytkownicy Google Workspace mogą też wyświetlać listę profili domen i kontaktów domen z katalogu za pomocą people.listDirectoryPeople lub wyszukiwać je za pomocą people.searchDirectoryPeople.
Scalony widok informacji o osobach
Informacje o osobach odczytywane przez interfejs 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 profilu domeny Google Workspace | Administrator domeny włączył udostępnianie kontaktów i profili poza domenę danych ograniczonych do domeny i przyznał zakres directory.readonly. |
| Informacje o prywatnym profilu uwierzytelnionego użytkownika | Jeden z zakresów profile został przyznany. |
| Kontakty uwierzytelnionego użytkownika | Przyznano zakres contacts. |
Interpretowanie scalonych danych o osobach
Dane o osobie są pobierane z jednego głównego typu źródła. Dane z innych źródeł są scalane z tymi danymi, jeśli źródła są połączone zweryfikowanymi adresami e-mail, numerami telefonów lub adresami URL profili. Oto możliwe sposoby tworzenia osoby:
| Główne źródło | Kontakty | Profile | Profile domeny Google Workspace | Kontakty z domeny Google Workspace | Wykorzystanie |
|---|---|---|---|---|---|
| Nawiązanie kontaktu | 1 | 0+ | 0+ | 0+ | Zwracane w przypadku większości punktów końcowych |
| Profil | 0+ | 1 | 0 lub 1 | 0 | Zwracany w elemencie people.get, gdy został użyty do pozyskania osoby zalogowanego użytkownika lub uzyskania dostępu do konta Google innego użytkownika. |
| Kontakt z domeną | 0+ | 0 | 0 | 1 | Zwrócone w: people.listDirectoryPeople lub people.searchDirectoryPeople. |
Za pomocą punktów końcowych mutacji można modyfikować tylko osoby oparte na kontaktach. Mutacje kontaktów w profilu i domenie nie są obsługiwane.