Obsoleto. En su lugar, usa el servicio avanzado de la API de People.
Un campo de correo electrónico en un contacto.
Métodos
Método | Tipo de datos que se muestra | Descripción breve |
---|---|---|
get | String | Obtén la dirección de este campo. |
get | Object | Obtiene la etiqueta de este campo. |
is | Boolean | Obtiene si este es el valor del campo principal. |
set |
| Establece la dirección de este campo. |
set |
| Establece este campo como primario. |
set |
| Establece la etiqueta de este campo. |
set |
| Establece la etiqueta de este campo. |
Métodos obsoletos
Método | Tipo de datos que se muestra | Descripción breve |
---|---|---|
| void | Borra esta dirección de correo electrónico del contacto. |
| String | Muestra el nombre visible de esta dirección de correo electrónico. |
|
| Establece el nombre visible para esta dirección de correo electrónico. |
Documentación detallada
getAddress()
Obtén la dirección de este campo.
// Logs the address for the 'Home Address' field for contact 'John Doe'. // Can be used similarly for other fields that contain addresses. const contacts = ContactsApp.getContactsByName('John Doe'); const homeAddress = contacts[0].getAddresses(ContactsApp.Field.HOME_ADDRESS); Logger.log(homeAddress[0].getAddress());
Volver
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 ámbitos:
-
https://www.google.com/m8/feeds
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
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. const contacts = ContactsApp.getContactsByName('John Doe'); const addressFields = contacts[0].getAddresses(); Logger.log(addressFields[0].isPrimary());
Volver
Boolean
: Indica si es el elemento principal.
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
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. const contacts = ContactsApp.getContactsByName('John Doe'); const 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 dirección nueva |
Volver
: Este campo es útil para el encadenamiento.Email
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
setAsPrimary()
Establece este campo como primario.
// Sets the first address field associated with contact 'John Doe' // as primary. This method can be similarly called for any field. const contacts = ContactsApp.getContactsByName('John Doe'); const addressFields = contacts[0].getAddresses(); addressFields[0].setAsPrimary();
Volver
: Este FieldValue para encadenarEmail
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)
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. const contacts = ContactsApp.getContactsByName('John Doe'); const addressFields = contacts[0].getAddresses(); addressFields[0].setLabel(ContactsApp.Field.WORK_ADDRESS);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
field |
| la nueva etiqueta estándar |
Volver
: Este FieldValue para encadenarEmail
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
: Este campo es útil para el encadenamiento.Email
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
deleteEmailField()
deleteEmailField()
Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.
Borra esta dirección de correo electrónico del contacto.
// Retrieves and deletes the work email address for contact 'John Doe' const contacts = ContactsApp.getContactsByName('John Doe'); const workEmail = contacts[0].getEmails(ContactsApp.Field.WORK_EMAIL); workEmail[0].deleteEmailField();
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
getDisplayName()
getDisplayName()
Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.
Muestra el nombre visible de esta dirección de correo electrónico.
// Logs the display name for the work email address for contact 'John Doe' const contacts = ContactsApp.getContactsByName('John Doe'); const workEmail = contacts[0].getEmails(ContactsApp.Field.WORK_EMAIL); Logger.log(workEmail[0].getDisplayName());
Volver
String
: Es el nombre visible de este correo electrónico.
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
setDisplayName(name)
setDisplayName(name)
Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.
Establece el nombre visible para esta dirección de correo electrónico.
// Sets the display name to 'Doe, John' for the work email address for contact // 'John Doe' const contacts = ContactsApp.getContactsByName('John Doe'); const workEmail = contacts[0].getEmails(ContactsApp.Field.WORK_EMAIL); workEmail[0].setDisplayName('Doe, John');
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
name | String | el nuevo nombre visible de esta dirección de correo electrónico |
Volver
: Este campo de correo electrónico es útil para encadenar.Email
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