Migra del servicio de Contactos al servicio avanzado de la API de People

Importante: Migra tus secuencias de comandos del servicio de Contactos al servicio avanzado de la API de People antes de que Apps Script cierre el servicio de Contactos el 31 de enero de 2025.

Apps Script dio de baja el servicio de Contactos el 16 de diciembre de 2022. En su lugar, usa el servicio avanzado de la API de People. La API de People usa un protocolo JSON más reciente y proporciona funciones avanzadas, como la combinación de contactos con perfiles.

Usa esta guía para descubrir qué métodos del servicio de Contactos no tienen equivalentes en el servicio avanzado de la API de People, qué puedes usar en su lugar y encontrar muestras de código para migrar tareas comunes. Para obtener más información, consulta la Guía de migración de la API de Contactos.

Métodos sin equivalentes de la API de Personas

En la siguiente lista, se enumeran los métodos getContacts del servicio de Contactos que no tienen formas equivalentes de buscar contactos en el servicio avanzado de la API de People. Con el servicio avanzado de la API de People, puedes realizar búsquedas por los campos names, nickNames, emailAddresses, phoneNumbers y organizations de un contacto que provengan de la fuente CONTACT.

Métodos sin equivalentes

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)

A continuación, se enumeran los métodos getContacts del servicio de Contactos que usan un parámetro label adicional. Puedes usar searchContacts desde el servicio avanzado de la API de People para obtener contactos por el campo equivalente, pero no puedes limitar la búsqueda a una etiqueta específica.

Métodos con equivalentes parciales
getContactsByEmailAddress(query, label) getContactsByName(query, label) getContactsByPhone(query, label)

Funciones adicionales disponibles con la API de People

Cuando migras al servicio avanzado de la API de People, puedes acceder a las siguientes funciones de la API de People que no están disponibles en el servicio de Contactos:

• Especifica la fuente de datos: Cuando buscas información sobre una persona, puedes especificar dónde buscar, como un contacto de Google o un perfil de Google.
• Buscar personas por una cadena de búsqueda: Puedes obtener una lista de perfiles y contactos que coincidan con una cadena específica.
• Solicitudes por lotes: Puedes agrupar tus llamadas a la API de People para reducir el tiempo de ejecución de la secuencia de comandos.

Muestras de código para tareas comunes

En esta sección, se enumeran las tareas comunes del servicio Contactos. En los ejemplos de código, se muestra cómo crear las tareas con el servicio avanzado de la API de People.

Cómo obtener un grupo de contactos por nombre

En la siguiente muestra de código, se muestra cómo obtener un grupo de contactos por su nombre, que es el equivalente a getContactGroup(name) en el servicio de Contactos.

advanced/people.gs

Ver en 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);
  }
}

Cómo obtener un contacto por dirección de correo electrónico

En la siguiente muestra de código, se muestra cómo obtener un contacto por su dirección de correo electrónico, que equivale a getContact(emailAddress) en el servicio Contactos.

advanced/people.gs

Ver en 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);
  }
}

Cómo obtener todos los contactos

En la siguiente muestra de código, se muestra cómo obtener todos los contactos de un usuario, lo que equivale a getContacts() en el servicio de Contactos.

advanced/people.gs

Ver en 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);
  }
}

Cómo obtener el nombre completo de un contacto

En la siguiente muestra de código, se muestra cómo obtener el nombre completo de un contacto, que equivale a getFullName() en el servicio de Contactos.

advanced/people.gs

Ver en 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);
  }
}

Cómo obtener todos los números de teléfono de un contacto

En la siguiente muestra de código, se muestra cómo obtener todos los números de teléfono de un contacto, que es equivalente a getPhones() en el servicio de Contactos.

advanced/people.gs

Ver en 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);
  }
}

Cómo obtener un número de teléfono específico de un contacto

En la siguiente muestra de código, se muestra cómo obtener un número de teléfono específico para un contacto, que es el equivalente a getPhoneNumber() en el servicio de Contactos.

advanced/people.gs

Ver en 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);
  }
}