Migracja z usługi Kontakty do zaawansowanej usługi People API

Ważne: przed wyłączeniem usługi Kontakty w marcu 2023 roku przez Apps Script przenieś skrypty z usługi Kontakty do usługi zaawansowanej People API.

16 grudnia 2022 roku Apps Script wycofał usługę Kontakty. Zamiast tego użyj zaawansowanej usługi People API. People API wykorzystuje nowszy protokół JSON i udostępnia zaawansowane funkcje, takie jak łączenie kontaktów z profilami.

Z tego przewodnika dowiesz się, które metody usługi Kontakty nie mają odpowiednika w zaawansowanej usłudze People API, których możesz użyć zamiast nich, i znajdziesz przykłady kodu do migracji typowych zadań. Więcej informacji znajdziesz w przewodniku po migracji interfejsu Contacts API.

Metody bez odpowiedników interfejsu People API

Poniżej znajdziesz listę metod getContacts w usłudze Kontakty, które nie oferują analogicznych sposobów wyszukiwania kontaktów w zaawansowanej usłudze People API. Dzięki zaawansowanej usłudze People API możesz wyszukiwać według pól names, nickNames, emailAddresses, phoneNumbers i organizations kontaktu, które pochodzą ze źródła CONTACT.

Metody bez odpowiedników
  • getContactsByAddress(query)
  • getContactsByAddress(query, label)
  • getContactsByAddress(query, label)
  • getContactsByCustomField(query, label)
  • getContactsByDate(month, day, label)
  • getContactsByDate(month, day, year, label)
  • getContactsByDate(month, day, year, label)
  • getContactsByIM(query)
  • getContactsByIM(query, label)
  • getContactsByJobTitle(query)
  • getContactsByNotes(query)
  • getContactsByUrl(query)
  • getContactsByUrl(query, label)
  • getContactsByGroup(group)

Poniżej znajdziesz listę metod getContacts z usługi Kontakty, które używają dodatkowego parametru label. Możesz użyć searchContacts w zaawansowanej usłudze People API, aby uzyskać kontakty według odpowiadającego mu pola, ale nie możesz ograniczyć wyszukiwania do konkretnej etykiety.

Metody z częściowymi odpowiednikami
  • getContactsByEmailAddress(query, label)
  • getContactsByName(query, label)
  • getContactsByPhone(query, label)

Dodatkowe funkcje dostępne w interfejsie People API

Po przejściu na usługę zaawansowaną People API będziesz mieć dostęp do następujących funkcji interfejsu People API, które nie są dostępne w usłudze Kontakty:

Przykłady kodu do typowych zadań

W tej sekcji wymienione są typowe czynności wykonywane w usłudze Kontakty. Przykładowy kod pokazuje, jak tworzyć zadania za pomocą zaawansowanej usługi People API.

Pobierz grupę kontaktów według nazwy

Poniższy przykładowy kod pokazuje, jak uzyskać grupę kontaktów według jej nazwy, która jest odpowiednikiem getContactGroup(name) w usłudze Kontakty.

zaawansowane/osoby.gs
/**
 * Gets a contact group with the given name
 * @param {string} name The group name.
 * @see https://developers.google.com/people/api/rest/v1/contactGroups/list
 */
function getContactGroup(name) {
  try {
    const people = People.ContactGroups.list();
    // Finds the contact group for the person where the name matches.
    const group = people['contactGroups'].find((group) => group['name'] === name);
    // Prints the contact group
    console.log('Group: %s', JSON.stringify(group, null, 2));
  } catch (err) {
    // TODO (developers) - Handle exception
    console.log('Failed to get the contact group with an error %s', err.message);
  }
}

Znajdź kontakt, używając adresu e-mail

Poniższy przykładowy kod pokazuje, jak znaleźć kontakt przy użyciu jego adresu e-mail, który jest odpowiednikiem getContact(emailAddress) w usłudze Kontakty.

zaawansowane/osoby.gs
/**
 * Gets a contact by the email address.
 * @param {string} email The email address.
 * @see https://developers.google.com/people/api/rest/v1/people.connections/list
 */
