Ler e gerenciar contatos

Depois de concluir as etapas em Preparar-se para usar a API People, você poderá ler e gerenciar contatos.

Os exemplos de código abaixo demonstram como enviar algumas solicitações simples. Para uma lista completa de métodos, consulte a documentação de referência.

Importante: somente as pessoas com base em contatos podem ser modificadas. A leitura de pessoas com base no perfil usando o nome do recurso "people/me" ou um ID da conta não pode ser modificada.

Listar os contatos do usuário

Para receber uma lista de pessoas nos contatos do usuário, use o seguinte código:

ProtocoloJavaPythonPHP.NET

GET /v1/people/me/connections?personFields=names,emailAddresses HTTP/1.1
Host: people.googleapis.com

ListConnectionsResponse response = peopleService.people().connections().list("people/me")
    .setPersonFields("names,emailAddresses")
    .execute();
List<Person> people = response.getConnections();

people = people_service.people().connections()
    .list('people/me', personFields='names,emailAddresses')

$people = $people_service->people_connections->listPeopleConnections(
    'people/me', array('personFields' => 'names,emailAddresses'));

PeopleResource.ConnectionsResource.ListRequest peopleRequest =
    peopleService.People.Connections.List("people/me");
peopleRequest.PersonFields = "names,emailAddresses";
ListConnectionsResponse response = peopleRequest.Execute();
IList<Person> people = response.Connections;

Listar os contatos do usuário que foram alterados

Java

// Initial request
ListConnectionsResponse fullSyncResponse = peopleService.people().connections().list("people/me")
    .setPersonFields("metadata,names,emailAddresses")
    .setRequestSyncToken(true)
    .execute();
// Fetch all the pages
while (fullSyncResponse.getNextPageToken() != null) {
  fullSyncResponse = peopleService.people().connections().list("people/me")
      .setPersonFields("metadata,names,emailAddresses")
      .setRequestSyncToken(true)
      .setPageToken(fullSyncResponse.getNextPageToken())
      .execute();
}

// Some time passes

// Fetch incremental changes using the sync token returned in the last fullSyncResponse.
try {
  ListConnectionsResponse incrementalSyncResponse = peopleService.people().connections().list("people/me")
      .setPersonFields("metadata,names,emailAddresses")
      .setSyncToken(fullSyncResponse.getNextSyncToken())
      .execute();
  for (Person person : incrementalSyncResponse.getConnections()) {
    handlePerson(person);
  }

  // Fetch all the pages
  while (incrementalSyncResponse.getNextPageToken() != null) {
    incrementalSyncResponse = peopleService.people().connections().list("people/me")
        .setPersonFields("metadata,names,emailAddresses")
        .setSyncToken(fullSyncResponse.getNextSyncToken())
        .setPageToken(incrementalSyncResponse.getNextPageToken())
        .execute();
    for (Person person : incrementalSyncResponse.getConnections()) {
      handlePerson(person);
    }
  }
} catch (GoogleJsonResponseException e) {
  if (e.getStatusCode() == 410) {
    // Sync token expired. Make full sync request.
  }
}

void handlePerson(Person person) {
  if (person.getMetadata().getDeleted()) {
    // Handle deleted person
  } else {
    // Handle changed person
  }
}

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

Mais detalhes sobre o comportamento de sincronização em ListConnections.

Pesquisar os contatos do usuário

Para pesquisar todos os contatos do usuário, use o seguinte código:

ProtocoloJava

// Warmup cache
GET /v1/people:searchContacts?query=&readMask=names,emailAddresses HTTP/1.1
Host: people.googleapis.com


// Send search request after several seconds
GET /v1/people:searchContacts?query=query&readMask=names,emailAddresses HTTP/1.1
Host: people.googleapis.com

// Warmup cache
SearchResponse response = peopleService.people().searchContacts()
    .setQuery("")
    .setReadMask("names,emailAddresses")
    .execute();


// Wait a few seconds
Thread.sleep(5);


// Send search request
SearchResponse response = peopleService.people().searchContacts()
    .setQuery("query")
    .setReadMask("names,emailAddresses")
    .execute();

Importante: a pesquisa usa um cache preguiçoso que é atualizado após uma solicitação. Os clientes primeiro precisam enviar uma solicitação de pesquisa de aquecimento com uma consulta vazia para garantir que o cache tenha os dados mais recentes.

Observação: a pesquisa faz uma correspondência de prefixo da consulta com os campos de uma pessoa. Por exemplo, uma pessoa com o nome "foo name" corresponde a consultas como "f", "fo", "foo", "foo n", "nam" etc., mas não a "oo n".

Criar um novo contato

Para criar um novo contato, use o seguinte código:

ProtocoloJava

POST /v1/people:createContact HTTP/1.1
Body: { "names": [{ "givenName": "John", "familyName": "Doe" }] }
Host: people.googleapis.com

Person contactToCreate = new Person();
List<Name> names = new ArrayList<>();
names.add(new Name().setGivenName("John").setFamilyName("Doe"));
contactToCreate.setNames(names);

Person createdContact = peopleService.people().createContact(contactToCreate).execute();

Uso da cota por solicitação

• 1 solicitação de leitura crítica (leitura de contatos e perfis)
• 1 solicitação de gravação crítica (criação e atualização de contatos)
• 1 gravação de contato diária (total)

Aviso: as solicitações de mutação para o mesmo usuário precisam ser enviadas sequencialmente para evitar aumento de latência e falhas.

Atualizar um contato

