Se usó la API de Cloud Translation para traducir esta página.

Class ContactsApp

Obsoleto. En su lugar, usa el servicio avanzado de la API de People.

Esta clase permite que los usuarios accedan a sus propios Contactos de Google y creen, quiten y actualicen los contactos que se incluyen en ellos.

Propiedades obsoletas

Propiedad	Tipo	Descripción
`ExtendedField`	`ExtendedField`
`Field`	`Field`
`Gender`	`Gender`
`Month`	`Month`
`Priority`	`Priority`
`Sensitivity`	`Sensitivity`

Métodos obsoletos

Método	Tipo de datos que se muestra	Descripción breve
`createContact(givenName, familyName, email)`	`Contact`	Crea un contacto nuevo.
`createContactGroup(name)`	`ContactGroup`	Crea un grupo de contactos con el nombre determinado // The code below creates a new contact group named "Work Friends" const group = ContactsApp.createContactGroup('Work Friends');
`deleteContact(contact)`	`void`	Borra el contacto.
`deleteContactGroup(group)`	`void`	Borra el grupo de contactos. // The code below creates deletes the contact group named "Work Friends" const group = ContactsApp.getContactGroup('Work Friends'); ContactsApp.deleteContactGroup(group);
`findByEmailAddress(email)`	`Contact`	Busca un contacto con la dirección de correo electrónico proporcionada.
`findContactGroup(name)`	`ContactGroup`	Busca un grupo de contactos con el nombre determinado.
`getAllContacts()`	`Contact[]`	Obtén todos los contactos que pertenecen a este usuario.
`getContact(emailAddress)`	`Contact`	Obtiene un contacto por la dirección de correo electrónico.
`getContactById(id)`	`Contact`	Obtiene el contacto con este ID.
`getContactGroup(name)`	`ContactGroup`	Obtiene un grupo de contactos con el nombre determinado o muestra un valor nulo si no se encuentra un grupo de contactos con ese nombre.
`getContactGroupById(id)`	`ContactGroup`	Obtiene un grupo de contactos con el ID determinado o muestra un valor nulo si no se encuentra ese grupo de contactos.
`getContactGroups()`	`ContactGroup[]`	Obtiene la lista completa de los grupos de contactos del usuario.
`getContacts()`	`Contact[]`	Obtiene todos los contactos del usuario.
`getContactsByAddress(query)`	`Contact[]`	Obtener contactos que coincidan con una dirección
`getContactsByAddress(query, label)`	`Contact[]`	Obtén contactos que coincidan con una dirección, limitados a un campo específico.
`getContactsByAddress(query, label)`	`Contact[]`	Obtén contactos que coincidan con una dirección, limitados a la etiqueta de dirección personalizada especificada.
`getContactsByCompany(query)`	`Contact[]`	Obtén contactos que coincidan con el campo de la empresa.
`getContactsByCustomField(query, label)`	`Contact[]`	Obtén contactos que coincidan con un valor determinado en un campo personalizado.
`getContactsByDate(month, day, label)`	`Contact[]`	Obtén contactos que coincidan con un mes y un día determinados para un campo estándar en particular.
`getContactsByDate(month, day, year, label)`	`Contact[]`	Obtén contactos que coincidan con un mes, un día y un año determinados para un campo estándar en particular.
`getContactsByDate(month, day, year, label)`	`Contact[]`	Obtén contactos que coincidan con un mes, un día y un año determinados para un campo personalizado en particular.
`getContactsByDate(month, day, label)`	`Contact[]`	Obtén contactos que coincidan con un mes y un día determinados para un campo personalizado en particular.
`getContactsByEmailAddress(query)`	`Contact[]`	Obtener contactos que coincidan con una dirección de correo electrónico
`getContactsByEmailAddress(query, label)`	`Contact[]`	Obtén contactos que coincidan con una dirección de correo electrónico, limitados a un campo específico.
`getContactsByEmailAddress(query, label)`	`Contact[]`	Obtén contactos que coincidan con una dirección de correo electrónico, limitados a la etiqueta de dirección de correo electrónico personalizada especificada.
`getContactsByGroup(group)`	`Contact[]`	Obtén los contactos de un ContactGroup determinado.
`getContactsByIM(query)`	`Contact[]`	Obtener contactos que coincidan con una dirección de mensajería instantánea
`getContactsByIM(query, label)`	`Contact[]`	Obtén contactos que coincidan con una dirección de mensajería instantánea, limitada a un campo específico.
`getContactsByIM(query, label)`	`Contact[]`	Obtén contactos que coincidan con una dirección de mensajería instantánea, limitada a la etiqueta de mensajería instantánea personalizada especificada.
`getContactsByJobTitle(query)`	`Contact[]`	Obtén contactos que coincidan con el campo de cargo.
`getContactsByName(query)`	`Contact[]`	Obtén contactos que coincidan con un nombre.
`getContactsByName(query, label)`	`Contact[]`	Obtén contactos que coincidan con un nombre, limitados a un campo específico.
`getContactsByNotes(query)`	`Contact[]`	Obtén contactos que coincidan con el campo de notas.
`getContactsByPhone(query)`	`Contact[]`	Obtener contactos que coincidan con un número de teléfono
`getContactsByPhone(query, label)`	`Contact[]`	Obtén contactos que coincidan con un número de teléfono, limitados a un campo específico.
`getContactsByPhone(query, label)`	`Contact[]`	Obtén contactos que coincidan con un número de teléfono, limitado a la etiqueta de número de teléfono personalizada especificada.
`getContactsByUrl(query)`	`Contact[]`	Obtén contactos que coincidan con una URL.
`getContactsByUrl(query, label)`	`Contact[]`	Obtén contactos que coincidan con una URL, limitados a un campo específico.
`getContactsByUrl(query, label)`	`Contact[]`	Obtén contactos que coincidan con una URL, limitados a la etiqueta de URL personalizada especificada.

