קריאה וניהול של אנשי קשר

אחרי שתבצעו את השלבים המפורטים במאמר הכנה לשימוש ב-People API, תוכלו לקרוא ולנהל את אנשי הקשר.

בדוגמאות הקוד הבאות מוסבר איך לשלוח כמה בקשות פשוטות. רשימה מלאה של השיטות מופיעה במאמרי העזרה.

הצגת רשימה של אנשי הקשר של המשתמש

כדי לקבל רשימה של אנשי הקשר של המשתמש, משתמשים בקוד הבא:

פרוטוקול

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

צור איש קשר חדש

כדי ליצור איש קשר חדש, משתמשים בקוד הבא:

פרוטוקול

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 כתיבת יומית של אנשי קשר (סה"כ)

עדכון של איש קשר קיים

כדי לעדכן איש קשר קיים, צריך לכלול את השדה person.metadata.sources.etag באדם שרוצים לעדכן כדי לוודא שאיש הקשר לא השתנה מאז הקריאה האחרונה. משתמשים בקוד הבא:

פרוטוקול

PATCH /v1/resource_name:updateContact?updatePersonFields=emailAddresses HTTP/1.1
Body: {
    "resourceName": "resource_name",
    "etag": "etag",
    "emailAddresses": [{ "value": "john.doe@gmail.com" }],
}
Host: people.googleapis.com

Java

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

List<EmailAddress> emailAddresses = new ArrayList<>();
emailAddresses.add(new EmailAddress().setValue("john.doe@gmail.com"));
contactToUpdate.setEmailAddresses(emailAddresses);

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

ניצול המכסה לכל בקשה

  • בקשת קריאה קריטית אחת (קריאה של פרטים ליצירת קשר ושל פרופילים)
  • 1 בקשות כתיבה קריטיות (יצירה ועדכון של אנשי קשר)
  • 1 כתיבת יומית של אנשי קשר (סה"כ)

מחיקה של איש קשר קיים

כדי למחוק איש קשר קיים, משתמשים בקוד הבא:

פרוטוקול

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

Java

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

ניצול המכסה לכל בקשה

  • בקשת כתיבה אחת (מחיקה של אנשי קשר וכתיבה בקבוצות של אנשי קשר)

יצירת אנשי קשר חדשים בכמות גדולה

כדי ליצור אנשי קשר חדשים בקבוצה, משתמשים בקוד הבא:

פרוטוקול

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": "john.doe@gmail.com"
        }
      ]
      "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 בקשות כתיבה (מחיקת אנשי קשר וכתיבה בקבוצות של אנשי קשר)