Class ContactGroup

ContactGroup

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

Un ContactGroup es un grupo de contactos.

MétodoTipo de datos que se muestraDescripción breve
addContact(contact)ContactGroupAgrega el contacto determinado a este grupo. 
// The code below creates a new contact and adds it to the "Work Friends"
// contact group
const contact = ContactsApp.createContact(
    'John',
    'Doe',
    'john.doe@example.com',
);
const group = ContactsApp.getContactGroup('Work Friends');
group.addContact(contact);
deleteGroup()voidBorra este grupo de contactos.
getContacts()Contact[]Obtiene todos los contactos de este grupo de contactos.
getGroupName()StringMuestra el nombre de este grupo.
getId()StringObtiene el ID de este grupo de contactos.
getName()StringObtiene el nombre de este grupo de contactos.
isSystemGroup()BooleanObtiene un valor booleano para determinar si este grupo de contactos es un grupo del sistema (no se puede borrar) o no.
removeContact(contact)ContactGroupQuita el contacto determinado de este grupo. 
// The code below retrieves all the contacts named "John Doe' and removes them
// from the "Work Friends" contact group
const contacts = ContactsApp.getContactsByName('John Doe');
const group = ContactsApp.getContactGroup('Work Friends');
for (const i in contacts) {
  group.removeContact(contacts[i]);
}
setGroupName(name)voidEstablece el nombre de este grupo.
setName(name)ContactGroupEstablece el nombre de este grupo de contactos.

Métodos obsoletos

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

Agrega el contacto determinado a este grupo. 

// The code below creates a new contact and adds it to the "Work Friends"
// contact group
const contact = ContactsApp.createContact(
    'John',
    'Doe',
    'john.doe@example.com',
);
const group = ContactsApp.getContactGroup('Work Friends');
group.addContact(contact);

Parámetros

NombreTipoDescripción
contactContactel contacto que se agregará al grupo

Volver

ContactGroup: Este grupo de contactos

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

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

Borra este grupo de contactos.

Solo borra los grupos que no son del sistema. Los grupos del sistema no se pueden borrar. 

// The code below retrieves a contact group named "Work Friends" and deletes it
const group = ContactsApp.getContactGroup('Work Friends');
group.deleteGroup();

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

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

Obtiene todos los contactos de este grupo de contactos. 

// The code below retrieves all the contacts in the group named "Work Friends"
const group = ContactsApp.getContactGroup('Work Friends');
const contacts = group.getContacts();

Volver

Contact[]: Los contactos de este grupo

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

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

Muestra el nombre de este grupo.

Volver

String: Es el nombre de este grupo.

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

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

Obtiene el ID de este grupo de contactos. 

// The code below retrieves a contact group named "Work Friends" and gets its id
const group = ContactsApp.getContactGroup('Work Friends');
const id = group.getId();

Volver

String: Es el ID de este grupo.

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

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

Obtiene el nombre de este grupo de contactos. 

// The code below creates a new contact group and then retrieves its name
const group = ContactsApp.createContactGroup('Work Friends');
const name = group.getName();

Volver

String: Es el nombre de este grupo de contactos.

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

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

Obtiene un valor booleano para determinar si este grupo de contactos es un grupo del sistema (no se puede borrar) o no.

Los grupos del sistema son un conjunto de grupos predefinidos en Contactos de Google, como “Mis contactos”, “Familia”, “Compañeros de trabajo”, etcétera. El nombre de un grupo del sistema suele contener las palabras “Grupo del sistema”. 

// The code below retrieves two contact groups, then logs whether or not
// each is a system group.
const myGroup = ContactsApp.getContactGroup('Work Friends');
const systemGroup = ContactsApp.getContactGroup('System Group: Coworkers');
Logger.log(myGroup.isSystemGroup());      // Returns false, if the group exists.
Logger.log(systemGroup.isSystemGroup());  // Returns true.

Volver

Boolean: Indica si este grupo de contactos es un grupo del sistema.

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

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

Quita el contacto determinado de este grupo. 

// The code below retrieves all the contacts named "John Doe' and removes them
// from the "Work Friends" contact group
const contacts = ContactsApp.getContactsByName('John Doe');
const group = ContactsApp.getContactGroup('Work Friends');
for (const i in contacts) {
  group.removeContact(contacts[i]);
}

Parámetros

NombreTipoDescripción
contactContactel contacto que se quitará del grupo

Volver

ContactGroup: Este grupo de contactos

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

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

Establece el nombre de este grupo.

Parámetros

NombreTipoDescripción
nameStringel nombre que se establecerá para este grupo

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

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

Establece el nombre de este grupo de contactos. 

// The code below retrieves the contact group named "Work Friends" and renames
// it to "Work Buddies"
const group = ContactsApp.getContactGroup('Work Friends');
group.setName('Work Buddies');

Parámetros

NombreTipoDescripción
nameStringel nombre nuevo del grupo de contactos

Volver

ContactGroup: Este grupo de contactos

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