Métodos obsoletos

`createContact(givenName, familyName, email)`

Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.

Crea un contacto nuevo.

// The code below creates a new contact with the name "John Doe" and the email
// address "john.doe@example.com".
const contact = ContactsApp.createContact(
    'John',
    'Doe',
    'john.doe@example.com',
);

Parámetros

Nombre	Tipo	Descripción
`givenName`	`String`	el nombre del contacto
`familyName`	`String`	el apellido del contacto
`email`	`String`	la dirección de correo electrónico del contacto

Volver

Contact: Es el objeto Contact recién creado.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

https://www.google.com/m8/feeds

Consulta también

deleteContact(contact)

`createContactGroup(name)`

Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.

Crea un grupo de contactos con el nombre determinado

// The code below creates a new contact group named "Work Friends"
const group = ContactsApp.createContactGroup('Work Friends');

Parámetros

Nombre	Tipo	Descripción
`name`	`String`	el nombre del nuevo grupo de contactos

Volver

ContactGroup: Es el grupo de contactos recién creado.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

https://www.google.com/m8/feeds

Consulta también

deleteContactGroup(group)

`deleteContact(contact)`

Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.

Borra el contacto.

// The code below retrieves a contact with the email address
// "john.doe@example.com" and then deletes that contact.
const contact = ContactsApp.getContact('john.doe@example.com');
ContactsApp.deleteContact(contact);

Parámetros

Nombre	Tipo	Descripción
`contact`	`Contact`	el contacto que se borrará

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

https://www.google.com/m8/feeds

Consulta también

createContact(givenName, familyName, email)

`deleteContactGroup(group)`

Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.

Borra el grupo de contactos.

// The code below creates deletes the contact group named "Work Friends"
const group = ContactsApp.getContactGroup('Work Friends');
ContactsApp.deleteContactGroup(group);

Parámetros

Nombre	Tipo	Descripción
`group`	`ContactGroup`	el grupo de contactos que quieres borrar

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

https://www.google.com/m8/feeds

Consulta también

createContactGroup(name)

`findByEmailAddress(email)`

Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.

Busca un contacto con la dirección de correo electrónico proporcionada.

Parámetros

Nombre	Tipo	Descripción
`email`	`String`	la dirección de correo electrónico del contacto que se busca

Volver

Contact: El contacto que contiene esa dirección de correo electrónico

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

https://www.google.com/m8/feeds

`findContactGroup(name)`

Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.

Busca un grupo de contactos con el nombre determinado.

Parámetros

Nombre	Tipo	Descripción
`name`	`String`	el nombre del grupo de contactos que se busca

Volver

ContactGroup: Es el grupo de contactos que coincide con el nombre determinado.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

https://www.google.com/m8/feeds

`getAllContacts()`

Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.

Obtén todos los contactos que pertenecen a este usuario.

Volver

Contact[]: Todos los contactos de este usuario

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

https://www.google.com/m8/feeds

`getContact(emailAddress)`

Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.

Obtiene un contacto por la dirección de correo electrónico.

Si varios contactos comparten la misma dirección de correo electrónico, el método favorece a aquellos que marcaron la dirección de correo electrónico como principal. Si ninguno de los contactos marcó la dirección de correo electrónico como principal o varios contactos la marcaron como principal, se muestra el primer resultado en el orden de los contactos ordenados.

// The code below retrieves a contact with the email address
// "john.doe@example.com".
const contact = ContactsApp.getContact('john.doe@example.com');

Parámetros

Nombre	Tipo	Descripción
`emailAddress`	`String`	la dirección de correo electrónico del contacto

Volver

Contact: El contacto que contiene esa dirección de correo electrónico

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

https://www.google.com/m8/feeds

`getContactById(id)`

Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.

Obtiene el contacto con este ID.

// The code below retrieves the contact with the id
// "http://www.google.com/m8/feeds/contacts/john.doe%40example.com/base/7c86afde08d34ca5"
const id =
    'http://www.google.com/m8/feeds/contacts/john.doe%40example.com/base/7c86afde08d34c';
const contact = ContactsApp.getContactById(id);

Parámetros

Nombre	Tipo	Descripción
`id`	`String`	el ID del contacto que se recuperará

Volver

Contact: El contacto coincidente o nulo

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

https://www.google.com/m8/feeds

Consulta también

getContact(emailAddress)

`getContactGroup(name)`

Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.

Obtiene un grupo de contactos con el nombre determinado o muestra un valor nulo si no se encuentra un grupo de contactos con ese nombre.

// The code below returns the contact group with the name "Work Friends"
const group = ContactsApp.getContactGroup('Work Friends');

Parámetros

Nombre	Tipo	Descripción
`name`	`String`	el nombre del grupo de contactos que debe coincidir

Volver

ContactGroup: Es el grupo de contactos coincidente o nulo si no se encuentra uno.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

https://www.google.com/m8/feeds

Consulta también

getContactGroups()

`getContactGroupById(id)`

Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.

Obtiene un grupo de contactos con el ID determinado o muestra un valor nulo si no se encuentra ese grupo de contactos.

// The code below returns the contact group with the id
// "http://www.google.com/m8/feeds/groups/john.doe%40example.com/base/54eefbb093fdecb"
const id =
    'http://www.google.com/m8/feeds/groups/john.doe%40example.com/base/54eefbb093fdecb';
const group = ContactsApp.getContactGroupById(id);

Parámetros

Nombre	Tipo	Descripción
`id`	`String`	el ID del grupo de contactos que debe coincidir

Volver

ContactGroup: Es el grupo de contactos coincidente o nulo si no se encuentra uno.

Consulta también

getContactGroups()

`getContactGroups()`

Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.

Obtiene la lista completa de los grupos de contactos del usuario.

Un usuario puede tener una lista de Contactos y, posiblemente, también una lista de Grupos de Contactos. Cada grupo de contactos puede contener contactos. Este método muestra una lista de todos los grupos de contactos.

// The retrieves all the contract groups for the user and then logs the group
// name of each contact group.
const groups = ContactsApp.getContactGroups();
for (let i = 0; i < groups.length; i++) {
  Logger.log(groups[i].getName());
}

Volver

ContactGroup[]: Es un array de los grupos de contactos del usuario.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

https://www.google.com/m8/feeds

Consulta también

getContactGroup(name)

`getContacts()`

Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.

Obtiene todos los contactos del usuario.

// The code below will retrieve all the user's contacts
const contacts = ContactsApp.getContacts();

Volver

Contact[]: Es un array de todos los contactos del usuario.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

https://www.google.com/m8/feeds

Consulta también

getContact(emailAddress)

`getContactsByAddress(query)`

Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.

Obtener contactos que coincidan con una dirección

// The code below returns an array of contacts where the contact's address
// contains "San Francisco'.
const contacts = ContactsApp.getContactsByAddress('San Francisco');

Parámetros

Nombre	Tipo	Descripción
`query`	`String`	la cadena que se buscará en las direcciones del contacto

Volver

Contact[]: Es un array de contactos coincidentes.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

https://www.google.com/m8/feeds

Consulta también

getContact(emailAddress)

`getContactsByAddress(query, label)`

Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.

Obtén contactos que coincidan con una dirección, limitados a un campo específico.

// The code below returns an array of contacts where the contact's address
// contains "San Francisco" in the Home address field.
const contacts = ContactsApp.getContactsByAddress(
    'San Francisco',
    ContactsApp.Field.HOME_ADDRESS,
);

Parámetros

Nombre	Tipo	Descripción
`query`	`String`	la cadena que se buscará en las direcciones del contacto
`label`	`Field`	el campo en el que se debe buscar

Volver

Contact[]: Es un array de contactos coincidentes.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

https://www.google.com/m8/feeds

Consulta también

getContact(emailAddress)

`getContactsByAddress(query, label)`

Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.

Obtén contactos que coincidan con una dirección, limitados a la etiqueta de dirección personalizada especificada.

// The code below returns an array of contacts where the contact's address
// contains "San Francisco" in a custom address label (created by the user)
// called "vacation".
const contacts = ContactsApp.getContactsByAddress('San Francisco', 'vacation');

Parámetros

Nombre	Tipo	Descripción
`query`	`String`	Es la cadena que se buscará en las direcciones del contacto con la etiqueta de dirección personalizada especificada.
`label`	`String`	la etiqueta de dirección personalizada en la que deseas buscar

Volver

Contact[]: Es un array de contactos coincidentes.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

https://www.google.com/m8/feeds

Consulta también

getContact(emailAddress)

`getContactsByCompany(query)`

Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.

Obtén contactos que coincidan con el campo de la empresa.

// The code below returns an array of contacts where the contact's company field
// contains "Google".
const contacts = ContactsApp.getContactsByCompany('Google');

Parámetros

Nombre	Tipo	Descripción
`query`	`String`	la cadena que se buscará en el campo de la empresa del contacto

Volver

Contact[]: Es un array de contactos coincidentes.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

https://www.google.com/m8/feeds

Consulta también

getContact(emailAddress)

`getContactsByCustomField(query, label)`

Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.

Obtén contactos que coincidan con un valor determinado en un campo personalizado.

El campo personalizado se puede especificar con una cadena o como uno de los valores de ContactsApp.ExtendedField.

// The code below returns an array of contacts where the contact's custom field
// named "Favorite Sport" contains "tennis".
const contacts = ContactsApp.getContactsByCustomField(
    'tennis',
    'Favorite Sport',
);

Parámetros

Nombre	Tipo	Descripción
`query`	`Object`	la cadena que se buscará en el campo personalizado del contacto
`label`	`ExtendedField`	el campo personalizado en el que se realizará la búsqueda

