Method: people.connections.list

Fornece uma lista dos contatos do usuário autenticado.

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 google.rpc.ErrorInfo com o motivo "EXPIRED_SYNC_TOKEN". No caso desse erro, 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 for especificado, os recursos excluídos desde a última sincronização serã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 vários minutos na propagação das solicitações de sincronização. Sincronizações incrementais não são destinadas a casos de uso de leitura após gravação.

Veja um exemplo de uso em Listar os contatos do usuário que foram alterados.

Solicitação HTTP

GET https://people.googleapis.com/v1/{resourceName=people/*}/connections

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

Parâmetros de caminho

Parâmetros
resourceName
(deprecated)

string

Obrigatório. O nome do recurso para o qual as conexões serão retornadas. Apenas people/me é válido.

Parâmetros de consulta

Parâmetros
pageToken

string

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

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

pageSize

integer

Opcional. O número de conexões a serem incluídas 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.

sortOrder

enum (SortOrder)

Opcional. A ordem em que as conexões devem ser classificadas. O valor padrão é LAST_MODIFIED_ASCENDING.

requestSyncToken

boolean

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

Mais detalhes sobre o comportamento de sincronização em people.connections.list.

syncToken

string

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

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

Mais detalhes sobre o comportamento de sincronização em people.connections.list.

requestMask
(deprecated)

object (RequestMask)

Opcional. OBSOLETO (use personFields)

Uma máscara para restringir os resultados a um subconjunto de campos de pessoa.

personFields

string (FieldMask format)

Obrigatório. Uma máscara de campo para restringir quais campos de cada pessoa são retornados. É possível especificar vários campos separados por vírgulas. Os valores válidos são:

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

enum (ReadSourceType)

Opcional. Uma máscara dos tipos de origem a serem retornados. O padrão será READ_SOURCE_TYPE_CONTACT e READ_SOURCE_TYPE_PROFILE, se nenhum valor for definido.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

A resposta a uma solicitação para as conexões do usuário autenticado.

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

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

object (Person)

É a lista de pessoas a que o solicitante está conectado.

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 as mudanças desde a última solicitação. A solicitação precisa definir requestSyncToken para retornar o token de sincronização. Quando a resposta é paginada, apenas a última página contém nextSyncToken.

totalPeople
(deprecated)

integer

OBSOLETO (Use totalItems) O número total de pessoas na lista sem paginação.

totalItems

integer

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

Escopos de autorização

Requer um dos seguintes escopos de OAuth:

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

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

SortOrder

A ordem em que uma lista de conexões deve ser classificada. Só será usado se a sincronização não for solicitada.

Enums
LAST_MODIFIED_ASCENDING Classifique as pessoas por quando elas foram alteradas. As entradas mais antigas primeiro.
LAST_MODIFIED_DESCENDING Classifique as pessoas por quando elas foram alteradas. As entradas mais recentes primeiro.
FIRST_NAME_ASCENDING Classificar pessoas pelo nome.
LAST_NAME_ASCENDING Classificar pessoas pelo sobrenome.