Method: people.connections.list

Zawiera listę kontaktów z uwierzytelnionego konta użytkownika.

Tokeny synchronizacji wygasają po 7 dniach od przeprowadzenia pełnej synchronizacji. Żądanie z wygasłym tokenem synchronizacji otrzyma błąd z google.rpc.ErrorInfo z powodu „EXPIRED_SYNC_TOKEN”. W takich przypadkach klienci powinni przesłać prośbę o pełną synchronizację bez użycia syncToken.

Pierwsza strona żądania pełnej synchronizacji ma dodatkowy limit. Po przekroczeniu limitu zwracany jest błąd 429. Ten limit jest stały i nie można go zwiększyć.

Gdy właściwość syncToken jest określona, zasoby usunięte od ostatniej synchronizacji są zwracane jako osoba z wartością PersonMetadata.deleted ustawioną na „true”.

Po określeniu pageToken lub syncToken wszystkie pozostałe parametry żądania muszą być zgodne z pierwszym wywołaniem.

W przypadku żądań synchronizacji opóźnienie propagacji może potrwać kilka minut. Synchronizacje przyrostowe nie są przeznaczone do przypadków użycia po odczytaniu i zapisie.

Przykładowe zastosowanie znajdziesz w sekcji Lista kontaktów, 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

Wymagany. Nazwa zasobu, dla którego chcesz przywrócić połączenia. Tylko people/me.

Parametry zapytania

Parametry
pageToken

string

Opcjonalne. Token strony otrzymany z poprzedniej odpowiedzi nextPageToken. Podaj go, aby pobrać następną stronę.

W podziale na strony wszystkie pozostałe parametry przekazane do people.connections.list muszą odpowiadać pierwszemu wywołaniu tokena strony.
pageSize

integer

Opcjonalne. Liczba połączeń do odpowiedzi. Prawidłowe wartości to od 1 do 1000 włącznie. Jeśli zasada jest nieskonfigurowana lub ma wartość 0, przyjmuje domyślną wartość 100.
sortOrder

enum (SortOrder)

Opcjonalne. Kolejność, w jakiej połączenia mają być sortowane. Domyślna wartość to LAST_MODIFIED_ASCENDING.
requestSyncToken

boolean

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

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

string

Opcjonalne. Token synchronizacji otrzymany z poprzedniej odpowiedzi nextSyncToken – wpisz go, aby pobrać tylko zasoby zmienione od czasu ostatniego żądania.

Podczas synchronizacji wszystkie pozostałe parametry przekazane do people.connections.list muszą odpowiadać pierwszemu wywołaniu tokena synchronizacji.

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

object (RequestMask)

Opcjonalne. WYCOFANO (zamiast tego użyj personFields)

Maska, która ogranicza wyniki do podzbioru pól osób.
personFields

string (FieldMask format)

Wymagany. Maska pola, która ogranicza pola zwracane przez poszczególne osoby. Możesz określić wiele pól, rozdzielając je przecinkami. Prawidłowe wartości to:

  • adresy
  • przedziały wiekowe
  • biografie
  • urodziny
  • kalendarzUrl
  • daneklienta
  • Zdjęcia na okładkę
  • adresy-e-mail
  • wydarzenia
  • externalIds
  • płeć
  • klienty
  • zainteresowania
  • języki
  • lokalizacje
  • kanału
  • metadane
  • inne słowa kluczowe
  • imiona i nazwiska
  • pseudonimy
  • zawody
  • organizacje
  • numery telefonów
  • zdjęcia
  • relacje
  • adresy sip
  • umiejętności
  • adresy
  • definiowany przez użytkownika
sources[]

enum (ReadSourceType)

Opcjonalne. Maska typu 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

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Odpowiedź na żądanie połączenia z uwierzytelnionym użytkownikiem.

Zapis JSON 
{
  "connections": [
    {
      object (Person)
    }
  ],
  "nextPageToken": string,
  "nextSyncToken": string,
  "totalPeople": integer,
  "totalItems": integer
}
Pola
connections[]

object (Person)

Lista osób, z którymi łączy się osoba wysyłają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 można było zwrócić token synchronizacji, żądanie musi mieć wartość requestSyncToken. W podziale na strony tylko ostatnia strona będzie zawierać tag nextSyncToken.
totalPeople
(deprecated)

integer

WYCOFANO (użyj elementu totalItems) łącznej liczby 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 należy sortować listę połączeń. Ta opcja jest używana tylko wtedy, gdy synchronizacja nie jest wymagana.

Wartości w polu enum
LAST_MODIFIED_ASCENDING Sortuj osoby według daty zmiany. Starsze wpisy są wyświetlane jako pierwsze.
LAST_MODIFIED_DESCENDING Sortuj osoby według daty wprowadzenia. Starsze wpisy są wyświetlane jako pierwsze.
FIRST_NAME_ASCENDING Posortuj osoby według imienia.
LAST_NAME_ASCENDING Sortuj osoby według nazwiska.