Volver

Contact[]: Es un array de contactos coincidentes.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

https://www.google.com/m8/feeds

Consulta también

getContact(emailAddress)

`getContactsByDate(month, day, label)`

Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.

Obtén contactos que coincidan con un mes y un día determinados para un campo estándar en particular.

// The code below returns an array of contacts where the contact's "Birthday"
// field contains April for the month and 19 for the day.
const contacts = ContactsApp.getContactsByDate(
    ContactsApp.Month.APRIL,
    19,
    ContactsApp.Field.BIRTHDAY,
);

Parámetros

Nombre	Tipo	Descripción
`month`	`Month`	el mes que debe coincidir, como uno de los valores de ContactsApp.Month
`day`	`Integer`	el día que debe coincidir
`label`	`Field`	el campo en el que se debe buscar, de ContactsApp.Field

Volver

Contact[]: Es un array de contactos coincidentes.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

https://www.google.com/m8/feeds

Consulta también

getContact(emailAddress)

`getContactsByDate(month, day, year, label)`

Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.

Obtén contactos que coincidan con un mes, un día y un año determinados para un campo estándar en particular.

// The code below returns an array of contacts where the contact's "Birthday"
// field contains April for the month, 19 for the day, and 1950 for the year.
const contacts = ContactsApp.getContactsByDate(
    ContactsApp.Month.APRIL,
    19,
    1950,
    ContactsApp.Field.BIRTHDAY,
);

Parámetros

Nombre	Tipo	Descripción
`month`	`Month`	el mes que debe coincidir, como uno de los valores de ContactsApp.Month
`day`	`Integer`	el día que debe coincidir
`year`	`Integer`	el año que debe coincidir, puede ser nulo
`label`	`Field`	el campo en el que se debe buscar, de ContactsApp.Field

Volver

Contact[]: Es un array de contactos coincidentes.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

https://www.google.com/m8/feeds

Consulta también

getContact(emailAddress)

`getContactsByDate(month, day, year, label)`

Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.

Obtén contactos que coincidan con un mes, un día y un año determinados para un campo personalizado en particular.

// The code below returns an array of contacts where the contact's custom "Start
// Date" field contains April for the month, 19 for the day, and 2011 for the
// year.
const contacts = ContactsApp.getContactsByDate(
    ContactsApp.Month.APRIL,
    19,
    2011,
    'Start Date',
);

Parámetros

Nombre	Tipo	Descripción
`month`	`Month`	el mes que debe coincidir, como uno de los valores de ContactsApp.Month
`day`	`Integer`	el día que debe coincidir
`year`	`Integer`	el año que debe coincidir, puede ser nulo
`label`	`String`	el campo personalizado en el que se realizará la búsqueda

Volver

Contact[]: Es un array de contactos coincidentes.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

https://www.google.com/m8/feeds

Consulta también

getContact(emailAddress)

`getContactsByDate(month, day, label)`

Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.

Obtén contactos que coincidan con un mes y un día determinados para un campo personalizado en particular.

// The code below returns an array of contacts where the contact's custom "Start
// Date" field contains April for the month and 19 for the day.
const contacts = ContactsApp.getContactsByDate(
    ContactsApp.Month.APRIL,
    19,
    'Start Date',
);

Parámetros

Nombre	Tipo	Descripción
`month`	`Month`	el mes que debe coincidir, como uno de los valores de ContactsApp.Month
`day`	`Integer`	el día que debe coincidir
`label`	`String`	el campo personalizado en el que se realizará la búsqueda

Volver

Contact[]: Es un array de contactos coincidentes.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

https://www.google.com/m8/feeds

Consulta también

getContact(emailAddress)

`getContactsByEmailAddress(query)`

Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.

Obtener contactos que coincidan con una dirección de correo electrónico

