Odczytywanie kontaktów i zarządzanie nimi

Po wykonaniu czynności opisanych w artykule Przygotowanie się do korzystania z interfejsu People API możesz odczytywać kontakty i zarządzać nimi.

Poniższe przykłady kodu pokazują, jak wysyłać kilka prostych żądań. Pełną listę metod znajdziesz w dokumentacji.

Ważne: można modyfikować tylko kontakty. Nie można modyfikować osób czytających profil za pomocą nazwy zasobu "people/me" lub identyfikatora konta.

Wyświetlanie listy kontaktów użytkownika

Aby uzyskać listę osób w kontaktach użytkownika, użyj tego kodu:

ProtokółJavaPythonPHP.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;

Wyświetlić listę kontaktów użytkownika, które uległy zmianie

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

Uwaga: w przypadku żądań synchronizacji zapisy mogą być opóźnione o kilka minut. Synchronizacja przyrostowa nie jest przeznaczona do odczytu po zapisie.

Więcej informacji o zachowaniu synchronizacji znajdziesz w funkcji ListConnections.

wyszukiwanie kontaktów użytkownika;

Aby przeszukiwać wszystkie kontakty użytkownika, użyj tego kodu:

ProtokółJava

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

Ważne: wyszukiwarka korzysta z opóźnionego buforowania, które jest aktualizowane po otrzymaniu żądania. Klienci powinni najpierw wysłać puste zapytanie w celu rozgrzania wyszukiwarki, aby mieć pewność, że w pamięci podręcznej są najnowsze dane.

Uwaga: wyszukiwarka dopasowuje prefiks zapytania do pól osoby. Na przykład osoba o nazwie „foo name” pasuje do zapytań takich jak „f”, „fo”, „foo”, „foo n”, „nam” itp., ale nie „oo n”.

Utwórz nowy kontakt

Aby utworzyć nowy kontakt, użyj tego kodu:

ProtokółJava

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

Wykorzystanie limitu na żądanie

• 1 Bardzo ważne żądania odczytu (kontakt i odczyt profilu)
• 1 Bardzo ważne żądania zapisu (tworzenie i aktualizowanie kontaktów)
• 1 Dzienna liczba zapisów kontaktów (łączna)

Ostrzeżenie: aby uniknąć wydłużenia czasu oczekiwania i błędów, żądania modyfikacji dotyczące tego samego użytkownika należy wysyłać kolejno.

Aktualizowanie istniejącego kontaktu

Aby zaktualizować istniejący kontakt, musisz uwzględnić pole person.metadata.sources.etag w osobie, której kontakt ma zostać zaktualizowany, aby mieć pewność, że kontakt nie zmienił się od ostatniego odczytu. Użyj tego kodu:

ProtokółJava

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

Wykorzystanie limitu na żądanie

• 1 Bardzo ważne żądania odczytu (kontakt i odczyt profilu)
• 1 Bardzo ważne żądania zapisu (tworzenie i aktualizowanie kontaktów)
• 1 Dzienna liczba zapisów kontaktów (łączna)

Ostrzeżenie: aby uniknąć wydłużenia czasu oczekiwania i błędów, żądania modyfikacji dotyczące tego samego użytkownika należy wysyłać kolejno.

Usuwanie istniejącego kontaktu

Aby usunąć istniejący kontakt, użyj tego kodu:

ProtokółJava

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

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

Wykorzystanie limitu na żądanie

• 1. Żądania zapisu (usuwanie kontaktów i zapisy dotyczące grup kontaktów)

Ostrzeżenie: aby uniknąć wydłużenia czasu oczekiwania i błędów, żądania modyfikacji dotyczące tego samego użytkownika należy wysyłać kolejno.

Tworzenie nowych kontaktów zbiorczo

Aby utworzyć zbiorczo nowe kontakty, użyj tego kodu:

ProtokółJava

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

Wykorzystanie limitu na żądanie

• 6 krytycznych żądań odczytu (odczyt kontaktu i profilu)
• 6 krytycznych żądań zapisu (tworzenie i aktualizowanie kontaktów)
• 200 kontaktów z użytkownikiem dziennie (łączna liczba)

Ostrzeżenie: aby uniknąć wydłużenia czasu oczekiwania i błędów, żądania modyfikacji dotyczące tego samego użytkownika należy wysyłać kolejno.

Grupowe aktualizowanie istniejących kontaktów

Aby zaktualizować istniejący kontakt, musisz uwzględnić pole person.metadata.sources.etag w każdej osobie, której dane chcesz zaktualizować, aby mieć pewność, że kontakt nie zmienił się od czasu ostatniego odczytu. Użyj tego kodu:

ProtokółJava

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

Wykorzystanie limitu na żądanie

• 6 krytycznych żądań odczytu (odczyt kontaktu i profilu)
• 6 krytycznych żądań zapisu (tworzenie i aktualizowanie kontaktów)
• 200 kontaktów z użytkownikiem dziennie (łączna liczba)

Ostrzeżenie: aby uniknąć wydłużenia czasu oczekiwania i błędów, żądania modyfikacji dotyczące tego samego użytkownika należy wysyłać kolejno.

zbiorcze usuwanie istniejących kontaktów.

Aby usunąć istniejących kontaktów zbiorczo, użyj tego kodu:

ProtokółJava

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

Wykorzystanie limitu na żądanie

• 10 żądań zapisu (usuwanie kontaktów i zapisywanie grup kontaktów)

Ostrzeżenie: aby uniknąć wydłużenia czasu oczekiwania i błędów, żądania modyfikacji dotyczące tego samego użytkownika należy wysyłać kolejno.