Class UrlField

UrlField

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

Um campo de URL em um contato.

Métodos

MétodoTipo de retornoBreve descrição
getAddress()StringConsiga o endereço para este campo.
getLabel()ObjectExtrai o rótulo desse campo.
isPrimary()BooleanDescobre se este é o valor do campo principal.
setAddress(address)UrlFieldDefine o endereço deste campo.
setAsPrimary()UrlFieldDefine este campo como principal.
setLabel(field)UrlFieldDefine o rótulo desse campo.
setLabel(label)UrlFieldDefine o rótulo desse campo.

Documentação detalhada

getAddress()

Consiga o endereço 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());

Retorno

String: o endereço como uma string

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

getLabel()

Extrai 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.
var contacts = ContactsApp.getContactsByName('John Doe');
var addressFields = contacts[0].getAddresses();
for (var i = 0; i < addressFields.length; i++) {
  Logger.log(addressFields[i].getLabel());
}

Retorno

Object: o rótulo deste 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

isPrimary()

Descobre se este é o valor do 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());

Retorno

Boolean: se é a principal

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

setAddress(address)

Define o endereço deste 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

NomeTipoDescrição
addressStringo novo endereço

Retorno

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

setAsPrimary()

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

Retorno

UrlField: este FieldValue 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(field)

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

NomeTipoDescrição
fieldFieldo novo identificador padrão

Retorno

UrlField: este FieldValue 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)

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.
var contacts = ContactsApp.getContactsByName('John Doe');
var addressFields = contacts[0].getAddresses();
addressFields[0].setLabel('Apartment');

Parâmetros

NomeTipoDescrição
labelStringo novo marcador deste campo

Retorno

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