Cette page a été traduite par l'API Cloud Translation.

Class DateField

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

Champ de date dans un contact.

Cette classe n'est utilisée que par le service Contacts. Les dates utilisées ailleurs dans App Script utilisent l'objet Date standard de JavaScript.

Méthodes

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

Méthodes obsolètes

Méthode	Type renvoyé	Brève description
`deleteDateField()`	`void`	Supprime cette date.
`getDay()`	`Integer`	Récupère le jour du mois pour cette date.
`getMonth()`	`Month`	Récupère le mois de cette date.
`getYear()`	`Integer`	Récupère l'année de cette date.
`setDate(month, day)`	`DateField`	Définit la date sur le jour actuel, sans année.
`setDate(month, day, year)`	`DateField`	Définit la date sur le jour actuel.
`setLabel(label)`	`DateField`	Définit le libellé de ce champ, par exemple "Anniversaire" ou "Anniversaire".

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

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

`deleteDateField()`

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

Supprime cette date.

// Deletes all the dates that are set for contact 'John Doe'
const contacts = ContactsApp.getContactsByName('John Doe');
const dates = contacts[0].getDates();
for (let i = 0; i < dates.length; i++) {
  dates[i].deleteDateField();
}

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

`getDay()`

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

Récupère le jour du mois pour cette date.

Remarque: Pour les objets Date JavaScript standards, la méthode getDay() renvoie plutôt le jour de la semaine.

// Logs the day of the birthday for contact 'John Doe'
const contacts = ContactsApp.getContactsByName('John Doe');
const birthday = contacts[0].getDates(ContactsApp.Field.BIRTHDAY)[0];
Logger.log(birthday.getDay());

Renvois

Integer : jour du mois

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

`getMonth()`

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

Récupère le mois de cette date.

// Logs the month of the birthday for contact 'John Doe'
const contacts = ContactsApp.getContactsByName('John Doe');
const birthday = contacts[0].getDates(ContactsApp.Field.BIRTHDAY)[0];
Logger.log(birthday.getMonth());

Renvois

Month : mois

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

`getYear()`

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

Récupère l'année de cette date.

// Logs the year of the birthday for contact 'John Doe'
const contacts = ContactsApp.getContactsByName('John Doe');
const birthday = contacts[0].getDates(ContactsApp.Field.BIRTHDAY)[0];
Logger.log(birthday.getYear());

Renvois

Integer : année

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

`setDate(month, day)`

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

Définit la date sur le jour actuel, sans année.

Cette méthode ne s'applique qu'aux champs de date qui ne nécessitent pas d'année, comme les dates de naissance.

// Sets the birthday for contact 'John Doe' to April 1
const contacts = ContactsApp.getContactsByName('John Doe');
const birthday = contacts[0].getDates(ContactsApp.Field.BIRTHDAY)[0];
birthday.setDate(ContactsApp.Month.APRIL, 1);

Paramètres

Nom	Type	Description
`month`	`Month`	le mois
`day`	`Integer`	le jour

Renvois

DateField : cette date, utile pour le chaînage

Génère

Error : si ce champ de date nécessite une année

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

`setDate(month, day, year)`

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

Définit la date sur le jour actuel.

// Sets the birthday for contact 'John Doe' to April 1, 1980
const contacts = ContactsApp.getContactsByName('John Doe');
const birthday = contacts[0].getDates(ContactsApp.Field.BIRTHDAY)[0];
birthday.setDate(ContactsApp.Month.APRIL, 1, 1980);

Paramètres

Nom	Type	Description
`month`	`Month`	le mois
`day`	`Integer`	le jour
`year`	`Integer`	l'année

Renvois

DateField : cette date, 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

`setLabel(label)`

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, par exemple "Anniversaire" ou "Anniversaire".

// Retrieves the first date that's set for contact 'John Doe' and re-labels
// it as an anniversary
const contacts = ContactsApp.getContactsByName('John Doe');
const firstDate = contacts[0].getDates()[0];
firstDate.setLabel(ContactsApp.Field.ANNIVERSARY);

Paramètres

Nom	Type	Description
`label`	`Field`	le nouveau libellé standard

Renvois

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