// The code below returns an array of contacts where the contact's email address
// contains "john.doe@example.com'.
const contacts = ContactsApp.getContactsByEmailAddress('john.doe@example.com');

Parámetros

Nombre	Tipo	Descripción
`query`	`String`	la cadena que se buscará en las direcciones de correo electrónico de los contactos

Volver

Contact[]: Es un array de contactos coincidentes.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

https://www.google.com/m8/feeds

Consulta también

getContact(emailAddress)

`getContactsByEmailAddress(query, label)`

Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.

Obtén contactos que coincidan con una dirección de correo electrónico, limitados a un campo específico.

// The code below returns an array of contacts where the contact's email address
// contains "john.doe@example.com" in the Home email field.
const contacts = ContactsApp.getContactsByEmailAddress(
    'john.doe@example.com',
    ContactsApp.Field.HOME_EMAIL,
);

Parámetros

Nombre	Tipo	Descripción
`query`	`String`	la cadena que se buscará en las direcciones de correo electrónico de los contactos
`label`	`Field`	el campo en el que se debe buscar

Volver

Contact[]: Es un array de contactos coincidentes.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

https://www.google.com/m8/feeds

Consulta también

getContact(emailAddress)

`getContactsByEmailAddress(query, label)`

Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.

Obtén contactos que coincidan con una dirección de correo electrónico, limitados a la etiqueta de dirección de correo electrónico personalizada especificada.

// The code below returns an array of contacts where the contact's email address
// contains "john.doe@example.com" in a custom email address label (created by
// the user) called "alternate".
const contacts = ContactsApp.getContactsByEmailAddress(
    'john.doe@example.com',
    'alternate',
);

Parámetros

Nombre	Tipo	Descripción
`query`	`String`	la cadena que se buscará en las direcciones de correo electrónico de los contactos con la etiqueta de dirección de correo electrónico personalizada especificada
`label`	`String`	la etiqueta de la dirección de correo electrónico personalizada en la que deseas realizar la búsqueda

Volver

Contact[]: Es un array de contactos coincidentes.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

https://www.google.com/m8/feeds

Consulta también

getContact(emailAddress)

`getContactsByGroup(group)`

Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.

Obtén los contactos de un ContactGroup determinado.

// The code below returns an array of contacts in the ContactGroup with the name
// "Work Friends".
const group = ContactsApp.getContactGroup('Work Friends');
const contacts = ContactsApp.getContactsByGroup(group);

Parámetros

Nombre	Tipo	Descripción
`group`	`ContactGroup`	el grupo de contactos

Volver

Contact[]: Es un array de contactos en el grupo determinado.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

https://www.google.com/m8/feeds

Consulta también

getContact(emailAddress)

`getContactsByIM(query)`

Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.

Obtener contactos que coincidan con una dirección de mensajería instantánea

// The code below returns an array of contacts where the contact's instant
// messaging address contains "ChatWithJohnDoe" in any instant messaging field.
const contacts = ContactsApp.getContactsByIM('ChatWithJohnDoe');

Parámetros

Nombre	Tipo	Descripción
`query`	`String`	la cadena que se buscará en las direcciones de mensajería instantánea del contacto

Volver

Contact[]: Es un array de contactos coincidentes.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

https://www.google.com/m8/feeds

Consulta también

getContact(emailAddress)

`getContactsByIM(query, label)`

Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.

Obtén contactos que coincidan con una dirección de mensajería instantánea, limitada a un campo específico.

// The code below returns an array of contacts where the contact's instant
// messaging address contains "ChatWithJohnDoe" in the AIM instant messaging
// field.
const contacts = ContactsApp.getContactsByIM(
    'ChatWithJohnDoe',
    ContactsApp.Field.AIM,
);

Parámetros

Nombre	Tipo	Descripción
`query`	`String`	la cadena que se buscará en las direcciones de mensajería instantánea del contacto
`label`	`Field`	el campo en el que se debe buscar

Volver

Contact[]: Es un array de contactos coincidentes.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

