读取和管理联系人

完成开始使用 People API 中的步骤后，就可以读取和管理联系人了。

以下代码示例演示了如何发送一些简单的请求。如需查看完整的方法列表，请参阅参考文档。

重要提示 ：只能修改联系人。基于个人资料的用户使用资源名称 "people/me" 或帐号 ID 进行读取无法修改。

列出用户的联系人

如需获取用户通讯录中的人员列表，请使用以下代码：

协议

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

Java

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

Python

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

PHP

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

.NET

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

列出已更改的用户联系人

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

注意 ：对于同步请求，写入操作的传播可能会延迟几分钟。增量同步不适用于写后读用例。

如需详细了解同步行为，请参阅 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

Java

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

Java

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 次每日联系人写入（总计）

警告 ：应按顺序发送针对同一用户的 Mutate 请求，以免延迟时间增加和失败。

更新现有联系人

如需更新现有联系人，您必须在要更新联系人的人员中包含 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

Java

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 次每日联系人写入（总计）

警告 ：应按顺序发送针对同一用户的 Mutate 请求，以免延迟时间增加和失败。

删除现有联系人

如需删除现有联系人，请使用以下代码：

协议

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

Java

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

每个请求的配额用量

• 1 写入请求（联系人删除和联系人组写入）

警告 ：应按顺序发送针对同一用户的 Mutate 请求，以免延迟时间增加和失败。

批量创建新联系人

如需批量创建新联系人，请使用以下代码：

协议

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

Java

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 次（总计）

警告 ：应按顺序发送针对同一用户的 Mutate 请求，以免延迟时间增加和失败。

批量更新现有联系人

如需更新现有联系人，您必须在每个联系人中添加 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

Java

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 次（总计）

警告 ：应按顺序发送针对同一用户的 Mutate 请求，以免延迟时间增加和失败。

批量删除现有联系人

如需 批量删除现有联系人，请使用以下代码：

协议

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

Java

BatchDeleteContactsRequest request = new BatchDeleteContactsRequest();

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

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

每个请求的配额用量

• 10 个写入请求（联系人删除和联系人组写入）

警告 ：应按顺序发送针对同一用户的 Mutate 请求，以免延迟时间增加和失败。