Class ContactsApp

ContatosApp

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

Essa classe permite que os usuários acessem os próprios Contatos do Google e criem, removam e atualizem os contatos listados.

Propriedades descontinuadas

Propriedade	Tipo	Descrição
ExtendedField	ExtendedField
Field	Field
Gender	Gender
Month	Month
Priority	Priority
Sensitivity	Sensitivity

Métodos obsoletos

Método	Tipo de retorno	Breve descrição
createContact(givenName, familyName, email)	Contact	Cria um novo contato.
createContactGroup(name)	ContactGroup	Cria um grupo de contatos com o nome especificado // The code below creates a new contact group named "Work Friends" const group = ContactsApp.createContactGroup('Work Friends');
deleteContact(contact)	void	Exclui o contato.
deleteContactGroup(group)	void	Exclui o grupo de contatos // The code below creates deletes the contact group named "Work Friends" const group = ContactsApp.getContactGroup('Work Friends'); ContactsApp.deleteContactGroup(group);
findByEmailAddress(email)	Contact	Encontra um contato com o endereço de e-mail especificado.
findContactGroup(name)	ContactGroup	Encontra um grupo de contatos com o nome especificado.
getAllContacts()	Contact[]	Receba todos os contatos pertencentes a esse usuário.
getContact(emailAddress)	Contact	Busca um contato pelo endereço de e-mail.
getContactById(id)	Contact	Recebe o contato com esse ID.
getContactGroup(name)	ContactGroup	Busca um grupo de contatos com o nome especificado ou retorna nulo se nenhum grupo de contatos for encontrado.
getContactGroupById(id)	ContactGroup	Recebe um grupo de contatos com o ID fornecido ou retorna nulo se nenhum grupo de contatos for encontrado.
getContactGroups()	ContactGroup[]	Recebe a lista completa dos grupos de contatos do usuário.
getContacts()	Contact[]	Recebe todos os contatos do usuário.
getContactsByAddress(query)	Contact[]	Receber contatos que correspondem a um endereço.
getContactsByAddress(query, label)	Contact[]	Receba contatos que correspondem a um endereço, limitados a um campo específico.
getContactsByAddress(query, label)	Contact[]	Receba contatos que correspondem a um endereço, limitados ao rótulo de endereço personalizado especificado.
getContactsByCompany(query)	Contact[]	Receber contatos que correspondem ao campo da empresa.
getContactsByCustomField(query, label)	Contact[]	Receba contatos que correspondem a um determinado valor em um campo personalizado.
getContactsByDate(month, day, label)	Contact[]	Receba os contatos que correspondem a um determinado mês e dia para um campo padrão específico.
getContactsByDate(month, day, year, label)	Contact[]	Receba contatos que correspondem a um determinado mês, dia e ano para um campo padrão específico.
getContactsByDate(month, day, year, label)	Contact[]	Receba contatos que correspondem a um determinado mês, dia e ano para um campo personalizado específico.
getContactsByDate(month, day, label)	Contact[]	Receba os contatos que correspondem a um determinado mês e dia para um campo personalizado específico.
getContactsByEmailAddress(query)	Contact[]	Receber contatos que correspondem a um endereço de e-mail.
getContactsByEmailAddress(query, label)	Contact[]	Receba contatos que correspondem a um endereço de e-mail, limitados a um campo específico.
getContactsByEmailAddress(query, label)	Contact[]	Receba contatos que correspondem a um endereço de e-mail, limitados ao rótulo de endereço de e-mail personalizado especificado.
getContactsByGroup(group)	Contact[]	Receba os contatos de um determinado grupo de contatos.
getContactsByIM(query)	Contact[]	Receber contatos que correspondem a um endereço de mensagens instantâneas.
getContactsByIM(query, label)	Contact[]	Receba contatos que correspondem a um endereço de mensagens instantâneas, limitado a um campo específico.
getContactsByIM(query, label)	Contact[]	Receba contatos que correspondem a um endereço de mensagem instantânea, limitados ao rótulo de mensagem instantânea personalizada especificado.
getContactsByJobTitle(query)	Contact[]	Receba contatos que correspondem ao campo "cargo".
getContactsByName(query)	Contact[]	Encontrar contatos que correspondem a um nome.
getContactsByName(query, label)	Contact[]	Receba contatos que correspondem a um nome, limitados a um campo específico.
getContactsByNotes(query)	Contact[]	Receber contatos que correspondem ao campo de anotações.
getContactsByPhone(query)	Contact[]	Receber contatos que correspondem a um número de telefone.
getContactsByPhone(query, label)	Contact[]	Receba contatos que correspondem a um número de telefone, limitados a um campo específico.
getContactsByPhone(query, label)	Contact[]	Conferir os contatos que correspondem a um número de telefone, limitados ao rótulo de número de telefone personalizado especificado.
getContactsByUrl(query)	Contact[]	Encontre contatos que correspondem a um URL.
getContactsByUrl(query, label)	Contact[]	Receba contatos que correspondem a um URL, limitados a um campo específico.
getContactsByUrl(query, label)	Contact[]	Receber contatos que correspondem a um URL, limitados ao rótulo de URL personalizado especificado.

