Class CustomField

BenutzerdefiniertesFeld

Veraltet. Verwenden Sie stattdessen den erweiterten Dienst der People API.

Ein benutzerdefiniertes Feld in einem Kontakt.

Methoden

MethodeRückgabetypKurzbeschreibung
getLabel()ObjectRuft das Label für dieses Feld ab.
setLabel(label)CustomFieldLegt das Label dieses Felds fest.
MethodeRückgabetypKurzbeschreibung
deleteCustomField()voidDieses Feld wird gelöscht.
getValue()ObjectRuft den Wert des Felds ab.
setLabel(field)CustomFieldLegt das Label dieses Felds fest.
setValue(value)CustomFieldLegt den Wert dieses Felds fest.

Detaillierte Dokumentation

getLabel()

Ruft das Label für dieses Feld ab. Dies kann ein Feld, ein erweitertes Feld oder ein String sein.

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

Rückflug

Object – das Label für dieses Feld

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setLabel(label)

Legt das Label dieses Felds fest.

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

Parameter

NameTypBeschreibung
labelStringdas neue Label für dieses Feld

Rückflug

CustomField – dieses Feld ist für die Verkettung nützlich

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

Eingestellte Methoden

Veraltet. Diese Funktion wurde eingestellt und sollte in neuen Scripts nicht verwendet werden.

Dieses Feld wird gelöscht.

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

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

Veraltet. Diese Funktion wurde eingestellt und sollte in neuen Scripts nicht verwendet werden.

Ruft den Wert des Felds ab.

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

Rückflug

Object: Der im Feld gespeicherte Wert.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

Veraltet. Diese Funktion wurde eingestellt und sollte in neuen Scripts nicht verwendet werden.

Legt das Label dieses Felds fest.

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

Parameter

NameTypBeschreibung
fieldExtendedFielddas neue Standardlabel

Rückflug

CustomField – dieses Feld ist für die Verkettung nützlich

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

Veraltet. Diese Funktion wurde eingestellt und sollte in neuen Scripts nicht verwendet werden.

Legt den Wert dieses Felds fest.

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

Parameter

NameTypBeschreibung
valueObjectden neuen Wert

Rückflug

CustomField – dieses Feld ist für die Verkettung nützlich

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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