Method: people.connections.list

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ść syncToken, zasoby usunięte od ostatniej synchronizacji zostaną zwrócone jako osoba z atrybutem PersonMetadata.deleted ustawionym na wartość Prawda.

Jeśli podany jest parametr pageToken lub syncToken, pozostałe parametry żądania muszą odpowiadać pierwszemu wywołaniu.

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
(deprecated)

string

To pole jest wymagane. Nazwa zasobu, dla którego są zwracane połączenia. Prawidłowe jest tylko people/me.

Parametry zapytania

Parametry
pageToken

string

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

W przypadku podziału na strony wszystkie pozostałe parametry podane w metodzie people.connections.list muszą odpowiadać pierwszemu wywołaniu, które dostarczyło token strony.
pageSize

integer

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

enum (SortOrder)

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

boolean

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

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

string

Opcjonalnie. Token synchronizacji otrzymany z poprzedniej odpowiedzi nextSyncToken Podaj ten token, aby pobrać tylko zasoby, które zmieniły się od czasu ostatniego żądania.

Podczas synchronizacji wszystkie pozostałe parametry podane do people.connections.list muszą odpowiadać pierwszemu wywołaniu, które dostarczyło token synchronizacji.

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

object (RequestMask)

Opcjonalnie. WYCOFANE (zamiast tego użyj personFields)

Maska ograniczająca wyniki do podzbioru pól dotyczących osób.
personFields

string (FieldMask format)

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:

  • adresy
  • ageRanges
  • biografie
  • urodziny
  • calendarUrls
  • clientData
  • coverPhotos
  • emailAddresses
  • wydarzenia
  • externalIds
  • płeć
  • imClients
  • zainteresowania
  • locales
  • lokalizacje
  • kanału
  • metadane
  • miscKeywords
  • names
  • pseudonimy
  • zawody
  • organizations
  • phoneNumbers
  • fotografie
  • relacje
  • sipAddresses
  • umiejętności
  • urls
  • userDefined
sources[]

enum (ReadSourceType)

Opcjonalnie. Maska typów źródeł do zwrócenia. Jeśli nie zostanie ustawiony, domyślna wartość to 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 jest połączona osoba zgłaszająca prośbę.
nextPageToken

string

Token, który można wysłać jako pageToken, aby pobrać następną stronę. Jeśli pominiesz to pole, nie będzie kolejnych stron.
nextSyncToken

string

Token, który można wysłać jako syncToken, aby pobrać zmiany od ostatniego żądania. Aby zwracał token synchronizacji, żądanie musi ustawić requestSyncToken. Jeśli odpowiedź jest podzielona na strony, tylko ostatnia strona będzie zawierać tekst nextSyncToken.
totalPeople
(deprecated)

integer

WYCOFANY (Użyj parametru 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 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.