Vom Kontakte-Dienst zum erweiterten People API-Dienst migrieren

Der Google Kontakte-Dienst wurde in Apps Script am 16. Dezember 2022 eingestellt. Verwenden Sie stattdessen den erweiterten Dienst der People API. Die People API verwendet ein neueres JSON-Protokoll und bietet erweiterte Funktionen wie das Zusammenführen von Kontakten mit Profilen.

In diesem Leitfaden erfahren Sie, welche Methoden des Google Kontakte-Dienstes keine Entsprechung im erweiterten Dienst der People API haben, was Sie stattdessen verwenden können und wo Sie Codebeispiele für die Migration häufiger Aufgaben finden. Weitere Informationen finden Sie im Leitfaden zur Migration der Contacts API.

Methoden ohne Entsprechung in der People API

Im Folgenden finden Sie eine Liste von getContacts Methoden im Google Kontakte-Dienst, für die es keine entsprechenden Möglichkeiten gibt, im erweiterten Dienst der People API nach Kontakten zu suchen. Mit dem erweiterten Dienst der People API können Sie nach den Feldern names, nickNames, emailAddresses, phoneNumbers und organizations eines Kontakts suchen, die aus der Quelle CONTACT stammen.

Methoden ohne Äquivalente
  • 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)

Im Folgenden sind getContacts-Methoden aus dem Google Kontakte-Dienst aufgeführt, die einen zusätzlichen label-Parameter verwenden. Sie können searchContacts aus dem erweiterten Dienst der People API verwenden, um Kontakte anhand des entsprechenden Felds abzurufen. Sie können die Suche jedoch nicht auf ein bestimmtes Label beschränken.

Methoden mit teilweisen Äquivalenten
  • getContactsByEmailAddress(query, label)
  • getContactsByName(query, label)
  • getContactsByPhone(query, label)

Zusätzliche Funktionen der People API

Wenn Sie zum erweiterten People API-Dienst migrieren, können Sie auf die folgenden People API-Funktionen zugreifen, die im Contacts-Dienst nicht verfügbar sind:

  • Datenquelle angeben: Wenn Sie nach Informationen zu einer Person suchen, können Sie angeben, wo gesucht werden soll, z. B. in einem Google-Kontakt oder einem Google-Profil.
  • Nach Personen anhand eines Suchstrings suchen: Sie können eine Liste mit Profilen und Kontakten abrufen, die mit einem bestimmten String übereinstimmen.
  • Batchanfragen: Sie können Ihre People API-Aufrufe in Batches zusammenfassen, um die Ausführungszeit des Scripts zu verkürzen.

Codebeispiele für gängige Aufgaben

In diesem Abschnitt werden häufige Aufgaben des Google Kontakte-Dienstes aufgeführt. Die Codebeispiele zeigen, wie Sie die Aufgaben mit dem erweiterten Dienst der People API erstellen.

Kontaktgruppe anhand des Namens abrufen

Im folgenden Codebeispiel wird gezeigt, wie eine Kontaktgruppe anhand ihres Namens abgerufen wird. Das entspricht getContactGroup(name) im Google Kontakte-Dienst.

advanced/people.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);
  }
}

Kontakt anhand der E-Mail-Adresse abrufen

Im folgenden Codebeispiel wird gezeigt, wie ein Kontakt anhand seiner E-Mail-Adresse abgerufen wird. Das entspricht getContact(emailAddress) im Google Kontakte-Dienst.

advanced/people.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);
  }
}

Alle Kontakte abrufen

Im folgenden Codebeispiel wird gezeigt, wie alle Kontakte eines Nutzers abgerufen werden. Das entspricht getContacts() im Contacts-Dienst.

advanced/people.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);
  }
}

Vollständigen Namen eines Kontakts abrufen

Im folgenden Codebeispiel wird gezeigt, wie Sie den vollständigen Namen eines Kontakts abrufen, was im Google Kontakte-Dienst dem Attribut getFullName() entspricht.

advanced/people.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);
  }
}

Alle Telefonnummern für einen Kontakt abrufen

Im folgenden Codebeispiel wird gezeigt, wie Sie alle Telefonnummern für einen Kontakt abrufen, was im Google Kontakte-Dienst dem Attribut getPhones() entspricht.

advanced/people.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);
  }
}

Eine bestimmte Telefonnummer für einen Kontakt abrufen

Im folgenden Codebeispiel wird gezeigt, wie eine bestimmte Telefonnummer für einen Kontakt abgerufen wird. Das entspricht getPhoneNumber() im Contacts-Dienst.

advanced/people.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);
  }
}