type CustomField (v202508)

AI-generated Key Takeaways

• A CustomField is an additional, user-created field on an entity with properties like id, name, description, activity status, entity type, data type, and visibility.

• CustomFieldService is used to manage CustomFields and includes methods to create and update them.

• CustomFields can be associated with various entity types including LINE_ITEM, ORDER, CREATIVE, PROPOSAL, and PROPOSAL_LINE_ITEM.

• CustomFields support different data types such as STRING, NUMBER, TOGGLE, and DROP_DOWN.

• The visibility of a CustomField determines its accessibility in the UI, ranging from API_ONLY to FULL.

Service

CustomFieldService

Dependencies

CustomFieldPage createCustomFields() updateCustomFields()

▼

CustomField

Inheritance

CustomField

▼

DropDownCustomField

An additional, user-created field on an entity.

---

Namespace

https://www.google.com/apis/ads/publisher/v202508

Field
id	xsd:long Unique ID of the CustomField. This value is readonly and is assigned by Google.
name	xsd:string Name of the CustomField. This is value is required to create a custom field. The max length is 127 characters.
description	xsd:string A description of the custom field. This value is optional. The maximum length is 511 characters
isActive	xsd:boolean Specifies whether or not the custom fields is active. This attribute is read-only.
entityType	CustomFieldEntityType The type of entity that this custom field is associated with. This attribute is read-only if there exists a CustomFieldValue for this field. Enumerations LINE_ITEM Represents the LineItem type. ORDER Represents the Order type. CREATIVE Represents the Creative type. PROPOSAL Represents the Proposal type. PROPOSAL_LINE_ITEM Represents the ProposalLineItem type. UNKNOWN The value returned if the actual value is not exposed by the requested API version.
dataType	CustomFieldDataType The type of data this custom field contains. This attribute is read-only if there exists a CustomFieldValue for this field. Enumerations STRING A string field. The max length is 255 characters. NUMBER A number field. TOGGLE A boolean field. Values may be "true", "false", or empty. DROP_DOWN A drop-down field. Values may only be the ids of CustomFieldOption objects. UNKNOWN The value returned if the actual value is not exposed by the requested API version.
visibility	CustomFieldVisibility How visible/accessible this field is in the UI. Enumerations UNKNOWN The value returned if the actual value is not exposed by the requested API version. API_ONLY Only visible through the API. READ_ONLY Visible in the UI, but only editable through the API FULL Visible and editable both in the API and the UI.