Class ContactGroup

Grupode contato

Obsoleto. Em vez disso, use o serviço avançado da API People.

Um grupo de contatos é um grupo de contatos.

MétodoTipo de retornoBreve descrição
addContact(contact)ContactGroupAdiciona o contato especificado 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()voidExclui este grupo de contatos.
getContacts()Contact[]Busca todos os contatos neste grupo.
getGroupName()StringRetorna o nome do grupo.
getId()StringRecebe o ID desse grupo de contatos.
getName()StringExtrai o nome deste grupo de contatos.
isSystemGroup()BooleanRecebe um valor booleano para determinar se esse grupo de contatos é um grupo do sistema (não exprimível) ou não.
removeContact(contact)ContactGroupRemove o contato especificado deste 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)voidDefine o nome do grupo.
setName(name)ContactGroupDefine o nome do grupo de contatos.

Métodos obsoletos

Obsoleto. Essa função foi descontinuada e não deve ser usada em novos scripts.

Adiciona o contato especificado 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

NomeTipoDescrição
contactContacto contato a ser adicionado ao grupo

Retornar

ContactGroup: este grupo de contatos

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

Consulte também

Obsoleto. Essa função foi descontinuada e não deve ser usada em novos scripts.

Exclui este grupo de contatos.

Exclui apenas grupos não relacionados ao sistema. Não é possível excluir grupos de sistema. 

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

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

Consulte também

Obsoleto. Essa função foi descontinuada e não deve ser usada em novos scripts.

Busca todos os contatos neste grupo. 

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

Retornar

Contact[]: os contatos neste grupo

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

Obsoleto. Essa função foi descontinuada e não deve ser usada em novos scripts.

Retorna o nome do grupo.

Retornar

String: o nome do grupo

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

Obsoleto. Essa função foi descontinuada e não deve ser usada em novos scripts.

Recebe o ID desse grupo de contatos. 

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

Retornar

String: o ID desse grupo

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

Obsoleto. Essa função foi descontinuada e não deve ser usada em novos scripts.

Extrai o nome deste grupo de contatos. 

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

Retornar

String: o nome do grupo de contatos

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

Consulte também

Obsoleto. Essa função foi descontinuada e não deve ser usada em novos scripts.

Recebe um valor booleano para determinar se esse grupo de contatos é um grupo do sistema (não exprimível) ou não.

Os grupos do sistema são um conjunto de grupos predefinidos no Contatos do Google, como "Meus contatos", "Família", "Colegas de trabalho" etc. O nome de um grupo do sistema geralmente contém as palavras "Grupo do 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.

Retornar

Boolean: indica se o grupo de contatos é um grupo do sistema

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

Obsoleto. Essa função foi descontinuada e não deve ser usada em novos scripts.

Remove o contato especificado deste 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

NomeTipoDescrição
contactContacto contato a ser removido do grupo

Retornar

ContactGroup: este grupo de contatos

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

Consulte também

Obsoleto. Essa função foi descontinuada e não deve ser usada em novos scripts.

Define o nome do grupo.

Parâmetros

NomeTipoDescrição
nameStringo nome a ser definido para esse grupo

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

Obsoleto. Essa função foi descontinuada e não deve ser usada em novos scripts.

Define o nome do grupo de contatos. 

// 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

NomeTipoDescrição
nameStringo novo nome do grupo de contatos

Retornar

ContactGroup: este grupo de contatos

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

Consulte também