Send feedback
Class CustomTargetingKey (0.29.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version latestkeyboard_arrow_down
public final class CustomTargetingKey extends GeneratedMessageV3 implements CustomTargetingKeyOrBuilder
The CustomTargetingKey resource.
Protobuf type google.ads.admanager.v1.CustomTargetingKey
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
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 ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static CustomTargetingKey . Builder newBuilder ()
newBuilder(CustomTargetingKey prototype)
public static CustomTargetingKey . Builder newBuilder ( CustomTargetingKey prototype )
public static CustomTargetingKey parseDelimitedFrom ( InputStream input )
public static CustomTargetingKey parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static CustomTargetingKey parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static CustomTargetingKey parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static CustomTargetingKey parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CustomTargetingKey parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static CustomTargetingKey parseFrom ( CodedInputStream input )
public static CustomTargetingKey parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static CustomTargetingKey parseFrom ( InputStream input )
public static CustomTargetingKey parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static CustomTargetingKey parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static CustomTargetingKey parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<CustomTargetingKey> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
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 ()
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()
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 ()
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];
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];
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];
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()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public CustomTargetingKey . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected CustomTargetingKey . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public CustomTargetingKey . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-01 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-01 UTC."],[[["This webpage provides documentation for the `CustomTargetingKey` class in the Google Ad Manager Java library, specifically within the `com.google.ads.admanager.v1` package."],["The latest version of the `CustomTargetingKey` documentation is version 0.19.0, and the page includes documentation for versions back to 0.1.0."],["`CustomTargetingKey` extends `GeneratedMessageV3`, and implements `CustomTargetingKeyOrBuilder`, indicating its role as a resource within the protocol buffer system."],["The `CustomTargetingKey` resource has properties such as `name`, `ad_tag_name`, `custom_targeting_key_id`, `display_name`, `reportable_type`, `status`, and `type`."],["The documentation includes details on static fields, methods for parsing, and instance methods related to `CustomTargetingKey`, such as getting its properties and builders, as well as handling serialization and equality."]]],[]]
