Class CustomField

Champ personnalisé

Obsolète. Utilisez plutôt le service avancé de l'API People.

Champ personnalisé dans un contact

Méthodes

Méthode	Type renvoyé	Brève description
getLabel()	Object	Récupère le libellé de ce champ.
setLabel(label)	CustomField	Définit le libellé de ce champ.

Méthodes obsolètes

Méthode	Type renvoyé	Brève description
deleteCustomField()	void	Supprime ce champ.
getValue()	Object	Récupère la valeur du champ.
setLabel(field)	CustomField	Définit le libellé de ce champ.
setValue(value)	CustomField	Définit la valeur de ce champ.

Documentation détaillée

getLabel()

Récupère le libellé de ce champ. Il peut s'agir d'un champ, d'un champ étendu ou d'une chaîne.

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

Renvois

Object : libellé de ce champ

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:

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

---

setLabel(label)

Définit le libellé de ce champ.

// 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');

Paramètres

Nom	Type	Description
label	String	le nouveau libellé de ce champ

Renvois

CustomField : champ utile pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:

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

Méthodes obsolètes

deleteCustomField()

Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans les nouveaux scripts.

Supprime ce champ.

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

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:

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

---

getValue()

Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans les nouveaux scripts.

Récupère la valeur du champ.

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

Renvois

Object : valeur stockée dans le champ

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:

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

---

setLabel(field)

Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans les nouveaux scripts.

Définit le libellé de ce champ.

// 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');

Paramètres

Nom	Type	Description
field	ExtendedField	le nouveau libellé standard

Renvois

CustomField : champ utile pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:

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

---

setValue(value)

Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans les nouveaux scripts.

Définit la valeur de ce champ.

// 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');

Paramètres

Nom	Type	Description
value	Object	la nouvelle valeur

Renvois

CustomField : champ utile pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:

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