Esta página foi traduzida pela API Cloud Translation.

Class ContactsApp

Obsoleto. Em vez disso, use a API People avançada serviço

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

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 fornecido
`deleteContact(contact)`	`void`	Exclui o contato.
`deleteContactGroup(group)`	`void`	Exclui o grupo de contatos
`findByEmailAddress(email)`	`Contact`	Encontra um contato com o endereço de e-mail fornecido.
`findContactGroup(name)`	`ContactGroup`	Encontra um grupo de contatos com o nome fornecido.
`getAllContacts()`	`Contact[]`	Recupera todos os contatos que pertencem a este usuário.
`getContact(emailAddress)`	`Contact`	Recebe um contato pelo endereço de e-mail.
`getContactById(id)`	`Contact`	Recupera o contato com este ID.
`getContactGroup(name)`	`ContactGroup`	Extrai um grupo de contatos com o nome fornecido ou retorna nulo se nenhum grupo de contatos for encontrado.
`getContactGroupById(id)`	`ContactGroup`	Extrai um grupo de contatos com o ID fornecido ou retorna nulo se nenhum grupo de contatos for encontrado.
`getContactGroups()`	`ContactGroup[]`	Extrai a lista completa dos grupos de contatos do usuário.
`getContacts()`	`Contact[]`	Recebe todos os contatos do usuário.
`getContactsByAddress(query)`	`Contact[]`	Acessa os contatos que correspondem a um endereço.
`getContactsByAddress(query, label)`	`Contact[]`	Recebe contatos que correspondem a um endereço, limitado a um campo específico.
`getContactsByAddress(query, label)`	`Contact[]`	Recebe contatos que correspondem a um endereço, limitado à etiqueta de endereço personalizada especificada.
`getContactsByCompany(query)`	`Contact[]`	Recebe contatos que correspondem ao campo da empresa.
`getContactsByCustomField(query, label)`	`Contact[]`	Recupera contatos que correspondam a um determinado valor em um campo personalizado.
`getContactsByDate(month, day, label)`	`Contact[]`	Obtenha contatos correspondentes a determinado mês e dia para um campo padrão específico.
`getContactsByDate(month, day, year, label)`	`Contact[]`	Encontre contatos correspondentes a determinado mês, dia e ano para um campo padrão específico.
`getContactsByDate(month, day, year, label)`	`Contact[]`	Encontre contatos correspondentes a determinado mês, dia e ano para um campo personalizado específico.
`getContactsByDate(month, day, label)`	`Contact[]`	Obtenha contatos correspondentes a determinado mês e dia para um campo personalizado específico.
`getContactsByEmailAddress(query)`	`Contact[]`	Mostra contatos que correspondem a um endereço de e-mail.
`getContactsByEmailAddress(query, label)`	`Contact[]`	Acessar contatos que correspondam a um endereço de e-mail, limitado a um campo específico.
`getContactsByEmailAddress(query, label)`	`Contact[]`	Recebe contatos que correspondem a um endereço de e-mail, limitado ao marcador de endereço de e-mail personalizado especificado.
`getContactsByGroup(group)`	`Contact[]`	Recupera os contatos em um determinado ContactGroup.
`getContactsByIM(query)`	`Contact[]`	Recebe contatos que correspondem a um endereço de mensagem instantânea.
`getContactsByIM(query, label)`	`Contact[]`	Obter contatos correspondentes a um endereço de mensagem instantânea, limitado a um campo específico.
`getContactsByIM(query, label)`	`Contact[]`	Recebe contatos que correspondem a um endereço de mensagem instantânea, limitado ao instantâneo personalizado especificado marcador de mensagem.
`getContactsByJobTitle(query)`	`Contact[]`	Recebe contatos que correspondem ao campo de cargo.
`getContactsByName(query)`	`Contact[]`	Recebe contatos que correspondem a um nome.
`getContactsByName(query, label)`	`Contact[]`	Recebe contatos que correspondem a um nome, limitado a um campo específico.
`getContactsByNotes(query)`	`Contact[]`	Acessa contatos que correspondam ao campo de notas.
`getContactsByPhone(query)`	`Contact[]`	Mostra contatos que correspondem a um número de telefone.
`getContactsByPhone(query, label)`	`Contact[]`	Acessar contatos que correspondam a um número de telefone, limitado a um campo específico.
`getContactsByPhone(query, label)`	`Contact[]`	Recebe contatos que correspondem a um número de telefone, limitado ao marcador de número de telefone personalizado especificado.
`getContactsByUrl(query)`	`Contact[]`	Recebe contatos que correspondem a um URL.
`getContactsByUrl(query, label)`	`Contact[]`	Recebe contatos que correspondem a um URL, limitado a um campo específico.
`getContactsByUrl(query, label)`	`Contact[]`	Recebe contatos que correspondem a um URL, limitado ao marcador 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
// "john.doe@example.com".
var contact = ContactsApp.createContact('John', 'Doe', 'john.doe@example.com');

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 precisam de 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 fornecido

