Package com.google.ads.googleads.v21.resources

Class CustomAudience

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableMessage<com.google.protobuf.GeneratedMessageV3>
com.google.protobuf.GeneratedMessageV3
com.google.ads.googleads.v21.resources.CustomAudience
All Implemented Interfaces:
CustomAudienceOrBuilder, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class CustomAudience extends com.google.protobuf.GeneratedMessageV3 implements CustomAudienceOrBuilder
 A custom audience. This is a list of users by interest.
 The unique key of a custom audience consists of the following fields: name.
 Violating the unique key constraint produces error:
 CustomAudienceError.NAME_ALREADY_USED
Protobuf type google.ads.googleads.v21.resources.CustomAudience
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final 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

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage.ExtendableMessage

    com.google.protobuf.GeneratedMessage.ExtendableMessage.ExtensionSerializer, com.google.protobuf.GeneratedMessage.ExtendableMessage.ExtensionWriter, com.google.protobuf.GeneratedMessage.ExtendableMessage.FieldEntry

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    DESCRIPTION_FIELD_NUMBER
     
    static final int
    ID_FIELD_NUMBER
     
    static final int
    MEMBERS_FIELD_NUMBER
     
    static final int
    NAME_FIELD_NUMBER
     
    static final int
    RESOURCE_NAME_FIELD_NUMBER
     
    static final int
    STATUS_FIELD_NUMBER
     
    static final int
    TYPE_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static CustomAudience
    getDefaultInstance()
     
    CustomAudience
    getDefaultInstanceForType()
     
    String
    getDescription()
    Description of this custom audience.
    com.google.protobuf.ByteString
    getDescriptionBytes()
    Description of this custom audience.
    static final 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.
    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.
    List<? extends CustomAudienceMemberOrBuilder>
    getMembersOrBuilderList()
    List of custom audience members that this custom audience is composed of.
    String
    getName()
    Name of the custom audience.
    com.google.protobuf.ByteString
    getNameBytes()
    Name of the custom audience.
    com.google.protobuf.Parser<CustomAudience>
    getParserForType()
     
    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()
     
    final 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 Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static CustomAudience
    parseDelimitedFrom(InputStream input)
     
    static CustomAudience
    parseDelimitedFrom(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(InputStream input)
     
    static CustomAudience
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CustomAudience
    parseFrom(ByteBuffer data)
     
    static CustomAudience
    parseFrom(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

    mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList

    Methods inherited from class com.google.protobuf.GeneratedMessage.ExtendableMessage

    extensionsAreInitialized, extensionsIterator, extensionsSerializedSize, extensionsSerializedSizeAsMessageSet, getAllFields, getAllFieldsRaw, getExtension, getExtension, getExtensionCount, getExtensionFields, getField, getRepeatedField, getRepeatedFieldCount, hasExtension, hasField, makeExtensionsImmutable, newExtensionSerializer, newExtensionWriter, newMessageSetExtensionSerializer, newMessageSetExtensionWriter

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getDescriptorForType, getOneofFieldDescriptor, getUnknownFields, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, 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, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder

    getExtension, getExtension, getExtension, getExtension, getExtensionCount, getExtensionCount, hasExtension, hasExtension

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Overrides:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getResourceName

      public 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 interface CustomAudienceOrBuilder
      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 interface CustomAudienceOrBuilder
      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 interface CustomAudienceOrBuilder
      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.v21.enums.CustomAudienceStatusEnum.CustomAudienceStatus status = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getStatusValue in interface CustomAudienceOrBuilder
      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.v21.enums.CustomAudienceStatusEnum.CustomAudienceStatus status = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getStatus in interface CustomAudienceOrBuilder
      Returns:
      The status.

    • getName

      public 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 interface CustomAudienceOrBuilder
      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 interface CustomAudienceOrBuilder
      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.v21.enums.CustomAudienceTypeEnum.CustomAudienceType type = 5;
      Specified by:
      getTypeValue in interface CustomAudienceOrBuilder
      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.v21.enums.CustomAudienceTypeEnum.CustomAudienceType type = 5;
      Specified by:
      getType in interface CustomAudienceOrBuilder
      Returns:
      The type.

    • getDescription

      public String getDescription()
       Description of this custom audience.
      string description = 6;
      Specified by:
      getDescription in interface CustomAudienceOrBuilder
      Returns:
      The description.

    • getDescriptionBytes

      public com.google.protobuf.ByteString getDescriptionBytes()
       Description of this custom audience.
      string description = 6;
      Specified by:
      getDescriptionBytes in interface CustomAudienceOrBuilder
      Returns:
      The bytes for description.

    • getMembersList

      public 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.v21.resources.CustomAudienceMember members = 7;
      Specified by:
      getMembersList in interface CustomAudienceOrBuilder

    • getMembersOrBuilderList

      public 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.v21.resources.CustomAudienceMember members = 7;
      Specified by:
      getMembersOrBuilderList in interface CustomAudienceOrBuilder

    • 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.v21.resources.CustomAudienceMember members = 7;
      Specified by:
      getMembersCount in interface CustomAudienceOrBuilder

    • 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.v21.resources.CustomAudienceMember members = 7;
      Specified by:
      getMembers in interface CustomAudienceOrBuilder

    • 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.v21.resources.CustomAudienceMember members = 7;
      Specified by:
      getMembersOrBuilder in interface CustomAudienceOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.ExtendableMessage<com.google.protobuf.GeneratedMessageV3>

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static CustomAudience parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CustomAudience parseFrom(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(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static CustomAudience parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static CustomAudience parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static CustomAudience parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static CustomAudience parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static CustomAudience parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public CustomAudience.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.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 interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected CustomAudience.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.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 interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public CustomAudience getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder