public final class CustomField extends GeneratedMessageV3 implements CustomFieldOrBuilder
An additional, user-created field on an entity.
Protobuf type google.ads.admanager.v1.CustomField
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
CUSTOM_FIELD_ID_FIELD_NUMBER
public static final int CUSTOM_FIELD_ID_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DATA_TYPE_FIELD_NUMBER
public static final int DATA_TYPE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ENTITY_TYPE_FIELD_NUMBER
public static final int ENTITY_TYPE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
OPTIONS_FIELD_NUMBER
public static final int OPTIONS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
STATUS_FIELD_NUMBER
public static final int STATUS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
VISIBILITY_FIELD_NUMBER
public static final int VISIBILITY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static CustomField getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static CustomField.Builder newBuilder()
newBuilder(CustomField prototype)
public static CustomField.Builder newBuilder(CustomField prototype)
public static CustomField parseDelimitedFrom(InputStream input)
public static CustomField parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static CustomField parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static CustomField parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static CustomField parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CustomField parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CustomField parseFrom(CodedInputStream input)
public static CustomField parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static CustomField parseFrom(InputStream input)
public static CustomField parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static CustomField parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static CustomField parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<CustomField> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getCustomFieldId()
public long getCustomFieldId()
Output only. Unique ID of the CustomField. This attribute is assigned by
Google.
optional int64 custom_field_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
long |
The customFieldId.
|
getDataType()
public 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];
getDataTypeValue()
public 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.
|
getDefaultInstanceForType()
public CustomField getDefaultInstanceForType()
getDescription()
public 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 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 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 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 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];
getEntityTypeValue()
public 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()
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 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 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
|
getOptionsCount()
public 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 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];
getOptionsOrBuilder(int index)
public 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
|
getOptionsOrBuilderList()
public 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> |
|
getParserForType()
public Parser<CustomField> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getStatus()
public 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];
getStatusValue()
public 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 CustomFieldVisibilityEnum.CustomFieldVisibility getVisibility()
Required. The visibility of the CustomField.
optional .google.ads.admanager.v1.CustomFieldVisibilityEnum.CustomFieldVisibility visibility = 9 [(.google.api.field_behavior) = REQUIRED];
getVisibilityValue()
public 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()
public boolean hasCustomFieldId()
Output only. Unique ID of the CustomField. This attribute is assigned by
Google.
optional int64 custom_field_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
Whether the customFieldId field is set.
|
hasDataType()
public 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 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 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 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 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 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.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public CustomField.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected CustomField.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public CustomField.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
