Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Interface CustomFieldOrBuilder (0.52.0)

public interface CustomFieldOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCustomFieldId() (deprecated)

public abstract long getCustomFieldId()

Deprecated. google.ads.admanager.v1.CustomField.custom_field_id is deprecated. See google/ads/admanager/v1/custom_field_messages.proto;l=44

Output only. Deprecated: Unique ID of the CustomField.

optional int64 custom_field_id = 2 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`long`	The customFieldId.

getDataType()

public abstract CustomFieldDataTypeEnum.CustomFieldDataType getDataType()

Required. The data type of the CustomField.

optional .google.ads.admanager.v1.CustomFieldDataTypeEnum.CustomFieldDataType data_type = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`CustomFieldDataTypeEnum.CustomFieldDataType`	The dataType.

getDataTypeValue()

public abstract int getDataTypeValue()

Required. The data type of the CustomField.

optional .google.ads.admanager.v1.CustomFieldDataTypeEnum.CustomFieldDataType data_type = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`int`	The enum numeric value on the wire for dataType.

getDescription()

public abstract String getDescription()

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

optional string description = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`String`	The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

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

optional string description = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ByteString`	The bytes for description.

getDisplayName()

public abstract String getDisplayName()

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

optional string display_name = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`String`	The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

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

optional string display_name = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`ByteString`	The bytes for displayName.

getEntityType()

public abstract CustomFieldEntityTypeEnum.CustomFieldEntityType getEntityType()

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

optional .google.ads.admanager.v1.CustomFieldEntityTypeEnum.CustomFieldEntityType entity_type = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`CustomFieldEntityTypeEnum.CustomFieldEntityType`	The entityType.

getEntityTypeValue()

public abstract int getEntityTypeValue()

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

optional .google.ads.admanager.v1.CustomFieldEntityTypeEnum.CustomFieldEntityType entity_type = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`int`	The enum numeric value on the wire for entityType.

getName()

public abstract String getName()

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

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type	Description
`String`	The name.

getNameBytes()

public abstract ByteString getNameBytes()

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

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type	Description
`ByteString`	The bytes for name.

getOptions(int index)

public abstract CustomFieldOption getOptions(int index)

Optional. The drop-down options for the CustomField.

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

repeated .google.ads.admanager.v1.CustomFieldOption options = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`CustomFieldOption`

getOptionsCount()

public abstract int getOptionsCount()

Optional. The drop-down options for the CustomField.

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

repeated .google.ads.admanager.v1.CustomFieldOption options = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`int`

getOptionsList()

public abstract List<CustomFieldOption> getOptionsList()

Optional. The drop-down options for the CustomField.

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

repeated .google.ads.admanager.v1.CustomFieldOption options = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`List<CustomFieldOption>`

getOptionsOrBuilder(int index)

public abstract CustomFieldOptionOrBuilder getOptionsOrBuilder(int index)

Optional. The drop-down options for the CustomField.

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

repeated .google.ads.admanager.v1.CustomFieldOption options = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`CustomFieldOptionOrBuilder`

getOptionsOrBuilderList()

public abstract List<? extends CustomFieldOptionOrBuilder> getOptionsOrBuilderList()

Optional. The drop-down options for the CustomField.

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

repeated .google.ads.admanager.v1.CustomFieldOption options = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`List<? extends com.google.ads.admanager.v1.CustomFieldOptionOrBuilder>`

getStatus()

public abstract CustomFieldStatusEnum.CustomFieldStatus getStatus()

Output only. The status of the CustomField.

optional .google.ads.admanager.v1.CustomFieldStatusEnum.CustomFieldStatus status = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`CustomFieldStatusEnum.CustomFieldStatus`	The status.

getStatusValue()

public abstract int getStatusValue()

Output only. The status of the CustomField.

optional .google.ads.admanager.v1.CustomFieldStatusEnum.CustomFieldStatus status = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`int`	The enum numeric value on the wire for status.

getVisibility()

public abstract CustomFieldVisibilityEnum.CustomFieldVisibility getVisibility()

Required. The visibility of the CustomField.

optional .google.ads.admanager.v1.CustomFieldVisibilityEnum.CustomFieldVisibility visibility = 9 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`CustomFieldVisibilityEnum.CustomFieldVisibility`	The visibility.

getVisibilityValue()

public abstract int getVisibilityValue()

Required. The visibility of the CustomField.

optional .google.ads.admanager.v1.CustomFieldVisibilityEnum.CustomFieldVisibility visibility = 9 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`int`	The enum numeric value on the wire for visibility.

hasCustomFieldId() (deprecated)

public abstract boolean hasCustomFieldId()

Deprecated. google.ads.admanager.v1.CustomField.custom_field_id is deprecated. See google/ads/admanager/v1/custom_field_messages.proto;l=44

Output only. Deprecated: Unique ID of the CustomField.

optional int64 custom_field_id = 2 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`boolean`	Whether the customFieldId field is set.

hasDataType()

public abstract boolean hasDataType()

Required. The data type of the CustomField.

optional .google.ads.admanager.v1.CustomFieldDataTypeEnum.CustomFieldDataType data_type = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`boolean`	Whether the dataType field is set.

hasDescription()

public abstract boolean hasDescription()

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

optional string description = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the description field is set.

hasDisplayName()

public abstract boolean hasDisplayName()

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

optional string display_name = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`boolean`	Whether the displayName field is set.

hasEntityType()

public abstract boolean hasEntityType()

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

optional .google.ads.admanager.v1.CustomFieldEntityTypeEnum.CustomFieldEntityType entity_type = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`boolean`	Whether the entityType field is set.

hasStatus()

public abstract boolean hasStatus()

Output only. The status of the CustomField.

optional .google.ads.admanager.v1.CustomFieldStatusEnum.CustomFieldStatus status = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`boolean`	Whether the status field is set.

hasVisibility()

public abstract boolean hasVisibility()

Required. The visibility of the CustomField.

optional .google.ads.admanager.v1.CustomFieldVisibilityEnum.CustomFieldVisibility visibility = 9 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`boolean`	Whether the visibility field is set.