讀取及管理聯絡人

完成「準備使用 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 個每日聯絡人寫入次數 (總計)

警告： 應依序傳送同一位使用者的變異要求，以免延遲時間增加和失敗。

更新現有聯絡人

如要更新現有聯絡人，您必須在要更新的聯絡人資料中加入 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 個每日聯絡人寫入次數 (總計)

警告： 應依序傳送同一位使用者的變異要求，以免延遲時間增加和失敗。

刪除現有聯絡人

如要刪除現有聯絡人，請使用下列程式碼：

通訊協定

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

Java

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

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 次

警告： 應依序傳送同一位使用者的變異要求，以免延遲時間增加和失敗。

批次更新現有聯絡人

如要更新現有聯絡人，您必須在每位要更新聯絡人的資料中加入 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 次

警告： 應依序傳送同一位使用者的變異要求，以免延遲時間增加和失敗。

批次刪除現有聯絡人

如要 批次刪除現有聯絡人，請使用下列程式碼：

通訊協定

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 個寫入要求 (聯絡人刪除和聯絡人群組寫入)

警告： 應依序傳送同一位使用者的變異要求，以免延遲時間增加和失敗。