- Solicitação HTTP
- Parâmetros de consulta
- Corpo da solicitação
- Corpo da resposta
- Escopos de autorização
- Faça um teste
Listar todos os "Outros contatos", ou seja, aqueles que não estão em um grupo de contatos. "Outros contatos" geralmente são contatos criados automaticamente com base em 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 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
for especificado, os recursos excluídos desde a última sincronização serão retornados como uma pessoa com syncToken
definido como verdadeiro.PersonMetadata.deleted
Quando
ou pageToken
é especificado, todos os outros parâmetros de solicitação precisam corresponder à primeira chamada.syncToken
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 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 |
Opcional. Um token de página, recebido de uma resposta Ao paginar, todos os outros parâmetros fornecidos para |
pageSize |
Opcional. O número de "Outros contatos" a serem incluídos 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 |
Opcional. Se a resposta precisa retornar Mais detalhes sobre o comportamento de sincronização em |
syncToken |
Opcional. Um token de sincronização, recebido de uma resposta anterior. Ao sincronizar, todos os outros parâmetros fornecidos para Mais detalhes sobre o comportamento de sincronização em |
readMask |
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 dependem do ReadSourceType usado. Se READ_SOURCE_TYPE_CONTACT for usado, os valores válidos serão:
Se READ_SOURCE_TYPE_PROFILE for usado, os valores válidos serão:
|
sources[] |
Opcional. Uma máscara dos tipos de origem a serem retornados. Se não for definido, o padrão será Os valores possíveis para este campo são: Não é permitido especificar |
Corpo da solicitação
O corpo da solicitação precisa estar vazio.
Corpo da resposta
A resposta a uma solicitação para "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 ( |
Campos | |
---|---|
otherContacts[] |
A lista de "Outros contatos" retornada como recursos Pessoa. A opção "Outros contatos" é compatível com um subconjunto limitado de campos. Consulte ListOtherContactsRequest.request_mask para informações mais detalhadas. |
nextPageToken |
Um token, que pode ser enviado como |
nextSyncToken |
Um token, que pode ser enviado como |
totalSize |
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.