Para atualizar um contato existente, é necessário incluir o campo person.metadata.sources.etag na pessoa para que o contato seja atualizado e garantir que ele não tenha mudado desde a última leitura. Use o seguinte código:

ProtocoloJava

PATCH /v1/resource_name:updateContact?updatePersonFields=emailAddresses HTTP/1.1
Body: {
    "resourceName": "resource_name",
    "etag": "etag",
    "emailAddresses": [{ "value": "[e-mail]" }],
}
Host: people.googleapis.com

Person contactToUpdate = peopleService.people().get("resource_name").execute();

List<EmailAddress> emailAddresses = new ArrayList<>();
emailAddresses.add(new EmailAddress().setValue("[e-mail]"));
contactToUpdate.setEmailAddresses(emailAddresses);

Person updatedContact = peopleService.people()
    .updateContact(contactToUpdate.getResourceName(), contactToUpdate)
    .setUpdatePersonFields("emailAddresses")
    .execute();

Uso da cota por solicitação

• 1 solicitação de leitura crítica (leitura de contatos e perfis)
• 1 solicitação de gravação crítica (criação e atualização de contatos)
• 1 gravação de contato diária (total)

Aviso: as solicitações de mutação para o mesmo usuário precisam ser enviadas sequencialmente para evitar aumento de latência e falhas.

Excluir um contato

Para excluir um contato, use o seguinte código:

ProtocoloJava

DELETE /v1/resource_name:deleteContact HTTP/1.1
Host: people.googleapis.com

peopleService.people().deleteContact("resource_name").execute();

Uso da cota por solicitação

• 1 Solicitações de gravação (exclusões e gravações de grupos de contatos)

Aviso: as solicitações de mutação para o mesmo usuário precisam ser enviadas sequencialmente para evitar aumento de latência e falhas.

Criar novos contatos em lote

Para criar novos contatos em lote, use o seguinte código:

ProtocoloJava

POST /v1/people:batchCreateContacts?readMask=names HTTP/1.1
Body: {
  "contacts": [
    {
      "contactPerson": {
        "names": [
          {
            "givenName": "John",
            "familyName": "Doe"
          }
        ]
      }
    }
  ]
}
Host: people.googleapis.com

Person person1 = new Person();
person1.setNames(ImmutableList.of(new Name().setGivenName("John").setFamilyName("Doe")));
ContactToCreate contactToCreate1 = new ContactToCreate();
contactToCreate1.setContactPerson(person1);

Person person2 = new Person();
person2.setNames(ImmutableList.of(new Name().setGivenName("Bob").setFamilyName("Dylan")));
ContactToCreate contactToCreate2 = new ContactToCreate();
contactToCreate2.setContactPerson(person2);

BatchCreateContactsRequest request = new BatchCreateContactsRequest();
request.setContacts(ImmutableList.of(contactToCreate1, contactToCreate2)).setReadMask("names");

BatchCreateContactsResponse response =
    peopleService.people().batchCreateContacts(request).execute();

Uso da cota por solicitação

• 6 solicitações de leitura críticas (leitura de contatos e perfis)
• 6 solicitações de gravação críticas (criação e atualização de contatos)
• 200 gravações de contato diárias (total)

Aviso: as solicitações de mutação para o mesmo usuário precisam ser enviadas sequencialmente para evitar aumento de latência e falhas.

Atualizar em lote os contatos atuais

Para atualizar um contato existente, é necessário incluir o campo person.metadata.sources.etag em cada pessoa para que o contato seja atualizado e não tenha mudado desde a última leitura. Use o seguinte código:

ProtocoloJava

POST /v1/people:batchUpdateContacts?updateMask=names&readMask=names,emailAddresses HTTP/1.1
Body: {
  "contacts": {
    "resource_name": {
      "emailAddresses": [
        {
          "value": "[e-mail]"
        }
      ]
      "etag": "etag"
    }
  }
}
Host: people.googleapis.com

Person contactToUpdate = peopleService.people().get("resource_name").execute();

contactToUpdate.setNames(
    ImmutableList.of(new Name().setGivenName("John").setFamilyName("Doe")));

BatchUpdateContactsRequest request = new BatchUpdateContactsRequest();
ImmutableMap<String, Person> map =
    ImmutableMap.of(contactToUpdate.getResourceName(), contactToUpdate);
request.setContacts(map).setUpdateMask("names").setReadMask("names,emailAddresses");

BatchUpdateContactsResponse response =
    peopleService.people().batchUpdateContacts(request).execute();

Uso da cota por solicitação

• 6 solicitações de leitura críticas (leitura de contatos e perfis)
• 6 solicitações de gravação críticas (criação e atualização de contatos)
• 200 gravações de contato diárias (total)

Aviso: as solicitações de mutação para o mesmo usuário precisam ser enviadas sequencialmente para evitar aumento de latência e falhas.

Excluir em lote os contatos

Para excluir em lote os contatos atuais, use o seguinte código:

ProtocoloJava

POST /v1/people:batchDeleteContacts HTTP/1.1
Body: {"resource_names": ["resource_name"]}
Host: people.googleapis.com

BatchDeleteContactsRequest request = new BatchDeleteContactsRequest();

request.setResourceNames(ImmutableList.of(resource_name));

peopleService.people().batchDeleteContacts(request).execute();

Uso da cota por solicitação

• 10 solicitações de gravação (exclusões de contato e gravações de grupos de contatos)

Aviso: as solicitações de mutação para o mesmo usuário precisam ser enviadas sequencialmente para evitar aumento de latência e falhas.