Class CustomAudience
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite
-
- com.google.protobuf.AbstractMessage
-
- com.google.protobuf.GeneratedMessageV3
-
- com.google.ads.googleads.v14.resources.CustomAudience
-
- All Implemented Interfaces:
CustomAudienceOrBuilder
,com.google.protobuf.Message
,com.google.protobuf.MessageLite
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,java.io.Serializable
public final class CustomAudience extends com.google.protobuf.GeneratedMessageV3 implements CustomAudienceOrBuilder
A custom audience. This is a list of users by interest.
Protobuf typegoogle.ads.googleads.v14.resources.CustomAudience
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
CustomAudience.Builder
A custom audience.-
Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
-
-
Field Summary
Fields Modifier and Type Field Description static int
DESCRIPTION_FIELD_NUMBER
static int
ID_FIELD_NUMBER
static int
MEMBERS_FIELD_NUMBER
static int
NAME_FIELD_NUMBER
static int
RESOURCE_NAME_FIELD_NUMBER
static int
STATUS_FIELD_NUMBER
static int
TYPE_FIELD_NUMBER
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object obj)
static CustomAudience
getDefaultInstance()
CustomAudience
getDefaultInstanceForType()
java.lang.String
getDescription()
Description of this custom audience.com.google.protobuf.ByteString
getDescriptionBytes()
Description of this custom audience.static com.google.protobuf.Descriptors.Descriptor
getDescriptor()
long
getId()
Output only.CustomAudienceMember
getMembers(int index)
List of custom audience members that this custom audience is composed of.int
getMembersCount()
List of custom audience members that this custom audience is composed of.java.util.List<CustomAudienceMember>
getMembersList()
List of custom audience members that this custom audience is composed of.CustomAudienceMemberOrBuilder
getMembersOrBuilder(int index)
List of custom audience members that this custom audience is composed of.java.util.List<? extends CustomAudienceMemberOrBuilder>
getMembersOrBuilderList()
List of custom audience members that this custom audience is composed of.java.lang.String
getName()
Name of the custom audience.com.google.protobuf.ByteString
getNameBytes()
Name of the custom audience.com.google.protobuf.Parser<CustomAudience>
getParserForType()
java.lang.String
getResourceName()
Immutable.com.google.protobuf.ByteString
getResourceNameBytes()
Immutable.int
getSerializedSize()
CustomAudienceStatusEnum.CustomAudienceStatus
getStatus()
Output only.int
getStatusValue()
Output only.CustomAudienceTypeEnum.CustomAudienceType
getType()
Type of the custom audience.int
getTypeValue()
Type of the custom audience.int
hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable()
boolean
isInitialized()
static CustomAudience.Builder
newBuilder()
static CustomAudience.Builder
newBuilder(CustomAudience prototype)
CustomAudience.Builder
newBuilderForType()
protected CustomAudience.Builder
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected java.lang.Object
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static CustomAudience
parseDelimitedFrom(java.io.InputStream input)
static CustomAudience
parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CustomAudience
parseFrom(byte[] data)
static CustomAudience
parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CustomAudience
parseFrom(com.google.protobuf.ByteString data)
static CustomAudience
parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CustomAudience
parseFrom(com.google.protobuf.CodedInputStream input)
static CustomAudience
parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CustomAudience
parseFrom(java.io.InputStream input)
static CustomAudience
parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CustomAudience
parseFrom(java.nio.ByteBuffer data)
static CustomAudience
parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<CustomAudience>
parser()
CustomAudience.Builder
toBuilder()
void
writeTo(com.google.protobuf.CodedOutputStream output)
-
Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
-
Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
Field Detail
-
RESOURCE_NAME_FIELD_NUMBER
public static final int RESOURCE_NAME_FIELD_NUMBER
- See Also:
- Constant Field Values
-
ID_FIELD_NUMBER
public static final int ID_FIELD_NUMBER
- See Also:
- Constant Field Values
-
STATUS_FIELD_NUMBER
public static final int STATUS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
- See Also:
- Constant Field Values
-
TYPE_FIELD_NUMBER
public static final int TYPE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
- See Also:
- Constant Field Values
-
MEMBERS_FIELD_NUMBER
public static final int MEMBERS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
-
Method Detail
-
newInstance
protected java.lang.Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
- Overrides:
newInstance
in classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessageV3
-
getResourceName
public java.lang.String getResourceName()
Immutable. The resource name of the custom audience. Custom audience resource names have the form: `customers/{customer_id}/customAudiences/{custom_audience_id}`
string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
- Specified by:
getResourceName
in interfaceCustomAudienceOrBuilder
- Returns:
- The resourceName.
-
getResourceNameBytes
public com.google.protobuf.ByteString getResourceNameBytes()
Immutable. The resource name of the custom audience. Custom audience resource names have the form: `customers/{customer_id}/customAudiences/{custom_audience_id}`
string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
- Specified by:
getResourceNameBytes
in interfaceCustomAudienceOrBuilder
- Returns:
- The bytes for resourceName.
-
getId
public long getId()
Output only. ID of the custom audience.
int64 id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
getId
in interfaceCustomAudienceOrBuilder
- Returns:
- The id.
-
getStatusValue
public int getStatusValue()
Output only. Status of this custom audience. Indicates whether the custom audience is enabled or removed.
.google.ads.googleads.v14.enums.CustomAudienceStatusEnum.CustomAudienceStatus status = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
getStatusValue
in interfaceCustomAudienceOrBuilder
- Returns:
- The enum numeric value on the wire for status.
-
getStatus
public CustomAudienceStatusEnum.CustomAudienceStatus getStatus()
Output only. Status of this custom audience. Indicates whether the custom audience is enabled or removed.
.google.ads.googleads.v14.enums.CustomAudienceStatusEnum.CustomAudienceStatus status = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
getStatus
in interfaceCustomAudienceOrBuilder
- Returns:
- The status.
-
getName
public java.lang.String getName()
Name of the custom audience. It should be unique for all custom audiences created by a customer. This field is required for creating operations.
string name = 4;
- Specified by:
getName
in interfaceCustomAudienceOrBuilder
- Returns:
- The name.
-
getNameBytes
public com.google.protobuf.ByteString getNameBytes()
Name of the custom audience. It should be unique for all custom audiences created by a customer. This field is required for creating operations.
string name = 4;
- Specified by:
getNameBytes
in interfaceCustomAudienceOrBuilder
- Returns:
- The bytes for name.
-
getTypeValue
public int getTypeValue()
Type of the custom audience. ("INTEREST" OR "PURCHASE_INTENT" is not allowed for newly created custom audience but kept for existing audiences)
.google.ads.googleads.v14.enums.CustomAudienceTypeEnum.CustomAudienceType type = 5;
- Specified by:
getTypeValue
in interfaceCustomAudienceOrBuilder
- Returns:
- The enum numeric value on the wire for type.
-
getType
public CustomAudienceTypeEnum.CustomAudienceType getType()
Type of the custom audience. ("INTEREST" OR "PURCHASE_INTENT" is not allowed for newly created custom audience but kept for existing audiences)
.google.ads.googleads.v14.enums.CustomAudienceTypeEnum.CustomAudienceType type = 5;
- Specified by:
getType
in interfaceCustomAudienceOrBuilder
- Returns:
- The type.
-
getDescription
public java.lang.String getDescription()
Description of this custom audience.
string description = 6;
- Specified by:
getDescription
in interfaceCustomAudienceOrBuilder
- Returns:
- The description.
-
getDescriptionBytes
public com.google.protobuf.ByteString getDescriptionBytes()
Description of this custom audience.
string description = 6;
- Specified by:
getDescriptionBytes
in interfaceCustomAudienceOrBuilder
- Returns:
- The bytes for description.
-
getMembersList
public java.util.List<CustomAudienceMember> getMembersList()
List of custom audience members that this custom audience is composed of. Members can be added during CustomAudience creation. If members are presented in UPDATE operation, existing members will be overridden.
repeated .google.ads.googleads.v14.resources.CustomAudienceMember members = 7;
- Specified by:
getMembersList
in interfaceCustomAudienceOrBuilder
-
getMembersOrBuilderList
public java.util.List<? extends CustomAudienceMemberOrBuilder> getMembersOrBuilderList()
List of custom audience members that this custom audience is composed of. Members can be added during CustomAudience creation. If members are presented in UPDATE operation, existing members will be overridden.
repeated .google.ads.googleads.v14.resources.CustomAudienceMember members = 7;
- Specified by:
getMembersOrBuilderList
in interfaceCustomAudienceOrBuilder
-
getMembersCount
public int getMembersCount()
List of custom audience members that this custom audience is composed of. Members can be added during CustomAudience creation. If members are presented in UPDATE operation, existing members will be overridden.
repeated .google.ads.googleads.v14.resources.CustomAudienceMember members = 7;
- Specified by:
getMembersCount
in interfaceCustomAudienceOrBuilder
-
getMembers
public CustomAudienceMember getMembers(int index)
List of custom audience members that this custom audience is composed of. Members can be added during CustomAudience creation. If members are presented in UPDATE operation, existing members will be overridden.
repeated .google.ads.googleads.v14.resources.CustomAudienceMember members = 7;
- Specified by:
getMembers
in interfaceCustomAudienceOrBuilder
-
getMembersOrBuilder
public CustomAudienceMemberOrBuilder getMembersOrBuilder(int index)
List of custom audience members that this custom audience is composed of. Members can be added during CustomAudience creation. If members are presented in UPDATE operation, existing members will be overridden.
repeated .google.ads.googleads.v14.resources.CustomAudienceMember members = 7;
- Specified by:
getMembersOrBuilder
in interfaceCustomAudienceOrBuilder
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessageV3
-
writeTo
public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io.IOException
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessageV3
- Throws:
java.io.IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessageV3
-
equals
public boolean equals(java.lang.Object obj)
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()
- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.google.protobuf.AbstractMessage
-
parseFrom
public static CustomAudience parseFrom(java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static CustomAudience parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static CustomAudience parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static CustomAudience parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static CustomAudience parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static CustomAudience parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static CustomAudience parseFrom(java.io.InputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static CustomAudience parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
parseDelimitedFrom
public static CustomAudience parseDelimitedFrom(java.io.InputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseDelimitedFrom
public static CustomAudience parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static CustomAudience parseFrom(com.google.protobuf.CodedInputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static CustomAudience parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
newBuilderForType
public CustomAudience.Builder newBuilderForType()
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
public static CustomAudience.Builder newBuilder()
-
newBuilder
public static CustomAudience.Builder newBuilder(CustomAudience prototype)
-
toBuilder
public CustomAudience.Builder toBuilder()
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected CustomAudience.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
- Specified by:
newBuilderForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
public static CustomAudience getDefaultInstance()
-
parser
public static com.google.protobuf.Parser<CustomAudience> parser()
-
getParserForType
public com.google.protobuf.Parser<CustomAudience> getParserForType()
- Specified by:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
public CustomAudience getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
-