type DropDownCustomField (v202308)

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.

LINE_ITEM

Represents the LineItem type.

ORDER

Represents the Order type.

CREATIVE

Represents the Creative type.

PRODUCT_TEMPLATE

Represents the ProductTemplate type.

PRODUCT

Represents the Product 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.

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.

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.

options

CustomFieldOption[]

The options allowed for this custom field. This is read only.