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. Unique ID of the CustomField. This value is readonly and is assigned by Google.

Declaration

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

Name

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

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