Method: people.connections.list

Zawiera listę kontaktów uwierzytelnionego użytkownika.

Ważność tokenów synchronizacji wygasa po 7 dniach od pełnej synchronizacji. Żądanie z wygasłym tokenem synchronizacji otrzyma błąd z komunikatem google.rpc.ErrorInfo z powodem „expirationD_SYNC_TOKEN”. W takim przypadku klienty błędów powinny wysłać żądanie pełnej 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 zasada syncToken jest określona, zasoby usunięte od czasu ostatniej synchronizacji są zwracane jako osoba, dla której zasada PersonMetadata.deleted ma wartość Prawda.

Jeśli jest określony pageToken lub syncToken, wszystkie pozostałe parametry żądania muszą być zgodne z pierwszym wywołaniem.

W przypadku żądań synchronizacji zapisywanie może być opóźnione o kilka minut. Synchronizacja przyrostowa nie jest przeznaczona do odczytu po zapisie.

Przykład użycia znajdziesz w sekcji Wyświetlanie listy kontaktów użytkownika, które się zmieniły.

Żądanie HTTP

GET https://people.googleapis.com/v1/{resourceName=people/*}/connections

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
resourceName
(deprecated)

string

Wymagane. Nazwa zasobu, dla którego zostaną zwrócone połączenia. Prawidłowa wartość to tylko people/me.

Parametry zapytania

Parametry
pageToken

string

Opcjonalnie: Token strony otrzymany z poprzedniej odpowiedzi nextPageToken. Podaj ten parametr, aby pobrać kolejną stronę.

Podczas podziału na strony wszystkie inne parametry przekazane do funkcji people.connections.list muszą być zgodne z pierwszym wywołaniem, które przekazało token strony.
pageSize

integer

Opcjonalnie: Liczba połączeń do uwzględnienia w odpowiedzi. Prawidłowe wartości to od 1 do 1000 włącznie. Jeśli nie zostanie ustawiony lub zostanie ustawiony na 0, domyślnie przyjmuje wartość 100.
sortOrder

enum (SortOrder)

Opcjonalnie: Kolejność sortowania połączeń. Domyślna wartość to LAST_MODIFIED_ASCENDING.
requestSyncToken

boolean

Opcjonalnie: Określa, czy odpowiedź powinna zwracać nextSyncToken na ostatniej stronie wyników. Można go użyć, aby uzyskać przyrostowe zmiany od czasu ostatniego żądania, ustawiając go w żądaniu syncToken.

Więcej informacji o zachowaniu synchronizacji znajdziesz na stronie people.connections.list.
syncToken

string

Opcjonalnie: token synchronizacji otrzymany z poprzedniej odpowiedzi (nextSyncToken) – podaj go, aby pobrać tylko zasoby zmienione od czasu ostatniego żądania;

Podczas synchronizacji wszystkie inne parametry przekazywane do funkcji people.connections.list muszą być zgodne z pierwszym wywołaniem, które przekazało token synchronizacji.

Więcej informacji o sposobie synchronizacji znajdziesz na stronie people.connections.list.
requestMask
(deprecated)

object (RequestMask)

Opcjonalnie: WYCOFANY (zamiast niego użyj personFields)

Maska służąca do ograniczania wyników do podzbioru pól osoby.
personFields

string (FieldMask format)

Wymagane. Maska pola ograniczająca, które pola każdej osoby są zwracane. Można określić wiele pól, rozdzielając je przecinkami. Prawidłowe wartości to:

  • adresy
  • ageRanges
  • biografie
  • urodziny
  • calendarUrls
  • clientData
  • coverPhotos
  • emailAddresses
  • wydarzenia
  • externalIds
  • płeć
  • imClients
  • zainteresowania
  • języki
  • lokalizacje
  • kanału
  • metadane
  • miscKeywords
  • nazwy
  • pseudonimy
  • zawody
  • organizacje
  • phoneNumbers
  • zdjęcia
  • relacje
  • sipAddresses
  • umiejętności
  • adresy
  • userDefined
sources[]

enum (ReadSourceType)

Opcjonalnie: Maska określająca, jakie typy źródeł mają być zwracane. Jeśli nie zostanie ustawiony, domyślnie przyjmuje się READ_SOURCE_TYPE_CONTACT i READ_SOURCE_TYPE_PROFILE.

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 (Person)
    }
  ],
  "nextPageToken": string,
  "nextSyncToken": string,
  "totalPeople": integer,
  "totalItems": integer
}
Pola
connections[]

object (Person)

Lista osób, z którymi użytkownik zgłaszający prośbę jest połączony.
nextPageToken

string

Token, który może zostać wysłany jako pageToken w celu pobrania następnej strony. Jeśli pominiesz to pole, nie będzie kolejnych stron.
nextSyncToken

string

Token, który może zostać wysłany jako syncToken w celu pobrania zmian od czasu ostatniego żądania. W żądaniu musi być ustawiona wartość requestSyncToken, aby zwrócić token synchronizacji. Jeśli odpowiedź jest podzielona na strony, nextSyncToken będzie się znajdować tylko na ostatniej stronie.
totalPeople
(deprecated)

integer

WYCOFANE (należy użyć totalItems) Łączna liczba osób na liście bez podziału na strony.
totalItems

integer

Łą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 na temat autoryzacji.

SortOrder

Kolejność sortowania listy połączeń. Jest ona używana tylko wtedy, gdy nie zażądano synchronizacji.

Wartości w polu enum
LAST_MODIFIED_ASCENDING Posortować osoby według daty zmiany. starsze.
LAST_MODIFIED_DESCENDING Sortuj osoby według daty ich zmiany (najpierw nowsze wpisy).
FIRST_NAME_ASCENDING Sortuj osoby według imion.
LAST_NAME_ASCENDING Sortuj osoby według nazwiska.