Esta página foi traduzida pela API Cloud Translation.

Class DateField

Obsoleto. Em vez disso, use o serviço avançado da API People.

Um campo de data em um contato.

Essa classe é usada apenas pelo serviço de contatos, e as datas usadas em outros lugares no Apps Script usam o objeto Date padrão do JavaScript.

Métodos

Método	Tipo de retorno	Breve descrição
`getLabel()`	`Object`	Recebe o rótulo desse campo.
`setLabel(label)`	`DateField`	Define o rótulo desse campo.

Métodos obsoletos

Método	Tipo de retorno	Breve descrição
`deleteDateField()`	`void`	Exclui essa data.
`getDay()`	`Integer`	Recebe o dia do mês para essa data.
`getMonth()`	`Month`	Recebe o mês dessa data.
`getYear()`	`Integer`	Recebe o ano da data.
`setDate(month, day)`	`DateField`	Define a data como o dia atual, sem o ano.
`setDate(month, day, year)`	`DateField`	Define a data como o dia atual.
`setLabel(label)`	`DateField`	Define o rótulo desse campo, como "Aniversário" ou "Data comemorativa".

Documentação detalhada

`getLabel()`

Recebe o rótulo desse campo. Pode ser um campo, um ExtendedField ou uma 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.
const contacts = ContactsApp.getContactsByName('John Doe');
const addressFields = contacts[0].getAddresses();
for (let i = 0; i < addressFields.length; i++) {
  Logger.log(addressFields[i].getLabel());
}

Retornar

Object: o rótulo do campo

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

`setLabel(label)`

Define o rótulo desse 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

Nome	Tipo	Descrição
`label`	`String`	o novo rótulo para esse campo

Retornar

DateField: este campo é útil para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

Métodos obsoletos

`deleteDateField()`

Obsoleto. Essa função foi descontinuada e não deve ser usada em novos scripts.

Exclui essa data.

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

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

`getDay()`

Obsoleto. Essa função foi descontinuada e não deve ser usada em novos scripts.

Recebe o dia do mês para essa data.

Observação: para objetos de data padrão do JavaScript, o método getDay() retorna o dia da semana.

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

Retornar

Integer: o dia do mês

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

`getMonth()`

Obsoleto. Essa função foi descontinuada e não deve ser usada em novos scripts.

Recebe o mês dessa data.

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

Retornar

Month: o mês

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

`getYear()`

Obsoleto. Essa função foi descontinuada e não deve ser usada em novos scripts.

Recebe o ano da data.

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

Retornar

Integer: o ano

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

`setDate(month, day)`

Obsoleto. Essa função foi descontinuada e não deve ser usada em novos scripts.

Define a data como o dia atual, sem o ano.

Esse método se aplica apenas a campos de data que não exigem um ano, como datas de nascimento.

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

Parâmetros

Nome	Tipo	Descrição
`month`	`Month`	o mês
`day`	`Integer`	o dia

Retornar

DateField: esta data, útil para encadeamento

Gera

Error: se o campo de data exigir um ano.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

`setDate(month, day, year)`

Obsoleto. Essa função foi descontinuada e não deve ser usada em novos scripts.

Define a data como o dia atual.

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

Parâmetros

Nome	Tipo	Descrição
`month`	`Month`	o mês
`day`	`Integer`	o dia
`year`	`Integer`	o ano

Retornar

DateField: esta data, útil para encadeamento

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

`setLabel(label)`

Obsoleto. Essa função foi descontinuada e não deve ser usada em novos scripts.

Define o rótulo desse campo, como "Aniversário" ou "Data comemorativa".

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

Parâmetros

Nome	Tipo	Descrição
`label`	`Field`	o novo rótulo padrão

Retornar

DateField: este campo é útil para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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