- [Resource: CustomField](https://developers.google.com/ad-manager/api/beta/reference/rest/v1/networks.customFields#CustomField)
  - [JSON representation](https://developers.google.com/ad-manager/api/beta/reference/rest/v1/networks.customFields#CustomField.SCHEMA_REPRESENTATION)
- [CustomFieldStatus](https://developers.google.com/ad-manager/api/beta/reference/rest/v1/networks.customFields#CustomFieldStatus)
- [CustomFieldEntityType](https://developers.google.com/ad-manager/api/beta/reference/rest/v1/networks.customFields#CustomFieldEntityType)
- [CustomFieldDataType](https://developers.google.com/ad-manager/api/beta/reference/rest/v1/networks.customFields#CustomFieldDataType)
- [CustomFieldVisibility](https://developers.google.com/ad-manager/api/beta/reference/rest/v1/networks.customFields#CustomFieldVisibility)
- [CustomFieldOption](https://developers.google.com/ad-manager/api/beta/reference/rest/v1/networks.customFields#CustomFieldOption)
  - [JSON representation](https://developers.google.com/ad-manager/api/beta/reference/rest/v1/networks.customFields#CustomFieldOption.SCHEMA_REPRESENTATION)
- [Methods](https://developers.google.com/ad-manager/api/beta/reference/rest/v1/networks.customFields#METHODS_SUMMARY)

## Resource: CustomField

An additional, user-created field on an entity.

| JSON representation |
|---|
| ``` { "name": string, "options": [ { object (`https://developers.google.com/ad-manager/api/beta/reference/rest/v1/networks.customFields#CustomFieldOption`) } ], "customFieldId": string, "displayName": string, "description": string, "status": enum (`https://developers.google.com/ad-manager/api/beta/reference/rest/v1/networks.customFields#CustomFieldStatus`), "entityType": enum (`https://developers.google.com/ad-manager/api/beta/reference/rest/v1/networks.customFields#CustomFieldEntityType`), "dataType": enum (`https://developers.google.com/ad-manager/api/beta/reference/rest/v1/networks.customFields#CustomFieldDataType`), "visibility": enum (`https://developers.google.com/ad-manager/api/beta/reference/rest/v1/networks.customFields#CustomFieldVisibility`) } ``` |

| Fields ||
|---|---|
| `name` | `string` Identifier. The resource name of the `CustomField`. Format: `networks/{networkCode}/customFields/{customField}` |
| `options[]` | ``object (`https://developers.google.com/ad-manager/api/beta/reference/rest/v1/networks.customFields#CustomFieldOption`)`` Optional. The drop-down options for the `CustomField`. Only applicable for `CustomField` with the drop-down data type. |
| `customFieldId (deprecated)` | `string (https://developers.google.com/discovery/v1/type-format format)` > [!WARNING] > Output only. Parse the ID from the `name` field instead. Output only. Deprecated: Unique ID of the CustomField. |
| `displayName` | `string` Required. Name of the CustomField. The max length is 127 characters. |
| `description` | `string` Optional. A description of the custom field. The maximum length is 511 characters. |
| `status` | ``enum (`https://developers.google.com/ad-manager/api/beta/reference/rest/v1/networks.customFields#CustomFieldStatus`)`` Output only. The status of the `CustomField`. |
| `entityType` | ``enum (`https://developers.google.com/ad-manager/api/beta/reference/rest/v1/networks.customFields#CustomFieldEntityType`)`` Required. The type of entity the `CustomField` can be applied to. |
| `dataType` | ``enum (`https://developers.google.com/ad-manager/api/beta/reference/rest/v1/networks.customFields#CustomFieldDataType`)`` Required. The data type of the `CustomField`. |
| `visibility` | ``enum (`https://developers.google.com/ad-manager/api/beta/reference/rest/v1/networks.customFields#CustomFieldVisibility`)`` Required. The visibility of the `CustomField`. |

## CustomFieldStatus

The status of the CustomField.

| Enums ||
|---|---|
| `CUSTOM_FIELD_STATUS_UNSPECIFIED` | No value specified |
| `ACTIVE` | The CustomField is active. |
| `INACTIVE` | The CustomField is inactive. |

## CustomFieldEntityType

The types of entities that a CustomField can be applied to.

| Enums ||
|---|---|
| `CUSTOM_FIELD_ENTITY_TYPE_UNSPECIFIED` | No value specified |
| `LINE_ITEM` | The CustomField is applied to LineItems. |
| `ORDER` | The CustomField is applied to Orders. |
| `CREATIVE` | The CustomField is applied to Creatives. |
| `PROPOSAL` | The CustomField is applied to Proposals. |
| `PROPOSAL_LINE_ITEM` | The CustomField is applied to ProposalLineItems. |

## CustomFieldDataType

The data type for a CustomField.

| Enums ||
|---|---|
| `CUSTOM_FIELD_DATA_TYPE_UNSPECIFIED` | No value specified |
| `STRING` | A string field The max length is 255 characters. |
| `NUMBER` | A number field. |
| `TOGGLE` | A "Yes" or "No" toggle field. |
| `DROP_DOWN` | A drop-down field. |

## CustomFieldVisibility

The visibility level of a CustomField.

| Enums ||
|---|---|
| `CUSTOM_FIELD_VISIBILITY_UNSPECIFIED` | No value specified |
| `HIDDEN` | The CustomField is not visible in the UI and only visible through the API. |
| `READ_ONLY` | The CustomField is visible in the UI and only editable through the API. |
| `EDITABLE` | The CustomField is visible and editable in both the API and UI. |

## CustomFieldOption

An option for a drop-down `CustomField`.

| JSON representation |
|---|
| ``` { "customFieldOptionId": string, "displayName": string } ``` |

| Fields ||
|---|---|
| `customFieldOptionId` | `string (https://developers.google.com/discovery/v1/type-format format)` Optional. Non-empty default. `CustomFieldOption` ID. |
| `displayName` | `string` Required. The display name of the `CustomFieldOption`. This value has a maximum length of 127 characters. |

| ## Methods ||
|---|---|
| ### `https://developers.google.com/ad-manager/api/beta/reference/rest/v1/networks.customFields/batchActivate` | Activates a list of `CustomField` objects. |
| ### `https://developers.google.com/ad-manager/api/beta/reference/rest/v1/networks.customFields/batchCreate` | Creates `CustomField` objects. |
| ### `https://developers.google.com/ad-manager/api/beta/reference/rest/v1/networks.customFields/batchDeactivate` | Deactivates a list of `CustomField` objects. |
| ### `https://developers.google.com/ad-manager/api/beta/reference/rest/v1/networks.customFields/batchUpdate` | Batch updates `CustomField` objects. |
| ### `https://developers.google.com/ad-manager/api/beta/reference/rest/v1/networks.customFields/create` | Creates a `CustomField` object. |
| ### `https://developers.google.com/ad-manager/api/beta/reference/rest/v1/networks.customFields/get` | Retrieves a `CustomField` object. |
| ### `https://developers.google.com/ad-manager/api/beta/reference/rest/v1/networks.customFields/list` | Lists `CustomField` objects. |
| ### `https://developers.google.com/ad-manager/api/beta/reference/rest/v1/networks.customFields/patch` | Updates a `CustomField` object. |