Class CustomField

CustomField

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

Um campo personalizado em um contato.

Métodos

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

Métodos obsoletos

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

Documentação detalhada

getLabel()

Recebe o rótulo deste 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.
var contacts = ContactsApp.getContactsByName('John Doe');
var addressFields = contacts[0].getAddresses();
for (var i = 0; i < addressFields.length; i++) {
  Logger.log(addressFields[i].getLabel());
}

Retornar

Object: o rótulo deste campo.

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

---

setLabel(label)

Define o rótulo deste 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.
var contacts = ContactsApp.getContactsByName('John Doe');
var addressFields = contacts[0].getAddresses();
addressFields[0].setLabel('Apartment');

Parâmetros

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

Retornar

CustomField: campo que é útil para encadeamento.

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

Métodos obsoletos

deleteCustomField()

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

Exclui este campo.

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

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

---

getValue()

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

Acessa o valor do campo.

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

Retornar

Object: o valor armazenado no campo.

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

---

setLabel(field)

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

Define o rótulo deste campo.

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

Parâmetros

Nome	Tipo	Descrição
field	ExtendedField	o novo marcador padrão

Retornar

CustomField: campo que é útil para encadeamento.

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

---

setValue(value)

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

Define o valor deste campo.

// Sets the first custom field associated with contact 'John Doe' to use 'Mail application' as
// a label, with 'Gmail' as the value.
var contacts = ContactsApp.getContactsByName('John Doe');
var 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: campo que é útil para encadeamento.

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