// The code below creates a new contact group named "Work Friends"
var 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 precisam de 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 "john.doe@example.com"
// and then deletes that contact.
var contact = ContactsApp.getContact('john.doe@example.com');
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 precisam de 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"
var 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 precisam de 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 fornecido.

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 o endereço de e-mail

Autorização

Os scripts que usam esse método precisam de 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 fornecido.

Parâmetros

Nome	Tipo	Descrição
`name`	`String`	o nome do grupo de contatos para encontrar

Retornar

ContactGroup: o grupo de contatos correspondente ao nome fornecido

Autorização

Os scripts que usam esse método precisam de 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.

Recupera todos os contatos que pertencem a este usuário.

Retornar

Contact[]: todos os contatos deste usuário

Autorização

Os scripts que usam esse método precisam de 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.

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

Se vários contatos compartilharem o mesmo endereço de e-mail, o método favorecerá os contatos que tenham marcou o endereço de e-mail como principal; se nenhum dos contatos tivesse o endereço de e-mail marcado como ou vários contatos tiverem o endereço de e-mail marcado como principal, retornará o primeiro resultará na ordem de classificação dos contatos.

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

Parâmetros

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

Retornar

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

Autorização

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

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

`getContactById(id)`

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

Recupera o contato com este ID.

// The code below retrieves the contact with the id
// "http://www.google.com/m8/feeds/contacts/john.doe%40example.com/base/7c86afde08d34ca5"
var id = 'http://www.google.com/m8/feeds/contacts/john.doe%40example.com/base/7c86afde08d34c';
var contact = ContactApp.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 precisam de 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.

Extrai um grupo de contatos com o nome fornecido ou retorna nulo se nenhum grupo de contatos for encontrado.

// The code below returns the contact group with the name "Work Friends"
var 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 contatos correspondente ou nulo se nenhum grupo de contatos correspondente for encontrado

Autorização

Os scripts que usam esse método precisam de 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.

Extrai 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"
var id = "http://www.google.com/m8/feeds/groups/john.doe%40example.com/base/54eefbb093fdecb";
var 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 contatos correspondente ou nulo se nenhum grupo de contatos correspondente for encontrado

Consulte também

getContactGroups()

`getContactGroups()`

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

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

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

// The retrieves all the contract groups for the user and then logs the group name of each
// contact group.
var groups  = ContactsApp.getContactGroups();
for (var 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 precisam de 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
var contacts = ContactsApp.getContacts();

Retornar

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

Autorização

Os scripts que usam esse método precisam de 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.

Acessa os contatos que correspondem a um endereço.

// The code below returns an array of contacts where the contact's address contains
// "San Francisco'.
var 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 precisam de 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.

Recebe contatos que correspondem a um endereço, limitado 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.
var 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 precisam de 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.

Recebe contatos que correspondem a um endereço, limitado à etiqueta de endereço 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".
var contacts = ContactsApp.getContactsByAddress('San Francisco', 'vacation');

Parâmetros

Nome	Tipo	Descrição
`query`	`String`	a string a ser pesquisada nos endereços de contato com o endereço personalizado especificado marcador
`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 precisam de 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.

Recebe contatos que correspondem ao campo da empresa.

// The code below returns an array of contacts where the contact's company field
// contains "Google".
var 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 precisam de 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.

Recupera contatos que correspondam a um determinado valor em um campo personalizado.

O campo personalizado pode ser especificado por uma string ou como um dos ContactsApp.ExtendedField e a distribuição dos valores dos dados.

// The code below returns an array of contacts where the contact's custom field
// named "Favorite Sport" contains "tennis".
var 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 para pesquisar

Retornar

Contact[]: uma matriz de contatos correspondentes.

Autorização

Os scripts que usam esse método precisam de 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.

Obtenha contatos correspondentes a 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.
var 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 correspondente
`label`	`Field`	o campo a ser pesquisado, de ContactsApp.Field

Retornar

Contact[]: uma matriz de contatos correspondentes.

Autorização

Os scripts que usam esse método precisam de 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.

Encontre contatos correspondentes a 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.
var 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 correspondente
`year`	`Integer`	o ano da correspondência, pode ser nulo
`label`	`Field`	o campo a ser pesquisado, de ContactsApp.Field

Retornar

Contact[]: uma matriz de contatos correspondentes.

Autorização

Os scripts que usam esse método precisam de 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.

Encontre contatos correspondentes a 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.
var 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 correspondente
`year`	`Integer`	o ano da correspondência, pode ser nulo
`label`	`String`	o campo personalizado para pesquisar

Retornar

Contact[]: uma matriz de contatos correspondentes.

Autorização

Os scripts que usam esse método precisam de 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.

Obtenha contatos correspondentes a 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.
var 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 correspondente
`label`	`String`	o campo personalizado para pesquisar

Retornar

Contact[]: uma matriz de contatos correspondentes.

Autorização

Os scripts que usam esse método precisam de 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.

Mostra 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
// "john.doe@example.com'.
var contacts = ContactsApp.getContactsByEmailAddress('john.doe@example.com');

Parâmetros

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

Retornar

Contact[]: uma matriz de contatos correspondentes.

Autorização

Os scripts que usam esse método precisam de 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.

Acessar contatos que correspondam a um endereço de e-mail, limitado a um 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.
var contacts = ContactsApp.getContactsByEmailAddress('john.doe@example.com',
                                                     ContactsApp.Field.HOME_EMAIL);

Parâmetros

Nome	Tipo	Descrição
`query`	`String`	a string a ser pesquisada em 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 precisam de 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.

Recebe contatos que correspondem a um endereço de e-mail, limitado ao marcador de endereço de e-mail personalizado especificado.

// 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".
var contacts = ContactsApp.getContactsByEmailAddress('john.doe@example.com', 'alternate');

Parâmetros

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

Retornar

Contact[]: uma matriz de contatos correspondentes.

Autorização

Os scripts que usam esse método precisam de 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.

Recupera os contatos em um determinado ContactGroup.

// The code below returns an array of contacts in the ContactGroup with the name
// "Work Friends".
var group  = ContactsApp.getContactGroup('Work Friends');
var 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 precisam de 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.

Recebe contatos que correspondem a um endereço de mensagem instantânea.

// The code below returns an array of contacts where the contact's instant messaging address
// contains "ChatWithJohnDoe" in any instant messaging field.
var 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 precisam de 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.

Obter contatos correspondentes a um endereço de mensagem instantânea, 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.
var 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 precisam de 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.

Recebe contatos que correspondem a um endereço de mensagem instantânea, limitado ao instantâneo personalizado especificado marcador de mensagem.

// 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".
var 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 marcador de mensagem instantânea personalizado especificado
`label`	`String`	o marcador de mensagem instantânea personalizado para pesquisar

Retornar

Contact[]: uma matriz de contatos correspondentes.

Autorização

Os scripts que usam esse método precisam de 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.

Recebe contatos que correspondem ao campo de cargo.

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

Parâmetros

Nome	Tipo	Descrição
`query`	`String`	a string a ser pesquisada no campo de cargo do contato

Retornar

Contact[]: uma matriz de contatos correspondentes.

Autorização

Os scripts que usam esse método precisam de 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.

Recebe contatos que correspondem a um nome.

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

Parâmetros

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

Retornar

Contact[]: uma matriz de contatos correspondentes.

Autorização

Os scripts que usam esse método precisam de 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.

Recebe contatos que correspondem a um nome, limitado a um campo específico.

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

Parâmetros

Nome	Tipo	Descrição
`query`	`String`	a string a ser pesquisada em 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 precisam de 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.

Acessa contatos que correspondam ao campo de notas.

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

Parâmetros

Nome	Tipo	Descrição
`query`	`String`	a string a ser pesquisada no campo de notas do contato

Retornar

Contact[]: uma matriz de contatos correspondentes.

Autorização

Os scripts que usam esse método precisam de 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.

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

Esse método expandirá os números de telefone com letras, portanto, se você pesquisar por "212-555-CODE" e você tem "212-555-2633" nos seus contatos ou vice-versa, o método encontrará as contato

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

Parâmetros

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

Retornar

Contact[]: uma matriz de contatos correspondentes.

Autorização

Os scripts que usam esse método precisam de 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.

Acessar contatos que correspondam a um número de telefone, limitado a um campo específico.

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

Parâmetros

Nome	Tipo	Descrição
`query`	`String`	a string a ser pesquisada 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 precisam de 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.

Recebe contatos que correspondem a um número de telefone, limitado ao marcador de número de telefone personalizado especificado.

// 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".
var 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 a string personalizada marcador do número de telefone
`label`	`String`	o marcador de número de telefone personalizado para pesquisar

Retornar

Contact[]: uma matriz de contatos correspondentes.

Autorização

Os scripts que usam esse método precisam de 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.

Recebe 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.
var 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 precisam de 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.

Recebe contatos que correspondem a um URL, limitado 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.
var 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 precisam de 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.

Recebe contatos que correspondem a um URL, limitado ao marcador 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".
var 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 para pesquisar

Retornar

Contact[]: uma matriz de contatos correspondentes.

Autorização

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

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

Consulte também

getContact(emailAddress)