Чтение и управление контактами

После выполнения шагов, описанных в разделе «Подготовка к использованию People API», вы готовы читать контакты и управлять ими.

Следующие примеры кода демонстрируют, как отправить несколько простых запросов. Полный список методов смотрите в справочной документации .

Важно: Изменять можно только людей, основанных на контактах. Люди на основе профиля, читающие с использованием имени ресурса "people/me" или идентификатора учетной записи, не могут быть изменены.

Список контактов пользователя

Чтобы получить список людей в контактах пользователя , используйте следующий код:

Протокол

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')

PHP

$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;

Перечислите контакты пользователя, которые изменились

Ява

// 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
  }
}

Примечание. Запись может иметь задержку распространения в несколько минут для запросов синхронизации. Добавочная синхронизация не предназначена для случаев использования чтения после записи.

Более подробную информацию о поведении синхронизации можно найти в ListConnections .

Поиск контактов пользователя

Чтобы выполнить поиск по всем контактам пользователя , используйте следующий код:

Протокол

// 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();

Важно: Поиск использует ленивый кеш, который обновляется после запроса. Клиенты должны сначала отправить запрос на поиск с пустым запросом, чтобы убедиться, что в кеше имеются самые последние данные.

Примечание. Поиск выполняет сопоставление префикса запроса с полями человека. Например, человек с именем «foo name» соответствует таким запросам, как «f», «fo», «foo», «foo n», «nam» и т. д., но не «oo n».

Создать новый контакт

Чтобы создать новый контакт , используйте следующий код:

Протокол

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();

Использование квоты на запрос

• 1 Критические запросы на чтение (чтение контактов и профилей)
• 1 Критические запросы на запись (создание и обновление контактов)
• 1 ежедневная запись в контакт (всего)

Предупреждение. Запросы на изменение для одного и того же пользователя следует отправлять последовательно, чтобы избежать увеличения задержек и сбоев.

Обновить существующий контакт

Чтобы обновить существующий контакт , вы должны включить поле person.metadata.sources.etag в контакт, который будет обновлен, чтобы убедиться, что контакт не изменился с момента вашего последнего чтения. Используйте следующий код:

Протокол

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();

Использование квоты на запрос

• 1 Критические запросы на чтение (чтение контактов и профилей)
• 1 Критические запросы на запись (создание и обновление контактов)
• 1 ежедневная запись в контакт (всего)

Предупреждение. Запросы на изменение для одного и того же пользователя следует отправлять последовательно, чтобы избежать увеличения задержек и сбоев.

Удалить существующий контакт

Чтобы удалить существующий контакт , используйте следующий код:

Протокол

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

Ява

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

Использование квоты на запрос

• 1 Запросы на запись (удаление контактов и запись группы контактов)

Предупреждение. Запросы на изменение для одного и того же пользователя следует отправлять последовательно, чтобы избежать увеличения задержек и сбоев.

Пакетное создание новых контактов

Для пакетного создания новых контактов используйте следующий код:

Протокол

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();

Использование квоты на запрос

• 6 критически важных запросов на чтение (чтение контактов и профилей)
• 6 критических запросов на запись (создание и обновление контактов)
• 200 ежедневных записей контактов (всего)

Предупреждение. Запросы на изменение для одного и того же пользователя следует отправлять последовательно, чтобы избежать увеличения задержек и сбоев.

Пакетное обновление существующих контактов

Чтобы обновить существующий контакт , вы должны включить поле person.metadata.sources.etag в каждого человека, чтобы контакт был обновлен, чтобы убедиться, что контакт не изменился с момента вашего последнего чтения. Используйте следующий код:

Протокол

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();

Использование квоты на запрос

• 6 критических запросов на чтение (чтение контактов и профилей)
• 6 критических запросов на запись (создание и обновление контактов)
• 200 ежедневных записей контактов (всего)

Предупреждение. Запросы на изменение для одного и того же пользователя следует отправлять последовательно, чтобы избежать увеличения задержек и сбоев.

Пакетное удаление существующих контактов

Чтобы пакетно удалить существующие контакты , используйте следующий код:

Протокол

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();

Использование квоты на запрос

• 10 запросов на запись (удаление контактов и запись групп контактов)

Предупреждение. Запросы на изменение для одного и того же пользователя следует отправлять последовательно, чтобы избежать увеличения задержек и сбоев.