Package com.google.ads.googleads.v10.resources

Class 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 type google.ads.googleads.v10.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<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,​BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,​BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

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

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Method Detail

      • newInstance

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

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.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 class com.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 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.v10.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.v10.enums.CustomAudienceStatusEnum.CustomAudienceStatus status = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStatus in interface CustomAudienceOrBuilder
        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 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.v10.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.v10.enums.CustomAudienceTypeEnum.CustomAudienceType type = 5;
        Specified by:
        getType in interface CustomAudienceOrBuilder
        Returns:
        The type.

      • getDescription

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

      • 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.v10.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.v10.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.v10.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.v10.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.GeneratedMessageV3

      • writeTo

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

      • getSerializedSize

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

      • equals

        public boolean equals​(java.lang.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​(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 interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • 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.GeneratedMessageV3

      • getDefaultInstanceForType

        public CustomAudience getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder