Interface CustomFieldOrBuilder (0.3.0)

Version 0.3.0

• 0.11.0 (latest)
• 0.10.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

public interface CustomFieldOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCustomFieldId()

public abstract long getCustomFieldId()

Output only. CustomField ID.

int64 custom_field_id = 2 [(.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.

.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.

.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. The description of the CustomField.

This value has a maximum length of 511 characters.

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

Returns
Type	Description
String	The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

Optional. The description of the CustomField.

This value has a maximum length of 511 characters.

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

Returns
Type	Description
ByteString	The bytes for description.

getDisplayName()

public abstract String getDisplayName()

Required. The display name of the CustomField.

This value has a maximum length of 127 characters.

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

Returns
Type	Description
String	The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

Required. The display name of the CustomField.

This value has a maximum length of 127 characters.

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.

.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.

.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_id}

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_id}

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.

.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.

.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.

.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.

.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.