Métodos obsoletos

createContact(givenName, familyName, email)

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

Cria um novo contato.

// The code below creates a new contact with the name "John Doe" and the email
// address "[e-mail]".
const contact = ContactsApp.createContact(
    'John',
    'Doe',
    '[e-mail]',
);

Parâmetros

Nome	Tipo	Descrição
givenName	String	o nome do contato
familyName	String	o sobrenome do contato
email	String	o endereço de e-mail do contato

Retornar

Contact: o objeto de contato recém-criado.

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

• deleteContact(contact)

---

createContactGroup(name)

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

Cria um grupo de contatos com o nome especificado

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

Parâmetros

Nome	Tipo	Descrição
name	String	o nome do novo grupo de contatos

Retornar

ContactGroup: o grupo de contatos recém-criado

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

• deleteContactGroup(group)

---

deleteContact(contact)

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

Exclui o contato.

// The code below retrieves a contact with the email address
// "[e-mail]" and then deletes that contact.
const contact = ContactsApp.getContact('[e-mail]');
ContactsApp.deleteContact(contact);

Parâmetros

Nome	Tipo	Descrição
contact	Contact	o contato a ser excluído

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

• createContact(givenName, familyName, email)

---

deleteContactGroup(group)

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

Exclui o grupo de contatos

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

Parâmetros

Nome	Tipo	Descrição
group	ContactGroup	o grupo de contatos a ser excluído

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

• createContactGroup(name)

---

findByEmailAddress(email)

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

Encontra um contato com o endereço de e-mail especificado.

Parâmetros

Nome	Tipo	Descrição
email	String	o endereço de e-mail do contato a ser encontrado

Retornar

Contact: o contato que contém esse endereço de e-mail

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

---

findContactGroup(name)

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

Encontra um grupo de contatos com o nome especificado.

Parâmetros

Nome	Tipo	Descrição
name	String	o nome do grupo de contatos a ser encontrado

Retornar

ContactGroup: o grupo de contatos que corresponde ao nome

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

---

getAllContacts()

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

Receba todos os contatos pertencentes a esse usuário.

Retornar

Contact[]: todos os contatos desse usuário

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

---

getContact(emailAddress)

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

Busca um contato pelo endereço de e-mail.

Se vários contatos compartilharem o mesmo endereço de e-mail, o método vai favorecer os contatos que marcaram o endereço de e-mail como principal. Se nenhum dos contatos tiver o endereço de e-mail marcado como principal ou vários contatos tiverem o endereço de e-mail marcado como principal, o método vai retornar o primeiro resultado na ordem dos contatos classificados.

// The code below retrieves a contact with the email address
// "[e-mail]".
const contact = ContactsApp.getContact('[e-mail]');

Parâmetros

Nome	Tipo	Descrição
emailAddress	String	o endereço de e-mail do contato

Retornar

Contact: o contato que contém esse endereço de e-mail

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

• getContacts()
• getContactById(id)

---

getContactById(id)

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

Recebe o contato com esse 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

Nome	Tipo	Descrição
id	String	o ID do contato a ser recuperado

Retornar

Contact: o contato correspondente ou nulo.

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

• getContact(emailAddress)

---

getContactGroup(name)

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

Busca um grupo de contatos com o nome especificado ou retorna nulo se nenhum grupo de contatos for encontrado.

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