function getContactByEmail(email) {
  try {
    // Gets the person with that email address by iterating over all contacts.
    const people = People.People.Connections.list('people/me', {
      personFields: 'names,emailAddresses'
    });
    const contact = people['connections'].find((connection) => {
      return connection['emailAddresses'].some((emailAddress) => emailAddress['value'] === email);
    });
    // Prints the contact.
    console.log('Contact: %s', JSON.stringify(contact, null, 2));
  } catch (err) {
    // TODO (developers) - Handle exception
    console.log('Failed to get the connection with an error %s', err.message);
  }
}

Pobierz wszystkie kontakty

Poniższy przykładowy kod pokazuje, jak uzyskać wszystkie kontakty użytkownika, czyli odpowiednik getContacts() w usłudze Kontakty.

zaawansowane/osoby.gs
/**
 * Gets a list of people in the user's contacts.
 * @see https://developers.google.com/people/api/rest/v1/people.connections/list
 */
function getConnections() {
  try {
    // Get the list of connections/contacts of user's profile
    const people = People.People.Connections.list('people/me', {
      personFields: 'names,emailAddresses'
    });
    // Print the connections/contacts
    console.log('Connections: %s', JSON.stringify(people, null, 2));
  } catch (err) {
    // TODO (developers) - Handle exception here
    console.log('Failed to get the connection with an error %s', err.message);
  }
}

Uzyskiwanie pełnego imienia i nazwiska kontaktu

Poniższy przykładowy kod pokazuje, jak uzyskać imię i nazwisko kontaktu, które jest odpowiednikiem getFullName() w usłudze Kontakty.

zaawansowane/osoby.gs
/**
 * Gets the full name (given name and last name) of the contact as a string.
 * @see https://developers.google.com/people/api/rest/v1/people/get
 */
function getFullName() {
  try {
    // Gets the person by specifying resource name/account ID
    // in the first parameter of People.People.get.
    // This example gets the person for the user running the script.
    const people = People.People.get('people/me', {personFields: 'names'});
    // Prints the full name (given name + family name)
    console.log(`${people['names'][0]['givenName']} ${people['names'][0]['familyName']}`);
  } catch (err) {
    // TODO (developers) - Handle exception
    console.log('Failed to get the connection with an error %s', err.message);
  }
}

Zobacz wszystkie numery telefonów kontaktu

Poniższy przykładowy kod pokazuje, jak uzyskać wszystkie numery telefonów kontaktu, co odpowiada numerowi getPhones() w usłudze Kontakty.

zaawansowane/osoby.gs
/**
 * Gets all the phone numbers for this contact.
 * @see https://developers.google.com/people/api/rest/v1/people/get
 */
function getPhoneNumbers() {
  try {
    // Gets the person by specifying resource name/account ID
    // in the first parameter of People.People.get.
    // This example gets the person for the user running the script.
    const people = People.People.get('people/me', {personFields: 'phoneNumbers'});
    // Prints the phone numbers.
    console.log(people['phoneNumbers']);
  } catch (err) {
    // TODO (developers) - Handle exception
    console.log('Failed to get the connection with an error %s', err.message);
  }
}

Uzyskiwanie określonego numeru telefonu kontaktu

Poniższy przykładowy kod pokazuje, jak uzyskać konkretny numer telefonu do kontaktu, który jest odpowiednikiem getPhoneNumber() w usłudze Kontakty.

zaawansowane/osoby.gs
/**
 * Gets a phone number by type, such as work or home.
 * @see https://developers.google.com/people/api/rest/v1/people/get
 */
function getPhone() {
  try {
    // Gets the person by specifying resource name/account ID
    // in the first parameter of People.People.get.
    // This example gets the person for the user running the script.
    const people = People.People.get('people/me', {personFields: 'phoneNumbers'});
    // Gets phone number by type, such as home or work.
    const phoneNumber = people['phoneNumbers'].find((phone) => phone['type'] === 'home')['value'];
    // Prints the phone numbers.
    console.log(phoneNumber);
  } catch (err) {
    // TODO (developers) - Handle exception
    console.log('Failed to get the connection with an error %s', err.message);
  }
}