Method: otherContacts.list

Lista todos os "Outros contatos", ou seja, os contatos que não estão em um grupo de contatos. "Outros contatos" normalmente são contatos criados automaticamente a partir de interações.

Os tokens de sincronização expiram sete dias após a sincronização completa. Uma solicitação com um token de sincronização expirado receberá um erro com um google.rpc.ErrorInfo com o motivo "EXPIRED_SYNC_TOKEN". Nesse caso, os clientes precisam fazer uma solicitação de sincronização completa sem um syncToken.

A primeira página de uma solicitação de sincronização completa tem uma cota adicional. Se a cota for excedida, o erro 429 será retornado. Essa cota é fixa e não pode ser aumentada.

Quando syncToken é especificado, os recursos excluídos desde a última sincronização são retornados como uma pessoa com PersonMetadata.deleted definido como verdadeiro.

Quando pageToken ou syncToken é especificado, todos os outros parâmetros de solicitação precisam corresponder à primeira chamada.

As gravações podem ter um atraso de propagação de vários minutos para solicitações de sincronização. Sincronizações incrementais não se destinam a casos de uso de leitura após gravação.

Veja exemplos de uso em Listar os outros contatos do usuário que foram alterados.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de consulta

Parâmetros
pageToken

string

Opcional. Um token de página, recebido de uma resposta anterior nextPageToken. Forneça isso para recuperar a página subsequente.

Ao paginar, todos os outros parâmetros fornecidos para otherContacts.list precisam corresponder à primeira chamada que forneceu o token da página.
pageSize

integer

Opcional. O número de "Outros contatos" incluir na resposta. Os valores válidos estão entre 1 e 1.000, inclusive. O padrão será 100 se não for definido ou for definido como 0.
requestSyncToken

boolean

Opcional. Se a resposta deve retornar nextSyncToken na última página de resultados. Ele pode ser usado para receber mudanças incrementais desde a última solicitação, configurando-o na solicitação syncToken.

Mais detalhes sobre o comportamento da sincronização em otherContacts.list.
syncToken

string

Opcional. Um token de sincronização, recebido de uma resposta anterior. nextSyncToken Forneça esse token para recuperar apenas os recursos alterados desde a última solicitação.

Ao sincronizar, todos os outros parâmetros fornecidos para otherContacts.list precisam corresponder à primeira chamada que forneceu o token de sincronização.

Mais detalhes sobre o comportamento da sincronização em otherContacts.list.
readMask

string (FieldMask format)

Obrigatório. Uma máscara de campo para restringir quais campos são retornados em cada pessoa. Vários campos podem ser especificados separados por vírgulas. Os valores válidos dependem do ReadSourceType usado.

Se READ_SOURCE_TYPE_CONTACT for usado, os valores válidos serão:

  • emailAddresses
  • metadados
  • nomes
  • phoneNumbers
  • fotos

Se READ_SOURCE_TYPE_PROFILE for usado, os valores válidos serão:

  • addresses
  • ageRanges
  • biografias
  • aniversários
  • calendarUrls
  • clientData
  • coverPhotos
  • emailAddresses
  • eventos
  • externalIds
  • sexos
  • imClients
  • interesses
  • locales
  • locais
  • dos canais
  • metadados
  • miscKeywords
  • nomes
  • apelidos
  • ocupações
  • organizations
  • phoneNumbers
  • fotos
  • relações
  • sipAddresses
  • skills
  • urls
  • userDefined
sources[]

enum (ReadSourceType)

Opcional. Uma máscara de quais tipos de origem serão retornados. Se não for definido, o padrão será READ_SOURCE_TYPE_CONTACT.

Os valores possíveis para este campo são:

Não é permitido especificar READ_SOURCE_TYPE_PROFILE sem especificar READ_SOURCE_TYPE_CONTACT.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

A resposta a uma solicitação para os "Outros contatos" do usuário autenticado.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "otherContacts": [
    {
      object (Person)
    }
  ],
  "nextPageToken": string,
  "nextSyncToken": string,
  "totalSize": integer
}
Campos
otherContacts[]

object (Person)

A lista de "Outros contatos" retornados como recursos Person. "Outros contatos" dão suporte a um subconjunto limitado de campos. Consulte ListOtherContactsRequest.request_mask para informações mais detalhadas.
nextPageToken

string

Um token, que pode ser enviado como pageToken para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.
nextSyncToken

string

Um token, que pode ser enviado como syncToken para recuperar mudanças desde a última solicitação. A solicitação precisa definir requestSyncToken para retornar o token de sincronização.
totalSize

integer

O número total de outros contatos na lista sem paginação.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte o Guia de autorização.