Method: otherContacts.list

Wymień wszystkie „Inne kontakty”, czyli kontakty, które nie należą do grupy kontaktów. „Inne kontakty” to zwykle kontakty tworzone automatycznie z interakcji.

Tokeny synchronizacji wygasają 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.

Propagacja zapisów w przypadku żądań synchronizacji może wynosić kilka minut. Synchronizacja przyrostowa nie jest przeznaczona do obsługi odczytu po zapisie.

Przykład użycia znajdziesz w sekcji Wyświetlanie listy innych kontaktów użytkownika, które uległy zmianie.

Żądanie HTTP

GET https://people.googleapis.com/v1/otherContacts

Adres URL używa składni transkodowania gRPC.

Parametry zapytania

Parametry
pageToken

string

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

Podczas dzielenia na strony wszystkie pozostałe parametry podane w narzędziu otherContacts.list muszą być zgodne z pierwszym wywołaniem, które dostarczyło token strony.
pageSize

integer

Opcjonalnie: Liczba „Innych kontaktów” umieścić w odpowiedzi. Prawidłowe wartości mieszczą się w zakresie od 1 do 1000 włącznie. Jeśli nie zostanie ustawiony lub zostanie ustawiony na 0, domyślna wartość to 100.
requestSyncToken

boolean

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

Więcej informacji o sposobie synchronizacji znajdziesz na stronie otherContacts.list.
syncToken

string

Opcjonalnie: Token synchronizacji otrzymany z poprzedniej odpowiedzi nextSyncToken Podaj ten token, aby pobrać tylko zasoby zmienione od ostatniego żądania.

Podczas synchronizacji wszystkie pozostałe parametry podane w usłudze otherContacts.list muszą być zgodne z pierwszym wywołaniem, które dostarczyło token synchronizacji.

Więcej informacji o sposobie synchronizacji znajdziesz na stronie otherContacts.list.
readMask

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 zależą od tego, jaki typ obiektu ReadSourceType jest używany.

Jeśli używana jest wartość READ_SOURCE_TYPE_CONTACT, prawidłowe wartości to:

  • emailAddresses
  • metadane
  • nazwy
  • phoneNumbers
  • zdjęcia

Jeśli używana jest funkcja READ_SOURCE_TYPE_PROFILE, 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 typów źródeł do zwrócenia. Jeśli nie zostanie ustawiony, domyślna wartość to READ_SOURCE_TYPE_CONTACT.

Możliwe wartości tego pola:

Podanie wartości READ_SOURCE_TYPE_PROFILE bez określenia READ_SOURCE_TYPE_CONTACT jest niedozwolone.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Odpowiedź na żądanie dotyczące opcji „Inne kontakty” uwierzytelnionego użytkownika.

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

Zapis JSON 
{
  "otherContacts": [
    {
      object (Person)
    }
  ],
  "nextPageToken": string,
  "nextSyncToken": string,
  "totalSize": integer
}
Pola
otherContacts[]

object (Person)

Lista „Inne kontakty” zwracanych jako zasoby osoby. „Inne kontakty” obsługują ograniczony podzbiór pól. Szczegółowe informacje znajdziesz w sekcji ListOtherContactsRequest.request_mask.
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 requestSyncToken należy ustawić zwracanie tokena synchronizacji.
totalSize

integer

Łączna liczba innych kontaktów na liście bez podziału na strony.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

  • https://www.googleapis.com/auth/contacts.other.readonly

Więcej informacji znajdziesz w przewodniku na temat autoryzacji.