- Żądanie HTTP
- Parametry ścieżki
- Parametry zapytania
- Treść żądania
- Treść odpowiedzi
- Zakresy autoryzacji
- SortOrder
- Wypróbuj
Zawiera listę kontaktów uwierzytelnionego użytkownika.
Tokeny synchronizacji wygasają po 7 dniach po pełnej synchronizacji. Żądanie z wygasłym tokenem synchronizacji doprowadzi do błędu z błędem google.rpc.ErrorInfo i informacją o przyczynie „expirationD_SYNC_TOKEN”. W takim przypadku klient powinien wysłać pełne żądanie synchronizacji bez
.syncToken
Pierwsza strona żądania pełnej synchronizacji ma dodatkowy limit. Jeśli limit zostanie przekroczony, zwrócony zostanie błąd 429. Ten limit jest stały i nie można go zwiększyć.
Jeśli określisz właściwość
, zasoby usunięte od ostatniej synchronizacji zostaną zwrócone jako osoba z atrybutem syncToken
ustawionym na wartość Prawda.PersonMetadata.deleted
Jeśli podany jest parametr
lub pageToken
, pozostałe parametry żądania muszą odpowiadać pierwszemu wywołaniu.syncToken
Na propagację zapisów może wystąpić kilkuminutowe opóźnienie w przypadku żądań synchronizacji. Synchronizacje przyrostowe nie są przeznaczone do zastosowań typu odczyt po zapisie.
Przykład użycia znajdziesz w artykule Wyświetlanie listy kontaktów użytkownika, które uległy zmianie.
Żądanie HTTP
GET https://people.googleapis.com/v1/{resourceName=people/*}/connections
Adres URL używa składni transkodowania gRPC.
Parametry ścieżki
Parametry | |
---|---|
resourceName |
To pole jest wymagane. Nazwa zasobu, dla którego są zwracane połączenia. Prawidłowe jest tylko |
Parametry zapytania
Parametry | |
---|---|
pageToken |
Opcjonalnie. Token strony otrzymany z poprzedniej odpowiedzi W przypadku podziału na strony wszystkie pozostałe parametry podane w metodzie |
pageSize |
Opcjonalnie. Liczba połączeń do uwzględnienia w odpowiedzi. Prawidłowe wartości mieszczą się w zakresie od 1 do 1000 włącznie. Jeśli zasada jest nieskonfigurowana lub ma wartość 0, domyślna wartość to 100. |
sortOrder |
Opcjonalnie. Kolejność sortowania połączeń. Domyślna wartość to |
requestSyncToken |
Opcjonalnie. Określa, czy odpowiedź powinna zwrócić wartość Więcej informacji o synchronizacji znajdziesz na |
syncToken |
Opcjonalnie. Token synchronizacji otrzymany z poprzedniej odpowiedzi Podczas synchronizacji wszystkie pozostałe parametry podane do Więcej informacji o synchronizacji znajdziesz na |
requestMask |
Opcjonalnie. WYCOFANE (zamiast tego użyj Maska ograniczająca wyniki do podzbioru pól dotyczących osób. |
personFields |
To pole jest wymagane. Maska pola określająca, które pola każdej osoby mają być zwracane. Można określić wiele pól, rozdzielając je przecinkami. Prawidłowe wartości to:
|
sources[] |
Opcjonalnie. Maska typów źródeł do zwrócenia. Jeśli nie zostanie ustawiony, domyślna wartość to |
Treść żądania
Treść żądania musi być pusta.
Treść odpowiedzi
Odpowiedź na żądanie połączeń uwierzytelnionego użytkownika.
W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:
Zapis JSON |
---|
{
"connections": [
{
object ( |
Pola | |
---|---|
connections[] |
Lista osób, z którymi jest połączona osoba zgłaszająca prośbę. |
nextPageToken |
Token, który można wysłać jako |
nextSyncToken |
Token, który można wysłać jako |
totalPeople |
WYCOFANY (Użyj parametru totalItems) Łączna liczba osób na liście bez podziału na strony. |
totalItems |
Łączna liczba elementów na liście bez podziału na strony. |
Zakresy autoryzacji
Wymaga jednego z tych zakresów OAuth:
https://www.googleapis.com/auth/contacts
https://www.googleapis.com/auth/contacts.readonly
Więcej informacji znajdziesz w przewodniku po autoryzacji.
SortOrder
Kolejność, w jakiej powinna być sortowana lista połączeń. Jest ona używana tylko wtedy, gdy nie jest wymagana synchronizacja.
Wartości w polu enum | |
---|---|
LAST_MODIFIED_ASCENDING |
Posortuj osoby według daty zmiany; na początku starsze wpisy. |
LAST_MODIFIED_DESCENDING |
Posortuj osoby według daty zmiany; na początku nowe wpisy. |
FIRST_NAME_ASCENDING |
Sortuj osoby według imion. |
LAST_NAME_ASCENDING |
Sortuj osoby według nazwiska. |