Parâmetros

Nome	Tipo	Descrição
name	String	o nome do grupo de contatos a ser correspondido

Retornar

ContactGroup: o grupo de contato correspondente ou nulo se nenhum grupo de contato correspondente for encontrado.

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

• getContactGroups()

---

getContactGroupById(id)

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

Recebe um grupo de contatos com o ID fornecido ou retorna nulo se nenhum grupo de contatos for encontrado.

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

Nome	Tipo	Descrição
id	String	o ID do grupo de contatos a ser correspondido

Retornar

ContactGroup: o grupo de contato correspondente ou nulo se nenhum grupo de contato correspondente for encontrado.

Consulte também

• getContactGroups()

---

getContactGroups()

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

Recebe a lista completa dos grupos de contatos do usuário.

Um usuário pode ter uma lista de contatos e, possivelmente, uma lista de grupos de contatos. Cada grupo de contatos pode conter contatos. Esse método retorna uma lista de todos os grupos de contato.

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

Retornar

ContactGroup[]: uma matriz dos grupos de contatos do usuário

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

• getContactGroup(name)

---

getContacts()

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

Recebe todos os contatos do usuário.

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

Retornar

Contact[]: uma matriz de todos os contatos do usuário

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

• getContact(emailAddress)

---

getContactsByAddress(query)

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

Receber contatos que correspondem a um endereço.

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

Parâmetros

Nome	Tipo	Descrição
query	String	a string a ser pesquisada nos endereços do contato

Retornar

Contact[]: uma matriz de contatos correspondentes

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

• getContact(emailAddress)

---

getContactsByAddress(query, label)

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

Receba contatos que correspondem a um endereço, limitados a um 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

Nome	Tipo	Descrição
query	String	a string a ser pesquisada nos endereços do contato
label	Field	o campo a ser pesquisado

Retornar

Contact[]: uma matriz de contatos correspondentes

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

• getContact(emailAddress)

---

getContactsByAddress(query, label)

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

Receba contatos que correspondem a um endereço, limitados ao rótulo de endereço personalizado especificado.

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

Nome	Tipo	Descrição
query	String	a string a ser pesquisada nos endereços do contato com o rótulo de endereço personalizado especificado
label	String	o rótulo de endereço personalizado para pesquisar

Retornar

Contact[]: uma matriz de contatos correspondentes

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

• getContact(emailAddress)

---

getContactsByCompany(query)

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

Receber contatos que correspondem ao campo da empresa.

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

Parâmetros

Nome	Tipo	Descrição
query	String	a string a ser pesquisada no campo da empresa do contato

Retornar

Contact[]: uma matriz de contatos correspondentes

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

• getContact(emailAddress)

---

getContactsByCustomField(query, label)

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

Receba contatos que correspondem a um determinado valor em um campo personalizado.

O campo personalizado pode ser especificado por uma string ou como um dos 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

Nome	Tipo	Descrição
query	Object	a string a ser pesquisada no campo personalizado do contato
label	ExtendedField	o campo personalizado em que você quer pesquisar

Retornar

Contact[]: uma matriz de contatos correspondentes

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

• getContact(emailAddress)

---

getContactsByDate(month, day, label)

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

Receba os contatos que correspondem a um determinado mês e dia para um campo padrão específico.

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

Nome	Tipo	Descrição
month	Month	o mês a ser correspondido, como um dos valores de ContactsApp.Month
day	Integer	o dia a ser correspondido
label	Field	O campo em que pesquisar, de ContactsApp.Field

Retornar

Contact[]: uma matriz de contatos correspondentes

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

• getContact(emailAddress)

---

getContactsByDate(month, day, year, label)

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

Receba contatos que correspondem a um determinado mês, dia e ano para um campo padrão específico.

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

Nome	Tipo	Descrição
month	Month	o mês a ser correspondido, como um dos valores de ContactsApp.Month
day	Integer	o dia a ser correspondido
year	Integer	O ano a ser correspondido, pode ser nulo
label	Field	O campo em que pesquisar, de ContactsApp.Field

Retornar

Contact[]: uma matriz de contatos correspondentes

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

• getContact(emailAddress)

---

getContactsByDate(month, day, year, label)

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

Receba contatos que correspondem a um determinado mês, dia e ano para um campo personalizado específico.

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

Nome	Tipo	Descrição
month	Month	o mês a ser correspondido, como um dos valores de ContactsApp.Month
day	Integer	o dia a ser correspondido
year	Integer	O ano a ser correspondido, pode ser nulo
label	String	o campo personalizado em que você quer pesquisar

Retornar

Contact[]: uma matriz de contatos correspondentes

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

• getContact(emailAddress)

---

getContactsByDate(month, day, label)

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

Receba os contatos que correspondem a um determinado mês e dia para um campo personalizado específico.

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

Nome	Tipo	Descrição
month	Month	o mês a ser correspondido, como um dos valores de ContactsApp.Month
day	Integer	o dia a ser correspondido
label	String	o campo personalizado em que você quer pesquisar

Retornar

Contact[]: uma matriz de contatos correspondentes

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

• getContact(emailAddress)

---

getContactsByEmailAddress(query)

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

Receber contatos que correspondem a um endereço de e-mail.

// The code below returns an array of contacts where the contact's email address
// contains "[e-mail]'.
const contacts = ContactsApp.getContactsByEmailAddress('[e-mail]');

Parâmetros

Nome	Tipo	Descrição
query	String	a string a ser pesquisada nos endereços de e-mail de contato

Retornar

Contact[]: uma matriz de contatos correspondentes

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

• getContact(emailAddress)

---

getContactsByEmailAddress(query, label)

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

Receba contatos que correspondem a um endereço de e-mail, limitados a um campo específico.

// The code below returns an array of contacts where the contact's email address
// contains "[e-mail]" in the Home email field.
const contacts = ContactsApp.getContactsByEmailAddress(
    '[e-mail]',
    ContactsApp.Field.HOME_EMAIL,
);

Parâmetros

Nome	Tipo	Descrição
query	String	a string a ser pesquisada nos endereços de e-mail de contato
label	Field	o campo a ser pesquisado

Retornar

Contact[]: uma matriz de contatos correspondentes

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

• getContact(emailAddress)

---

getContactsByEmailAddress(query, label)

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

Receba contatos que correspondem a um endereço de e-mail, limitados ao rótulo de endereço de e-mail personalizado especificado.

// The code below returns an array of contacts where the contact's email address
// contains "[e-mail]" in a custom email address label (created by
// the user) called "alternate".
const contacts = ContactsApp.getContactsByEmailAddress(
    '[e-mail]',
    'alternate',
);

Parâmetros

Nome	Tipo	Descrição
query	String	a string a ser pesquisada em endereços de e-mail de contato com o rótulo de endereço de e-mail personalizado especificado
label	String	o rótulo do endereço de e-mail personalizado para pesquisar

Retornar

Contact[]: uma matriz de contatos correspondentes

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

• getContact(emailAddress)

---

getContactsByGroup(group)

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

Receba os contatos de um determinado grupo de contatos.

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

Nome	Tipo	Descrição
group	ContactGroup	o grupo de contatos

Retornar

Contact[]: uma matriz de contatos no grupo especificado

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

• getContact(emailAddress)

---

getContactsByIM(query)

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

Receber contatos que correspondem a um endereço de mensagens instantâneas.

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

Nome	Tipo	Descrição
query	String	a string a ser pesquisada nos endereços de mensagens instantâneas do contato

Retornar

Contact[]: uma matriz de contatos correspondentes

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

• getContact(emailAddress)

---

getContactsByIM(query, label)

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

Receba contatos que correspondem a um endereço de mensagens instantâneas, limitado a um 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

Nome	Tipo	Descrição
query	String	a string a ser pesquisada nos endereços de mensagens instantâneas do contato
label	Field	o campo a ser pesquisado

Retornar

Contact[]: uma matriz de contatos correspondentes

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

• getContact(emailAddress)

---

getContactsByIM(query, label)

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

Receba contatos que correspondem a um endereço de mensagem instantânea, limitados ao rótulo de mensagem instantânea personalizada especificado.

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

Nome	Tipo	Descrição
query	String	a string a ser pesquisada nos endereços de mensagens instantâneas do contato com o rótulo de mensagens instantâneas personalizado especificado
label	String	o rótulo de mensagens instantâneas personalizadas para pesquisar

