Class AddressField

AddressField

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

Campo de dirección de un contacto.

Métodos

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

Métodos obsoletos

Método	Tipo de datos que se muestra	Descripción breve
deleteAddressField()	void	Borra este campo de la dirección.

Documentación detallada

getAddress()

Obtén la dirección para este campo.

// Logs the address for the 'Home Address' field for contact 'John Doe'.
// Can be used similarly for other fields that contain addresses.
var contacts = ContactsApp.getContactsByName('John Doe');
var homeAddress = contacts[0].getAddresses(ContactsApp.Field.HOME_ADDRESS);
Logger.log(homeAddress[0].getAddress());

Devolvedor

String: Es la dirección 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

---

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

---

setAddress(address)

Establece la dirección de este campo.

// Sets the address for the 'Home Address' field for contact 'John Doe'.
// Can be used similarly for other fields that contain addresses.
var contacts = ContactsApp.getContactsByName('John Doe');
var homeAddress = contacts[0].getAddresses(ContactsApp.Field.HOME_ADDRESS);
homeAddress[0].setAddress('123 Main St, Raleigh, NC, 27601');

Parámetros

Nombre	Tipo	Descripción
address	String	la nueva dirección

Devolvedor

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

---

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

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

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

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

deleteAddressField()

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

Borra este campo de la dirección.

// The code below deletes the home addresses for a contact named "John Doe"
var contacts = ContactsApp.getContactsByName('John Doe');
var homeAddresses = contacts[0].getAddresses(ContactsApp.Field.HOME_ADDRESS);
for (var i in homeAddresses) {
  homeAddresses[i].deleteAddressField();
}

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