https://www.google.com/m8/feeds

Consulta también

getContact(emailAddress)

`getContactsByIM(query, label)`

Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.

Obtén contactos que coincidan con una dirección de mensajería instantánea, limitada a la etiqueta de mensajería instantánea personalizada especificada.

// The code below returns an array of contacts where the contact's instant
// messaging address contains "ChatWithJohnDoe" in a custom instant messaging
// label (created by the user) called "eBuddy".
const contacts = ContactsApp.getContactsByIM('ChatWithJohnDoe', 'eBuddy');

Parámetros

Nombre	Tipo	Descripción
`query`	`String`	la cadena que se buscará en las direcciones de mensajería instantánea del contacto con la etiqueta de mensajería instantánea personalizada especificada
`label`	`String`	la etiqueta de mensajería instantánea personalizada en la que deseas realizar la búsqueda

Volver

Contact[]: Es un array de contactos coincidentes.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

https://www.google.com/m8/feeds

Consulta también

getContact(emailAddress)

`getContactsByJobTitle(query)`

Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.

Obtén contactos que coincidan con el campo de cargo.

// The code below returns an array of contacts where the contact's job title
// field contains "Product Manager".
const contacts = ContactsApp.getContactsByJobTitle('Product Manager');

Parámetros

Nombre	Tipo	Descripción
`query`	`String`	la cadena que se buscará en el campo de cargo del contacto

Volver

Contact[]: Es un array de contactos coincidentes.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

https://www.google.com/m8/feeds

Consulta también

getContact(emailAddress)

`getContactsByName(query)`

Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.

Obtén contactos que coincidan con un nombre.

// The code below returns an array of contacts where the contact name contains
// "John"
const contacts = ContactsApp.getContactsByName('John');

Parámetros

Nombre	Tipo	Descripción
`query`	`String`	la cadena que se buscará en los nombres de los contactos

Volver

Contact[]: Es un array de contactos coincidentes.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

https://www.google.com/m8/feeds

Consulta también

getContact(emailAddress)

`getContactsByName(query, label)`

Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.

Obtén contactos que coincidan con un nombre, limitados a un campo específico.

// The code below returns an array of contacts where the contact name contains
// "John" in the Given Name field.
const contacts = ContactsApp.getContactsByName(
    'John',
    ContactsApp.Field.GIVEN_NAME,
);

Parámetros

Nombre	Tipo	Descripción
`query`	`String`	la cadena que se buscará en los nombres de los contactos
`label`	`Field`	el campo en el que se debe buscar

Volver

Contact[]: Es un array de contactos coincidentes.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

https://www.google.com/m8/feeds

Consulta también

getContact(emailAddress)

`getContactsByNotes(query)`

Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.

Obtén contactos que coincidan con el campo de notas.

// The code below returns an array of contacts where the contact's notes field
// contains "sent birthday card".
const contacts = ContactsApp.getContactsByNotes('sent birthday card');

Parámetros

Nombre	Tipo	Descripción
`query`	`String`	Es la cadena que se busca en el campo de notas del contacto.

Volver

Contact[]: Es un array de contactos coincidentes.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

https://www.google.com/m8/feeds

Consulta también

getContact(emailAddress)

`getContactsByPhone(query)`

Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.

Obtener contactos que coincidan con un número de teléfono

Este método expandirá los números de teléfono con letras, por lo que, si buscas "212-555-CODE" y tienes "212-555-2633" en tus contactos o viceversa, el método encontrará el contacto adecuado.

// The code below returns an array of contacts where the contact's phone number
// contains "212-555-1234' in any phone number field.
const contacts = ContactsApp.getContactsByPhone('212-555-1234');

Parámetros

Nombre	Tipo	Descripción
`query`	`String`	la cadena que se buscará en los números de teléfono del contacto

Volver

Contact[]: Es un array de contactos coincidentes.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

https://www.google.com/m8/feeds

Consulta también

getContact(emailAddress)

