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

Class Audience.Builder

  • All Implemented Interfaces:
    AudienceOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.lang.Cloneable
    Enclosing class:
    Audience
    public static final class Audience.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Audience.Builder>
implements AudienceOrBuilder
     Audience is an effective targeting option that allows you to
 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.v10.resources.Audience

    • Method Detail

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

      • clear

        public Audience.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<Audience.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Audience.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

        public Audience.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<Audience.Builder>

      • setField

        public Audience.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                 java.lang.Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<Audience.Builder>

      • clearField

        public Audience.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Audience.Builder>

      • clearOneof

        public Audience.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Audience.Builder>

      • setRepeatedField

        public Audience.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                         int index,
                                         java.lang.Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Audience.Builder>

      • addRepeatedField

        public Audience.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                         java.lang.Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Audience.Builder>

      • mergeFrom

        public Audience.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Audience.Builder>

      • isInitialized

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

      • mergeFrom

        public Audience.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws java.io.IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Audience.Builder>
        Throws:
        java.io.IOException

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

      • setResourceName

        public Audience.Builder setResourceName​(java.lang.String value)
         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) = { ... }
        Parameters:
        value - The resourceName to set.
        Returns:
        This builder for chaining.

      • clearResourceName

        public Audience.Builder clearResourceName()
         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) = { ... }
        Returns:
        This builder for chaining.

      • setResourceNameBytes

        public Audience.Builder setResourceNameBytes​(com.google.protobuf.ByteString value)
         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) = { ... }
        Parameters:
        value - The bytes for resourceName to set.
        Returns:
        This builder for chaining.

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

      • setId

        public Audience.Builder setId​(long value)
         Output only. ID of the audience.
        int64 id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The id to set.
        Returns:
        This builder for chaining.

      • clearId

        public Audience.Builder clearId()
         Output only. ID of the audience.
        int64 id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        This builder for chaining.

      • getStatusValue

        public int getStatusValue()
         Output only. Status of this audience. Indicates whether the audience
 is enabled or removed.
        .google.ads.googleads.v10.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.

      • setStatusValue

        public Audience.Builder setStatusValue​(int value)
         Output only. Status of this audience. Indicates whether the audience
 is enabled or removed.
        .google.ads.googleads.v10.enums.AudienceStatusEnum.AudienceStatus status = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The enum numeric value on the wire for status to set.
        Returns:
        This builder for chaining.

      • getStatus

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

      • setStatus

        public Audience.Builder setStatus​(AudienceStatusEnum.AudienceStatus value)
         Output only. Status of this audience. Indicates whether the audience
 is enabled or removed.
        .google.ads.googleads.v10.enums.AudienceStatusEnum.AudienceStatus status = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The status to set.
        Returns:
        This builder for chaining.

      • clearStatus

        public Audience.Builder clearStatus()
         Output only. Status of this audience. Indicates whether the audience
 is enabled or removed.
        .google.ads.googleads.v10.enums.AudienceStatusEnum.AudienceStatus status = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        This builder for chaining.

      • getName

        public java.lang.String getName()
         Required. Name of the audience. It should be unique across all
 audiences. It must have a minimum length of 1 and
 maximum length of 255.
        string name = 4 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getName in interface AudienceOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Required. Name of the audience. It should be unique across all
 audiences. It must have a minimum length of 1 and
 maximum length of 255.
        string name = 4 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getNameBytes in interface AudienceOrBuilder
        Returns:
        The bytes for name.

      • setName

        public Audience.Builder setName​(java.lang.String value)
         Required. Name of the audience. It should be unique across all
 audiences. It must have a minimum length of 1 and
 maximum length of 255.
        string name = 4 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The name to set.
        Returns:
        This builder for chaining.

      • clearName

        public Audience.Builder clearName()
         Required. Name of the audience. It should be unique across all
 audiences. It must have a minimum length of 1 and
 maximum length of 255.
        string name = 4 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        This builder for chaining.

      • setNameBytes

        public Audience.Builder setNameBytes​(com.google.protobuf.ByteString value)
         Required. Name of the audience. It should be unique across all
 audiences. It must have a minimum length of 1 and
 maximum length of 255.
        string name = 4 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The bytes for name to set.
        Returns:
        This builder for chaining.

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

      • setDescription

        public Audience.Builder setDescription​(java.lang.String value)
         Description of this audience.
        string description = 5;
        Parameters:
        value - The description to set.
        Returns:
        This builder for chaining.

      • clearDescription

        public Audience.Builder clearDescription()
         Description of this audience.
        string description = 5;
        Returns:
        This builder for chaining.

      • setDescriptionBytes

        public Audience.Builder setDescriptionBytes​(com.google.protobuf.ByteString value)
         Description of this audience.
        string description = 5;
        Parameters:
        value - The bytes for description to set.
        Returns:
        This builder for chaining.

      • getDimensionsList

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

      • getDimensionsCount

        public int getDimensionsCount()
         Positive dimensions specifying the audience composition.
        repeated .google.ads.googleads.v10.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.v10.common.AudienceDimension dimensions = 6;
        Specified by:
        getDimensions in interface AudienceOrBuilder

      • setDimensions

        public Audience.Builder setDimensions​(int index,
                                      AudienceDimension value)
         Positive dimensions specifying the audience composition.
        repeated .google.ads.googleads.v10.common.AudienceDimension dimensions = 6;

      • setDimensions

        public Audience.Builder setDimensions​(int index,
                                      AudienceDimension.Builder builderForValue)
         Positive dimensions specifying the audience composition.
        repeated .google.ads.googleads.v10.common.AudienceDimension dimensions = 6;

      • addDimensions

        public Audience.Builder addDimensions​(AudienceDimension value)
         Positive dimensions specifying the audience composition.
        repeated .google.ads.googleads.v10.common.AudienceDimension dimensions = 6;

      • addDimensions

        public Audience.Builder addDimensions​(int index,
                                      AudienceDimension value)
         Positive dimensions specifying the audience composition.
        repeated .google.ads.googleads.v10.common.AudienceDimension dimensions = 6;

      • addDimensions

        public Audience.Builder addDimensions​(AudienceDimension.Builder builderForValue)
         Positive dimensions specifying the audience composition.
        repeated .google.ads.googleads.v10.common.AudienceDimension dimensions = 6;

      • addDimensions

        public Audience.Builder addDimensions​(int index,
                                      AudienceDimension.Builder builderForValue)
         Positive dimensions specifying the audience composition.
        repeated .google.ads.googleads.v10.common.AudienceDimension dimensions = 6;

      • addAllDimensions

        public Audience.Builder addAllDimensions​(java.lang.Iterable<? extends AudienceDimension> values)
         Positive dimensions specifying the audience composition.
        repeated .google.ads.googleads.v10.common.AudienceDimension dimensions = 6;

      • clearDimensions

        public Audience.Builder clearDimensions()
         Positive dimensions specifying the audience composition.
        repeated .google.ads.googleads.v10.common.AudienceDimension dimensions = 6;

      • removeDimensions

        public Audience.Builder removeDimensions​(int index)
         Positive dimensions specifying the audience composition.
        repeated .google.ads.googleads.v10.common.AudienceDimension dimensions = 6;

      • getDimensionsBuilder

        public AudienceDimension.Builder getDimensionsBuilder​(int index)
         Positive dimensions specifying the audience composition.
        repeated .google.ads.googleads.v10.common.AudienceDimension dimensions = 6;

      • addDimensionsBuilder

        public AudienceDimension.Builder addDimensionsBuilder()
         Positive dimensions specifying the audience composition.
        repeated .google.ads.googleads.v10.common.AudienceDimension dimensions = 6;

      • addDimensionsBuilder

        public AudienceDimension.Builder addDimensionsBuilder​(int index)
         Positive dimensions specifying the audience composition.
        repeated .google.ads.googleads.v10.common.AudienceDimension dimensions = 6;

      • getDimensionsBuilderList

        public java.util.List<AudienceDimension.Builder> getDimensionsBuilderList()
         Positive dimensions specifying the audience composition.
        repeated .google.ads.googleads.v10.common.AudienceDimension dimensions = 6;

      • hasExclusionDimension

        public boolean hasExclusionDimension()
         Negative dimension specifying the audience composition.
        .google.ads.googleads.v10.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.v10.common.AudienceExclusionDimension exclusion_dimension = 7;
        Specified by:
        getExclusionDimension in interface AudienceOrBuilder
        Returns:
        The exclusionDimension.

      • setExclusionDimension

        public Audience.Builder setExclusionDimension​(AudienceExclusionDimension value)
         Negative dimension specifying the audience composition.
        .google.ads.googleads.v10.common.AudienceExclusionDimension exclusion_dimension = 7;

      • setExclusionDimension

        public Audience.Builder setExclusionDimension​(AudienceExclusionDimension.Builder builderForValue)
         Negative dimension specifying the audience composition.
        .google.ads.googleads.v10.common.AudienceExclusionDimension exclusion_dimension = 7;

      • mergeExclusionDimension

        public Audience.Builder mergeExclusionDimension​(AudienceExclusionDimension value)
         Negative dimension specifying the audience composition.
        .google.ads.googleads.v10.common.AudienceExclusionDimension exclusion_dimension = 7;

      • clearExclusionDimension

        public Audience.Builder clearExclusionDimension()
         Negative dimension specifying the audience composition.
        .google.ads.googleads.v10.common.AudienceExclusionDimension exclusion_dimension = 7;

      • getExclusionDimensionBuilder

        public AudienceExclusionDimension.Builder getExclusionDimensionBuilder()
         Negative dimension specifying the audience composition.
        .google.ads.googleads.v10.common.AudienceExclusionDimension exclusion_dimension = 7;

      • setUnknownFields

        public final Audience.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Audience.Builder>

      • mergeUnknownFields

        public final Audience.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Audience.Builder>