Show / Hide Table of Contents

Class CustomField

An additional, user-created field on an entity.

Inheritance
object
CustomField
Implements
IMessage<CustomField>
IEquatable<CustomField>
IDeepCloneable<CustomField>
IBufferMessage
IMessage
Inherited Members
object.GetHashCode()
object.GetType()
object.ToString()
Namespace: Google.Ads.AdManager.V1
Assembly: Google.Ads.AdManager.V1.dll
Syntax
public sealed class CustomField : IMessage<CustomField>, IEquatable<CustomField>, IDeepCloneable<CustomField>, IBufferMessage, IMessage

Constructors

CustomField()

Declaration
public CustomField()

CustomField(CustomField)

Declaration
public CustomField(CustomField other)
Parameters
Type Name Description
CustomField other

Properties

CustomFieldId

Output only. Deprecated: Unique ID of the CustomField.

Declaration
[Obsolete]
public long CustomFieldId { get; set; }
Property Value
Type Description
long

CustomFieldName

CustomFieldName-typed view over the Name resource name property.

Declaration
public CustomFieldName CustomFieldName { get; set; }
Property Value
Type Description
CustomFieldName

DataType

Required. The data type of the CustomField.

Declaration
public CustomFieldDataTypeEnum.Types.CustomFieldDataType DataType { get; set; }
Property Value
Type Description
CustomFieldDataTypeEnum.Types.CustomFieldDataType

Description

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

Declaration
public string Description { get; set; }
Property Value
Type Description
string

DisplayName

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

Declaration
public string DisplayName { get; set; }
Property Value
Type Description
string

EntityType

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

Declaration
public CustomFieldEntityTypeEnum.Types.CustomFieldEntityType EntityType { get; set; }
Property Value
Type Description
CustomFieldEntityTypeEnum.Types.CustomFieldEntityType

HasCustomFieldId

Gets whether the "custom_field_id" field is set

Declaration
[Obsolete]
public bool HasCustomFieldId { get; }
Property Value
Type Description
bool

HasDataType

Gets whether the "data_type" field is set

Declaration
public bool HasDataType { get; }
Property Value
Type Description
bool

HasDescription

Gets whether the "description" field is set

Declaration
public bool HasDescription { get; }
Property Value
Type Description
bool

HasDisplayName

Gets whether the "display_name" field is set

Declaration
public bool HasDisplayName { get; }
Property Value
Type Description
bool

HasEntityType

Gets whether the "entity_type" field is set

Declaration
public bool HasEntityType { get; }
Property Value
Type Description
bool

HasStatus

Gets whether the "status" field is set

Declaration
public bool HasStatus { get; }
Property Value
Type Description
bool

HasVisibility

Gets whether the "visibility" field is set

Declaration
public bool HasVisibility { get; }
Property Value
Type Description
bool

Name

Identifier. The resource name of the CustomField. Format: networks/{network_code}/customFields/{custom_field}

Declaration
public string Name { get; set; }
Property Value
Type Description
string

Options

Optional. The drop-down options for the CustomField.

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

Declaration
public RepeatedField<CustomFieldOption> Options { get; }
Property Value
Type Description
RepeatedField<CustomFieldOption>

Status

Output only. The status of the CustomField.

Declaration
public CustomFieldStatusEnum.Types.CustomFieldStatus Status { get; set; }
Property Value
Type Description
CustomFieldStatusEnum.Types.CustomFieldStatus

Visibility

Required. The visibility of the CustomField.

Declaration
public CustomFieldVisibilityEnum.Types.CustomFieldVisibility Visibility { get; set; }
Property Value
Type Description
CustomFieldVisibilityEnum.Types.CustomFieldVisibility
In this article
Back to top Generated by DocFX