Class CustomField

Campo personalizado

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

Um campo personalizado em um contato.

Métodos

Método	Tipo de retorno	Breve descrição
getLabel()	Object	Recebe o rótulo desse campo.
setLabel(label)	CustomField	Define o rótulo desse campo.

Métodos obsoletos

Método	Tipo de retorno	Breve descrição
deleteCustomField()	void	Exclui esse campo.
getValue()	Object	Recebe o valor do campo.
setLabel(field)	CustomField	Define o rótulo desse campo.
setValue(value)	CustomField	Define o valor desse campo.

Documentação detalhada

getLabel()

Recebe o rótulo desse campo. Pode ser um campo, um ExtendedField ou uma string.

// Logs the label for all the address fields associated with contact
// 'John Doe'. This method can be similarly called for any field that has
// a label.
const contacts = ContactsApp.getContactsByName('John Doe');
const addressFields = contacts[0].getAddresses();
for (let i = 0; i < addressFields.length; i++) {
  Logger.log(addressFields[i].getLabel());
}

Retornar

Object: o rótulo do campo

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

---

setLabel(label)

Define o rótulo desse campo.

// Sets the label to 'Apartment' for the first address field associated
// with contact 'John Doe'. This method can be similarly called for any
// field that has a label.
const contacts = ContactsApp.getContactsByName('John Doe');
const addressFields = contacts[0].getAddresses();
addressFields[0].setLabel('Apartment');

Parâmetros

Nome	Tipo	Descrição
label	String	o novo rótulo para esse campo

Retornar

CustomField: este campo é útil para encadeamento.

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

Métodos obsoletos

deleteCustomField()

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

Exclui esse campo.

const contacts = ContactsApp.getContactsByName('John Doe');
const fields = contacts[0].getCustomFields();
for (let i = 0; i < fields.length; i++) {
  if (fields[i].getLabel() === 'foo') {
    fields[i].deleteCustomField();
  }
}

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

---

getValue()

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

Recebe o valor do campo.

// Logs the value of all the custom fields for contact 'John Doe'
const contacts = ContactsApp.getContactsByName('John Doe');
const fields = contacts[0].getCustomFields();
for (const i in fields) {
  Logger.log(fields[i].getValue());
}

Retornar

Object: o valor armazenado no campo

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

---

setLabel(field)

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

Define o rótulo desse campo.

// Sets the first custom field associated with contact 'John Doe' to use 'Mail
// application' as a label, with 'Gmail' as the value.
const contacts = ContactsApp.getContactsByName('John Doe');
const field = contacts[0].getCustomFields()[0];
field.setLabel('Mail application');
field.setValue('Gmail');

Parâmetros

Nome	Tipo	Descrição
field	ExtendedField	o novo rótulo padrão

Retornar

CustomField: este campo é útil para encadeamento.

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

---

setValue(value)

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

Define o valor desse campo.

// Sets the first custom field associated with contact 'John Doe' to use 'Mail
// application' as a label, with 'Gmail' as the value.
const contacts = ContactsApp.getContactsByName('John Doe');
const field = contacts[0].getCustomFields()[0];
field.setLabel('Mail application');
field.setValue('Gmail');

Parâmetros

Nome	Tipo	Descrição
value	Object	o novo valor

Retornar

CustomField: este campo é útil para encadeamento.

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