type CustomFieldValue (v202411)

  • CustomFieldValue represents the value of a custom field that doesn't use a drop-down data type.

  • It inherits from BaseCustomFieldValue which provides the customFieldId to link it to a specific custom field.

  • The value field stores the actual custom field value, with its type varying depending on the custom field's data type (e.g., text, number, boolean).

  • Specific value types like TextValue, NumberValue, and BooleanValue are used to represent different data types within the value field.

  • This structure is used within various services like CreativeService, ForecastService, LineItemService, OrderService, ProposalLineItemService, and ProposalService to manage custom field values.

The value of a CustomField that does not have a CustomField.dataType of CustomFieldDataType.DROP_DOWN.


Namespace
https://www.google.com/apis/ads/publisher/v202411

Field

BaseCustomFieldValue (inherited)

customFieldId

xsd:long

Id of the CustomField to which this value belongs. This attribute is required.

CustomFieldValue

value

  1. Value
    1. ObjectValue
    2. BooleanValue
    3. DateTimeValue
    4. DateValue
    5. NumberValue
    6. SetValue
    7. TextValue

The value for this field. The appropriate type of Value is determined by the CustomField.dataType of the CustomField that this conforms to.

CustomFieldDataType Value type
STRING TextValue
NUMBER NumberValue
TOGGLE BooleanValue