Package com.google.ads.googleads.v15.resources

Class Audience

  • All Implemented Interfaces:
    AudienceOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable
    public final class Audience
extends com.google.protobuf.GeneratedMessageV3
implements AudienceOrBuilder
     Audience is an effective targeting option that lets you
 intersect different segment attributes, such as detailed demographics and
 affinities, to create audiences that represent sections of your target
 segments.
    Protobuf type google.ads.googleads.v15.resources.Audience
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Audience.Builder
      Audience is an effective targeting option that lets you intersect different segment attributes, such as detailed demographics and affinities, to create audiences that represent sections of your target segments.

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

      • 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 audience.
 Audience names have the form:

 `customers/{customer_id}/audiences/{audience_id}`
        string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Specified by:
        getResourceName in interface AudienceOrBuilder
        Returns:
        The resourceName.

      • getResourceNameBytes

        public com.google.protobuf.ByteString getResourceNameBytes()
         Immutable. The resource name of the audience.
 Audience names have the form:

 `customers/{customer_id}/audiences/{audience_id}`
        string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Specified by:
        getResourceNameBytes in interface AudienceOrBuilder
        Returns:
        The bytes for resourceName.

      • getId

        public long getId()
         Output only. ID of the audience.
        int64 id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getId in interface AudienceOrBuilder
        Returns:
        The id.

      • getStatusValue

        public int getStatusValue()
         Output only. Status of this audience. Indicates whether the audience
 is enabled or removed.
        .google.ads.googleads.v15.enums.AudienceStatusEnum.AudienceStatus status = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStatusValue in interface AudienceOrBuilder
        Returns:
        The enum numeric value on the wire for status.

      • getStatus

        public AudienceStatusEnum.AudienceStatus getStatus()
         Output only. Status of this audience. Indicates whether the audience
 is enabled or removed.
        .google.ads.googleads.v15.enums.AudienceStatusEnum.AudienceStatus status = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStatus in interface AudienceOrBuilder
        Returns:
        The status.

      • hasName

        public boolean hasName()
         Name of the audience. It should be unique across all audiences within the
 account. It must have a minimum length of 1 and maximum length of 255.
 Required when scope is not set or is set to CUSTOMER. Cannot be set or
 updated when scope is ASSET_GROUP.
        optional string name = 10;
        Specified by:
        hasName in interface AudienceOrBuilder
        Returns:
        Whether the name field is set.

      • getName

        public java.lang.String getName()
         Name of the audience. It should be unique across all audiences within the
 account. It must have a minimum length of 1 and maximum length of 255.
 Required when scope is not set or is set to CUSTOMER. Cannot be set or
 updated when scope is ASSET_GROUP.
        optional string name = 10;
        Specified by:
        getName in interface AudienceOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Name of the audience. It should be unique across all audiences within the
 account. It must have a minimum length of 1 and maximum length of 255.
 Required when scope is not set or is set to CUSTOMER. Cannot be set or
 updated when scope is ASSET_GROUP.
        optional string name = 10;
        Specified by:
        getNameBytes in interface AudienceOrBuilder
        Returns:
        The bytes for name.

      • getDescription

        public java.lang.String getDescription()
         Description of this audience.
        string description = 5;
        Specified by:
        getDescription in interface AudienceOrBuilder
        Returns:
        The description.

      • getDescriptionBytes

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

      • getDimensionsList

        public java.util.List<AudienceDimension> getDimensionsList()
         Positive dimensions specifying the audience composition.
        repeated .google.ads.googleads.v15.common.AudienceDimension dimensions = 6;
        Specified by:
        getDimensionsList in interface AudienceOrBuilder

      • getDimensionsCount

        public int getDimensionsCount()
         Positive dimensions specifying the audience composition.
        repeated .google.ads.googleads.v15.common.AudienceDimension dimensions = 6;
        Specified by:
        getDimensionsCount in interface AudienceOrBuilder

      • getDimensions

        public AudienceDimension getDimensions​(int index)
         Positive dimensions specifying the audience composition.
        repeated .google.ads.googleads.v15.common.AudienceDimension dimensions = 6;
        Specified by:
        getDimensions in interface AudienceOrBuilder

      • hasExclusionDimension

        public boolean hasExclusionDimension()
         Negative dimension specifying the audience composition.
        .google.ads.googleads.v15.common.AudienceExclusionDimension exclusion_dimension = 7;
        Specified by:
        hasExclusionDimension in interface AudienceOrBuilder
        Returns:
        Whether the exclusionDimension field is set.

      • getExclusionDimension

        public AudienceExclusionDimension getExclusionDimension()
         Negative dimension specifying the audience composition.
        .google.ads.googleads.v15.common.AudienceExclusionDimension exclusion_dimension = 7;
        Specified by:
        getExclusionDimension in interface AudienceOrBuilder
        Returns:
        The exclusionDimension.

      • getScopeValue

        public int getScopeValue()
         Defines the scope this audience can be used in. By default, the scope is
 CUSTOMER. Audiences can be created with a scope of ASSET_GROUP for
 exclusive use by a single asset_group. Scope may change from ASSET_GROUP to
 CUSTOMER but not from CUSTOMER to ASSET_GROUP.
        .google.ads.googleads.v15.enums.AudienceScopeEnum.AudienceScope scope = 8;
        Specified by:
        getScopeValue in interface AudienceOrBuilder
        Returns:
        The enum numeric value on the wire for scope.

      • getScope

        public AudienceScopeEnum.AudienceScope getScope()
         Defines the scope this audience can be used in. By default, the scope is
 CUSTOMER. Audiences can be created with a scope of ASSET_GROUP for
 exclusive use by a single asset_group. Scope may change from ASSET_GROUP to
 CUSTOMER but not from CUSTOMER to ASSET_GROUP.
        .google.ads.googleads.v15.enums.AudienceScopeEnum.AudienceScope scope = 8;
        Specified by:
        getScope in interface AudienceOrBuilder
        Returns:
        The scope.

      • getAssetGroup

        public java.lang.String getAssetGroup()
         Immutable. The asset group that this audience is scoped under. Must be set
 if and only if scope is ASSET_GROUP. Immutable after creation. If an
 audience with ASSET_GROUP scope is upgraded to CUSTOMER scope, this field
 will automatically be cleared.
        string asset_group = 9 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Specified by:
        getAssetGroup in interface AudienceOrBuilder
        Returns:
        The assetGroup.

      • getAssetGroupBytes

        public com.google.protobuf.ByteString getAssetGroupBytes()
         Immutable. The asset group that this audience is scoped under. Must be set
 if and only if scope is ASSET_GROUP. Immutable after creation. If an
 audience with ASSET_GROUP scope is upgraded to CUSTOMER scope, this field
 will automatically be cleared.
        string asset_group = 9 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Specified by:
        getAssetGroupBytes in interface AudienceOrBuilder
        Returns:
        The bytes for assetGroup.

      • 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 Audience parseFrom​(java.nio.ByteBuffer data)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Audience parseFrom​(java.nio.ByteBuffer data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Audience parseFrom​(com.google.protobuf.ByteString data)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Audience parseFrom​(com.google.protobuf.ByteString data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Audience parseFrom​(byte[] data)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Audience parseFrom​(byte[] data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Audience parseFrom​(java.io.InputStream input)
                          throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static Audience parseFrom​(java.io.InputStream input,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static Audience parseDelimitedFrom​(java.io.InputStream input)
                                   throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static Audience parseDelimitedFrom​(java.io.InputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static Audience parseFrom​(com.google.protobuf.CodedInputStream input)
                          throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static Audience parseFrom​(com.google.protobuf.CodedInputStream input,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws java.io.IOException
        Throws:
        java.io.IOException

      • newBuilderForType

        public Audience.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public Audience.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected Audience.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static Audience getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<Audience> parser()

      • getParserForType

        public com.google.protobuf.Parser<Audience> 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 Audience getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder