type CustomField (v202502)

  • A CustomField is a user-created field on an entity.

  • CustomFields have attributes including a unique ID, name, description, activity status, entity type, data type, and visibility.

  • CustomFields are associated with various entity types such as LineItem, Order, Creative, Proposal, and ProposalLineItem.

  • The data type of a CustomField can be a string, number, toggle, or drop-down.

  • CustomField visibility can be API only, read-only, or full access in the UI.
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/v202502

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.