Eseguire la migrazione dal servizio Contatti al servizio avanzato dell'API People

Importante: esegui la migrazione dei tuoi script dal servizio Contatti al servizio avanzato dell'API People prima che Apps Script arresti il servizio Contatti a marzo 2023.

Apps Script ha ritirato il servizio Contatti il 16 dicembre 2022. Utilizza invece il servizio avanzato API People. L'API People utilizza un protocollo JSON più recente e offre funzionalità avanzate, come l'unione di contatti e profili.

Utilizza questa guida per scoprire quali metodi del servizio Contatti non hanno equivalenti nel servizio avanzato dell'API People, scoprire cosa puoi utilizzare e trovare esempi di codice per la migrazione delle attività comuni. Per ulteriori informazioni, consulta la guida alla migrazione dell'API Contacts.

Metodi senza equivalenti dell'API People

Di seguito sono elencati i metodi getContacts nel servizio Contatti che non offrono modalità equivalenti per cercare i contatti nel servizio avanzato People API. Con il servizio avanzato dell'API People, puoi eseguire una ricerca in base ai campi names, nickNames, emailAddresses, phoneNumbers e organizations di un contatto provenienti dall'origine CONTACT.

Metodi senza equivalenti

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)

Di seguito sono elencati i metodi getContacts del servizio Contatti che utilizzano un parametro label aggiuntivo. Puoi utilizzare searchContacts del servizio avanzato dell'API People per recuperare i contatti in base al campo equivalente, ma non puoi limitare la ricerca a un'etichetta specifica.

Metodi con equivalenti parziali
getContactsByEmailAddress(query, label) getContactsByName(query, label) getContactsByPhone(query, label)

Funzionalità aggiuntive disponibili con l'API People

Quando esegui la migrazione al servizio avanzato dell'API People, puoi accedere alle seguenti funzionalità dell'API People che non sono disponibili nel servizio Contatti:

• Specificare l'origine dati: quando cerchi informazioni su una persona, puoi specificare dove eseguire la ricerca, ad esempio un contatto o un profilo Google.
• Cerca persone in base a una stringa di query: puoi ottenere un elenco di profili e contatti che corrispondono a una stringa specifica.
• Richieste batch: puoi raggruppare le chiamate API People per ridurre i tempi di esecuzione dello script.

Esempi di codice per attività comuni

In questa sezione sono elencate le attività comuni del servizio Contatti. Gli esempi di codice mostrano come creare le attività utilizzando il servizio avanzato dell'API People.

Ottieni un gruppo di contatti per nome

Il seguente esempio di codice mostra come ottenere un gruppo di contatti in base al nome, che equivale a getContactGroup(name) nel servizio Contatti.

Advanced/people.gs

Visualizza su GitHub

/**
 * 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);
  }
}

Trovare un contatto tramite indirizzo email

Il seguente esempio di codice mostra come ottenere un contatto tramite il suo indirizzo email, che equivale a getContact(emailAddress) nel servizio Contatti.

Advanced/people.gs

Visualizza su GitHub

/**
 * 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);
  }
}

Recupera tutti i contatti

Il seguente esempio di codice mostra come recuperare tutti i contatti di un utente, l'equivalente a getContacts() nel servizio Contatti.

Advanced/people.gs

Visualizza su GitHub

/**
 * 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);
  }
}

Conoscere il nome completo di un contatto

Il seguente esempio di codice mostra come ottenere il nome completo di un contatto, che è l'equivalente a getFullName() nel servizio Contatti.

Advanced/people.gs

Visualizza su GitHub

/**
 * 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);
  }
}

Recuperare tutti i numeri di telefono di un contatto

Il seguente esempio di codice mostra come ottenere tutti i numeri di telefono di un contatto, che equivale a getPhones() nel servizio Contatti.

Advanced/people.gs

Visualizza su GitHub

/**
 * 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);
  }
}

Ottenere un numero di telefono specifico per un contatto

Il seguente esempio di codice mostra come ottenere un numero di telefono specifico per un contatto, che equivale a getPhoneNumber() nel servizio Contatti.

Advanced/people.gs

Visualizza su GitHub

/**
 * 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);
  }
}