Class CustomField
Mit Sammlungen den Überblick behalten
Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
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
Name | Typ | Beschreibung |
label | String | das 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
deleteCustomField()
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
getValue()
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
setLabel(field)
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
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
setValue(value)
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
Name | Typ | Beschreibung |
value | Object | den 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
Sofern nicht anders angegeben, sind die Inhalte dieser Seite unter der Creative Commons Attribution 4.0 License und Codebeispiele unter der Apache 2.0 License lizenziert. Weitere Informationen finden Sie in den Websiterichtlinien von Google Developers. Java ist eine eingetragene Marke von Oracle und/oder seinen Partnern.
Zuletzt aktualisiert: 2025-07-26 (UTC).
[null,null,["Zuletzt aktualisiert: 2025-07-26 (UTC)."],[[["\u003cp\u003e\u003ccode\u003eCustomField\u003c/code\u003e is deprecated and the People API advanced service should be used instead.\u003c/p\u003e\n"],["\u003cp\u003eIt represents a custom field within a Contact and previously allowed for getting, setting, and deleting custom field data.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003egetLabel()\u003c/code\u003e and \u003ccode\u003esetLabel(label)\u003c/code\u003e methods remain available for retrieving and setting the label of a custom field.\u003c/p\u003e\n"],["\u003cp\u003eSeveral methods, including \u003ccode\u003edeleteCustomField()\u003c/code\u003e, \u003ccode\u003egetValue()\u003c/code\u003e, \u003ccode\u003esetLabel(field)\u003c/code\u003e, and \u003ccode\u003esetValue(value)\u003c/code\u003e, are deprecated and should no longer be used.\u003c/p\u003e\n"]]],["The `CustomField` in the Contacts API is deprecated in favor of the People API. It allows interacting with a custom field in a contact, using `getLabel()` to retrieve the field's label and `setLabel(label)` to change it. Deprecated methods include `deleteCustomField()` to remove the field, `getValue()` to get the field's value, `setLabel(field)` to set a label, and `setValue(value)` to assign the field's value. These actions require specific authorization scopes.\n"],null,["# Class CustomField\n\nCustomField\n\n\n**Deprecated.** Instead, use the [People API advanced\nservice](/apps-script/advanced/people)\n\nA custom field in a Contact. \n\n### Methods\n\n| Method | Return type | Brief description |\n|--------------------------------------|------------------|--------------------------------|\n| [getLabel()](#getLabel()) | `Object` | Gets the label for this field. |\n| [setLabel(label)](#setLabel(String)) | [CustomField](#) | Sets the label of this field. |\n\n### Deprecated methods\n\n| Method | Return type | Brief description |\n|---------------------------------------------|------------------|-------------------------------|\n| [deleteCustomField()](#deleteCustomField()) | `void` | Deletes this field. |\n| [getValue()](#getValue()) | `Object` | Gets the value of the field. |\n| [setLabel(field)](#setLabel(ExtendedField)) | [CustomField](#) | Sets the label of this field. |\n| [setValue(value)](#setValue(Object)) | [CustomField](#) | Sets the value of this field. |\n\nDetailed documentation\n----------------------\n\n### `get``Label()`\n\nGets the label for this field. This may be a Field, ExtendedField, or a String.\n\n```javascript\n// Logs the label for all the address fields associated with contact\n// 'John Doe'. This method can be similarly called for any field that has\n// a label.\nconst contacts = ContactsApp.getContactsByName('John Doe');\nconst addressFields = contacts[0].getAddresses();\nfor (let i = 0; i \u003c addressFields.length; i++) {\n Logger.log(addressFields[i].getLabel());\n}\n```\n\n#### Return\n\n\n`Object` --- the label for this field\n\n#### Authorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes):\n\n- `https://www.google.com/m8/feeds`\n\n*** ** * ** ***\n\n### `set``Label(label)`\n\nSets the label of this field.\n\n```javascript\n// Sets the label to 'Apartment' for the first address field associated\n// with contact 'John Doe'. This method can be similarly called for any\n// field that has a label.\nconst contacts = ContactsApp.getContactsByName('John Doe');\nconst addressFields = contacts[0].getAddresses();\naddressFields[0].setLabel('Apartment');\n```\n\n#### Parameters\n\n| Name | Type | Description |\n|---------|----------|------------------------------|\n| `label` | `String` | the new label for this field |\n\n#### Return\n\n\n[CustomField](#) --- this field, useful for chaining\n\n#### Authorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes):\n\n- `https://www.google.com/m8/feeds`\n\nDeprecated methods\n------------------\n\n### `delete``Custom``Field()`\n\n\n**Deprecated.** This function is deprecated and should not be used in new scripts.\n\nDeletes this field.\n\n```javascript\nconst contacts = ContactsApp.getContactsByName('John Doe');\nconst fields = contacts[0].getCustomFields();\nfor (let i = 0; i \u003c fields.length; i++) {\n if (fields[i].getLabel() === 'foo') {\n fields[i].deleteCustomField();\n }\n}\n```\n\n#### Authorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes):\n\n- `https://www.google.com/m8/feeds`\n\n*** ** * ** ***\n\n### `get``Value()`\n\n\n**Deprecated.** This function is deprecated and should not be used in new scripts.\n\nGets the value of the field.\n\n```javascript\n// Logs the value of all the custom fields for contact 'John Doe'\nconst contacts = ContactsApp.getContactsByName('John Doe');\nconst fields = contacts[0].getCustomFields();\nfor (const i in fields) {\n Logger.log(fields[i].getValue());\n}\n```\n\n#### Return\n\n\n`Object` --- the value stored in the field\n\n#### Authorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes):\n\n- `https://www.google.com/m8/feeds`\n\n*** ** * ** ***\n\n### `set``Label(field)`\n\n\n**Deprecated.** This function is deprecated and should not be used in new scripts.\n\nSets the label of this field.\n\n```javascript\n// Sets the first custom field associated with contact 'John Doe' to use 'Mail\n// application' as a label, with 'Gmail' as the value.\nconst contacts = ContactsApp.getContactsByName('John Doe');\nconst field = contacts[0].getCustomFields()[0];\nfield.setLabel('Mail application');\nfield.setValue('Gmail');\n```\n\n#### Parameters\n\n| Name | Type | Description |\n|---------|-----------------------------------------------------------------|------------------------|\n| `field` | [ExtendedField](/apps-script/reference/contacts/extended-field) | the new standard label |\n\n#### Return\n\n\n[CustomField](#) --- this field, useful for chaining\n\n#### Authorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes):\n\n- `https://www.google.com/m8/feeds`\n\n*** ** * ** ***\n\n### `set``Value(value)`\n\n\n**Deprecated.** This function is deprecated and should not be used in new scripts.\n\nSets the value of this field.\n\n```javascript\n// Sets the first custom field associated with contact 'John Doe' to use 'Mail\n// application' as a label, with 'Gmail' as the value.\nconst contacts = ContactsApp.getContactsByName('John Doe');\nconst field = contacts[0].getCustomFields()[0];\nfield.setLabel('Mail application');\nfield.setValue('Gmail');\n```\n\n#### Parameters\n\n| Name | Type | Description |\n|---------|----------|---------------|\n| `value` | `Object` | the new value |\n\n#### Return\n\n\n[CustomField](#) --- this field, useful for chaining\n\n#### Authorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes):\n\n- `https://www.google.com/m8/feeds`"]]