Method: otherContacts.list

wyświetl listę wszystkich „Innych kontaktów”, czyli kontaktów, które nie należą do żadnej grupy kontaktów; „Inne kontakty” są zwykle tworzone automatycznie na podstawie interakcji.

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 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 je, aby pobrać kolejną stronę.

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

integer

Opcjonalnie. Liczba „Innych kontaktów”, które mają być uwzględnione 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.
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 otherContacts.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 otherContacts.list muszą odpowiadać pierwszemu wywołaniu, które dostarczyło token synchronizacji.

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

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 zależą od użytego typu ReadSourceType.

Jeśli używany jest parametr READ_SOURCE_TYPE_CONTACT, prawidłowe wartości to:

  • emailAddresses
  • metadane
  • names
  • phoneNumbers
  • fotografie

Jeśli używany jest profil READ_SOURCE_TYPE_PROFILE, 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.

Możliwe wartości tego pola to:

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 „Innych kontaktów” 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” zwrócona 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ż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.
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 po autoryzacji.