Class CustomField

Campo personalizado

Obsoleto. En su lugar, usa el servicio avanzado de la API de People.

Es un campo personalizado en un contacto.

Métodos

Método	Tipo de datos que se muestra	Descripción breve
getLabel()	Object	Obtiene la etiqueta de este campo.
setLabel(label)	CustomField	Establece la etiqueta de este campo.

Métodos obsoletos

Método	Tipo de datos que se muestra	Descripción breve
deleteCustomField()	void	Borra este campo.
getValue()	Object	Obtiene el valor del campo.
setLabel(field)	CustomField	Establece la etiqueta de este campo.
setValue(value)	CustomField	Establece el valor de este campo.

Documentación detallada

getLabel()

Obtiene la etiqueta de este campo. Puede ser un campo, un ExtendedField o una cadena.

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

Volver

Object: Es la etiqueta de este campo.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

---

setLabel(label)

Establece la etiqueta de este 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

Nombre	Tipo	Descripción
label	String	la nueva etiqueta para este campo

Volver

CustomField: Este campo es útil para el encadenamiento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

Métodos obsoletos

deleteCustomField()

Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.

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

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

---

getValue()

Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.

Obtiene el valor del 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());
}

Volver

Object: Es el valor almacenado en el campo.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

---

setLabel(field)

Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.

Establece la etiqueta de este 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

Nombre	Tipo	Descripción
field	ExtendedField	la nueva etiqueta estándar

Volver

CustomField: Este campo es útil para el encadenamiento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

---

setValue(value)

Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.

Establece el valor de este 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

Nombre	Tipo	Descripción
value	Object	el valor nuevo

Volver

CustomField: Este campo es útil para el encadenamiento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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