`getContactsByPhone(query, label)`

Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.

Obtén contactos que coincidan con un número de teléfono, limitados a un campo específico.

Este método expandirá los números de teléfono con letras, por lo que, si buscas "212-555-CODE" y tienes "212-555-2633" en tus contactos o viceversa, el método encontrará el contacto adecuado.

// The code below returns an array of contacts where the contact's phone number
// contains "212-555-1234" in the Home phone number field.
const contacts = ContactsApp.getContactsByPhone(
    '212-555-1234',
    ContactsApp.Field.HOME_PHONE,
);

Parámetros

Nombre	Tipo	Descripción
`query`	`String`	la cadena que se buscará en los números de teléfono del contacto
`label`	`Field`	el campo en el que se debe buscar

Volver

Contact[]: Es un array de contactos coincidentes.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

https://www.google.com/m8/feeds

Consulta también

getContact(emailAddress)

`getContactsByPhone(query, label)`

Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.

Obtén contactos que coincidan con un número de teléfono, limitado a la etiqueta de número de teléfono personalizada especificada.

Este método expandirá los números de teléfono con letras, por lo que, si buscas "212-555-CODE" y tienes "212-555-2633" en tus contactos o viceversa, el método encontrará el contacto adecuado.

// The code below returns an array of contacts where the contact's phone number
// contains "212-555-1234" in a custom phone number label (created by the user)
// called "alternate".
const contacts = ContactsApp.getContactsByPhone('212-555-1234', 'alternate');

Parámetros

Nombre	Tipo	Descripción
`query`	`String`	la cadena que se buscará en los números de teléfono del contacto con la etiqueta de número de teléfono personalizada especificada
`label`	`String`	la etiqueta de número de teléfono personalizada en la que deseas realizar la búsqueda

Volver

Contact[]: Es un array de contactos coincidentes.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

https://www.google.com/m8/feeds

Consulta también

getContact(emailAddress)

`getContactsByUrl(query)`

Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.

Obtén contactos que coincidan con una URL.

// The code below returns an array of contacts where the contact's URL contains
// "www.example.com' in any URL field.
const contacts = ContactsApp.getContactsByUrl('www.example.com');

Parámetros

Nombre	Tipo	Descripción
`query`	`String`	la cadena que se buscará en las URLs del contacto

Volver

Contact[]: Es un array de contactos coincidentes.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

https://www.google.com/m8/feeds

Consulta también

getContact(emailAddress)

`getContactsByUrl(query, label)`

Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.

Obtén contactos que coincidan con una URL, limitados a un campo específico.

// The code below returns an array of contacts where the contact's URL contains
// "www.example.com" in the Work URL field.
const contacts = ContactsApp.getContactsByUrl(
    'www.example.com',
    ContactsApp.Field.WORK_WEBSITE,
);

Parámetros

Nombre	Tipo	Descripción
`query`	`String`	la cadena que se buscará en las URLs del contacto
`label`	`Field`	el campo en el que se debe buscar

Volver

Contact[]: Es un array de contactos coincidentes.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

https://www.google.com/m8/feeds

Consulta también

getContact(emailAddress)

`getContactsByUrl(query, label)`

Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.

Obtén contactos que coincidan con una URL, limitados a la etiqueta de URL personalizada especificada.

// The code below returns an array of contacts where the contact's URL contains
// "www.example.com" in a custom URL label (created by the user) called
// "alternate work".
const contacts = ContactsApp.getContactsByUrl(
    'www.example.com',
    'alternate work',
);

Parámetros

Nombre	Tipo	Descripción
`query`	`String`	Es la cadena que se buscará en las URLs del contacto con la etiqueta de URL personalizada especificada.
`label`	`String`	la etiqueta de URL personalizada en la que deseas realizar la búsqueda

Volver

Contact[]: Es un array de contactos coincidentes.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

https://www.google.com/m8/feeds

Consulta también

getContact(emailAddress)