Class PhoneField

PhoneField

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

El campo de número de teléfono de un contacto

Métodos

Método	Tipo de datos que se muestra	Descripción breve
getLabel()	Object	Obtiene la etiqueta de este campo.
isPrimary()	Boolean	Obtiene si este es el valor del campo principal.
setAsPrimary()	PhoneField	Establece este campo como principal.
setLabel(field)	PhoneField	Establece la etiqueta de este campo.
setLabel(label)	PhoneField	Establece la etiqueta de este campo.

Métodos obsoletos

Método	Tipo de datos que se muestra	Descripción breve
deletePhoneField()	void	Borra este campo de número de teléfono.
getPhoneNumber()	String	Obtén el número de teléfono para este campo.
setPhoneNumber(number)	PhoneField	Establece el número de teléfono para este campo.

Documentación detallada

getLabel()

Obtiene la etiqueta de este campo. Puede ser un campo, un campo ExtendedField o una 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());
}

Devolvedor

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 alcances:

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

---

isPrimary()

Obtiene si este es el valor del campo principal.

// Logs whether or not the first address field associated with contact
// 'John Doe' is labeled as primary. This method can be similarly called
// for any field.
var contacts = ContactsApp.getContactsByName('John Doe');
var addressFields = contacts[0].getAddresses();
Logger.log(addressFields[0].isPrimary());

Devolvedor

Boolean: Si es principal

Autorización

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

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

---

setAsPrimary()

Establece este campo como principal.

// Sets the the first address field associated with contact 'John Doe'
// as primary. This method can be similarly called for any field.
var contacts = ContactsApp.getContactsByName('John Doe');
var addressFields = contacts[0].getAddresses();
addressFields[0].setAsPrimary();

Devolvedor

PhoneField: Este FieldValue para encadenamiento

Autorización

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

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

---

setLabel(field)

Establece la etiqueta de este campo.

// Sets the label to 'Work' 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(ContactsApp.Field.WORK_ADDRESS);

Parámetros

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

Devolvedor

PhoneField: Este FieldValue para encadenamiento

Autorización

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

• 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.
var contacts = ContactsApp.getContactsByName('John Doe');
var addressFields = contacts[0].getAddresses();
addressFields[0].setLabel('Apartment');

Parámetros

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

Devolvedor

PhoneField: Este campo es útil para encadenar.

Autorización

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

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

Métodos obsoletos

deletePhoneField()

Obsoleto. Esta función es obsoleta y no debe utilizarse en nuevas secuencias de comandos.

Borra este campo de número de teléfono.

// Retrieves and deletes the work phone number field for contact 'John
// Doe'
var contacts = ContactsApp.getContactsByName('John Doe');
var phoneFields = contacts[0].getPhones(ContactsApp.Field.WORK_PHONE);
phoneFields[0].deletePhoneField();

Autorización

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

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

---

getPhoneNumber()

Obsoleto. Esta función es obsoleta y no debe utilizarse en nuevas secuencias de comandos.

Obtén el número de teléfono para este campo.

// Logs the work phone number for contact 'John Doe'
var contacts = ContactsApp.getContactsByName('John Doe');
var phoneFields = contacts[0].getPhones(ContactsApp.Field.WORK_PHONE);
Logger.log(phoneFields[0].getPhoneNumber());

Devolvedor

String: Es el número como una cadena.

Autorización

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

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

---

setPhoneNumber(number)

Obsoleto. Esta función es obsoleta y no debe utilizarse en nuevas secuencias de comandos.

Establece el número de teléfono para este campo.

// Sets the work phone number for contact 'John Doe'
var contacts = ContactsApp.getContactsByName('John Doe');
var phoneFields = contacts[0].getPhones(ContactsApp.Field.WORK_PHONE);
phoneFields[0].setPhoneNumber('212-555-1234');

Parámetros

Nombre	Tipo	Descripción
number	String	el nuevo número

Devolvedor

PhoneField: Este campo es útil para encadenar.

Autorización

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

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