REST Resource: networks.customFields

    • CustomFields are additional user-created fields on an entity with various properties like name, display name, description, status, entity type, data type, and visibility.

    • CustomFieldStatus defines the active or inactive state of a CustomField.

    • CustomFieldEntityType specifies which types of entities, such as LineItems or Orders, a CustomField can be applied to.

    • CustomFieldDataType determines the format of the data in a CustomField, including string, number, toggle, or drop-down.

    • CustomFieldVisibility controls whether a CustomField is hidden, read-only, or editable in the UI and API.

    Resource: CustomField

    An additional, user-created field on an entity.

    JSON representation 
     { 
 "name" 
 : 
 string 
 , 
 "options" 
 : 
 [ 
 { 
 object (  CustomFieldOption 
 
) 
 } 
 ] 
 , 
 "customFieldId" 
 : 
 string 
 , 
 "displayName" 
 : 
 string 
 , 
 "description" 
 : 
 string 
 , 
 "status" 
 : 
 enum (  CustomFieldStatus 
 
) 
 , 
 "entityType" 
 : 
 enum (  CustomFieldEntityType 
 
) 
 , 
 "dataType" 
 : 
 enum (  CustomFieldDataType 
 
) 
 , 
 "visibility" 
 : 
 enum (  CustomFieldVisibility 
 
) 
 }
    Fields
    name

    string

    Identifier. The resource name of the CustomField . Format: networks/{networkCode}/customFields/{customField}

    options[]

    object ( CustomFieldOption )

    Optional. The drop-down options for the CustomField .

    Only applicable for CustomField with the drop-down data type.
    customFieldId

    string ( int64 format)

    Output only. Unique ID of the CustomField. This attribute is assigned by Google.
    displayName

    string

    Required. Name of the CustomField. The max length is 127 characters.
    description

    string

    Optional. A description of the custom field. The maximum length is 511 characters.
    status

    enum ( CustomFieldStatus )

    Output only. The status of the CustomField .
    entityType

    enum ( CustomFieldEntityType )

    Required. The type of entity the CustomField can be applied to.
    dataType

    enum ( CustomFieldDataType )

    Required. The data type of the CustomField .
    visibility

    enum ( CustomFieldVisibility )

    Required. The visibility of the CustomField .

    CustomFieldStatus

    The status of the CustomField.

    Enums
    CUSTOM_FIELD_STATUS_UNSPECIFIED No value specified
    ACTIVE The CustomField is active.
    INACTIVE The CustomField is inactive.

    CustomFieldEntityType

    The types of entities that a CustomField can be applied to.

    Enums
    CUSTOM_FIELD_ENTITY_TYPE_UNSPECIFIED No value specified
    LINE_ITEM The CustomField is applied to LineItems.
    ORDER The CustomField is applied to Orders.
    CREATIVE The CustomField is applied to Creatives.
    PROPOSAL The CustomField is applied to Proposals.
    PROPOSAL_LINE_ITEM The CustomField is applied to ProposalLineItems.

    CustomFieldDataType

    The data type for a CustomField.

    Enums
    CUSTOM_FIELD_DATA_TYPE_UNSPECIFIED No value specified
    STRING

    A string field

    The max length is 255 characters.
    NUMBER A number field.
    TOGGLE A "Yes" or "No" toggle field.
    DROP_DOWN A drop-down field.

    CustomFieldVisibility

    The visibility level of a CustomField.

    Enums
    CUSTOM_FIELD_VISIBILITY_UNSPECIFIED No value specified
    HIDDEN The CustomField is not visible in the UI and only visible through the API.
    READ_ONLY The CustomField is visible in the UI and only editable through the API.
    EDITABLE The CustomField is visible and editable in both the API and UI.

    CustomFieldOption

    An option for a drop-down CustomField .

    JSON representation 
     { 
 "customFieldOptionId" 
 : 
 string 
 , 
 "displayName" 
 : 
 string 
 }
    Fields
    customFieldOptionId

    string ( int64 format)

    Optional. Non-empty default. CustomFieldOption ID.
    displayName

    string

    Required. The display name of the CustomFieldOption .

    This value has a maximum length of 127 characters.

    Methods

    batchActivate

    		Activates a list of CustomField objects.

    batchCreate

    		API to batch create CustomField objects.

    batchDeactivate

    		Deactivates a list of CustomField objects.

    batchUpdate

    		API to batch update CustomField objects.

    create

    		API to create a CustomField object.

    get

    		API to retrieve a CustomField object.

    list

    		API to retrieve a list of CustomField objects.

    patch

    		API to update a CustomField object.
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: