Class CustomField (0.4.0)

public final class CustomField extends GeneratedMessageV3 implements CustomFieldOrBuilder

The CustomField resource.

Protobuf type google.ads.admanager.v1.CustomField

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()
Returns
Type Description
CustomField

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static CustomField.Builder newBuilder()
Returns
Type Description
CustomField.Builder

newBuilder(CustomField prototype)

public static CustomField.Builder newBuilder(CustomField prototype)
Parameter
Name Description
prototype CustomField
Returns
Type Description
CustomField.Builder

parseDelimitedFrom(InputStream input)

public static CustomField parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CustomField
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CustomField parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CustomField
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static CustomField parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
CustomField
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CustomField parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CustomField
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CustomField parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
CustomField
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CustomField parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CustomField
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CustomField parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
CustomField
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CustomField parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CustomField
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static CustomField parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CustomField
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CustomField parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CustomField
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static CustomField parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
CustomField
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CustomField parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CustomField
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<CustomField> parser()
Returns
Type Description
Parser<CustomField>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCustomFieldId()

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

getDefaultInstanceForType()

public CustomField getDefaultInstanceForType()
Returns
Type Description
CustomField

getDescription()

public 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 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 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 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 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 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 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 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 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 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];

Returns
Type Description
List<CustomFieldOption>

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
Returns
Type Description
CustomFieldOptionOrBuilder

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()
Returns
Type Description
Parser<CustomField>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStatus()

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

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public CustomField.Builder newBuilderForType()
Returns
Type Description
CustomField.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CustomField.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
CustomField.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public CustomField.Builder toBuilder()
Returns
Type Description
CustomField.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException