Class CustomTargetingKey (0.35.0) 

public final class CustomTargetingKey extends GeneratedMessageV3 implements CustomTargetingKeyOrBuilder

The CustomTargetingKey resource.

Protobuf type google.ads.admanager.v1.CustomTargetingKey

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > CustomTargetingKey

Static Fields

AD_TAG_NAME_FIELD_NUMBER

public static final int AD_TAG_NAME_FIELD_NUMBER
Field Value
Type Description
int

CUSTOM_TARGETING_KEY_ID_FIELD_NUMBER

public static final int CUSTOM_TARGETING_KEY_ID_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

REPORTABLE_TYPE_FIELD_NUMBER

public static final int REPORTABLE_TYPE_FIELD_NUMBER
Field Value
Type Description
int

STATUS_FIELD_NUMBER

public static final int STATUS_FIELD_NUMBER
Field Value
Type Description
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CustomTargetingKey getDefaultInstance()
Returns
Type Description
CustomTargetingKey

getDescriptor()

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

newBuilder()

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

newBuilder(CustomTargetingKey prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAdTagName()

public String getAdTagName()

Immutable. Name of the key. Keys can contain up to 10 characters each. You can use alphanumeric characters and symbols other than the following: ", ', =, !, +, #, *, ~, ;, ^, (, ), <, >, [, ], the white space character.

string ad_tag_name = 3 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The adTagName.

getAdTagNameBytes()

public ByteString getAdTagNameBytes()

Immutable. Name of the key. Keys can contain up to 10 characters each. You can use alphanumeric characters and symbols other than the following: ", ', =, !, +, #, *, ~, ;, ^, (, ), <, >, [, ], the white space character.

string ad_tag_name = 3 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for adTagName.

getCustomTargetingKeyId()

public long getCustomTargetingKeyId()

Output only. CustomTargetingKey ID.

int64 custom_targeting_key_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
long

The customTargetingKeyId.

getDefaultInstanceForType()

public CustomTargetingKey getDefaultInstanceForType()
Returns
Type Description
CustomTargetingKey

getDisplayName()

public String getDisplayName()

Optional. Descriptive name for the CustomTargetingKey.

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

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Optional. Descriptive name for the CustomTargetingKey.

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

Returns
Type Description
ByteString

The bytes for displayName.

getName()

public String getName()

Identifier. The resource name of the CustomTargetingKey. Format: networks/{network_code}/customTargetingKeys/{custom_targeting_key_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 CustomTargetingKey. Format: networks/{network_code}/customTargetingKeys/{custom_targeting_key_id}

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

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<CustomTargetingKey> getParserForType()
Returns
Type Description
Parser<CustomTargetingKey>
Overrides

getReportableType()

public CustomTargetingKeyReportableTypeEnum.CustomTargetingKeyReportableType getReportableType()

Required. Reportable state of the CustomTargetingKey.

.google.ads.admanager.v1.CustomTargetingKeyReportableTypeEnum.CustomTargetingKeyReportableType reportable_type = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
CustomTargetingKeyReportableTypeEnum.CustomTargetingKeyReportableType

The reportableType.

getReportableTypeValue()

public int getReportableTypeValue()

Required. Reportable state of the CustomTargetingKey.

.google.ads.admanager.v1.CustomTargetingKeyReportableTypeEnum.CustomTargetingKeyReportableType reportable_type = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for reportableType.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStatus()

public CustomTargetingKeyStatusEnum.CustomTargetingKeyStatus getStatus()

Output only. Status of the CustomTargetingKey.

.google.ads.admanager.v1.CustomTargetingKeyStatusEnum.CustomTargetingKeyStatus status = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
CustomTargetingKeyStatusEnum.CustomTargetingKeyStatus

The status.

getStatusValue()

public int getStatusValue()

Output only. Status of the CustomTargetingKey.

.google.ads.admanager.v1.CustomTargetingKeyStatusEnum.CustomTargetingKeyStatus status = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for status.

getType()

public CustomTargetingKeyTypeEnum.CustomTargetingKeyType getType()

Required. Indicates whether users will select from predefined values or create new targeting values, while specifying targeting criteria for a line item.

.google.ads.admanager.v1.CustomTargetingKeyTypeEnum.CustomTargetingKeyType type = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
CustomTargetingKeyTypeEnum.CustomTargetingKeyType

The type.

getTypeValue()

public int getTypeValue()

Required. Indicates whether users will select from predefined values or create new targeting values, while specifying targeting criteria for a line item.

.google.ads.admanager.v1.CustomTargetingKeyTypeEnum.CustomTargetingKeyType type = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for type.

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 CustomTargetingKey.Builder newBuilderForType()
Returns
Type Description
CustomTargetingKey.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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