AI-generated Key Takeaways
-
A CustomField is an additional, user-created field on an entity within the CustomFieldService.
-
Key attributes of a CustomField include a unique readonly ID, a required name with a max length of 127 characters, an optional description with a max length of 511 characters, and a readonly isActive status.
-
CustomFields are associated with a specific entity type (e.g., LINE_ITEM, ORDER, CREATIVE) and have a data type (e.g., STRING, NUMBER, TOGGLE, DROP_DOWN), both of which are read-only if a CustomFieldValue exists.
-
The visibility of a CustomField in the UI can be API_ONLY, READ_ONLY, or FULL.
An additional, user-created field on an entity.
- Namespace
-
https://www.google.com/apis/ads/publisher/v202411
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
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
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
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.