Retornar

Contact[]: uma matriz de contatos correspondentes

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

• getContact(emailAddress)

---

getContactsByJobTitle(query)

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

Receba contatos que correspondem ao campo "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

Nome	Tipo	Descrição
query	String	a string a ser pesquisada no campo "Cargo do contato"

Retornar

Contact[]: uma matriz de contatos correspondentes

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

• getContact(emailAddress)

---

getContactsByName(query)

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

Encontrar contatos que correspondem a um nome.

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

Parâmetros

Nome	Tipo	Descrição
query	String	a string a ser pesquisada nos nomes de contato

Retornar

Contact[]: uma matriz de contatos correspondentes

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

• getContact(emailAddress)

---

getContactsByName(query, label)

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

Receba contatos que correspondem a um nome, limitados a um 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

Nome	Tipo	Descrição
query	String	a string a ser pesquisada nos nomes de contato
label	Field	o campo a ser pesquisado

Retornar

Contact[]: uma matriz de contatos correspondentes

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

• getContact(emailAddress)

---

getContactsByNotes(query)

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

Receber contatos que correspondem ao campo de anotações.

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

Nome	Tipo	Descrição
query	String	a string a ser pesquisada no campo de anotações do contato

Retornar

Contact[]: uma matriz de contatos correspondentes

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

• getContact(emailAddress)

---

getContactsByPhone(query)

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

Receber contatos que correspondem a um número de telefone.

Esse método vai expandir os números de telefone com letras. Portanto, se você pesquisar "212-555-CODIGO" e tiver "212-555-2633" nos seus contatos ou vice-versa, o método vai encontrar o contato adequado.

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

Nome	Tipo	Descrição
query	String	a string a pesquisar nos números de telefone do contato

Retornar

Contact[]: uma matriz de contatos correspondentes

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

• getContact(emailAddress)

---

getContactsByPhone(query, label)

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

Receba contatos que correspondem a um número de telefone, limitados a um campo específico.

Esse método vai expandir os números de telefone com letras. Portanto, se você pesquisar "212-555-CODIGO" e tiver "212-555-2633" nos seus contatos ou vice-versa, o método vai encontrar o contato adequado.

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

Nome	Tipo	Descrição
query	String	a string a pesquisar nos números de telefone do contato
label	Field	o campo a ser pesquisado

Retornar

Contact[]: uma matriz de contatos correspondentes

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

• getContact(emailAddress)

---

getContactsByPhone(query, label)

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

Conferir os contatos que correspondem a um número de telefone, limitados ao rótulo de número de telefone personalizado especificado.

Esse método vai expandir os números de telefone com letras. Portanto, se você pesquisar "212-555-CODIGO" e tiver "212-555-2633" nos seus contatos ou vice-versa, o método vai encontrar o contato adequado.

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

Nome	Tipo	Descrição
query	String	a string a ser pesquisada nos números de telefone do contato com o rótulo de número de telefone personalizado especificado
label	String	o rótulo do número de telefone personalizado para pesquisar

Retornar

Contact[]: uma matriz de contatos correspondentes

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

• getContact(emailAddress)

---

getContactsByUrl(query)

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

Encontre contatos que correspondem a um 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

Nome	Tipo	Descrição
query	String	a string a ser pesquisada nos URLs do contato

Retornar

Contact[]: uma matriz de contatos correspondentes

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

• getContact(emailAddress)

---

getContactsByUrl(query, label)

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

Receba contatos que correspondem a um URL, limitados a um 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

Nome	Tipo	Descrição
query	String	a string a ser pesquisada nos URLs do contato
label	Field	o campo a ser pesquisado

Retornar

Contact[]: uma matriz de contatos correspondentes

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

• getContact(emailAddress)

---

getContactsByUrl(query, label)

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

Receber contatos que correspondem a um URL, limitados ao rótulo de URL personalizado especificado.

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

Nome	Tipo	Descrição
query	String	a string a ser pesquisada nos URLs do contato com o rótulo de URL personalizado especificado
label	String	o rótulo do URL personalizado em que você quer pesquisar

Retornar

Contact[]: uma matriz de contatos correspondentes

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

• getContact(emailAddress)